讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

SoundView
SoundView

字幕擦除翻译、配音口型同步

Seko
Seko

AI短剧一键生成成片

Spring Boot 参数校验怎么校验文件大小

落枫君_4768

落枫君_4768

发布时间:2026-11-18 06:35:21

|

205人浏览过

|

来源于php中文网

原创

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

Spring Boot 参数校验怎么校验文件大小

如何配置自定义校验注解

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

Spring Boot 参数校验怎么校验文件大小

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 Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

如何处理校验失败的异常响应

当文件大小超过限制时,Spring Boot 默认会抛出 MethodArgumentNotValidException。为了让前端获得清晰的错误提示,需要配置一个全局异常处理器(Global Exception Handler)。该处理器捕获特定异常,提取校验消息,并将其封装为统一的响应结构返回给客户端。这样可以确保所有校验错误都以一致的格式呈现,便于前端解析和处理。

Spring Boot 参数校验怎么校验文件大小

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(针对字符串)等标准注解。这种设计符合单一职责原则,使得每个校验注解专注于其特定的验证逻辑,避免重复检查和逻辑混乱。

热门AI工具

更多
笔灵降AI

一款AI论文写作工具,主要用于论文降AI神器,适配知网及维普!一键降至安全线,100%保留原文格式;无口语化问题,文风更学术,降后字数控制最佳!,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

12837

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

9922

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

8412

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1344

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1068

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1616

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

3369

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20591

2023.08.03

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn