Spring Boot整合FTP服务器的详细教程

本文由简悦 SimpRead 转码，原文地址 blog.csdn.net

Spring Boot 是一个简化新 Spring 应用的初始搭建以及开发过程的框架。在本教程中，我们将探讨如何使用 Spring Boot 来整合 FTP 服务器，实现文件的上传和下载功能。

准备工作

在开始之前，请确保你的开发环境中已经安装了 Java、Maven 和 IDE（如 Eclipse 或 IntelliJ IDEA）。此外，我们还需要添加 Apache Commons Net 库作为项目的依赖。

步骤一：创建 Spring Boot 项目

访问 Spring Initializr（https://start.spring.io/）创建一个新的 Spring Boot 项目。
选择项目元数据（如 Group、Artifact、Name、Description）。
选择依赖项，这里我们选择 “Web” 和“DevTools”。
下载生成的项目压缩包，并解压到你的工作目录。

步骤二：添加 FTP 依赖

在项目的pom.xml文件中添加 Apache Commons Net 依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>commons-net</groupId>
        <artifactId>commons-net</artifactId>
        <version>3.8.0</version>
    </dependency>
</dependencies>

步骤三：配置 FTP 连接信息

在src/main/resources目录下创建application.properties文件，并添加 FTP 服务器的连接信息：

# FTP服务器配置
ftp.server.host=ftp.example.com
ftp.server.port=21
ftp.server.username=yourusername
ftp.server.password=yourpassword
ftp.server.remote-directory=/path/to/remote/directory

步骤四：编写 FTP 服务类

创建一个服务类来处理 FTP 操作，例如上传和下载文件：

import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
 
@Service
public class FTPService {
 
    @Value("${ftp.server.host}")
    private String host;
 
    @Value("${ftp.server.port}")
    private int port;
 
    @Value("${ftp.server.username}")
    private String username;
 
    @Value("${ftp.server.password}")
    private String password;
 
    @Value("${ftp.server.remote-directory}")
    private String remoteDirectory;
 
    public boolean uploadFile(String localFilePath, String remoteFileName) {
        FTPClient ftpClient = new FTPClient();
        try {
            ftpClient.connect(host, port);
            ftpClient.login(username, password);
            ftpClient.enterLocalPassiveMode();
            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
 
            FileInputStream inputStream = new FileInputStream(localFilePath);
            boolean success = ftpClient.storeFile(remoteDirectory + "/" + remoteFileName, inputStream);
            inputStream.close();
            ftpClient.logout();
            ftpClient.disconnect();
            return success;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return false;
    }
 
    public boolean downloadFile(String remoteFileName, String localFilePath) {
        FTPClient ftpClient = new FTPClient();
        try {
            ftpClient.connect(host, port);
            ftpClient.login(username, password);
            ftpClient.enterLocalPassiveMode();
            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
 
            FileOutputStream outputStream = new FileOutputStream(localFilePath);
            boolean success = ftpClient.retrieveFile(remoteDirectory + "/" + remoteFileName, outputStream);
            outputStream.close();
            ftpClient.logout();
            ftpClient.disconnect();
            return success;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return false;
    }
}

步骤五：创建控制器

创建一个控制器来暴露上传和下载文件的 API：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping("/ftp")
public class FTPController {
 
    @Autowired
    private FTPService ftpService;
 
    @PostMapping("/upload")
    public String uploadFile(@RequestParam String localFilePath, @RequestParam String remoteFileName) {
        boolean success = ftpService.uploadFile(localFilePath, remoteFileName);
        return success ? "File uploaded successfully" : "Failed to upload file";
    }
 
    @PostMapping("/download")
    public String downloadFile(@RequestParam String remoteFileName, @RequestParam String localFilePath) {
        boolean success = ftpService.downloadFile(remoteFileName, localFilePath);
        return success ? "File downloaded successfully" : "Failed to download file";
    }
}

步骤六：运行 Spring Boot 应用

使用 IDE 运行Application类的main方法，或者使用 Maven 命令mvn spring-boot:run来启动应用。

结语

通过本教程，你已经学会了如何使用 Spring Boot 来整合 FTP 服务器，实现文件的上传和下载功能。这为你的应用程序提供了与 FTP 服务器交互的能力，可以用于文件管理、备份等多种场景。希望这个教程对你有所帮助！