场景解决之springboot当中文件上传被限制大小的问题

在 Spring Boot 应用开发里，文件上传是常见功能。但实际使用时，文件上传大小受限问题频发，给开发和用户体验带来诸多困扰。下面深入探讨此问题及解决办法。

一、问题场景

普通 Web 应用场景：在一个企业内部文档管理系统中，员工需要上传各类文档，如项目报告、合同文件等。若系统默认文件上传大小限制过小，当员工尝试上传稍大些的文档（如超过 1MB 的项目报告）时，上传操作会失败，且页面可能仅显示一个通用的错误提示，没有明确告知是文件大小超出限制，导致员工多次尝试仍无法成功上传，影响工作效率。
富媒体应用场景：对于一个在线图片或视频编辑平台，用户期望上传高质量的图片或较长的视频素材进行处理。然而，若文件上传大小限制设置不合理，用户上传高清图片（可能几 MB）或几分钟的视频（可能几十 MB）时，系统直接报错，用户体验极差，甚至可能导致用户流失。

二、问题原因

1、默认配置限制：Spring Boot 默认对文件上传大小进行了限制。在 Servlet 3.1 及以上版本环境下，MultipartConfigElement会对文件上传进行配置，默认单个文件大小限制为 1MB，总请求大小限制为 10MB。这是为了防止因超大文件上传导致的内存溢出、服务器性能下降等问题，但在许多实际业务场景中，这样的默认值过小。
2、配置未生效：开发者在尝试修改文件上传大小限制时，可能由于配置方式错误或配置文件加载顺序问题，导致修改后的配置未生效。比如，在application.properties文件中正确添加了配置，但在代码中又通过其他方式重新初始化了MultipartConfigElement，覆盖了配置文件中的设置。

三、解决方案

1.在配置文件中修改
在application.properties文件中添加或修改如下配置：

spring.servlet.multipart.max-file-size=50MB
spring.servlet.multipart.max-request-size=100MB

这里max-file-size用于设置单个文件的最大上传大小，max-request-size用于设置整个请求（可能包含多个文件）的最大大小。修改完成后，Spring Boot 应用会读取这些配置，调整文件上传大小限制。
2. 通过 Java 配置类设置
创建一个配置类，例如MultipartConfig.java：

import org.springframework.boot.web.servlet.MultipartConfigFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.MultipartConfigElement;
@Configuration
public class MultipartConfig {
    @Bean
    public MultipartConfigElement multipartConfigElement() {
        MultipartConfigFactory factory = new MultipartConfigFactory();
        factory.setMaxFileSize("50MB");
        factory.setMaxRequestSize("100MB");
        return factory.createMultipartConfig();
    }
}

通过这种方式，以编程形式设置文件上传大小限制，与在配置文件中设置效果相同，可根据项目需求灵活选择。
3. 处理文件大小超出限制的异常
为了给用户提供更友好的提示，在控制器层捕获MaxUploadSizeExceededException异常：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public ResponseEntity<String> handleMaxUploadSizeExceededException(MaxUploadSizeExceededException e) {
        return new ResponseEntity<>("文件大小超出限制，请选择较小的文件上传。", HttpStatus.BAD_REQUEST);
    }
}

这样，当用户上传文件大小超出限制时，系统会返回一个明确的错误提示，告知用户问题所在。