SpringBoot：SpringBoot 接口参数校验几种实用技巧

已于 2024-05-17 09:22:18 修改
阅读量812 收藏 9
点赞数 6
分类专栏： Spring 文章标签： spring boot 后端 java tomcat spring 架构 分布式
于 2024-05-16 23:56:14 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/A79800/article/details/138978634
版权

一、前言

  在 Spring Boot 中，接口参数校验是一个常见的需求，用于确保接收到的数据符合预期的格式和规则。Spring Boot 提供了多种参数校验的方式，包括使用 JSR 303/380 规范的注解（如 Hibernate Validator）、自定义校验注解、AOP 拦截等。

二、JSR 是什么？

  JSR 是 Java Specification Requests 的缩写，意思是 Java 规范提案。是指向 JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交 JSR，以向 Java 平台增添新的 API 和服务。JSR 已成为 Java 界的一个重要标准。JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。

  在Spring中提供了SpringValidation验证框架对参数的验证机制提供了@Validated（Spring’sJSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），结合BindingResult对象可以直接获取错误信息。

三、@Valid 与 @Validated区别？

1. 用法位置：
  @Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上，支持嵌套检测。它通常与@RequestBody一起使用，以验证传入JSON或XML等格式的请求体。

  @Validated：可以用在类型、方法和方法参数上，但不能直接用在成员属性（字段）上。它支持分组校验，允许你定义不同的校验组并在需要时应用它们。

2. 嵌套验证：
  @Valid 支持嵌套验证，即如果待验证的类中包含其他需要验证的类，那么@Valid也会验证这些嵌套类的属性。

  @Validated 默认情况下不支持嵌套验证，但可以通过配置来支持。

3. 分组校验：
  @Validated 支持分组校验，允许你定义不同的校验组并在需要时应用它们。这对于在不同场景下应用不同的校验规则非常有用。

  @Valid 不直接支持分组校验，但可以通过其他方式（如自定义校验器）实现类似的功能。

4. 与Spring框架的集成：
  @Valid 是JSR 303/380规范的一部分，是标准的Java Bean验证（Bean Validation）API的注解。它可以在任何支持Bean Validation的环境中使用，包括Spring。

  @Validated 是Spring框架提供的注解，提供了对JSR 303/380规范的扩展和增强。它除了支持标准的Bean Validation功能外，还提供了额外的功能，如分组校验和自定义校验器。

四、参数校验技巧及代码案例

引入依赖

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

准备一个入参实体类

package com.example.yddemo.validate;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;

public class User {

    @Min(value = 10, message = "ID不能小于 10", groups = V1.class)
    @Min(value = 20, message = "ID不能小于 20", groups = V2.class)
    private Long id;

    @NotEmpty(message = "姓名必需填写")
    private String name;

    private String phone;
	
	// 分组校验使用
    public static interface V1 {}

    public static interface V2 {}

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", phone='" + phone + '\'' +
                '}';
    }
}

全局异常信息返回

package com.example.yddemo.validate;

import com.alibaba.fastjson.JSON;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = {Exception.class})
    public ResponseEntity<?> handleValidationExceptions(Exception ex) {
        String message = "";
        BindingResult bindingResult = null;
        // 提取错误信息并返回给前端
        // ...
        if (ex instanceof ConstraintViolationException) {
            ConstraintViolationException e = (ConstraintViolationException) ex;
            message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
        } else if (ex instanceof MethodArgumentNotValidException) {
            bindingResult = ((MethodArgumentNotValidException) ex).getBindingResult();
            Optional<List<String>> list = Optional.of(bindingResult.getAllErrors().stream().map(err -> err.getDefaultMessage()).collect(Collectors.toList()));
            message = JSON.toJSONString(list.get());
        }

        return ResponseEntity.badRequest().body(message);
    }

}

1. 单个参数校验

@RestController
@Validated
public class TestValidateController1 {

    @GetMapping("/user/validate/one")
    public String userValidateOne(@NotEmpty(message = "参数 Id 不能为空") String id) {
        // 业务逻辑
        return "success" + id;
    }
}

在这里插入图片描述

2. 简单实体类参数校验

package com.example.yddemo.validate;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
public class TestValidateController {

    @GetMapping("/user/validate1")
    public User userValidate1(@Valid @RequestBody User user) {
        // 业务逻辑
        return user;
    }
}

