Spring Boot 设置上传文件大小限制

在开发 Web 应用程序时，我们通常需要处理文件上传功能。为了确保系统的安全性和稳定性，我们需要限制上传文件的大小。本篇博客将介绍如何使用 Spring Boot 设置上传文件大小限制。

1. application.properties 配置文件

Spring Boot 提供了一种简单的方式来配置上传文件大小限制。首先，我们需要在 application.properties（或 application.yml）配置文件中添加以下属性：

# 设置上传文件的最大大小，默认为 1MB 
spring.servlet.multipart.max-file-size=1MB 
 
# 设置请求中最大允许的文件大小，默认为 10MB 
spring.servlet.multipart.max-request-size=10MB

在上述示例中，我们设置了两个属性。

multipart.max-file-size 属性用于设置单个上传文件的最大大小，

而 multipart.max-request-size 属性则用于设置整个请求中允许的最大文件大小。

2. 单个文件大小限制

如果你只关心单个上传文件的大小限制，可以只设置 multipart.max-file-size 属性。例如，如果要将最大文件大小限制为 5MB，可以这样配置：

spring.servlet.multipart.max-file-size=5MB

3. 整个请求大小限制

如果你更关心整个请求中包含的所有文件的大小限制，可以只设置 multipart.max-request-size 属性。例如，如果要将整个请求的最大文件大小限制为 20MB，可以这样配置：

spring.servlet.multipart.max-request-size=20MB

4. 单位转换

在配置文件中，你可以使用以下单位来指定文件大小：

• KB：千字节
• MB：兆字节
• GB：吉字节
• TB：太字节

5. 自定义异常处理

当上传的文件超过限制大小时，Spring Boot 默认会抛出 MaxUploadSizeExceededException 异常。你可以通过自定义全局异常处理器来捕获该异常，并返回友好的错误信息给用户。

@ControllerAdvice
public class GlobalExceptionHandler {
 
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public ResponseEntity handleMaxUploadSizeExceededException(
            MaxUploadSizeExceededException ex) {
        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body("上传文件大小超过限制");
    }
}

在上述示例中，我们使用 @ControllerAdvice 注解和 @ExceptionHandler 注解来定义全局异常处理器，并处理 MaxUploadSizeExceededException 异常。

总结

通过本篇博客的介绍，我们了解了如何使用 Spring Boot 设置上传文件大小限制。通过配置 application.properties 文件中的 spring.servlet.multipart.max-file-size 和 spring.servlet.multipart.max-request-size 属性，我们可以轻松地控制上传文件的大小限制。此外，我们还学习了如何自定义异常处理，以提供更友好的错误信息。