spring boot实现文件上传到ftp（PASV被动模式）

===============================================

 2022/3/13_第1次修改                       ccb_warlock

 

===============================================

今年1月临时接手了一个spring boot项目的开发，其中包含了文件上传和获取的功能。但是发现原功能通过直接压缩文件成字符串然后存入数据库来实现，于是我准备改写存入FTP来优化。但是发现查了很多文章，几乎找不到一篇代码结构清晰且能跑的起来的代码片段，于是我整理了这篇记录供需要的人参考。

这里我只实现文件的上传功能，文件的下载因为是内网项目，所以我还是采取了nginx代理FTP的的方式直接通过url来访问。

 

---

一、部署ftp

docker部署ftp参考：https://www.cnblogs.com/straycats/p/16002473.html

 

---

二、pom引用

这里我使用的是java中普遍操作ftp的轮子org.apache.commons.net。

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

 

---

三、application.yaml增加配置信息

将FTP的配置记录到配置文件中。

ftp:
  # ftp服务的地址
  host: 127.0.0.1
  # 连接端口
  port: 38021
  # 用户名
  username: myftp
  # 密码
  password: 123456
  # 模式（PORT.主动模式，PASV.被动模式）
  mode: PASV
  # http访问的路径前缀
  url: http://127.0.0.1:8001/ftp

 

---

四、工具类封装

为了方便后续调用，我抽象了ftp操作的方法集成到了一个独立的工具类（FTPUtil）。

package com.example.demo.utils;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.net.ftp.FTP;
import org.apache.commons.net.ftp.FTPClient;
import org.apache.commons.net.ftp.FTPReply;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

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

@Slf4j
@Component
public class FTPUtil {
    private static String host;
    private static int port;
    private static String userName;
    private static String password;
    private static String mode;

    @Value("${ftp.host:127.0.0.1}")
    private void setHost(String host) {
        FTPUtil.host = host;
    }

    @Value("${ftp.port:21}")
    private void setPort(int port){
        FTPUtil.port = port;
    }

    @Value("${ftp.username:''}")
    private void setUserName(String userName){
        FTPUtil.userName = userName;
    }

    @Value("${ftp.password:''}")
    private void setPassword(String password){
        FTPUtil.password = password;
    }

    @Value("${ftp.mode:PASV}")
    private void setMode(String mode){
        FTPUtil.mode = mode;
    }

    private static FTPClient getInstance(String workingDirectory) {
        FTPClient ftpClient = new FTPClient();
        ftpClient.setControlEncoding("UTF-8");

        try{
            ftpClient.connect(host, port);
            ftpClient.login(userName, password);

            int replyCode = ftpClient.getReplyCode();

            if(!FTPReply.isPositiveCompletion(replyCode)){
                log.error("FTP服务（{}:{}）连接失败。", host, port);
                throw new Exception("FTP服务连接失败");
            }
            log.info("FTP服务（{}:{}）连接成功。", host, port);

            if("PORT".equals(mode)){
                ftpClient.enterLocalActiveMode();
            }
            else{
                ftpClient.enterLocalPassiveMode();
            }

            ftpClient.setFileType(FTP.BINARY_FILE_TYPE);
            changeWorkingDirectory(ftpClient, workingDirectory);
        }
        catch(Exception e){
            e.printStackTrace();
        }

        return ftpClient;
    }

    private static void changeWorkingDirectory(FTPClient ftpClient, String workingDirectory) throws IOException {
        String[] directories = workingDirectory.split("/");

        for(String directory : directories){
            if(StringUtils.isBlank(directory)){
                continue;
            }

            if(ftpClient.changeWorkingDirectory(directory)){
                continue;
            }

            ftpClient.makeDirectory(directory);
            ftpClient.changeWorkingDirectory(directory);
        }
    }

    private static void close(FTPClient client){
        if(null == client){
            return;
        }

        try{
            client.logout();
        }
        catch(Exception e){
            log.error("FTP退出登录失败。异常信息：{}", e.getMessage());
        }
        finally {
            if(client.isConnected()){
                try{
                    client.disconnect();
                    log.info("FTP断开连接成功。");
                }
                catch(Exception e){
                    log.error("FTP断开连接失败。异常信息：{}", e.getMessage());
                }
            }
        }
    }

    public static void upload(String workingDirectory, String fileName, MultipartFile file) throws Exception {
        InputStream inputStream = file.getInputStream();
        FTPClient client = getInstance(workingDirectory);

        if (client.storeFile(fileName, inputStream)) {
            log.info("上传文件{}成功。", fileName);
        }
        else{
            log.error("上传文件{}失败（{}）。", fileName, client.getReplyString());
        }

        close(client);
        inputStream.close();
    }

}

 

