摘要：要使用容器上傳文件，您需要注冊一個類在中。最好不要使用內容加載應用程序的文件系統。允許用戶上傳文件的表單從后端提供的文件列表調整文件上傳限制配置文件上傳時，設置文件大小限制通常很有用。

本指南將指導您完成創建可以接收HTTP多文件上傳服務器應用程序的過程。

你要構建什么

您將創建一個接受文件上傳的Spring Boot Web應用程序。您還將構建一個簡單的HTML界面來上傳測試文件。

你需要什么

大約15分鐘

最喜歡的文本編輯器或IDE

JDK 1.8或更高版本

Gradle 4+或Maven 3.2+

您還可以將代碼直接導入IDE：

使用STS構建/導入入門指南

使用IntelliJ IDEA導入入門指南

如何完成本指南

與大多數Spring入門指南一樣，您可以從頭開始并完成每個步驟，或者您可以繞過您已熟悉的基本設置步驟。無論哪種方式，您最終都會使用工作代碼。

要從頭開始，請繼續使用Gradle構建。

要跳過基礎知識，請執行以下操作：

下載并解壓縮本指南的源存儲庫，或使用Git克隆它：

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

進入gs-uploading-files/initial

跳轉到創建Application類。

完成后，可以根據ggs-uploading-files/complete中的代碼檢查結果。

首先，設置一個基本的構建腳本。在使用Spring構建應用程序時，您可以使用任何您喜歡的構建系統，但此處包含了使用Gradle和Maven所需的代碼。如果您不熟悉這兩者，請參閱使用Gradle構建Java項目或使用Maven構建Java項目。

創建目錄結構

在您選擇的項目目錄中，創建以下子目錄結構;例如，在*nix系統上使用mkdir -p src/main/java/hello:

└── src
    └── main
        └── java
            └── hello

創建Gradle構建文件

下面是最初的Gradle構建文件。

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.3.RELEASE")
    }
}

apply plugin: "java"
apply plugin: "eclipse"
apply plugin: "org.springframework.boot"
apply plugin: "io.spring.dependency-management"

bootJar {
    baseName = "gs-uploading-files"
    version =  "0.1.0"
}

repositories {
    mavenCentral()
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

在Spring Boot gradle plugin提供了許多便捷的功能：

它收集類路徑上的所有jar并構建一個可運行的“über-jar”，這使得執行和傳輸服務更加方便。

它搜索public static void main()標記為可運行類的方法。

它提供了一個內置的依賴項解析器，它設置版本號以匹配Spring Boot依賴項。您可以覆蓋任何您希望的版本，但它將默認為Boot的所選版本集。

首先，設置一個基本的構建腳本。在使用Spring構建應用程序時，您可以使用任何您喜歡的構建系統，但此處包含了使用Maven所需的代碼。如果您不熟悉Maven，請參閱使用Maven構建Java項目。

創建目錄結構

在您選擇的項目目錄中，創建以下子目錄結構;例如，在*nix系統上使用mkdir -p src/main/java/hello:

└── src
    └── main
        └── java
            └── hello

pom.xml

    4.0.0

    org.springframework
    gs-uploading-files
    0.1.0

    
        org.springframework.boot
        spring-boot-starter-parent
        2.0.3.RELEASE
    

    
        1.8
    


    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

在Spring Boot gradle plugin提供了許多便捷的功能：

它收集類路徑上的所有jar并構建一個可運行的“über-jar”，這使得執行和傳輸服務更加方便。

它搜索public static void main()標記為可運行類的方法。

它提供了一個內置的依賴項解析器，它設置版本號以匹配Spring Boot依賴項。您可以覆蓋任何您希望的版本，但它將默認為Boot的所選版本集。

閱讀如何將本指南直接導入使用STS構建/導入入門指南。

閱讀使用IntelliJ IDEA導入入門指南中如何使用本指南。

創建一個Application類

要啟動Spring Boot MVC應用程序，我們首先需要一個啟動器; spring-boot-starter-thymeleaf和spring-boot-starter-web已經添加為依賴關系。要使用Servlet容器上傳文件，您需要注冊一個MultipartConfigElement類（在web.xml中**）。感謝Spring Boot，一切都是自動配置的！

您開始使用此應用程序所需的只是以下Application類。

package hello;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

作為自動配置Spring MVC的一部分，Spring Boot將創建一個MultipartConfigElement bean并為文件上傳做好準備。

創建文件上傳控制器

初始應用程序已經包含一些類來處理在磁盤上存儲和加載上傳的文件; 它們都位于hello.storage包中。我們將在新的FileUploadController中使用它們。

src/main/java/hello/FileUploadController.java

package hello;

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 hello.storage.StorageFileNotFoundException;
import hello.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().toString())
                .collect(Collectors.toList()));

        return "uploadForm";
    }

    @GetMapping("/files/{filename:.+}")
    @ResponseBody
    public ResponseEntity 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();
    }

}

這個類帶有@Controller注解，因此Spring MVC可以選擇并查找路由。每個方法都標記有@GetMapping或@PostMapping將路徑和HTTP操作綁定到特定的Controller操作。

在這種情況下：

GET /查找從StorageService上傳的文件的當前列表，并將其加載到Thymeleaf模板中。它使用MvcUriComponentsBuilder計算到實際資源的鏈接

GET /files/{filename}加載資源（如果存在），并將其發送到瀏覽器以使用Content-Disposition響應頭進行下載

POST /適用于處理多部分消息file并將其提供給StorageService保存

在生產場景中，您更有可能將文件存儲在臨時位置，數據庫或Mongo的GridFS之類的NoSQL存儲中。最好不要使用內容加載應用程序的文件系統。

您需要為控制器提供與StorageService存儲層（例如文件系統）交互的控件。界面是這樣的：

src/main/java/hello/storage/StorageService.java

package hello.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 loadAll();

    Path load(String filename);

    Resource loadAsResource(String filename);

    void deleteAll();

}

示例應用程序中有一個接口的示例實現。如果您想節省時間，可以復制并粘貼它。

創建一個簡單的HTML模板

為了構建一些有趣的東西，下面的Thymeleaf模板是上傳文件以及顯示已上傳內容的一個很好的例子。

src/main/resources/templates/uploadForm.html

    

        

    

    

        

            

                
File to upload:

                

            
        
    

    

        

            

                
            

        

    

調整文件上傳限制

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

構建可執行的JAR

package hello;

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 hello.storage.StorageProperties;
import hello.storage.StorageService;

@SpringBootApplication
@EnableConfigurationProperties(StorageProperties.class)
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    CommandLineRunner init(StorageService storageService) {
        return (args) -> {
            storageService.deleteAll();
            storageService.init();
        };
    }
}

構建可執行的JAR

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

java -jar target/gs-uploading-files-0.1.0.jar

You successfully uploaded !

測試您的應用程序

package hello;

import java.nio.file.Paths;
import java.util.stream.Stream;

import org.hamcrest.Matchers;
import org.junit.Test;
import org.junit.runner.RunWith;

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.context.junit4.SpringRunner;
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.result.MockMvcResultMatchers.header;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.model;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import hello.storage.StorageFileNotFoundException;
import hello.storage.StorageService;

@RunWith(SpringRunner.class)
@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(fileUpload("/").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());
    }

}

概要