1、是什么?

它简化了 Java Bean Validation 的集成。Java Bean Validation 通过 JSR 380,也称为 Bean Validation 2.0,是一种标准化的方式,用于在 Java 应用程序中对对象的约束进行声明式验证。它允许开发人员使用注解来定义验证规则,并自动将规则应用于相应的字段或方法参数

为了我们方便地使用参数校验功能了

2、怎么玩?

(1) 首先导入相关依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <groupId>com.ly</groupId>
<artifactId>springboot-validate</artifactId>
<version>1.0-SNAPSHOT</version> <parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.1.4</version>
</parent> <properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties> <dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency> <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency> <dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>
(2) 在对应实体上加@Validated注解,开启校验规则
package com.ly.valid.controller;

import com.ly.valid.common.R;
import com.ly.valid.common.ResultCodeEnum;
import com.ly.valid.entity.Person;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController; import java.util.HashMap;
import java.util.List;
import java.util.Map; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 21:01
* @tags 喜欢就去努力的争取
*/
@RestController
public class TestController { /**
* 保存
*/
@PostMapping("/test1")
public R save(@Validated @RequestBody Person person, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
List<FieldError> fieldErrorList = bindingResult.getFieldErrors();
Map<String, String> map = new HashMap<>(fieldErrorList.size());
fieldErrorList.forEach(item -> {
String message = item.getDefaultMessage(); // 如果没有在相应的注解中加message,则会获取默认信息 例如:@NotBlank(message = "品牌名必须提交"),获取的message则为品牌名必须提交
String field = item.getField(); // 获取哪个字段出现的问题
map.put(field, message);
});
return R.fail(ResultCodeEnum.PARAM_ERROR, map);
} else {
// 伪代码
// personService.save(person);
}
return R.success();
} /**
* 全局处理
*
* @param person
* @return
*/
@PostMapping("/test2")
public R test(@Validated Person person) {
return R.success(person);
} }
(3) 给对应的实体Bean添加校验注解,并自定义message提示
package com.ly.valid.entity;

import com.ly.valid.constant.RegularConstant;
import jakarta.validation.constraints.*;
import lombok.Data; import java.time.LocalDate; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 21:03
* @tags 喜欢就去努力的争取
*/
@Data
public class Person { @NotBlank(message = "name 姓名不能为空")
private String name; @NotNull(message = "age 年龄不能为空")
@Min(value = 0, message = "年龄不能小于0")
private Integer age; @NotNull(message = "gender 性别不能为空")
private Integer gender; @Email(regexp = RegularConstant.EMAIL, message = "email 邮箱格式不正确")
private String email; @Pattern(regexp = RegularConstant.PHONE, message = "phone 手机号格式不正确")
private String phone; @Past(message = "birthday 生日日期有误")
private LocalDate birthday; }
(4) 不加@Validate注解,测试一下

(5) 开启校验功能@Validated:不使用自定义message会有默认提示信息

(6) 方式一: 我想自定义提示信息怎么整?简单,只需要给响应的校验bean后面紧跟着添加一个BindingResult,就可以获取到校验的结果了
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
List<FieldError> fieldErrorList = bindingResult.getFieldErrors();
Map<String, String> map = new HashMap<>();
fieldErrorList.forEach(item -> {
String message = item.getDefaultMessage(); // 如果没有在相应的注解中加message,则会获取默认信息 例如:@NotBlank(message = "品牌名必须提交"),获取的message则为品牌名必须提交
String field = item.getField(); // 获取哪个字段出现的问题
map.put(field, message);
});
return R.error(400, "提交的数据不合法").put("data", map);
} else {
brandService.save(brand);
}
return R.ok();
}
(7) 测试一下

(8) 方式二:如果有很多需要这样手动一个个处理,就显得很麻烦了;所以我们需要一个全局处理
package com.ly.valid.common;

