Пример загрузки файла Spring Boot
В этой статье показано, как загрузить файл в веб-приложение Spring Boot.
Используемые инструменты:
-
Spring Boot 1.4.3.RELEASE
-
Весна 4.3.5. ВЫПУСК
-
Thymeleaf
-
специалист
-
Встроенный Tomcat 8.5.6
1. Структура проекта
Стандартная структура проекта.
2. Зависимость проекта
Весенние загрузочные зависимости, нет необходимости в дополнительной библиотеке для загрузки файлов.
pom.xml
4.0.0 com.example spring-boot-file-upload jar 1.0 org.springframework.boot spring-boot-starter-parent 1.4.3.RELEASE 1.8 org.springframework.boot spring-boot-starter-thymeleaf org.springframework.boot spring-boot-devtools true org.springframework.boot spring-boot-maven-plugin
3. Пример загрузки файла
Загрузка весеннего загрузочного файла, нулевая конфигурация.
3.1 In the Controller, maps the uploaded file to MultipartFile
UploadController.java
package com.example.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.multipart.MultipartFile; import org.springframework.web.servlet.mvc.support.RedirectAttributes; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; @Controller public class UploadController { //Save the uploaded file to this folder private static String UPLOADED_FOLDER = "F://temp//"; @GetMapping("/") public String index() { return "upload"; } @PostMapping("/upload") // //new annotation since 4.3 public String singleFileUpload(@RequestParam("file") MultipartFile file, RedirectAttributes redirectAttributes) { if (file.isEmpty()) { redirectAttributes.addFlashAttribute("message", "Please select a file to upload"); return "redirect:uploadStatus"; } try { // Get the file and save it somewhere byte[] bytes = file.getBytes(); Path path = Paths.get(UPLOADED_FOLDER + file.getOriginalFilename()); Files.write(path, bytes); redirectAttributes.addFlashAttribute("message", "You successfully uploaded '" + file.getOriginalFilename() + "'"); } catch (IOException e) { e.printStackTrace(); } return "redirect:/uploadStatus"; } @GetMapping("/uploadStatus") public String uploadStatus() { return "uploadStatus"; } }
3.2 In thymeleaf, just some normal HTML file tags.
upload.jsp
Spring Boot file upload example
3.3 Another page for upload status
uploadStatus.jsp
Spring Boot - Upload Status
4. Превышен максимальный размер загрузки
Для обработки исключения превышения максимального размера загрузки объявляет@ControllerAdvice
и перехватываетMultipartException
GlobalExceptionHandler.java
package com.example.controller; import org.springframework.web.bind.annotation.ControllerAdvice; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.multipart.MultipartException; import org.springframework.web.servlet.mvc.support.RedirectAttributes; @ControllerAdvice public class GlobalExceptionHandler { //https://jira.spring.io/browse/SPR-14651 //Spring 4.3.5 supports RedirectAttributes @ExceptionHandler(MultipartException.class) public String handleError1(MultipartException e, RedirectAttributes redirectAttributes) { redirectAttributes.addFlashAttribute("message", e.getCause().getMessage()); return "redirect:/uploadStatus"; } /* Spring < 4.3.5 @ExceptionHandler(MultipartException.class) public String handleError2(MultipartException e) { return "redirect:/errorPage"; }*/ }
5. Сброс соединения Tomcat
Если вы развернулись на Tomcat, настройтеmaxSwallowSize
, чтобы избежать этогоTomcat connection reset issue. Для встроенного Tomcat объявляетTomcatEmbeddedServletContainerFactory
следующим образом:
SpringBootWebApplication.java
package com.example; import org.apache.coyote.http11.AbstractHttp11Protocol; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.embedded.tomcat.TomcatConnectorCustomizer; import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory; import org.springframework.context.annotation.Bean; @SpringBootApplication public class SpringBootWebApplication { private int maxUploadSizeInMb = 10 * 1024 * 1024; // 10 MB public static void main(String[] args) throws Exception { SpringApplication.run(SpringBootWebApplication.class, args); } //Tomcat large file upload connection reset //http://www.example.com/spring/spring-file-upload-and-connection-reset-issue/ @Bean public TomcatEmbeddedServletContainerFactory tomcatEmbedded() { TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory(); tomcat.addConnectorCustomizers((TomcatConnectorCustomizer) connector -> { if ((connector.getProtocolHandler() instanceof AbstractHttp11Protocol>)) { //-1 means unlimited ((AbstractHttp11Protocol>) connector.getProtocolHandler()).setMaxSwallowSize(-1); } }); return tomcat; } }
6. Размер файла
По умолчанию максимальный размер загружаемого файла Spring Boot составляет 1 МБ, значения можно настроить с помощью следующих свойств приложения:
application.properties
#http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#common-application-properties #search multipart spring.http.multipart.max-file-size=10MB spring.http.multipart.max-request-size=10MB
7. DEMO
Запустите Spring Boot со встроенным Tomcatmvn spring-boot:run
по умолчанию.
Терминал
$ mvn spring-boot:run . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v1.4.3.RELEASE) 2017-01-21 07:48:53 INFO com.example.SpringBootWebApplication - Starting SpringBootWebApplication on MKYONG-WIN10 with PID 2384 (E:\spring-boot-file-upload\target\classes started by example in E:\spring-boot-file-upload) 2017-01-21 07:48:53 DEBUG com.example.SpringBootWebApplication - Running with Spring Boot v1.4.3.RELEASE, Spring v4.3.5.RELEASE 2017-01-21 07:48:53 INFO com.example.SpringBootWebApplication - No active profile set, falling back to default profiles: default 2017-01-21 07:48:55 INFO com.example.SpringBootWebApplication - Started SpringBootWebApplication in 2.54 seconds (JVM running for 2.924)
7.1 Access http://localhost:8080/
7.2 Select a file and upload it.
7.3 Select a file larger than 10mb, you will visit this page.
8. Скачать исходный код
Скачать -spring-boot-file-upload-example.zip (7 КБ)