本指南將引導(dǎo)您完成創(chuàng)建可以接收 HTTP 多部分文件上傳的服務(wù)器應(yīng)用程序的過(guò)程。

你將建造什么

您將創(chuàng)建一個(gè)接受文件上傳的 Spring Boot Web 應(yīng)用程序。您還將構(gòu)建一個(gè)簡(jiǎn)單的 HTML 界面來(lái)上傳測(cè)試文件。

如何完成本指南

像大多數(shù) Spring入門指南一樣，您可以從頭開始并完成每個(gè)步驟，也可以繞過(guò)您已經(jīng)熟悉的基本設(shè)置步驟。無(wú)論哪種方式，您最終都會(huì)得到工作代碼。

要從頭開始，請(qǐng)繼續(xù)從 Spring Initializr 開始。

要跳過(guò)Java基礎(chǔ)教程，請(qǐng)執(zhí)行以下操作：

下載并解壓縮本指南的源存儲(chǔ)庫(kù)，或使用Git克隆它：

git clone https://github.com/spring-guides/gs-uploading-files.git

光盤進(jìn)入gs-uploading-files/initial

繼續(xù)創(chuàng)建應(yīng)用程序類。

完成后，您可以對(duì)照中的代碼檢查結(jié)果gs-uploading-files/complete。

從 Spring Initializr 開始

您可以使用這個(gè)預(yù)先初始化的項(xiàng)目并單擊 Generate 下載 ZIP 文件。此項(xiàng)目配置為適合本教程中的示例。

手動(dòng)初始化項(xiàng)目：

導(dǎo)航到https://start.spring.io。該服務(wù)提取應(yīng)用程序所需的所有依賴項(xiàng)，并為您完成大部分設(shè)置。

選擇 Gradle 或 Maven 以及您要使用的語(yǔ)言。本指南假定您選擇了 Java。

單擊Dependencies并選擇Spring Web和Thymeleaf。

單擊生成。

下載生成的 ZIP 文件，該文件是根據(jù)您的選擇配置的 Web 應(yīng)用程序的存檔。

如果您的 IDE 具有 Spring Initializr 集成，您可以從您的 IDE 完成此過(guò)程。

你也可以從 Github 上 fork 項(xiàng)目并在你的 IDE 或其他編輯器中打開它。

創(chuàng)建應(yīng)用程序類

要啟動(dòng) Spring Boot MVC 應(yīng)用程序，首先需要一個(gè)啟動(dòng)器。在此示例中，spring-boot-starter-thymeleaf并且spring-boot-starter-web已作為依賴項(xiàng)添加。要使用 Servlet 容器上傳文件，您需要注冊(cè)一個(gè)MultipartConfigElement類(在 web.xml 中)。感謝 Spring Boot，一切都是為您自動(dòng)配置的!

開始使用此應(yīng)用程序所需的只是以下UploadingFilesApplication類

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);
	}
}

作為自動(dòng)配置 Spring MVC 的一部分，Spring Boot 將創(chuàng)建一個(gè)MultipartConfigElementbean 并為文件上傳做好準(zhǔn)備。

創(chuàng)建文件上傳控制器

初始應(yīng)用程序已經(jīng)包含一些類來(lái)處理在磁盤上存儲(chǔ)和加載上傳的文件。它們都位于com.example.uploadingfiles.storage包裝中。您將在新的FileUploadController. 以下清單顯示了文件上傳控制器：

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 可以拾取它并查找路由。每個(gè)方法都被標(biāo)記@GetMapping或@PostMapping將路徑和 HTTP 操作綁定到特定的控制器操作。

在這種情況下：

GET /：從 中查找當(dāng)前上傳文件的列表StorageService并將其加載到 Thymeleaf 模板中。它通過(guò)使用 計(jì)算到實(shí)際資源的鏈接MvcUriComponentsBuilder。

GET /files/{filename}：加載資源(如果存在)并使用Content-Disposition響應(yīng)頭將其發(fā)送到瀏覽器進(jìn)行下載。

POST /：處理多部分消息file并將其提供給StorageService保存。

您將需要提供一個(gè)StorageService以便控制器可以與存儲(chǔ)層(例如文件系統(tǒng))進(jìn)行交互。以下清單顯示了該界面：

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();
}

創(chuàng)建 HTML 模板

以下 Thymeleaf 模板顯示了如何上傳文件并顯示已上傳內(nèi)容的示例：

<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>

該模板包含三個(gè)部分：

Spring MVC 在其中寫入flash-scoped message頂部的可選消息。

允許用戶上傳文件的表單。

從后端提供的文件列表。

