SpringBoot 使用 FTP 操作文件的过程(删除、上传、下载文件)

一、引言

在生产环境中，经常会使用FTP(文件传输协议)来上传和下载文件。本文将会详细地讲解如何在Spring Boot应用中使用FTP操作文件，包括文件的上传、下载、删除等操作。

二、FTP操作文件的依赖

在使用Java操作FTP的过程中，需要引入两个依赖：

<!-- FTP客户端依赖 -->
<dependency>
  <groupId>commons-net</groupId>
  <artifactId>commons-net</artifactId>
  <version>3.6</version>
</dependency>

<!-- Spring集成FTP客户端依赖 -->
<dependency>
  <groupId>org.springframework.integration</groupId>
  <artifactId>spring-integration-ftp</artifactId>
  <version>5.5.0</version>
</dependency>

三、FTP操作文件的配置

在Spring Boot应用中，我们需要在application.yml或application.properties中配置FTP的相关参数：

spring:
  ftp:
    host: 127.0.0.1    # FTP服务器地址
    port: 21           # FTP服务器端口号
    username: ftp      # FTP用户名
    password: ftp      # FTP密码
    remote-root: /     # 远程文件根目录
    local-root: /tmp/  # 本地文件根目录

四、FTP文件上传示例

接下来，我们将演示如何使用FTP客户端上传文件。

@Component
public class FtpFileUploader {

    @Autowired
    private FtpProperties ftpProperties;

    public File uploadFile(File file) {
        // 创建FTP客户端对象
        FTPClient ftpClient = new FTPClient();
        FileInputStream fis = null;
        try {
            // 连接FTP服务器
            ftpClient.connect(ftpProperties.getHost(), ftpProperties.getPort());
            // 登录FTP服务器
            ftpClient.login(ftpProperties.getUsername(), ftpProperties.getPassword());
            // 切换到FTP远程根目录
            ftpClient.changeWorkingDirectory(ftpProperties.getRemoteRoot());
            // 读取本地文件流
            fis = new FileInputStream(file);
            // 把文件上传到FTP服务器指定目录下
            ftpClient.storeFile(file.getName(), fis);
            return file;
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (fis != null) {
                    fis.close();
                }
                ftpClient.logout();
                ftpClient.disconnect();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

五、FTP文件下载示例

接下来，我们将演示如何使用FTP客户端下载文件。

@Component
public class FtpFileDownloader {

    @Autowired
    private FtpProperties ftpProperties;

    public File downloadFile(String fileName) {
        // 创建FTP客户端对象
        FTPClient ftpClient = new FTPClient();
        FileOutputStream fos = null;
        try {
            // 连接FTP服务器
            ftpClient.connect(ftpProperties.getHost(), ftpProperties.getPort());
            // 登录FTP服务器
            ftpClient.login(ftpProperties.getUsername(), ftpProperties.getPassword());
            // 切换到FTP远程根目录
            ftpClient.changeWorkingDirectory(ftpProperties.getRemoteRoot());
            // 创建本地目录
            File localDir = FileUtil.mkdir(ftpProperties.getLocalRoot() + ftpProperties.getRemoteRoot());
            // 创建本地文件对象
            File localFile = new File(localDir, fileName);
            fos = new FileOutputStream(localFile);
            // 把FTP服务器上的文件下载到本地指定目录下
            ftpClient.retrieveFile(fileName, fos);
            return localFile;
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (fos != null) {
                    fos.close();
                }
                ftpClient.logout();
                ftpClient.disconnect();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

六、FTP文件删除示例

接下来，我们将演示如何使用FTP客户端删除文件。

@Component
public class FtpFileDeleter {

    @Autowired
    private FtpProperties ftpProperties;

    public boolean deleteFile(String fileName) {
        // 创建FTP客户端对象
        FTPClient ftpClient = new FTPClient();
        try {
            // 连接FTP服务器
            ftpClient.connect(ftpProperties.getHost(), ftpProperties.getPort());
            // 登录FTP服务器
            ftpClient.login(ftpProperties.getUsername(), ftpProperties.getPassword());
            // 切换到FTP远程根目录
            ftpClient.changeWorkingDirectory(ftpProperties.getRemoteRoot());
            // 删除FTP服务器上的文件
            return ftpClient.deleteFile(fileName);
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            try {
                ftpClient.logout();
                ftpClient.disconnect();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return false;
    }

}

七、总结

通过上述示例，我们可以使用FTP客户端轻松地操作文件，包括文件上传、下载和删除等操作。同时，我们也可以通过Spring与FTP集成来简化FTP操作的代码，提高开发效率。