Apache commons.net FTPClient使用简述

本文遵守CC BY-SA 3.0。

前言：

　　之前写过个搭建FTP服务器的，搭建完成就要开始使用，网上大概看到过两种通过java来读取、写入，一种是用sun的包，还有一个就是apache的commons.net，前面那个没用过，就不展开了，这里主要介绍apache的这个，废话略多，开始正文。

　　 哦也，还要补充一点，由于网上信息杂乱，好多用法都是直接到官网看API文档自己摆弄的，要是有什么问题或者土鳖的用法，欢迎拍我砖&指证，下面贴出API地址：

　　Apache FTPClient官方API

一、建立连接

　　其实比较简单，就是首先开启连接，然后输入用户名/密码，login函数会返回个boolean，根据需要使用即可。

　　值得说明的是，我总是感觉那个用户名和密码的明文组合真的很蛋疼，就自作主张的使用了一个Properties文件，把url/username/passwd都放进去了，当然，还有个basePath，这个后面的结合apache会用到，到时候再说。

　　还要注意的是9，10行的两句话，

　　　　1.setFileType(int fileType)，如果没有需求上传图片的话还ok，但是要是传图片，就需要设置一下文件类型为二进制，这样上传的图片才不会报错（记得我的错误貌似是什么ASCII编码什么的。。）

　　　　2.setControlEncoding（），设置FTP的字符编码，这个函数是从FTP父类过来的。