import jakarta.validation.ConstraintViolation;
import jakarta.validation.ConstraintViolationException;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.validation.BindException;
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.List;
import java.util.stream.Collectors; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 22:13
* @tags 喜欢就去努力的争取
*/
@RestControllerAdvice
public class GlobalExceptionHandler { /**
* 处理 form data方式调用接口校验失败抛出的异常 (对象参数)
*/
@ExceptionHandler(BindException.class)
public R error(BindException e) {
List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
List<String> errorMessages = fieldErrors.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.toList();
return R.fail(ResultCodeEnum.PARAM_ERROR.getCode(), errorMessages.toString());
} /**
* 处理 json 请求体调用接口校验失败抛出的异常
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public R error(MethodArgumentNotValidException e) {
List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
List<String> errorMessages = fieldErrors.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.toList();
return R.fail(ResultCodeEnum.PARAM_ERROR.getCode(), errorMessages.toString());
} /**
* 单个参数校验失败抛出的异常
*/
@ExceptionHandler(ConstraintViolationException.class)
public R error(ConstraintViolationException e) {
String errorMsg = e.getConstraintViolations()
.stream()
.map(ConstraintViolation::getMessageTemplate)
.collect(Collectors.joining());
return R.fail(errorMsg);
}
}
(9) 测试一下

3、相关注解信息

