文件上傳的功能實現是我們做Web應用時候最爲常見的應用場景,比如:實現頭像的上傳,Excel文件數據的導入等功能,都需要我們先實現文件的上傳,然後再做圖片的裁剪,excel數據的解析入庫等後續操作。
今天通過這篇文章,我們就來一起學習一下如何在Spring Boot中實現文件的上傳。
動手試試
第一步:創建一個基礎的Spring Boot項目,如果還不會的話就先看看這篇《快速入門》。
第二步:在pom.xml
中引入模版引擎依賴:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
你也可以選擇其他你熟悉的模版引擎,比如:Freemarker。
第三步:在resources
目錄下,創建新目錄templates
;在templates
目錄下再創建一個文件上傳的頁面upload.html
,內容如下:
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8" />
<title>文件上傳頁面</title>
</head>
<body>
<h1>文件上傳頁面</h1>
<form method="post" action="/upload" enctype="multipart/form-data">
選擇要上傳的文件:<input type="file" name="file"><br>
<hr>
<input type="submit" value="提交">
</form>
</body>
</html>
第四步:創建文件上傳的處理控制器,命名爲UploadController
@Controller
@Slf4j
public class UploadController {
@Value("${file.upload.path}")
private String path;
@GetMapping("/")
public String uploadPage() {
return "upload";
}
@PostMapping("/upload")
@ResponseBody
public String create(@RequestPart MultipartFile file) throws IOException {
String fileName = file.getOriginalFilename();
String filePath = path + fileName;
File dest = new File(filePath);
Files.copy(file.getInputStream(), dest.toPath());
return "Upload file success : " + dest.getAbsolutePath();
}
}
其中包含這幾個重要元素:
- 成員變量
path
,通過@Value
注入配置文件中的file.upload.path
屬性。這個配置用來定義文件上傳後要保存的目錄位置。 - GET請求,路徑
/
,用於顯示upload.html
這個文件上傳頁面。 - POST請求。路徑
/upload
,用於處理上傳的文件,即:保存到file.upload.path
配置的路徑下面。
注意:這裏主要演示文件上傳的主要流程,真實應用還有更多內容要考慮,比如:文件上傳後的文件名處理(防止重名)、分佈式情況下文件上傳後如何共享訪問等。更高級的最後,我們後續文章繼續講。
第五步:編輯application.properties
配置文件
spring.servlet.multipart.max-file-size=2MB
spring.servlet.multipart.max-request-size=2MB
file.upload.path=/Users/didi/
前兩個參數用於限制了上傳請求和上傳文件的大小,而file.upload.path
是上面我們自己定義的用來保存上傳文件的路徑。
更多本系列免費教程連載「點擊進入彙總目錄」
測試驗證
第一步:啓動Spring Boot應用,訪問http://localhost:8080
,可以看到如下的文件上傳頁面。
第二步:選擇一個不大於2MB的文件,點擊“提交”按鈕,完成上傳。
如果上傳成功,將顯示類似下面的頁面:
你可以根據打印的文件路徑去查看文件是否真的上傳了。
代碼示例
本文的相關例子可以查看下面倉庫中的chapter4-3
目錄:
- Github:https://github.com/dyc87112/SpringBoot-Learning/
- Gitee:https://gitee.com/didispace/SpringBoot-Learning/
如果您覺得本文不錯,歡迎Star
支持,您的關注是我堅持的動力!
歡迎關注我的公衆號:程序猿DD,獲得獨家整理的免費學習資源助力你的Java學習之路!另每週贈書不停哦~