java使用ftp案例

1、依赖引入

        <dependency>
            <groupId>commons-net</groupId>
            <artifactId>commons-net</artifactId>
            <version>3.9.0</version>
        </dependency>

2、案例代码

package work.vcloud.scan.util.ftp;

import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPFile;
import org.apache.commons.net.ftp.FTPReply;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

@Component
public class FtpUtil {
    // 连接超时时间(毫秒)
    private static final int CONNECT_TIMEOUT = 60 * 1000;
    
    //FTP服务器地址
    @Value("${ftp.host}")
    private String host;

    //FTP服务器端口
    @Value("${ftp.port}")
    private Integer port;

    //FTP用户名
    @Value("${ftp.userName}")
    private String userName;

    //FTP密码
    @Value("${ftp.password}")
    private String password;


    private FTPClient getFtpClient() throws Exception {
        // 创建FTPClient实例
        FTPClient ftpClient = new FTPClient();
        // 设置连接超时时间
        ftpClient.setConnectTimeout(CONNECT_TIMEOUT);
        // 连接FTP服务器
        ftpClient.connect(host, port);
        // 获取服务器响应码
        int reply = ftpClient.getReplyCode();
        // 检查响应码是否为正面响应，如果不是，则断开连接并抛出异常
        if (!FTPReply.isPositiveCompletion(reply)) {
            ftpClient.disconnect();
            throw new Exception("FTP connection failed with reply code: " + reply);
        }
        // 尝试使用用户名和密码登录FTP服务器
        boolean success = ftpClient.login(userName, password);
        // 如果登录失败，抛出异常
        if (!success) {
            throw new Exception("FTP login failed.");
        }
        // 设置上传文件类型为二进制，否则文件可能无法正确打开
        ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
        // 设置缓冲区大小
        ftpClient.setBufferSize(1024);
        // 设置控制编码为UTF-8
        ftpClient.setControlEncoding("UTF-8");
        // 切换到本地被动模式
        ftpClient.enterLocalPassiveMode();
        // 返回已连接的FTPClient实例
        return ftpClient;
    }

    /**
     * Description: 从FTP服务器下载文件
     *
     * @param path         FTP服务器保存目录
     * @param filename     下载FTP服务器上的文件名
     * @param outputStream 输出流
     * @return 成功返回true，否则返回false
     */
    public boolean download(String path, String filename, OutputStream outputStream) throws Exception {
        FTPClient ftpClient = getFtpClient();
        try {
            ftpClient.changeWorkingDirectory(path);
            ftpClient.retrieveFile(filename, outputStream);
            outputStream.flush();
            outputStream.close();
            ftpClient.logout();
            return true;
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (ftpClient.isConnected()) {
                ftpClient.disconnect();
            }
        }
        return false;
    }


    /**
     * Description: 向FTP服务器上传文件
     *
     * @param path        FTP服务器保存目录
     * @param filename    上传到FTP服务器上的文件名
     * @param inputStream 输入流
     * @return 成功返回true，否则返回false
     */
    public boolean upload(String path, String filename, InputStream inputStream) throws Exception {
        FTPClient ftpClient = getFtpClient();
        try {
            boolean flag = ftpClient.changeWorkingDirectory(path);
            if (!flag) {
                ftpClient.makeDirectory(path);
                ftpClient.changeWorkingDirectory(path);
            }

            ftpClient.storeFile(filename, inputStream);
            inputStream.close();
            ftpClient.logout();
            return true;
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (ftpClient.isConnected()) {
                ftpClient.disconnect();
            }
        }
        return false;
    }


    /**
     * Description: 遍历FTP服务器上的文件
     *
     * @param path FTP服务器保存目录
     * @return 成功返回true，否则返回false
     */
    public void listFtpFile(String path) throws Exception {
        FTPClient ftpClient = getFtpClient();
        try {
            ftpClient.changeWorkingDirectory(path);
            FTPFile[] files = ftpClient.listFiles("./");
            for (int i = 0; i < files.length; i++) {
                System.out.println(files[i].getName());
            }
            ftpClient.logout();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (ftpClient.isConnected()) {
                ftpClient.disconnect();
            }
        }
    }

}