Spring Boot上传文件

Joe.Ye • 2023-03-09 • Spring Boot

上传文件是互联网中常常应用的场景之一，最典型的情况就是上传头像等。

pom 包配置

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

引入spring-boot-starter-thymeleaf做页面模板引擎，写一些简单的上传示例。

启动类设置

@SpringBootApplication
public class FileUploadWebApplication {

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

    @Bean
    public TomcatServletWebServerFactory tomcatEmbedded() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
        tomcat.addConnectorCustomizers((TomcatConnectorCustomizer) connector -> {
            if ((connector.getProtocolHandler() instanceof AbstractHttp11Protocol<?>)) {
                //-1 means unlimited
                ((AbstractHttp11Protocol<?>) connector.getProtocolHandler()).setMaxSwallowSize(-1);
            }
        });
        return tomcat;
    }

}

tomcatEmbedded这段代码是为了解决，上传文件大于10M出现连接重置的问题。此异常内容GlobalException也捕获不到。

编写前端页面

上传页面：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<body>
<h1>Spring Boot file upload example</h1>
<form method="POST" action="/upload/single" enctype="multipart/form-data">
    <input type="file" name="file" /><br/><br/>
    <input type="submit" value="Submit" />
</form>
</body>
</html>

上传结果展示页面：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<body>
<h1>Spring Boot - Upload Status</h1>
<div th:if="${message}">
    <h2 th:text="${message}"/>
</div>
</body>
</html>

编写上传控制类

@Controller
public class UploadFileController {

    @GetMapping("/upload")
    public String upload() {
        return "upload/upload";
    }

    @GetMapping("/uploadStatus")
    public String uploadStatus() {
        return "upload/upload_status";
    }

    // 上传业务处理
    @PostMapping("/upload/single")
    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("E:/logs/" + file.getOriginalFilename());
            Files.write(path, bytes);

            redirectAttributes.addFlashAttribute("message",
                    "You successfully uploaded '" + file.getOriginalFilename() + "'");

        } catch (IOException e) {
            e.printStackTrace();
        }

        return "redirect:/uploadStatus";
    }

}

通过MultipartFile读取文件信息，如果文件为空跳转到结果页并给出提示；如果不为空读取文件流并写入到指定目录，最后将结果展示到页面。

MultipartFile是Spring上传文件的封装类，包含了文件的二进制流和文件属性等信息，在配置文件中也可对相关属性进行配置，基本的配置信息如下：

server.servlet.multipart.enabled=true #默认支持文件上传
server.servlet.multipart.file-size-threshold=0 #支持文件写入磁盘
server.servlet.multipart.location= # 上传文件的临时目录
server.servlet.multipart.max-file-size=1Mb # 最大支持文件大小
server.servlet.multipart.max-request-size=10Mb # 最大支持请求大小
server:
  port: 8080
  servlet:
    context-path: /
    multipart:
      enabled: true
      file-size-threshold: 0
      location:
      max-file-size: 1Mb
      max-request-size: 10Mb

最常用的是最后两个配置内容，限制文件上传大小，上传时超过大小会抛出异常：

org.apache.tomcat.util.http.fileupload.FileUploadBase$FileSizeLimitExceededException: The field file exceeds its maximum permitted size of 1048576 bytes.

异常处理

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MultipartException.class)
    public String handleMultipartException(MultipartException e, RedirectAttributes redirectAttributes) {
        redirectAttributes.addFlashAttribute("message", e.getCause().getMessage());
        return "redirect:/uploadStatus";
    }

}

设置一个@ControllerAdvice用来监控Multipart上传的文件大小是否受限，当出现此异常时在前端页面给出提示。利用@ControllerAdvice可以做很多东西，比如全局的统一异常处理等。

版权声明：
作者：Joe.Ye
链接：https://www.appblog.cn/index.php/2023/03/09/spring-boot-upload-files/
来源：APP全栈技术分享
文章版权归作者所有，未经允许请勿转载。

THE END
分享
二维码
打赏
海报
Spring Boot上传文件
上传文件是互联网中常常应用的场景之一，最典型的情况就是上传头像等。 pom 包配置 <dependency> <groupId>org.springframework.boot</gr……
<<上一篇
下一篇>>
文章目录
关闭
目 录