在这里插入图片描述

3. 参数校验分组
  当需要根据不同的业务场景执行不同的校验规则时，可以使用分组校验。

@GetMapping("/user/validate/v2")
    public User userValidateV2(@Validated(User.V2.class) @RequestBody User user) {
        // 业务逻辑
        return user;
    }


    @GetMapping("/user/validate/v1")
    public User userValidateV1(@Validated(User.V1.class) @RequestBody User user) {
        // 业务逻辑
        return user;
    }

在这里插入图片描述
在这里插入图片描述
4. 嵌套参数校验
  实际的工作中往往参数对象比这复杂的多，User 对象中可能还嵌套有其他的对象，这个其他的对象也可能需要参数的校验

@Valid
    private Order order;



package com.example.yddemo.validate;

import javax.validation.constraints.NotEmpty;

public class Order {

    @NotEmpty(message = "编码不能为空")
    private String code;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }
}

在这里插入图片描述

5. 自定义注解校验
  当 JSR 303/380 提供的注解不满足需求时，可以自定义校验注解。

构造MobileValidator 验证器

package com.example.yddemo.validate;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class MobileValidator implements ConstraintValidator<MobileCheck, String> {
    // 处理细节

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return false;
    }

    @Override
    public void initialize(MobileCheck constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }
}

注解

package com.example.yddemo.validate;

import javax.validation.Constraint;
import javax.validation.Payload;
import javax.validation.constraints.Pattern;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MobileValidator.class)
@Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号码格式不正确")
public @interface MobileCheck {

    String message() default "手机号码格式不正确";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

在实体类DTO中使用

