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