注解 数据类型 说明
@NotBlank CharSequence 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@NotEmpty CharSequence,Collection,Map,Arrays 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@Length(min=下限, max=上限) CharSequence 验证注解的元素值长度在min和max区间内
@NotNull 所有类型 验证注解的元素值不是null
@Null 所有类型 验证注解的元素值是null
@Max(value=n) BigDecimal,BigInteger,byte,short,int,long和原始类型的相应包装。HV额外支持:CharSequence的任何子类型(评估字符序列表示的数字值),Number的任何子类型。 验证注解的元素值小于等于@Max指定的value值
@Min(value=n) BigDecimal,BigInteger,byte,short,int,long和原始类型的相应包装。HV额外支持:CharSequence的任何子类型(评估char序列表示的数值),Number的任何子类型。 验证注解的元素值大于等于@Min指定的value值
@Size(min=最小值, max=最大值) 字符串,集合,映射和数组。HV额外支持:CharSequence的任何子类型。 验证注解的元素值的在min和max(包含)指定区间之内,如字符长度、集合大小
@Email CharSequence 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
@Pattern(regex=正则表达式, flag=) CharSequence 验证注解的元素值与指定的正则表达式匹配
@Range(min=最小值, max=最大值 CharSequence, Collection, Map and Arrays, BigDecimal, BigInteger, CharSequece, byte, short, int, long以及原始类型各自的包装 验证注解的元素值在最小值和最大值之间
@AssertFalse Boolean, boolean 验证注解的元素值是false
@AssertTrue Boolean, boolean 验证注解的元素值是true
@DecimalMax(value=n) BigDecimal,BigInteger,String,byte,short,int,long和原始类型的相应包装。HV额外支持:Number和CharSequence的任何子类型。 验证注解的元素值小于等于@ DecimalMax指定的value值
@DecimalMin(value=n) BigDecimal,BigInteger,String,byte,short,int,long和原始类型的相应包装。HV额外支持:Number和CharSequence的任何子类型。 验证注解的元素值小于等于@ DecimalMin指定的value值
@Digits(integer=整数位数, fraction=小数位数) BigDecimal,BigInteger,String,byte,short,int,long和原始类型的相应包装。HV额外支持:Number和CharSequence的任何子类型。 验证注解的元素值的整数位数和小数位数上限
@Future java.util.Date,java.util.Calendar, java.time.Instant, java.time.LocalDate, java.time.LocalDateTime, java.time.LocalTime, java.time.MonthDay, java.time.OffsetDateTime, java.time.OffsetTime, java.time.Year, java.time.YearMonth, java.time.ZonedDateTime, java.time.chrono.HijrahDate, java.time.chrono.JapaneseDate, java.time.chrono.MinguoDate, java.time.chrono.ThaiBuddhistDate; Additionally supported by HV, if the Joda Time date/time API is on the classpath: any implementations of ReadablePartial and ReadableInstant 验证注解的元素值(日期类型)比当前时间晚
@Past java.util.Date,java.util.Calendar, java.time.Instant, java.time.LocalDate, java.time.LocalDateTime, java.time.LocalTime, java.time.MonthDay, java.time.OffsetDateTime, java.time.OffsetTime, java.time.Year, java.time.YearMonth, java.time.ZonedDateTime, java.time.chrono.HijrahDate, java.time.chrono.JapaneseDate, java.time.chrono.MinguoDate, java.time.chrono.ThaiBuddhistDate; ,则由HV附加支持:ReadablePartial和ReadableInstant的任何实现。 验证注解的元素值(日期类型)比当前时间早
@Valid Any non-primitive type(引用类型) 验证关联的对象,如账户对象里有一个订单对象,指定验证订单对象

注:HV ---> Hibernate-Validator

4、分组校验(当我们新增和修改字段时,有可能校验规则是不一样的,那么该如何处理呢?)

(1) 定义分组信息(唯一即可)
package com.ly.valid.group;

/**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 23:10
* @tags 喜欢就去努力的争取
*/
public interface AddGroup {
} package com.ly.valid.group; import jakarta.validation.groups.Default; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 23:10
* @tags 喜欢就去努力的争取
*/
public interface UpdateGroup extends Default {
}
(2) 在分组参数后指定它的groups,需要指定在什么情况下需要进行校验,类型是一个接口数组
package com.ly.valid.entity;

import com.ly.valid.constant.RegularConstant;
import com.ly.valid.group.AddGroup;
import com.ly.valid.group.UpdateGroup;
import jakarta.validation.constraints.*;
import jakarta.validation.groups.Default;
import lombok.Data; import java.time.LocalDate; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-11 21:03
* @tags 喜欢就去努力的争取
*/
@Data
public class Person { @NotBlank(message = "name 姓名不能为空", groups = AddGroup.class)
private String name; @NotNull(message = "age 年龄不能为空", groups = UpdateGroup.class)
@Min(value = 0, message = "年龄不能小于0")
private Integer age; @NotNull(message = "gender 性别不能为空", groups = {AddGroup.class, UpdateGroup.class})
private Integer gender; @NotBlank(message = "email 邮箱不能为空", groups = Default.class)
@Email(regexp = RegularConstant.EMAIL, message = "email 邮箱格式不正确", groups = Default.class)
private String email; @NotBlank(message = "phone 手机号不能为空", groups = UpdateGroup.class)
@Pattern(regexp = RegularConstant.PHONE, message = "phone 手机号格式不正确")
private String phone; @Past(message = "birthday 生日日期有误")
private LocalDate birthday;
}
(3) 然后再我们的controller层参数前加上@Validated(value = {UpdateGroup.class})注解,指定它是哪一组
/**
* 测试添加分组
*
* @param person
* @return
*/
@PostMapping("/testAddGroup")
public R testAddGroup(@Validated(AddGroup.class) Person person) {
return R.success(person);
} /**
* 测试修改分组
*
* @param person
* @return
*/
@PostMapping("/testUpdateGroup")
public R testUpdateGroup(@Validated(UpdateGroup.class) Person person) {
return R.success(person);
} /**
* 测试添加和修改分组
*
* @param person
* @return
*/
@PostMapping("/testAddAndUpdateGroup")
public R testAddAndUpdateGroup(@Validated({UpdateGroup.class, AddGroup.class}) Person person) {
return R.success(person);
} /**
* 测试默认分组
*
* @param person
* @return
*/
@PostMapping("/testDefaultGroup")
public R testDefaultGroup(@Validated(Default.class) Person person) {
return R.success(person);
}
(4) 测试AddGroup

(5) 测试UpdateGroup

注意:细心的同学发现了,为什么email邮箱是Default.class,修改的时候也触发了呢?原因如下图:

(6) 测试AddAndUpdateGroup

(7) 测试DefaultGroup

注意:默认没有指定分组的情况下@NotBlank,在分组校验的情况下@Validated(value = {AddGroup.class})不生效

5、自定义校验规则

例如:现在我有一个字段gender它的取值就三种0:保密 1:男 2:女,像这种有限个数的枚举值我们该如何去限制呢?这就要使用到的自定义校验注解

(1) 自定义校验注解
package com.ly.valid.anno;

import jakarta.validation.Constraint;
import jakarta.validation.Payload; import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target; import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME; /**
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-12 0:27
* @tags 喜欢就去努力的争取
*/
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EnumValueValidator.class})
public @interface EnumValue { // 默认错误消息
String message() default "{my.enum-value.err.msg}";
// String message() default ENUM_VALUE_MESSAGE; String[] strValues() default {}; int[] intValues() default {}; // 分组
Class<?>[] groups() default {}; // 负载,可以增加自定义校验逻辑
Class<? extends Payload>[] payload() default {}; // 指定多个时使用
@Target({FIELD, METHOD, PARAMETER, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
@interface List {
EnumValue[] value();
}
}
(2) 自定义校验器
package com.ly.valid.anno;

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext; import java.util.Arrays;
import java.util.HashSet;
import java.util.Set; /**
* 枚举值校验注解处理类
*
* @author ly (个人博客:https://www.cnblogs.com/ybbit)
* @date 2023-12-12 0:34
* @tags 喜欢就去努力的争取
*/
public class EnumValueValidator implements ConstraintValidator<EnumValue, Object> { /**
* 字符串
*/
private final Set<String> strValueSet = new HashSet<>(); /**
* 数值
*/
private final Set<Integer> intValueSet = new HashSet<>(); @Override
public void initialize(EnumValue constraintAnnotation) {
strValueSet.addAll(Arrays.asList(constraintAnnotation.strValues()));
for (int i : constraintAnnotation.intValues()) {
intValueSet.add(i);
}
} @Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
if (value instanceof Integer) {
// 整数值类型
return intValueSet.contains(value);
} else if (value instanceof String) {
// 字符串类型
return strValueSet.contains(value);
}
return false;
}
}
(3) 关联自定义的校验器和自定义的校验注解

注意:这里的ValidationMessages.properties是数据校验国际化配置文件;名字必须是这个

my.enum-value.err.msg=性别字段值只能为0、1、2

@EnumValue(intValues = {0, 1, 2}, groups = AddGroup.class)
@NotNull(message = "gender 性别不能为空", groups = {AddGroup.class, UpdateGroup.class})
private Integer gender;

(4) 测试一下

6、paload() 负载的用法

// TODO 未完待续

SpringBoot-Validate优雅的实现参数校验,详细示例~的更多相关文章

