java连接ftp工具类

小鱼儿 2022-01-27 05:19 325阅读 0赞

这里使用了org.apache.commons.net.ftp这个类库，仅仅是对这个类库稍微封装了一下方便使用，这里写了一个工具类，大家可以参考一下。

### 介绍一个 [ftp客户端工具：iis7服务器管理工具][ftp_iis7] ###

IIs7服务器管理工具可以批量管理ftp站点，同时具备定时上传下载的功能。

作为服务器集成管理器，它最优秀的功能就是批量管理windows与linux系统服务器、vps。能极大的提高站长及服务器运维人员工作效率。同时iis7服务器管理工具还是vnc客户端，服务器真正实现了一站式管理，可谓是非常方便。  
下载地址：[http://yczm.iis7.com/?tscc][ftp_iis7]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3RvbW9ycm93X2ZpbmU_size_16_color_FFFFFF_t_70_pic_center]

### 依赖 ###

<dependency>
                <groupId>commons-net</groupId>
                <artifactId>commons-net</artifactId>
                <version>${commons.net.version}</version>
            </dependency>

### 工具类 ###

public class FtpUtil {
        /**
         * 维护FTPClient实例
         */
        private final static LinkedBlockingQueue<FTPClient> FTP_CLIENT_QUEUE = new LinkedBlockingQueue<>();
    
        /**
         * 创建目录
         *
         * @param ftpConfig  配置
         * @param remotePath 需要创建目录的目录
         * @param makePath   需要创建的目录
         * @return 是否创建成功
         */
        public static boolean makeDirectory(FtpConfig ftpConfig, String remotePath, String makePath) {
            try {
                FTPClient ftpClient = connectClient(ftpConfig);
                boolean changeResult = ftpClient.changeWorkingDirectory(remotePath);
                if (!changeResult) {
                    throw new RuntimeException("切换目录失败");
                }
                boolean result = ftpClient.makeDirectory(makePath);
                // 退出FTP
                ftpClient.logout();
                //归还对象
                offer(ftpClient);
                return result;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    
        /**
         * 移动文件
         *
         * @param ftpConfig 配置
         * @param fromPath  待移动目录
         * @param fromName  待移动文件名
         * @param toPath    移动后目录
         * @param toName    移动后文件名
         * @return 是否移动成功
         */
        public static boolean moveFile(FtpConfig ftpConfig, String fromPath, String fromName, String toPath, String toName) {
            try {
                FTPClient ftpClient = connectClient(ftpConfig);
                boolean changeResult = ftpClient.changeWorkingDirectory(fromPath);
                if (!changeResult) {
                    throw new RuntimeException("切换目录失败");
                }
                boolean result = ftpClient.rename(fromName, toPath + File.separator + toName);
                // 退出FTP
                ftpClient.logout();
                //归还对象
                offer(ftpClient);
                return result;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    
    
        /**
         * 删除文件
         *
         * @param ftpConfig  配置
         * @param remotePath 远程目录
         * @param fileName   文件名
         * @return 是否删除成功
         */
        public static boolean deleteFile(FtpConfig ftpConfig, String remotePath, String fileName) {
            try {
                FTPClient ftpClient = connectClient(ftpConfig);
                boolean changeResult = ftpClient.changeWorkingDirectory(remotePath);
                if (!changeResult) {
                    throw new RuntimeException("切换目录失败");
                }
                boolean result = ftpClient.deleteFile(fileName);
                // 退出FTP
                ftpClient.logout();
                //归还对象
                offer(ftpClient);
                return result;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    
        /**
         * 下载文件
         *
         * @param ftpConfig  配置
         * @param remotePath 远程目录
         * @param fileName   文件名
         * @param localPath  本地目录
         * @param localName  本地文件名
         * @return 是否下载成功
         */
        public static boolean download(FtpConfig ftpConfig, String remotePath, String fileName, String localPath, String localName) {
            try {
                FTPClient ftpClient = connectClient(ftpConfig);
                boolean changeResult = ftpClient.changeWorkingDirectory(remotePath);
                if (!changeResult) {
                    throw new RuntimeException("切换目录失败");
                }
                ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
                File file = new File(localPath, localName);
                if (!file.getParentFile().exists()) {
                    boolean mkdirsResult = file.getParentFile().mkdirs();
                    if (!mkdirsResult) {
                        throw new RuntimeException("创建目录失败");
                    }
                }
                if (!file.exists()) {
                    boolean createFileResult = file.createNewFile();
                    if (!createFileResult) {
                        throw new RuntimeException("创建文件失败");
                    }
                }
                OutputStream outputStream = new FileOutputStream(file);
                boolean result = ftpClient.retrieveFile(fileName, outputStream);
                outputStream.flush();
                outputStream.close();
                // 退出FTP
                ftpClient.logout();
                //归还对象
                offer(ftpClient);
                return result;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    
        /**
         * 上传文件
         *
         * @param ftpConfig   配置
         * @param remotePath  远程目录
         * @param inputStream 待上传文件输入流
         * @param fileName    文件名
         * @return 是否上传成功
         */
        public static boolean upload(FtpConfig ftpConfig, String remotePath, InputStream inputStream, String fileName) {
            try {
                FTPClient ftpClient = connectClient(ftpConfig);
                boolean changeResult = ftpClient.changeWorkingDirectory(remotePath);
                if (!changeResult) {
                    throw new RuntimeException("切换目录失败");
                }
                // 设置被动模式
                ftpClient.enterLocalPassiveMode();
                // 设置流上传方式
                ftpClient.setFileTransferMode(FTP.STREAM_TRANSFER_MODE);
                // 设置二进制上传
                ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
                //中文存在问题
                // 上传 fileName为上传后的文件名
                boolean result = ftpClient.storeFile(fileName, inputStream);
                // 关闭本地文件流
                inputStream.close();
                // 退出FTP
                ftpClient.logout();
                //归还对象
                offer(ftpClient);
                return result;
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
    
        /**
         * 登录ftp
         *
         * @param ftpConfig 配置
         * @return 是否登录成功
         * @throws IOException
         */
        private static FTPClient connectClient(FtpConfig ftpConfig) throws IOException {
            FTPClient ftpClient = getClient();
            // 连接FTP服务器
            ftpClient.connect(ftpConfig.ip, ftpConfig.port);
            // 登录FTP
            ftpClient.login(ftpConfig.userName, ftpConfig.password);
            // 正常返回230登陆成功
            int reply = ftpClient.getReplyCode();
            if (!FTPReply.isPositiveCompletion(reply)) {
                ftpClient.disconnect();
                throw new RuntimeException("连接ftp失败");
            }
            ftpClient.setControlEncoding("GBK");
            return ftpClient;
        }
    
        /**
         * 获取ftpClient对象
         *
         * @return 获取client对象
         */
        private static FTPClient getClient() {
            FTPClient ftpClient = FTP_CLIENT_QUEUE.poll();
            if (ftpClient != null) {
                return ftpClient;
            }
            return new FTPClient();
        }
    
        private static void offer(FTPClient ftpClient) {
            FTP_CLIENT_QUEUE.offer(ftpClient);
        }
    
        /**
         * 连接ftp配置
         */
        public static class FtpConfig {
            private String ip;
            private int port;
            private String userName;
            private String password;
    
            public FtpConfig setIp(String ip) {
                this.ip = ip;
                return this;
            }
    
            public FtpConfig setPort(int port) {
                this.port = port;
                return this;
            }
    
            public FtpConfig setUserName(String userName) {
                this.userName = userName;
                return this;
            }
    
            public FtpConfig setPassword(String password) {
                this.password = password;
                return this;
            }
        }
    }

### 使用示例 ###

public class Main {
        private final static Logger logger = LoggerFactory.getLogger(Main.class);
    
        public static void main(String[] args) throws Exception {
            //连接配置
            FtpUtil.FtpConfig ftpConfig = new FtpUtil.FtpConfig().setUserName("1098481123@qq.com")
                    .setPassword("zhan123456").setIp("192.168.33.105").setPort(21);
            //创建目录
            FtpUtil.makeDirectory(ftpConfig, "/", "test");
            FtpUtil.makeDirectory(ftpConfig, "/", "test2");
    
            //上传文件
            InputStream inputStream = new FileInputStream("G:\\a.txt");
            FtpUtil.upload(ftpConfig, "/test", inputStream, "zhan.txt");
    
            //下载文件
            FtpUtil.download(ftpConfig, "/test", "zhan.txt", "G:", "b.txt");
    
            //移动文件
            FtpUtil.moveFile(ftpConfig, "/test", "zhan.txt", "/test2", "zhan1.txt");
    
            //删除文件
            FtpUtil.deleteFile(ftpConfig, "/test", "zhan.txt");
            FtpUtil.deleteFile(ftpConfig, "/test2", "zhan1.txt");
        }
    }

[ftp_iis7]: http://yczm.iis7.com/?tscc
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3RvbW9ycm93X2ZpbmU_size_16_color_FFFFFF_t_70_pic_center]: /images/20220127/39f4cacb4f4341a5a13a879126e53755.png