Java通过FTPClient实现登陆、文件上传、文件下载以及文件夹的遍历

最近工作中遇到需要定期从FTP上下载文件的需求，故整理了一个工具类以供后续使用。

工具类中主要使用了org.apache.commons.net.ftp中的相关类，因此加入如下的Maven依赖：

    commons-net
	commons-net
	3.6

创建FTP工具类：FTPUtil.java。具体使用方法详见注释：

import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;
import org.apache.log4j.Logger;

import java.io.*;

public class FTPUtil {
    private static Logger logger = Logger.getLogger(FTPUtil.class);

    /**
     * 登陆FTP并获取FTPClient对象
     *
     * @param host     FTP主机地址
     * @param port     FTP端口
     * @param userName 登录用户名
     * @param password 登录密码
     * @return
     */
    public static FTPClient loginFTP(String host, int port, String userName, String password) {
        FTPClient ftpClient = null;
        try {
            ftpClient = new FTPClient();
            // 连接FTP服务器
            ftpClient.connect(host, port);
            // 登陆FTP服务器
            ftpClient.login(userName, password);
            // 中文支持
            ftpClient.setControlEncoding("UTF-8");
            // 设置文件类型为二进制（如果从FTP下载或上传的文件是压缩文件的时候，不进行该设置可能会导致获取的压缩文件解压失败）
            ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);
            ftpClient.enterLocalPassiveMode();

            if (!FTPReply.isPositiveCompletion(ftpClient.getReplyCode())) {
                logger.error("连接FTP失败，用户名或密码错误。");
                ftpClient.disconnect();
            } else {
                logger.info("FTP连接成功!");
            }
        } catch (Exception e) {
            logger.error("登陆FTP失败，请检查FTP相关配置信息是否正确！", e);
        }
        return ftpClient;
    }

    /**
     * 从FTP下载文件到本地
     * @param ftpClient     已经登陆成功的FTPClient
     * @param ftpFilePath   FTP上的目标文件路径
     * @param localFilePath 下载到本地的文件路径
     */
    public static void downloadFileFromFTP(FTPClient ftpClient, String ftpFilePath, String localFilePath) {
        InputStream is = null;
        FileOutputStream fos = null;
        try {
            // 获取ftp上的文件
            is = ftpClient.retrieveFileStream(ftpFilePath);
            fos = new FileOutputStream(new File(localFilePath));
            // 文件读取方式一
            int i;
            byte[] bytes = new byte[1024];
            while ((i = is.read(bytes)) != -1) {
                fos.write(bytes, 0, i);
            }
            // 文件读取方式二
            //ftpClient.retrieveFile(ftpFilePath, new FileOutputStream(new File(localFilePath)));
            ftpClient.completePendingCommand();
            logger.info("FTP文件下载成功！");
        } catch (Exception e) {
            logger.error("FTP文件下载失败！", e);
        } finally {
            try {
                if (fos != null) {
                    fos.close();
                }
                if (is != null) {
                    is.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 上传本地文件到FTP
     * @param ftpClient         已经登陆成功的FTPClient
     * @param localFilePath     要上传的本地文件路径
     * @param ftpFilePath       要保存的FTP文件路径
     */
    public static void uploadFileToFTP(FTPClient ftpClient, String localFilePath, String ftpFilePath) {
        OutputStream os = null;
        FileInputStream fis = null;
        try {
            // 获取ftp上的文件
            os = ftpClient.storeFileStream(ftpFilePath);
            fis = new FileInputStream(new File(localFilePath));
            // 文件保存方式一
            int length;
            byte[] bytes = new byte[1024];
            while ((length = fis.read(bytes)) != -1) {
                os.write(bytes, 0, length);
            }
            // 文件保存方式二
            //ftpClient.storeFile(ftpFilePath, new FileInputStream(new File(localFilePath)));
            ftpClient.completePendingCommand();
            logger.info("FTP文件上传成功！");
        } catch (Exception e) {
            logger.error("FTP文件上传失败！", e);
        } finally {
            try {
                if (fis != null) {
                    fis.close();
                }
                if (os != null) {
                    os.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 获取FTP某一特定目录下的所有文件名称
     * @param ftpClient     已经登陆成功的FTPClient
     * @param ftpDirPath    FTP上的目标文件路径
     */
    public void getFileNameListFromFTP(FTPClient ftpClient, String ftpDirPath) {
        try {
            if (ftpDirPath.startsWith("/") && ftpDirPath.endsWith("/")) {
                // 通过提供的文件路径获取FTPFile对象列表
                FTPFile[] files = ftpClient.listFiles(ftpDirPath);
                // 遍历文件列表，打印出文件名称
                for (int i = 0; i < files.length; i++) {
                    FTPFile ftpFile = files[i];
                    // 此处只打印文件，未遍历子目录（如果需要遍历，加上递归逻辑即可）
                    if (ftpFile.isFile()) {
                        logger.info(ftpDirPath + ftpFile.getName());
                    }
                }
            } else {
                logger.error("当前FTP路径不可用");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

最后创建测试类FTPUtilTest.java：

import org.apache.commons.net.ftp.FTPClient;

import java.io.IOException;

public class FTPUtilTest {
    public static void main(String[] args) throws IOException {
        FTPClient ftpClient = FTPUtil.loginFTP("192.168.8.88", 21, "userName", "******");
        FTPUtil.downloadFileFromFTP(ftpClient, "/usr/local/test.txt", "/Users/123/Downloads/test.txt");
        FTPUtil.uploadFileToFTP(ftpClient, "/Users/123/Downloads/test2.txt", "/usr/local/test2.txt");
        ftpClient.disconnect();
    }
}

注意事项：

一、很多人在循环调用上传或下载方法的时候，有的会遇到第一次调用没问题，但是从第二次开始ftpClient.retrieveFileStream和ftpClient.storeFileStream返回null的问题，因此此问题的原因在于漏掉了下面这句代码

ftpClient.completePendingCommand();

切记在成功读取或者上传一个文件之后调用该方法。

二、如果遇到上传或者下载后的Zip文件无法打开或者使用密码无法解压的情况，则是遗漏了下面这句代码：

ftpClient.setFileType(FTPClient.BINARY_FILE_TYPE);