目錄：
一，SpringBoot配置Multipart
二，封裝文件操作FileHelper.java
三，上傳下載API開發FileController.java
四，單元測試FileControllerTest.java
五，功能擴展
六，常見問題和解決方法
附錄：如何高效率的調試REST接口？
開源項目：https://github.com/jextop/StarterApi
SpringBoot是Java開發時常用框架，有非常豐富的組件和易用的功能。Multipart用於支持客戶端將文件上傳到服務器，服務器從請求流中得到文件內容，保存到本地或者雲端。系統架構示意圖如下：
主要類和接口關係如下：
開發步驟：
代碼文件 | 功能要點 | |
SpringBoot配置Multipart | application.yml | SpringBoot Web已經引入依賴，在application.yml中配置multipart |
ServerConfig.java | 讀取服務地址，拼接url | |
MultipartConfig.java | 讀取本地存儲地址，保存文件 | |
文件操作 | FileHelper.java | 讀寫文件, 以及輔助功能 |
API開發 | FileController.java | 增加REST接口POST /upload/{file}, GET /download/{name} |
單元測試 | FileControllerTest.java | 測試功能，MockHttpServletResponse, MockMultipartFile |
功能擴展 | 集成DB讀寫功能，建立數據表File | 在數據庫中存儲文件名稱，MD5等信息，上傳時判斷MD5一樣就重用，下載時返回源文件名。 |
FileTypeEnum.java | 聲明文件類型，歸類存儲 | |
LocationEnum.java | 支持本地或雲端存儲，比如阿里雲、七牛雲 |
一，SpringBoot配置Multipart
1. SpringBoot Web項目，已經包含了Multipart依賴，需要在application.yml中配置如下，開啓multipart功能，指定文件大小範圍和存儲路徑：
spring:
servlet:
multipart:
enabled: true
location: files
file-size-threshold: 0B
max-file-size: 10MB
max-request-size: 10MB
2. 配置ServerConfig，讀取API服務的IP地址或者域名，在返回文件信息時拼接url。
3. 配置MultipartConfig，讀取文件存儲路徑，FileHelper寫入文件時使用。
二，封裝文件操作
文件讀寫，生成存儲路徑和網絡url，實現代碼詳見FileHelper.java
1. save()將MultipartFile文件流保存到服務器或雲端。
2. read()將文件內容讀出並寫如HttpServletResponse中。
3. getFilePath()得到文件存儲路徑。
4. getFileUrl()得到訪問文件的網絡url
三，上傳下載API開發FileController.java
增加兩個REST接口，上傳接口/file/upload是POST請求，處理單個或者多個文件；下載接口/file/download/{name}是GET請求，name是根據文件唯一編號+擴展名生成的名稱。實現代碼詳見FileController.java
@RestController
@RequestMapping("/file")
public class FileController {
@PostMapping("/upload")
public Object upload(
@RequestParam(value = "file", required = false) MultipartFile file,
@RequestParam(value = "files", required = false) MultipartFile[] files
) {
if (file != null) {
LogUtil.info("/file/upload", file.getName());
}
if (!EmptyUtil.isEmpty(files)) {
LogUtil.info("/file/upload", files.length);
}
}
@GetMapping("/{name}")
public Object download(HttpServletResponse response, @PathVariable("name") String name) {
LogUtil.info("/file", name);
}
}
1，文件上傳時首先根據內容生成MD5，通過MD5判斷文件是否重複，然後保存文件並記錄信息到數據庫，返回文件url，時序圖如下。
問答：爲什麼要保存文件信息到數據庫？
- 首先將文件MD5保存起來，可以有效的避免文件重複。
- 存儲在服務器時，文件名稱使用一個新生成的唯一編號，這個編號也是url關鍵字。
- 文件原名保存到數據庫，下載時可以返回給客戶端。
2，下載文件時，從請求參數中獲取文件編號，根據服務器存儲路徑查找文件。通過根據文件編號在數據庫中查詢並返回信息，流程圖如下。
四，單元測試FileControllerTest.java
Spring框架提供了Mock功能輔助測試HTTP，我們用到org.springframework.mock.web包中的兩個類：MockMultipartFile在上傳時模擬文件，MockHttpServletResponse在下載時模擬HttpResponse響應。
1，創建一個臨時文件，然後構建一個MockMultipartFile，測試upload()函數時傳入。
File file = File.createTempFile("tmp", ".txt");
FileUtil.write(file.getPath(), "tmp file".getBytes());
MockMultipartFile multipart = new MockMultipartFile(
file.getName(), file.getName(), null,
new FileInputStream(file)
);
Object ret = fileController.doUpload(multipart, null);
2，新建一個MockHttpServletResponse實例，傳入download()函數，將下載文件內容寫入Response。
HttpServletResponse response = new MockHttpServletResponse();
Object ret = fileController.download(response, “f200216377344237183100944.jpg”);
3，運行FileControllerTest.java,，測試結果：
五，功能擴展
1. 存儲文件時，將文件信息和MD5存入數據庫，MD5用於檢查重複文件，文件原名稱等信息在下載時返回。
2. 文件存儲時使用新生成的唯一編號作爲文件名稱，編號也是網絡url關鍵字。
3. 文件存儲可以擴展到雲端，比如阿里雲、七牛雲，在FileController的upload()和download()函數流程中切換。
六，常見問題和解決方法
l 獨立部署在Tomcat中時，文件存儲路徑不正確
解決：在application.yml中配置文件存儲路徑時，使用絕對路徑，比如：spring.servlet.multipart.location=/tmp/files
原因：在Tomcat容器中運行時，相對路徑在Tomcat主目錄內。
l 上傳文件2M時提示錯誤，如何控制允許的文件大小？
解決：在application.yml中配置multipart允許的文件大小，比如：
spring:
servlet:
multipart:
enabled: true
file-size-threshold: 0B
max-file-size: 10MB
max-request-size: 10MB
原因：沒有配置時，將使用默認值：
file-size-threshold: 單個數據size，默認0B
max-file-size: 最大文件size，默認1MB
max-request-size: 最大請求size，默認10MB
附錄：如何高效率的調試REST接口？
有多種方法和API調式工具可用，介紹3個方式：
1，單元測試：上文介紹過Spring框架提供了Mock功能輔助HTTP測試，單元測試覆蓋主要功能函數，並且和自動構建系統集成，能及時發現功能缺陷和代碼改動帶來的bug，保證項目質量。
2，Swagger接口文檔和調用：Swagger框架定義了完整的REST接口文檔規範，提供了強大的頁面測試功能，能夠調試和可視化API接口服務，並且將文檔融合到代碼中，讓維護文檔和修改代碼整合爲一體，使得修改代碼邏輯的同時方便的修改文檔說明。
瀏覽器打開http://localhost:8011/swagger-ui.html，展開接口信息，選擇文件然後”Try it ou!”
3，Postman是一個常用的API調試工具，支持各種請求方式和配置環境變量，並對返回結果進行測試校驗，支持批量自動化運行，可以和自動構建系統集成，而且可以導入導出JSON文件，高效團隊協作。