---

五、调用

为了方便呈现，这里设计了一个post接口方便测试

1）服务（IFileService、FileServiceImpl）

IFileService

package com.example.demo.api.interfaces;

import org.springframework.web.multipart.MultipartFile;

public interface IFileService {

    void uploadFile(long companyId, MultipartFile file) throws Exception;

}

 

FileServiceImpl

package com.example.demo.domain.service;

import org.apache.commons.lang3.StringUtils;
import com.example.demo.api.interfaces.IFileService;
import com.example.demo.utils.FTPUtil;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.InputStream;
import java.util.Calendar;
import java.util.List;
import java.util.UUID;

@Service
public class FileServiceImpl implements IFileService {

    @Value("${ftp:url:''}")
    private String ftpUrl;

    @Override
    public String uploadFile(long companyId, MultipartFile file) throws Exception {
        String fileName = getUuidFileName(file.getOriginalFilename());

        //无多级目录
        FTPUtil.upload("", fileName, file);
        return ftpUrl + "/" + fileName;

        //存到company/{companyId}/images路径下
        //FTPUtil.upload("company/" + companyId + "/images", fileName, file);
        //return ftpUrl + "/company/" + companyId + "/images/" + fileName;
    }

    private String getUuidFileName(String originalFileName){
        String uuid = getUuid();
        if(StringUtils.isBlank(originalFileName)){
            return uuid;
        }

        int i = originalFileName.lastIndexOf('.');
        return -1 == i ? uuid : uuid + originalFileName.substring(i);
    }

    private String getUuid(){
        String uuid = UUID.randomUUID().toString();
        return uuid.replace("-", "");
    }

}

 

2）控制器（FileController）

PS. 这里的ApiResult是demo中封装的接口输出格式类

package com.example.demo.api.controller;

import com.example.demo.api.interfaces.IFileService;
import com.example.demo.common.base.BaseController;
import com.example.demo.entity.vo.ApiResult;
import io.swagger.annotations.Api;
import io.swagger.v3.oas.annotations.Operation;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.annotation.Resource;

@Api(tags = "文件")
@RestController
@RequestMapping("file")
public class FileController {

    @Resource
    private IFileService fileService;

    @Operation(summary = "上传文件")
    @PostMapping(path = "/images/{companyId}")
    public ApiResult uploadFile(@PathVariable long companyId, @RequestParam("file") MultipartFile file)
            throws Exception {
        String url = fileService.uploadFile(companyId, file);
        return ApiResult.success(url);
    }

}

 

---

六、测试

接着我们用postman测试post接口，其中companyId随便赋值一个数。

 

当FileServiceImpl使用“无多级目录”的代码时，文件将会保存在“FTP物理路径/用户名”的目录下（如果ftp完全根据我提供的资料部署，则文件保存到/Users/mbp/docker/vol/vsftpd/data/myftp）。

 

当FileServiceImpl使用“存到company/{companyId}/images路径下”，文件将会保存在“FTP物理路径/用户名/company/{companyId}/images”的目录下如果ftp完全根据我提供的资料部署，则文件保存到/Users/mbp/docker/vol/vsftpd/data/myftp/company/{companyId}/images）。

 

---

七、我遇到的问题

1）500 Illegal PORT command.

答：

因为我部署的ftp是被动模式，所以ftp获取客户端实例时需要设置模式（详见“四、工具类封装”的65 - 70行代码）。

 

2）Connection closed without indication.

答：

这是我在mac上通过docker部署时，如果容器的端口20映射笔记本的端口20、容器端口21映射笔记本的端口21，则会引起该报错（如果有大佬愿意指点，请在评论中留言）。我采取的解决方案是换笔记本的端口绑（38021、38022）。

 

3）上传的文件损坏

答：

在初始化客户端实例时需要设置其文件类型为二进制（详见“四、工具类封装”的第72行代码）。

PS. 很多文章的代码都没注意这个问题，文件看着是上传到ftp目录了，但实际该文件损坏。

 

4）ftp多级目录没有自动生成

答：

客户端实例的changeWorkingDirectory方法无法处理多级目录，所以设计循环遍历路径，有需要则创建（详见“四、工具类封装”的82 - 97行代码）。

 

 

---

参考资料：

1.https://www.cnblogs.com/wanisily/p/7699873.html

2.https://www.cnblogs.com/mickole/articles/3643819.html