springboot應用上傳文件 · springboot官方文檔中文版

# 上載本指南將引導您完成創建可以接收HTTP分段文件上傳的服務器應用程序的過程。 ## 你會建立什么您將創建一個接受文件上傳的Spring Boot Web應用程序。您還將構建一個簡單的HTML界面來上傳測試文件。 ## 你需要什么 * 約15分鐘 * 最喜歡的文本編輯器或IDE * [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本 * [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi) * 您還可以將代碼直接導入到IDE中： * [彈簧工具套件（STS）](https://spring.io/guides/gs/sts) * [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/) ## 如何完成本指南像大多數Spring 一樣 [入門指南](https://spring.io/guides) ，您可以從頭開始并完成每個步驟，也可以繞過您已經熟悉的基本設置步驟。無論哪種方式，您最終都可以使用代碼。要 **從頭開始** ，請繼續進行“ [從Spring Initializr開始”](https://spring.io/guides/gs/uploading-files/#scratch) 。要 **跳過基礎知識** ，請執行以下操作： * [下載](https://github.com/spring-guides/gs-uploading-files/archive/master.zip) 并解壓縮本指南的源存儲庫，或使用對其進行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-uploading-files.git](https://github.com/spring-guides/gs-uploading-files.git)` * 光盤進入 `gs-uploading-files/initial` * 繼續 [創建應用程序類](https://spring.io/guides/gs/uploading-files/#initial) 。 **完成后** ，您可以根據中的代碼檢查結果 `gs-uploading-files/complete`. ## 從Spring Initializr開始如果您使用Maven，請訪問 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.4.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=Uploading-files&name=Uploading-files&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.Uploading-files&dependencies=web,thymeleaf) 以生成具有所需依賴項（Spring Web和Thymeleaf）的新項目。以下清單顯示了 `pom.xml` 選擇Maven時創建的文件： ~~~ <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.4.4</version> <relativePath/>  </parent> <groupId>com.example</groupId> <artifactId>uploading-files</artifactId> <version>0.0.1-SNAPSHOT</version> <name>uploading-files</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ~~~ 如果您使用Gradle，請訪問 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.4.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=Uploading-files&name=Uploading-files&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.Uploading-files&dependencies=web,thymeleaf) 以生成具有所需依賴項（Spring Web和Thymeleaf）的新項目。以下清單顯示了 `build.gradle` 選擇Gradle時創建的文件： ~~~ plugins { id 'org.springframework.boot' version '2.4.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-thymeleaf' implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation('org.springframework.boot:spring-boot-starter-test')\ } test { useJUnitPlatform() } ~~~ ### 手動初始化（可選）如果要手動初始化項目而不是使用前面顯示的鏈接，請按照以下步驟操作： 1. 導航到 [https://start.spring.io](https://start.spring.io) 。該服務提取應用程序所需的所有依賴關系，并為您完成大部分設置。 2. 選擇Gradle或Maven以及您要使用的語言。本指南假定您選擇了Java。 3. 單擊 **Dependencies，** 然后選擇 **Spring Web** 和 **Thymeleaf** 。 4. 點擊 **生成** 。 5. 下載生成的ZIP文件，該文件是使用您的選擇配置的Web應用程序的存檔。如果您的IDE集成了Spring Initializr，則可以從IDE中完成此過程。 ## 創建一個應用程序類要啟動一個Spring Boot MVC應用程序，首先需要一個啟動器。在此示例中， `spring-boot-starter-thymeleaf` 和 `spring-boot-starter-web`已經添加為依賴項。要使用Servlet容器上傳文件，您需要注冊一個 `MultipartConfigElement` 類（這將是 `<multipart-config>`在web.xml中）。借助Spring Boot，一切都將自動為您配置！開始使用此應用程序只需要滿足以下條件： `UploadingFilesApplication` 類（來自 `src/main/java/com/example/uploadingfiles/UploadingFilesApplication.java`): ~~~ package com.example.uploadingfiles; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class UploadingFilesApplication { public static void main(String[] args) { SpringApplication.run(UploadingFilesApplication.class, args); } } ~~~ 作為自動配置Spring MVC的一部分，Spring Boot將創建一個 `MultipartConfigElement` Bean，并準備好進行文件上傳。 ## 創建一個文件上傳控制器初始應用程序已經包含一些用于處理在磁盤上存儲和加載上載文件的類。它們都位于 `com.example.uploadingfiles.storage`包裹。您將在新產品中使用這些產品 `FileUploadController`。以下清單（來自 `src/main/java/com/example/uploadingfiles/FileUploadController.java`）顯示文件上傳控制器： ~~~ package com.example.uploadingfiles; import java.io.IOException; import java.util.stream.Collectors; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.io.Resource; import org.springframework.http.HttpHeaders; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.multipart.MultipartFile; import org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder; import org.springframework.web.servlet.mvc.support.RedirectAttributes; import com.example.uploadingfiles.storage.StorageFileNotFoundException; import com.example.uploadingfiles.storage.StorageService; @Controller public class FileUploadController { private final StorageService storageService; @Autowired public FileUploadController(StorageService storageService) { this.storageService = storageService; } @GetMapping("/") public String listUploadedFiles(Model model) throws IOException { model.addAttribute("files", storageService.loadAll().map( path -> MvcUriComponentsBuilder.fromMethodName(FileUploadController.class, "serveFile", path.getFileName().toString()).build().toUri().toString()) .collect(Collectors.toList())); return "uploadForm"; } @GetMapping("/files/{filename:.+}") @ResponseBody public ResponseEntity<Resource> serveFile(@PathVariable String filename) { Resource file = storageService.loadAsResource(filename); return ResponseEntity.ok().header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getFilename() + "\"").body(file); } @PostMapping("/") public String handleFileUpload(@RequestParam("file") MultipartFile file, RedirectAttributes redirectAttributes) { storageService.store(file); redirectAttributes.addFlashAttribute("message", "You successfully uploaded " + file.getOriginalFilename() + "!"); return "redirect:/"; } @ExceptionHandler(StorageFileNotFoundException.class) public ResponseEntity<?> handleStorageFileNotFound(StorageFileNotFoundException exc) { return ResponseEntity.notFound().build(); } } ~~~ 這 `FileUploadController` 該類帶有注釋 `@Controller`以便Spring MVC可以選擇它并尋找路線。每個方法都標有 `@GetMapping` 或者 `@PostMapping` 將路徑和HTTP操作綁定到特定的控制器操作。在這種情況下： * `GET /`：從中查找上傳文件的當前列表 `StorageService`并將其加載到Thymeleaf模板中。通過使用以下命令計算到實際資源的鏈接 `MvcUriComponentsBuilder`. * `GET /files/{filename}`：加載資源（如果存在）并將其發送到瀏覽器以通過使用 `Content-Disposition` 響應頭。 * `POST /`：處理多部分消息 `file` 并將其提供給 `StorageService` 保存。在生產場景中，您更有可能將文件存儲在臨時位置，數據庫或NoSQL存儲區（例如 Mongo的GridFS ）中。最好不要在內容中加載應用程序的文件系統。您需要提供一個 `StorageService`以便控制器可以與存儲層（例如文件系統）進行交互。以下清單（來自 `src/main/java/com/example/uploadingfiles/storage/StorageService.java`）顯示該界面： ~~~ package com.example.uploadingfiles.storage; import org.springframework.core.io.Resource; import org.springframework.web.multipart.MultipartFile; import java.nio.file.Path; import java.util.stream.Stream; public interface StorageService { void init(); void store(MultipartFile file); Stream<Path> loadAll(); Path load(String filename); Resource loadAsResource(String filename); void deleteAll(); } ~~~ ## 創建一個HTML模板以下Thymeleaf模板（來自 `src/main/resources/templates/uploadForm.html`）顯示了有關如何上傳文件以及顯示已上傳內容的示例： ~~~ <html xmlns:th="https://www.thymeleaf.org"> <body> <div th:if="${message}"> <h2 th:text="${message}"/> </div> <div> <form method="POST" enctype="multipart/form-data" action="/"> <table> <tr><td>File to upload:</td><td><input type="file" name="file" /></td></tr> <tr><td></td><td><input type="submit" value="Upload" /></td></tr> </table> </form> </div> <div> <ul> <li th:each="file : ${files}"> <a th:href="${file}" th:text="${file}" /> </li> </ul> </div> </body> </html> ~~~ 該模板包括三個部分： * 頂部的可選消息，Spring MVC會在該消息中寫入 [Flash范圍的消息](https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc-flash-attributes) 。 * 一種允許用戶上傳文件的表格。 * 后端提供的文件列表。 ## 調整文件上傳限制配置文件上傳時，設置文件大小限制通常很有用。想象一下要處理5GB的文件上傳！借助Spring Boot，我們可以對其自動配置進行調整 `MultipartConfigElement` 帶有一些屬性設置。將以下屬性添加到現有屬性設置（在 `src/main/resources/application.properties`): ~~~ spring.servlet.multipart.max-file-size=128KB spring.servlet.multipart.max-request-size=128KB ~~~ 分段設置受以下約束： * `spring.http.multipart.max-file-size` 設置為128KB，表示文件總大小不能超過128KB。 * `spring.http.multipart.max-request-size` 設置為128KB，表示一個請求的總請求大小 `multipart/form-data` 不能超過128KB。 ## 運行應用程序您需要將文件上傳到的目標文件夾，因此您需要增強基本功能 `UploadingFilesApplication` Spring Initializr創建并添加Boot的類 `CommandLineRunner`在啟動時刪除并重新創建該文件夾。以下清單（來自 `src/main/java/com/example/uploadingfiles/UploadingFilesApplication.java`）顯示了如何執行此操作： ~~~ package com.example.uploadingfiles; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.annotation.Bean; import com.example.uploadingfiles.storage.StorageProperties; import com.example.uploadingfiles.storage.StorageService; @SpringBootApplication @EnableConfigurationProperties(StorageProperties.class) public class UploadingFilesApplication { public static void main(String[] args) { SpringApplication.run(UploadingFilesApplication.class, args); } @Bean CommandLineRunner init(StorageService storageService) { return (args) -> { storageService.deleteAll(); storageService.init(); }; } } ~~~ `@SpringBootApplication` 是一個方便注釋，它添加了以下所有內容： * `@Configuration`：將類標記為應用程序上下文的Bean定義的源。 * `@EnableAutoConfiguration`：告訴Spring Boot根據類路徑設置，其他bean和各種屬性設置開始添加bean。例如，如果 `spring-webmvc` 在類路徑上，此注釋將應用程序標記為Web應用程序并激活關鍵行為，例如設置 `DispatcherServlet`. * `@ComponentScan`：告訴Spring在服務器中尋找其他組件，配置和服務 `com/example` 包，讓它找到控制器。這 `main()` 方法使用Spring Boot的 `SpringApplication.run()`啟動應用程序的方法。您是否注意到沒有一行XML？沒有 `web.xml`文件。該Web應用程序是100％純Java，因此您無需處理任何管道或基礎結構。 ### 建立可執行的JAR 您可以使用Gradle或Maven從命令行運行該應用程序。您還可以構建一個包含所有必需的依賴項，類和資源的可執行JAR文件，然后運行該文件。生成可執行jar使得在整個開發生命周期中，跨不同環境等等的情況下，都可以輕松地將服務作為應用程序進行發布，版本控制和部署。如果您使用Gradle，則可以通過使用以下命令運行該應用程序 `./gradlew bootRun`。或者，您可以通過使用以下命令構建JAR文件： `./gradlew build` 然后運行JAR文件，如下所示： ~~~ java -jar build/libs/gs-uploading-files-0.1.0.jar ~~~ 如果您使用Maven，則可以通過使用以下命令運行該應用程序 `./mvnw spring-boot:run`。或者，您可以使用以下命令構建JAR文件： `./mvnw clean package` 然后運行JAR文件，如下所示： ~~~ java -jar target/gs-uploading-files-0.1.0.jar ~~~ 此處描述的步驟將創建可運行的JAR。您還可以構建經典的WAR文件。運行服務器端接收文件上傳的部分。顯示日志記錄輸出。該服務應在幾秒鐘內啟動并運行。在服務器運行的情況下，您需要打開瀏覽器并訪問 `[http://localhost:8080/](http://localhost:8080/)`查看上傳表單。選擇一個（小）文件，然后按 **Upload** 。您應該從控制器上看到成功頁面。如果選擇的文件太大，則會出現一個錯誤的錯誤頁面。然后，您應該在瀏覽器窗口中看到類似于以下內容的一行： “您成功上傳了！” ## 測試您的應用程序有多種方法可以在我們的應用程序中測試此特定功能。以下清單（來自 `src/test/java/com/example/uploadingfiles/FileUploadTests.java`）顯示了一個使用 `MockMvc` 這樣就不需要啟動servlet容器： ~~~ package com.example.uploadingfiles; import java.nio.file.Paths; import java.util.stream.Stream; import org.hamcrest.Matchers; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.mock.mockito.MockBean; import org.springframework.mock.web.MockMultipartFile; import org.springframework.test.web.servlet.MockMvc; import static org.mockito.BDDMockito.given; import static org.mockito.BDDMockito.then; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.model; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; import com.example.uploadingfiles.storage.StorageFileNotFoundException; import com.example.uploadingfiles.storage.StorageService; @AutoConfigureMockMvc @SpringBootTest public class FileUploadTests { @Autowired private MockMvc mvc; @MockBean private StorageService storageService; @Test public void shouldListAllFiles() throws Exception { given(this.storageService.loadAll()) .willReturn(Stream.of(Paths.get("first.txt"), Paths.get("second.txt"))); this.mvc.perform(get("/")).andExpect(status().isOk()) .andExpect(model().attribute("files", Matchers.contains("http://localhost/files/first.txt", "http://localhost/files/second.txt"))); } @Test public void shouldSaveUploadedFile() throws Exception { MockMultipartFile multipartFile = new MockMultipartFile("file", "test.txt", "text/plain", "Spring Framework".getBytes()); this.mvc.perform(multipart("/").file(multipartFile)) .andExpect(status().isFound()) .andExpect(header().string("Location", "/")); then(this.storageService).should().store(multipartFile); } @SuppressWarnings("unchecked") @Test public void should404WhenMissingFile() throws Exception { given(this.storageService.loadAsResource("test.txt")) .willThrow(StorageFileNotFoundException.class); this.mvc.perform(get("/files/test.txt")).andExpect(status().isNotFound()); } } ~~~ 在這些測試中，您將使用各種模擬來建立與控制器和控制器之間的交互。 `StorageService` 而且還可以通過使用Servlet容器本身 `MockMultipartFile`. 有關集成測試的示例，請參見 `FileUploadIntegrationTests` 類（在 `src/test/java/com/example/uploadingfiles`). ## 概括恭喜你！您剛剛編寫了一個使用Spring處理文件上傳的Web應用程序。