調(diào)整文件上傳限制

配置文件上傳時(shí)，設(shè)置文件大小限制通常很有用。想象一下嘗試處理 5GB 文件上傳!MultipartConfigElement使用 Spring Boot，我們可以使用一些屬性設(shè)置來(lái)調(diào)整它的自動(dòng)配置。

將以下屬性添加到現(xiàn)有屬性設(shè)置：

spring.servlet.multipart.max-file-size=128KB
spring.servlet.multipart.max-request-size=128KB

多部分設(shè)置的約束如下：

spring.servlet.multipart.max-file-size設(shè)置為 128KB，這意味著總文件大小不能超過(guò) 128KB。

spring.servlet.multipart.max-request-size設(shè)置為 128KB，這意味著 a 的總請(qǐng)求大小multipart/form-data不能超過(guò) 128KB。

運(yùn)行應(yīng)用程序

您需要一個(gè)目標(biāo)文件夾來(lái)上傳文件，因此您需要增強(qiáng)UploadingFilesApplicationSpring Initializr 創(chuàng)建的基本類并添加一個(gè) BootCommandLineRunner以在啟動(dòng)時(shí)刪除并重新創(chuàng)建該文件夾。以下清單顯示了如何執(zhí)行此操作：

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是一個(gè)方便的注釋，它添加了以下所有內(nèi)容：

@Configuration: 將類標(biāo)記為應(yīng)用程序上下文的 bean 定義源。

@EnableAutoConfiguration：告訴 Spring Boot 根據(jù)類路徑設(shè)置、其他 bean 和各種屬性設(shè)置開始添加 bean。例如，如果spring-webmvc位于類路徑上，則此注釋將應(yīng)用程序標(biāo)記為 Web 應(yīng)用程序并激活關(guān)鍵行為，例如設(shè)置DispatcherServlet.

@ComponentScan: 告訴 Spring 在包中查找其他組件、配置和服務(wù)com/example，讓它找到控制器。

該main()方法使用 Spring Boot 的SpringApplication.run()方法來(lái)啟動(dòng)應(yīng)用程序。您是否注意到?jīng)]有一行 XML?也沒(méi)有web.xml文件。這個(gè) Web 應(yīng)用程序是 100% 純 Java，您不必處理任何管道或基礎(chǔ)設(shè)施的配置。

構(gòu)建一個(gè)可執(zhí)行的 JAR

您可以使用 Gradle 或 Maven 從命令行運(yùn)行應(yīng)用程序。您還可以構(gòu)建一個(gè)包含所有必要依賴項(xiàng)、類和資源的單個(gè)可執(zhí)行 JAR 文件并運(yùn)行它。構(gòu)建可執(zhí)行 jar 可以在整個(gè)開發(fā)生命周期、跨不同環(huán)境等中輕松地作為應(yīng)用程序交付、版本化和部署服務(wù)。

如果您使用 Gradle，則可以使用./gradlew bootRun. 或者，您可以使用構(gòu)建 JAR 文件./gradlew build，然后運(yùn)行 ??JAR 文件，如下所示：

java -jar build/libs/gs-uploading-files-0.1.0.jar

如果您使用 Maven，則可以使用./mvnw spring-boot:run. 或者，您可以使用構(gòu)建 JAR 文件，./mvnw clean package然后運(yùn)行該 JAR 文件，如下所示：

java -jar 目標(biāo)/gs-uploading-files-0.1.0.jar

它運(yùn)行接收文件上傳的服務(wù)器端部分。顯示記錄輸出。該服務(wù)應(yīng)在幾秒鐘內(nèi)啟動(dòng)并運(yùn)行。

在服務(wù)器運(yùn)行的情況下，您需要打開瀏覽器并訪問(wèn)http://localhost:8080/以查看上傳表單。選擇一個(gè)(小)文件，然后按Upload。您應(yīng)該會(huì)從控制器中看到成功頁(yè)面。如果你選擇的文件太大，你會(huì)得到一個(gè)丑陋的錯(cuò)誤頁(yè)面。

然后，您應(yīng)該會(huì)在瀏覽器窗口中看到類似于以下內(nèi)容的行：

“您成功上傳了<文件名>!”

測(cè)試您的應(yīng)用程序

有多種方法可以在我們的應(yīng)用程序中測(cè)試此特定功能。以下清單顯示了一個(gè)示例，MockMvc它不需要啟動(dòng) 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());
	}
}

在這些測(cè)試中，您使用各種模擬來(lái)設(shè)置與您的控制器以及StorageService與 Servlet 容器本身的交互，使用MockMultipartFile.