一个简单的文件分享工具

一个简单的文件分享工具

GitHub 地址：https://github.com/SmythAsen/ShareFilesSystem

在过去的一个星期，我在做一个基于TCP/IP传输层协议的文件分享工具，这个工具的主要功能就是类似于将要分享文件的分享端作为Ftp文件服务器，而下载文件方则为客户端。而在此过程中，服务端需要提供给客户端ip地址和端口号。
说明：编写此程序目的在于学习TCP/IP传输协议相关知识，http协议及ftp协议的底层实现原理。并未打算应用此程序，所以没有说明界面设计，主要注重功能的实现，同时写本文也是为了记录和总结这学习的过程，更是为了锻炼自己的写作能力，欢迎大家指出我的不足与错误。也欢迎大家来github提出你们的想法。

一、当前进度

由于比较忙，项目的整体进度比较慢，一个星期下来只实现了客户端的基本功能，所以这一次记录也主要记录客户端的工作以及原理。

二、工具主要设计思想

• 服务端：
  　1.服务端需要共享一个文件夹，并将文件列表发送给每一个连接上来的客户端。
  　2.需要接受到客户端发送过来的下载文件的指令
  　3.根据文件下载指令向客户端传输指定的文件以及文件的大小。
• 客户端：
  　1.客户端需要输入服务端ip以及端口号来与其进行连接。
  　2.接受客户端发送过来的文件列表
  　3.将输入的文件下载指令发送给服务端
  　4.接收服务端传送过来的文件并保存到到指定目录

三、客户端实现原理

• 首先客户端需要连接上服务器，非常简单。

　　//连接到服务器
    public void connect() throws UnknownHostException, IOException{
                socket = new Socket(ip, port);
                isconnect = true;
    }

注意，这里的ip和端口都是来自客户端界面的。 同时我们需要将错误抛给调用他的界面，一点出现任何问题让界面进行处理。

• 其次客户端需要接受来自服务端的文件列表

//获取从服务器传输过来的文件名
    @SuppressWarnings("unchecked")
    public String getFilesName() {
        String filesName = "";
        if(isconnect){
            ObjectInputStream ois = null;
            try {
                ois = new ObjectInputStream(socket.getInputStream());
                //从服务器取得文件列表
                files = (TreeMap<Integer, String>) ois.readObject();
                Set<Integer> ids = files.keySet();
                for (Object id : ids) {
                    String s = id + ":" +files.get(id)+"\n";
                    filesName += s;
                }
            } catch (IOException | ClassNotFoundException e) {
                e.printStackTrace();
            }
            return filesName;
        }
        return "未接收到内容";
    }

这里需要注意的是服务端我是用TreeMap将文件名以及对应的指令传输过来的。所以需要使用ObjectInputStream来接收文件列表并将接收类型强转为TreeMap类型。最后将接收的文件id和文件名拼成一个字符串返回个调用此方法的客户端界面。

• 接下来，就是将界面输入的需要下载的文件指令发送给服务端了。

    /**
     * 检验客户端界面发过来的指令是否正确，  
     如果正确则向服务器发送下载指令并向客户端返回tru，  
     如果不正确则向客服的界面返回false
     * @param id
     * @param dir
     * @return
     */
    public boolean sendComm(int id, String dir) {
        //判断界面传过来的指令是否存在
        boolean isCommExist = false;
        for (int i  : files.keySet()) {
            if(i == id){
                isCommExist = true;
            }
        }
        if(isCommExist){
            PrintStream ps;
            try {
                //发送下载指令
                ps = new PrintStream(socket.getOutputStream());
                ps.println(String.valueOf(id));
                //设置下载文件
                this.dir = dir;
                this.filename = files.get(id);
            } catch (IOException e) {
                return false;
            }
            return true;
        }
        return false;
    }

在这里我们首先要检验界面要我们发送的指令是否在，如果不存在则要求重新输入，如果存在则向服务端发送该指令，并向界面给的路径设置为我们即将保存文件的路径。

• 最后就是下载文件了

  //下载文件
    private void download(String dir,String filename) throws IOException {
        BufferedInputStream bis = new BufferedInputStream(socket.getInputStream());
        BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(new File(dir,filename)));
        ObjectInputStream ois = new ObjectInputStream(socket.getInputStream());
        //取得所下载文件大小
        fileSize = ois.readLong();
        System.out.println("cc:文件下载的大小为"+fileSize);
        byte[] b = new byte[1024];
        int len = 0;
        while((len = bis.read(b)) != -1){
            bos.write(b, 0, len);
            currentFileSize += len;
        }
        bos.close();
    }

这里，我们需要分别准备服务端的输入流和客户端的输出流，在接收文件的同时将其保存到指定的路径下。当然为了在客户端试试显示下载的情况，这里也需要先获得服务端传输过来的文件大小并将其返回给界面，并将当前下载进度返回给界面。

四、客户端判断逻辑

