在 spring boot 中校验文件大小,核心做法是结合 @size 注解与自定义的 validator 实现。因为标准的 jsr-380 规范中,@size 仅支持对字符串、集合和数组的长度进行校验,无法直接处理 multipartfile 的字节数。因此需要编写一个针对 multipartfile 的自定义校验器,并在 controller 方法参数上使用 @validated 触发校验流程。

如何配置自定义校验注解
要实现这一功能,第一步是定义一个注解类,用于标记在 Controller 的参数上。这个注解需要绑定到具体的 Validator 实现类,并允许开发者指定最大文件大小(以字节为单位)以及错误提示信息。通过这种方式,可以将校验逻辑从业务代码中解耦,保持 Controller 的整洁。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.validation.Constraint;
import javax.validation.Payload;
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FileSizeValidator.class)
public @interface ValidFileSize {
long max() default 5 * 1024 * 1024; // 默认 5MB
String message() default "文件过大";
Class[] groups() default {};
Class[] payload() default {};
}
接下来是实现 Validator 接口的具体类。该类接收 MultipartFile 对象,检查其是否为空或零长度,若存在内容则对比 getSize() 与注解中定义的 max 值。如果超出限制,返回 false,否则返回 true。Spring 的校验框架会自动调用此类的 isValid 方法。
import org.springframework.web.multipart.MultipartFile;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class FileSizeValidator implements ConstraintValidator<ValidFileSize, MultipartFile> {
private long maxSize;
@Override
public void initialize(ValidFileSize constraintAnnotation) {
this.maxSize = constraintAnnotation.max();
}
@Override
public boolean isValid(MultipartFile file, ConstraintValidatorContext context) {
if (file == null || file.isEmpty()) {
return true; // 空文件由 @NotNull 或其他注解处理,这里只关注大小
}
return file.getSize() <= maxSize;
}
}
在 Controller 中使用时,只需在 MultipartFile 参数上方添加 @ValidFileSize(max = 1024 * 1024) 即可。当请求进入时,Spring 会拦截该参数,实例化 FileSizeValidator 并执行校验。如果校验失败,将抛出 MethodArgumentNotValidException,可通过全局异常处理器统一返回 JSON 格式的错误信息。
如何处理校验失败的异常响应
当文件大小超过限制时,Spring Boot 默认会抛出 MethodArgumentNotValidException。为了让前端获得清晰的错误提示,需要配置一个全局异常处理器(Global Exception Handler)。该处理器捕获特定异常,提取校验消息,并将其封装为统一的响应结构返回给客户端。这样可以确保所有校验错误都以一致的格式呈现,便于前端解析和处理。

import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<Map<String, String>> handleValidationExceptions(
MethodArgumentNotValidException ex) {
Map<String, String> errors = new HashMap<>();
ex.getBindingResult().getAllErrors().forEach((error) -> {
String fieldName = ((FieldError) error).getField();
String errorMessage = error.getDefaultMessage();
errors.put(fieldName, errorMessage);
});
return ResponseEntity.badRequest().body(errors);
}
}
此外,还可以自定义一个更通用的异常处理类,专门处理文件上传相关的校验错误。例如,可以捕获 MultipartException 来处理文件解析失败的情况,或者在 ControllerAdvice 中增加对 ValidFileSize 校验失败的特定响应。这样可以根据不同的校验场景返回不同的 HTTP 状态码或错误详情,提升 API 的健壮性和用户体验。
当文件为空时校验行为如何
在上述实现的 FileSizeValidator 中,我们特别处理了文件为空的情况。如果 MultipartFile 对象为 null 或 isEmpty() 返回 true,校验器直接返回 true,认为校验通过。这意味着 @ValidFileSize 本身不负责检查文件是否存在,它只关注已上传文件的大小。如果需要确保文件必须上传,应配合使用 @NotNull 或 @NotBlank(针对字符串)等标准注解。这种设计符合单一职责原则,使得每个校验注解专注于其特定的验证逻辑,避免重复检查和逻辑混乱。


