  1. SpringBoot Validation优雅的全局参数校验

    前言 我们都知道在平时写controller时候,都需要对请求参数进行后端校验,一般我们可能会这样写 public String add(UserVO userVO) { if(userVO.getA ...

  2. SpringBoot实现通用的接口参数校验

    本文介绍基于Spring Boot和JDK8编写一个AOP,结合自定义注解实现通用的接口参数校验. 缘由 目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例 ...

  3. 如何优雅的做参数校验-JSR330

    前言: 本文不是讲@Validate.@Valid是如何使用的.区别是什么,想看这些内容的请换篇文章. 背景: 当前端传过来的参数是进行对称性加密.base64加密等处理后过的参数时,在control ...

  4. springboot @valid与@validated的参数校验使用总结

    好久没在这平台写博客了,最近整理了这东西,先给出总结 // @Valid只能用在controller,@Validated可以用在其他被spring管理的类上 // @Valid可以加在成员变量上(本 ...

  5. Springboot+MyBatis+mysql+jsp页面跳转详细示例

           SpringBoot与MyBatis搭建环境,底层数据库为mysql,页面使用JSP(官网上不推荐使用jsp),完成从数据库中查询出数据,在jsp页面中显示,并且实现页面的跳转功能. 项 ...

  6. SpringBoot 参数校验的方法

    Introduction 有参数传递的地方都少不了参数校验.在web开发中,前端的参数校验是为了用户体验,后端的参数校验是为了安全.试想一下,如果在controller层中没有经过任何校验的参数通过s ...

  7. spring-boot 使用hibernate validation对参数进行优雅的校验

    springboot天生支持使用hibernate validation对参数的优雅校验,如果不使用它,只能对参数挨个进行如下方式的手工校验,不仅难看,使用起来还很不方便: if(StringUtil ...

  8. SpringBoot接口 - 如何优雅的对参数进行校验?

    在以SpringBoot开发Restful接口时, 对于接口的查询参数后台也是要进行校验的,同时还需要给出校验的返回信息放到上文我们统一封装的结构中.那么如何优雅的进行参数的统一校验呢? @pdai ...

  9. 一起来学SpringBoot(十七)优雅的参数校验

    参数校验在开发中经常需要写一些字段校验的代码,比如字段非空,字段长度限制,邮箱格式验证等等,写这些与业务逻辑关系不大的代码个人感觉有两个麻烦: 验证代码繁琐,重复劳动方法内代码显得冗长每次要看哪些参数 ...

  10. springboot 接口参数校验

    前言 在开发接口的时候,参数校验是必不可少的.参数的类型,长度等规则,在开发初期都应该由产品经理或者技术负责人等来约定.如果不对入参做校验,很有可能会因为一些不合法的参数而导致系统出现异常. 上一篇文 ...

随机推荐

  1. 《CTFshow-Web入门》08. Web 71~80

    @ 目录 web71 题解 原理 web72 题解 原理 web73 题解 web74 题解 web75 题解 原理 web76 题解 web77 题解 原理 web78 题解 原理 web79 题解 ...

  2. QA|不同模块之间的引用(导入问题)问题;|Pycharm

    结构如图,在xxu的test.py中想要导入t2包中的sayhello和word两个方法 注意:首先需要打开xxu和t2的上层目录,因为解释器是从打开的那个文件开始查找的,所以这里应该打开B01_01 ...

  3. Maven关联本地已有仓库的方法

    1. 将本地仓库目录localwarehouse进行压缩为localwarehouse.rar. 2. 将localwarehouse.rar解压到D:\maven文件夹中,然后在setting.xm ...

  4. DevSecOps之应用安全测试工具及选型

    上篇文章,有同学私信想了解有哪些DevSecOps工具,这里整理出来,供大家参考(PS: 非专业安全人士,仅从DevOps建设角度,给出自己见解) 软件中的漏洞和弱点很常见:84%的软件漏洞都是利用应 ...

  5. KRPano JS 场景编辑器源码

    KRPano JS编辑器,可以运行在Node环境中. 源码地址:https://github.com/xxweimei/krpano-editor-js 或者下载zip包:http://pan.bai ...

  6. JDK8升级JDK11最全实践干货来了

    1.前言 截至目前(2023年),Java8发布至今已有9年,2018年9月25日,Oracle发布了Java11,这是Java8之后的首个LTS版本.那么从JDK8到JDK11,到底带来了哪些特性呢 ...

  7. 一个颜值功能双在线的Zookeeper可视化工具

    大家好,我是 Java陈序员,今天给大家介绍一个颜值功能双在线的 Zookeeper 可视化工具. 项目介绍 PrettyZoo 是一个基于 Apache Curator 和 JavaFX 实现的 Z ...

  8. 解决Dependency 'fastdfs-client-java’not found

    如何能把 fastdfs的jar包安装到本地的仓库中(因为中央仓库没有FASTDFS的jar包地址) 1.首先去github上下载下来fastdfs的压缩包 下载链接 然后直接解压出来 2.使用cmd ...

  9. 【Cucumber】关于BDD自然语言自动化测试的语法总结

    1.关键字 - Feature 每一个.feature文件必须以关键字Feature开始,Feature关键字之后可以添加该feature的描述,其作用类似于注释,仅仅为了便于理解沟通交流,描述内容中 ...

  10. LLM探索:为ChatGLM2的gRPC后端增加连续对话功能

    前言 之前我做 AIHub 的时候通过 gRPC 的方式接入了 ChatGLM 等开源大模型,对于大模型这块我搞了个 StarAI 框架,相当于简化版的 langchain ,可以比较方便的把各种大模 ...