 @MobileCheck
    private String phone;

在这里插入图片描述
总结：以上是使用注解@Valid 与@Validated 实现SpringBoot 接口参数校验几种实用技巧，也可以使用AOP 拦截实现参数校验，下一篇我们在详细介绍。

奋斗的狍子007
关注
专栏目录
【微服务】springboot 实现动态修改接口返回值
congge
09-28 8307
springboot 实现动态修改接口返回值
Spring Boot进阶(02)：防止程序员疯狂 Debug：快速掌握 Validation 参数校验技巧，让你的代码健康起来！
**My Coding Family**
06-18 1583
spring boot使用Validation进行参数校验，非常好使，一文教你学会。
Spring Boot实现通用的接口参数校验
08-27
本文介绍基于 Spring Boot 和 JDK8 编写一个 AOP ，结合自定义注解实现通用的接口参数校验。具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Spring Boot 实现接口的各种参数校验
zhiyikeji的博客
01-24 6523
在我们进行接口开发时，在对参数的接收时，我们需要冗余复杂的校验规则 来进行接口参数的校验，接下来推荐一个好用的校验工具Spring Validation。 Java API规范 (JSR303) 定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。 Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验
Springboot中如何优雅的进行字段校验
最新发布
YIYIYI
09-29 1060
Springboot中如何优雅的进行字段校验
springboot 接口参数校验
weixin_30315435的博客
05-03 1096
前言 在开发接口的时候，参数校验是必不可少的。参数的类型，长度等规则，在开发初期都应该由产品经理或者技术负责人等来约定。如果不对入参做校验，很有可能会因为一些不合法的参数而导致系统出现异常。 上一篇文章讲了多种接受参数的方法【快学springboot】3.多种接受参数的方式。因为目前json类型的参数是最常用的，所以这里只讲解json类型的参数校验。其他类型的大同小异。 新建一个Param....
Spring Validation 最佳实践及其实现原理，参数校验没那么简单！
weixin_44421461的博客
08-10 364
点击上方“Java基基”，选择“设为星标”做积极的人，而不是积极废人！源码精品专栏原创 | Java 2020超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析...
springboot接口参数校验
weixin_45239670的博客
02-22 578
依赖 <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> </dependency> 公共异常处理器 package com.app.appapi.handler; import com.app.appapi.resul
springboot接口参数校验（有这一篇就够了）
l_s_r的博客
10-25 271
3、@RequestParam跟@PathVariable的参数校验使用@Validated注解；1、校验@RequestParam/@PathVariable的参数需要在Controller类上加上@Validated注解，方法上加上无效。2、@RequestParam的参数默认不允许为空，如果想让参数为空，这样写：@RequestParam(required=false)springboot接口参数校验的详细操作可以看下面这2篇文章，写的都挺全的。我这里只说一下在使用时遇到的问题及处理。
Springboot中接口参数校验
weixin_43797561的博客
05-26 177
Springboot中接口参数校验 <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency>
Spring Boot 实现各种参数校验，非常实用
m0_61926454的博客
06-17 1057
Java API规范 (JSR303) 定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。接下来，我们以spring-boot项目为例，介绍Spring Validation的使用。几乎涵盖你需要的SpringBoot所有操作...
Java-SpringBoot：用户认证（Authentication）和用户授权（Authorization）
embelfe_segge的博客
05-14 7406
Java-SpringBoot-2 学习视频：B站 狂神说Java – https://www.bilibili.com/video/BV1PE411i7CV 学习文档： 微信公众号 狂神说 –https://mp.weixin.qq.com/mp/homepage?__biz=Mzg2NTAzMTExNg==&hid=1&sn=3247dca1433a891523d9e4176c90c499&scene=18&uin=&key=&devicetype=Win
基于注解的springboot参数分组校验
qq_43567814的博客
06-22 306
自定一个基于注解的分组参数检查器 适用场景 你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。 新的改变 我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了如下几点新功能，帮助你用它写博客： 全新的界面设计 ，将会带来全新的写作体验； 在创作中心设置你喜爱的代码高亮样式，Markdown 将代码片显示选择的高亮样式 进行展示；
spring boot 之 接口参数校验
我叫晨曦啊的博客
05-28 1187
spring boot 接口参数校验
必读！SpringBoot接口参数校验N种实用技巧大揭秘
竹林幽深
11-08 1208
实际的开发工作中大部分的接口都是需要进行参数有效性校验的，参数可能是简单的基本数据类型，也可能是对象类型，基本上所有接收参数的接口都是需要对这些参数进行校验的，你对这些参数是怎么校验的？在实际的工作中往往参数对象比这复杂的多，Users 对象中可能还嵌套有其他的对象，这个其他的对象也可能需要参数的校验。从这里返回的信息来看我们的 phone 虽然写了@NotEmpty 但是并没有起作用，因为我们并没有指明他的分组，并且接口上我们指明了是用 G1 分组。这里对需要校验的字段都应用了不同的注解来约束。
会员中心-接口参数校验
afn12345的专栏
01-12 307
一、参数验证：        1.接口设计原则：职责单一、入参结构明确等几个特性去设计，后续详细讨论；        2.接口参数校验：大量的参数 以及级联关系，如果常规方式 ，各种if 充满接口校验方式，不易维护           基础架构本身是springboot—spring cloud，经过查阅资料与调研，选择hibernate validator 第三方包来集成处理      ...
Springboot接口参数校验
Spirit_NKlaus的专栏
03-01 1086
在设计接口时我们通常需要对接口中的非法参数做校验，以降低在程序运行时因为一些非法参数而导致程序发生异常的风险，例如登录的时候需要校验用户名密码是否为空，创建用户的时候需要校验邮件、手机号码格式是否准确。如果你的一个实体中的字段某一些是新增的时候必传，某一些修改时又不用传，那么对于不用传的字段肯定不需要校验的，这时候如果我们共用一个实体作为多个接口参数那肯定存在兼容问题，此时你就可以考虑将参数分组判断。接口的第一个参数是 自定义注解类型，第二个参数是 被注解字段的类。addUserV2接口。
接口参数校验
m0_59164927的博客
12-03 1661
接口参数校验
【SpringBoot】接口参数校验
exlinker的博客
09-25 533
前言 在我们编写后端接口时，不能相信用户给我们的东西，我们需要尽可能的将所有特殊情况考虑到，并且给出回避方案。例如： /** * 用户BO */ @Data public class UserBo { // 年龄 private Integer age; // 性别 private String name; } /** * 测试接口 */ @PostMapping public void saveUser(@RequestBody UserBo userBo) {
如何对SpringBoot接口参数进行校验？
chengxuyuanlaow的博客
11-01 2000
后端对前端传过来的参数也是需要进行校验的，如果在controller中直接校验需要用大量的if else做判断}}// ...}}针对这个普遍的问题，Java开者在Java API规范 (JSR303) 定义了Bean校验的标准，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值