• 连接判断逻辑

  // 检验输入信息
            if (!tf_ip.getText().trim().equals("") && !tf_port.getText().trim().equals("")) { // 保证输入框有内容
                if (tf_port.getText().trim().matches("^\\d*$")) {// 判断端口输入框内容是否为数字
                    ip = tf_ip.getText().trim(); // 将输入的ip地址传输到处理程序
                    port = Integer.parseInt(tf_port.getText().trim());// 将输入的接口传入到处理程序
                        try {
                            // 连接服务器
                            cc = new ClientCore(ip, port);
                            cc.connect();
                            isconnected = true;
                        } catch (UnknownHostException e) {
                            isconnected = false;
                        } catch (IOException e) {
                            isconnected = false;
                        }
                }
                if (isconnected) {
                    label_isconnect.setText("连接成功！");
                    label_isconnect.setForeground(Color.GREEN);
                    // 连接成功后将服务器传输过来的内容展示在客户端上面
                    filesName = cc.getFilesName();// 获取文件列表
                    filelist.setText("服务器文件:\n" + filesName);// 展示文件列表
                } else {
                    connectErr(label_isconnect, "IP地址或端口号错误！");
                }
            } else {
                connectErr(label_isconnect, "请输入IP地址或端口号！");
            }

1.我们要判断输入框时候有内容，如果没有这提示输入ip或端口。
2.我们还要判断端口号里的内容是否为数字，如果为数字则将其强转型为int类型并尝试连接服务端。期间出现任何问题则判断为连接不成功。
3.根据标志isconnected来判断是否连接成功，并提示相应的操作。

• 下载判断逻辑

  if (isconnected) {
                // 检验选择的指令是否存在，路径是否正确
                int comm = 0;
                String dir = null;
                // 首先检验时候有输入id和路径
                if (!"".equals(tf_id.getText().trim()) && !"".equals(tf_savedir.getText().trim())) {
                    // 将验证工作交给类ClientCore处理
                    if (tf_id.getText().trim().matches("^\\d*$")) { // 判断文件id是否为数字
                        comm = Integer.parseInt(tf_id.getText().trim());
                        dir = tf_savedir.getText().trim();
                        // 如果通過CilentCore的验证，则下载该文件,下载文件逻辑交给ClientCore
                        if (cc.sendComm(comm, dir)) { // 判断指令是否正确
                            try {
                                cc.startDownload();
                            } catch (IOException e) {
                                // TODO 处理下载错误逻辑...
                                e.printStackTrace();
                            }
                            // 监控下载进度，此处应该判断，当文件下载遇到错误是如何处理//TODO
                            btn_download.setEnabled(false);
                            setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
                            task = new DownloadTask(ClientFrame.this, cc, btn_download, pr, isdownload);
                            task.addPropertyChangeListener(this);
                            task.execute();
                        }
                    } else {
                        downloadErr("请输入正确指令");
                    }
                } else {
                    downloadErr("请输入下载指令或下载路径");
                }
            } else {
                downloadErr("请先连接服务器");
            }
        }

1.在下载之前，我们首先要检查一下是否已经连接上服务端了，如果没有连接则提示先连接服务端再下载。
2.我们同样也需要判断输入框内是否有内容，如果没有则提示相应的信息。如果有，这里我们同样要判断指令为数字才能将其发送给处理核心的类。如果一切都没有问题则开始下载。
在开始下载的同时需要开启一个线程来监控下载的进度。下面是监控下载进度的代码。
downloadTask.java

package com.asen.client;

import java.awt.Color;
import java.awt.Toolkit;
import java.text.SimpleDateFormat;

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JProgressBar;
import javax.swing.SwingWorker;

/**
 * 为客户端下载提供的委托事件，用于更新进度条
 * @author Asen
 */
public class DownloadTask extends SwingWorker<Void, Void> {

    private JFrame frame;
    private JProgressBar pr;
    private JLabel isdownload;
    private JButton btn_download;
    private ClientCore cc; // 客服端逻辑处理类

    public DownloadTask(JFrame frame, ClientCore cc, JButton btn_download, JProgressBar pr, JLabel isdownload) {
        this.frame = frame;
        this.btn_download = btn_download;
        this.pr = pr;
        this.isdownload = isdownload;
        this.cc = cc;
    }

    /*
     * 主要任务，当现场启动后，会在后台运行
     */
    @Override
    public Void doInBackground() {

        int progress = 0; 
//      // 初始化进度条
        setProgress(0);
        //让程序监控进度的程序休眠0.5ms，保证拿到文件的总大小
        try {
            Thread.sleep(500);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        //获得进度条的最大值
        long total = cc.getFileSize();
        pr.setMinimum(0);
        pr.setMaximum((int) total);
        String tip = "";
        while (progress < total) {
            progress = cc.getCurrentFileSize();
            pr.setValue(progress);
            tip = "正在下载:"+String.valueOf(progress/(1024*1024))+"MB/"+String.valueOf(total/(1024*1024))+"MB";
            pr.setString(tip);
            isdownload.setText("正在下载..");
            isdownload.setForeground(Color.ORANGE);
            System.out.println("dt:当前下载大小------>" + progress);
        }
        return null;
    }

    @Override
    public void done() {
        SimpleDateFormat sdf = new SimpleDateFormat("yyy-MM-dd HH:mm:dd");
        System.out.println(sdf.format(System.currentTimeMillis())+":下载完成！");
        isdownload.setText("下载完成");
        pr.setString("下载完成,文件大小:"+cc.getFileSize()/(1024*1024)+"MB");
        isdownload.setForeground(Color.GREEN);
        Toolkit.getDefaultToolkit().beep(); //下载完成后发出提示音
        btn_download.setEnabled(true);
        frame.setCursor(null); // 关闭鼠标等待状态
    }
}

以上基本就是该项目的所有核心代码了，当然这里界面的代码我就没有放进来了，因为有点多，而且还没多大用处，如果需要详细了解该项目的话，请点击最顶端的github地址查看项目源码，我会将后期的完善以及升级也提交上去。如果想了解我更多可以点击下方原文链接关注下面的公众号哦。
原文链接