public static FTPClient getFtpClient(Properties properties){
        FTPClient ftpClient = new FTPClient();
        try{
            String url = properties.getProperty("url");
            String username = properties.getProperty("username");
            String passwd = properties.getProperty("passwd");
            ftpClient.connect(url);
            ftpClient.login(username, passwd);
//            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
//            ftpClient.setControlEncoding("UTF-8");
            
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return ftpClient;
    }

　　=============我风骚的插了进来==================

　　既然说到Properties，我再贴个读取的工具函数好了，同样很简单，权当是增加篇幅。。

　　需要注意以下几个事情：

　　1.那个Tools其实就是个工具类，我把创建的properties文件放在了这个类的目录下面，完事直接取就行了；

　　2.注意这个函数是private的，我感觉想取这个文件的话还是就在这个工具类里面就好了，也不清楚是不是多此一举（我就这么弄），有其他需求自行修改哈。。

private static Properties getProperties() {
        InputStream inStream = Tools.class.getResourceAsStream("ftpLogin.properties");
        Properties properties = new Properties();
        try {
            properties.load(inStream);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return properties;
    }

　　=========================================

二、文件上传

　　heihei，我没使用文件下载，不过看了一下API文档，感觉也就那么回事，有需求再研究下，这里就记一下上传吧。

　　下面这段代码同样有几个地方需要注意一下：

　　1. 不要在意那个16行的注释，原来的第三个参数就是fileType，当时脑抽，逻辑是有问题的，放在这里警戒自己；

　　2. Tools.Mkdirs()：这个函数使用来创建多级目录用的，没有在API文档里面找到相关用法，也查了网上的做法，也都不高明。。干脆献丑自己搞了一段，没什么水平，需要改进，后面会贴出来；

　　3. changeWorkingDirectory(path)：创建完了目录需要将当前工作目录切换过来，然后直接在下面创建文件；

　　4. storeFile(String remote,InputStream local): 名字是要写到的远程文件的名字，这里用了和输入文件同名，关于输入流，就是内容文件（输入文件）的输入流；

　　5. sendSiteCommand(String command): 这个是在远程端执行ftp命令用的，和一个叫doCommand()的函数有点像，不过那个貌似只能操作有输出的命令，没用过，不负责任哈:-)，这个函数还要多说一点，之所以这么用，是因为我发现使用storeFile()上传上去的文件都是默认700的，因为我结合了apache2服务器使用，直接导致劳资无法使用已经上传的文件，所以才有修改权限的事情；

　　6. 这里其实写的还有点问题，因为我写文件的次数比较多，从这么get然后再close的用法显然在性能上面有损耗，最好在上传的时候集中一下，就是说要先get到这个ftpClient，然后再集中上传，都上传完了再close掉，不过我暂时还没有写。。

　　7. 关于这一大片的tmp**，这东西我写了不少，但是一个都没用，不过倒是可以留着，等开始调试的时候会发现好处的；

　　8. 关于中文编码：一共要进行两次转码，根据查询发现FTPClient默认的字符编码貌似是ISO-8859-1，而我使用的是linux平台，应该是UTF-8的，所以这里需要进行一次转码，是对文件名的，还有一次在Mkdirs()中，是对文件夹名的；

/*
     * @param filename : the file u want to upload(without path)
     * 
     * @param path : the path u want to upload to(without filename)
     * 
     */
    @SuppressWarnings("resource")
    public static Boolean FtpUpload(File filename,String path){
        Boolean success = false;
        String LOCAL_CHARSET = "GBK";
        String SERVER_CHARSET = "ISO-8859-1";
        try {
            FileInputStream in = new FileInputStream(filename);
            //get properties & get connect ftpClient
            Properties properties = Tools.getProperties();
            FTPClient ftpClient = Tools.getFtpClient(properties);
            
            // 开启服务器对UTF-8的支持，如果服务器支持就用UTF-8编码，否则就使用本地编码（GBK）.
            if(FTPReply.isPositiveCompletion(ftpClient.sendCommand("OPTS UTF8", "ON"))) {
                LOCAL_CHARSET = "UTF-8";
            }
            ftpClient.setControlEncoding(LOCAL_CHARSET);
            
//            if(fileType == FTP.BINARY_FILE_TYPE){
//                ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
//            }
            //check if connection failed
            int reply = 0;
            reply = ftpClient.getReplyCode();
            if (!FTPReply.isPositiveCompletion(reply)) { 
                ftpClient.disconnect(); 
                return success;
            }
            //mkdirs(in case of multiple level directory)
            if(path != null && !path.isEmpty()){
                //MKdirs中有关于path的转码
                boolean tmpMkdir = Tools.Mkdirs(ftpClient, path);
                System.out.println(ftpClient.printWorkingDirectory());
                boolean tmpCd = ftpClient.changeWorkingDirectory(path);
                System.out.println(ftpClient.printWorkingDirectory());
            }
            //上传文件时，文件名称需要做编码转换
            String name = new String(filename.getName().getBytes(LOCAL_CHARSET),SERVER_CHARSET);
            boolean tmpStore = ftpClient.storeFile(name, in);
            boolean tmpDoCommand = ftpClient.sendSiteCommand("chmod 755 " + name);
            //here is a mark that maybe i should close ftp connections after all store..
            //like create a new function to close :-(
            in.close();
            ftpClient.logout();
            success = true;
            }catch (FileNotFoundException e1) {
                // TODO Auto-generated catch block
                e1.printStackTrace();
            } catch (SocketException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            } catch (Exception e){
                e.printStackTrace();
            }
        return success;
    }

　　===============我又风骚的插了进来===================

　　上面说到了那个创建Mkdirs的函数，在这里贴出来（话说真的写的好渣，不过比没有强哈，我会再改进，这篇博文立了好多flag，我会一个一个收的，改进是永无止境的）

　　下面还是来做些说明：

　　1. sendSiteCommand(): 这个函数有出现的原因是因为之前的文件上传，我只对文件进行了权限修改，这边是创建文件夹，我也做了同样的事情；

　　2.创建完成之后，我又把目录弄回去了，考虑到mkdir了之后操作各有不同，就恢复了工作路径，还是那句话，根据需要自行处理；

　　3. 关于中文编码：上面提到过，一共需要两次转码，之前一次是对文件名进行转码，在这里则对文件夹名进行转码；

public static Boolean Mkdirs(FTPClient ftpClient,String path){
        Boolean success = false;
        String[] subDirs = path.split("/");
        
        String LOCAL_CHARSET = "GBK";
        String SERVER_CHARSET = "ISO-8859-1";
        
        //check if is absolute path
        if(path.substring(0, 0).equalsIgnoreCase("/")){
            subDirs[0] = "/" + subDirs[0];
        }
        boolean tmpMkdirs = false;
        try {
            // 开启服务器对UTF-8的支持，如果服务器支持就用UTF-8编码，否则就使用本地编码（GBK）.
            if(FTPReply.isPositiveCompletion(ftpClient.sendCommand("OPTS UTF8", "ON"))) {
                LOCAL_CHARSET = "UTF-8";
            }
            ftpClient.setControlEncoding(LOCAL_CHARSET);
            
            String orginPath = ftpClient.printWorkingDirectory();
            for(String subDir : subDirs){
                //encoding
                String strSubDir = new String(subDir.getBytes(LOCAL_CHARSET),SERVER_CHARSET);
                tmpMkdirs = ftpClient.makeDirectory(strSubDir);
                boolean tmpDoCommand = ftpClient.sendSiteCommand("chmod 755 " + strSubDir);
                ftpClient.changeWorkingDirectory(strSubDir);
                success = success || tmpMkdirs;
            }
            //ftpClient.changeWorkingDirectory(orginPath);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return success;
    }

　　==============================================

三、apache2服务器

　　上面说到了basePath还记得不，由于项目需求，要从搭建的FTP服务器上面读取数据，就干脆弄了个apache服务器，用来将FTP的目录发布出来，供其他项目共享，而这个basePath就是共享目录的目录名，记得加"/"哈。

　　搭建apache服务器的具体细节请参看我的另一篇博文 Ubuntu下搭建apache服务器。