SpringBoot - Bean validation 参数校验
前言
后台开发中对参数的校验是不可缺少的一个环节,为了解决如何优雅的对参数进行校验?
- JSR303(Java Specification Requests)应运而生,JSR303 是JavaBean参数校验的标准。
- Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。
- Hibernate validator 5 是 Bean Validation 1.1的实现。
常见注解
- Bean Validation中定义的注解:
注解 | 详细信息 |
---|---|
@Null | 被注释的元素必须为 null |
@NotNull | 被注释的元素必须不为 null |
@AssertTrue | 被注释的元素必须为 true |
@AssertFalse | 被注释的元素必须为 false |
@Min(value) | 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 |
@Max(value) | 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 |
@DecimalMin(value) | 被注释的元素必须是一个数字,其值必须大于等于指定的最小值 |
@DecimalMax(value) | 被注释的元素必须是一个数字,其值必须小于等于指定的最大值 |
@Size(max, min) | 被注释的元素的大小必须在指定的范围内 |
@Digits (integer, fraction) | 被注释的元素必须是一个数字,其值必须在可接受的范围内 |
@Past | 被注释的元素必须是一个过去的日期 |
@Future | 被注释的元素必须是一个将来的日期 |
@Pattern(value) | 被注释的元素必须符合指定的正则表达式 |
- Hibernate validator 在JSR303的基础上对校验注解进行了扩展,扩展注解如下:
注解 | 详细信息 |
---|---|
被注释的元素必须是电子邮箱地址 | |
@Length | 被注释的字符串的大小必须在指定的范围内 |
@NotEmpty | 被注释的字符串的必须非空 |
@Range | 被注释的元素必须在合适的范围内 |
参数校验的应用
依赖
<!-- hibernate validator-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.4.Final</version>
</dependency>
简单的参数校验示例
- 要想开启参数校验,需要在类上标注@Validated注解
- 控制器
@PostMapping(value = "/test")
public ValidOneEvt param(@RequestBody @Validated ValidOneEvt evt){
return evt;
}
- 实体验证
@Getter
@Builder
public class ValidOneEvt {
@NotEmpty(message = "名称不能为空")
private String name;
private String sex;
}
- 测试结果
级联校验
- 级联校验需要在校验的实体上添加@Valid。
- 控制器
@PostMapping(value = "/test")
public ValidOneEvt param(@RequestBody @Validated ValidOneEvt evt){
return evt;
}
- 实体验证
@Getter
@Builder
public class ValidOneEvt {
@NotEmpty(message = "名称不能为空")
private String name;
private String sex;
@Valid
private ValidTwoEvt validTwoEvt;
}
- 级联实体
@Getter
@Setter
public class ValidTwoEvt {
@Length(min = 2)
private String name;
}
- 请求示例
- 校验结果
@Validated 与 @Valid
两者具有相似性
注解地方
- @Valid:可以用在方法、构造函数、方法参数和成员属性(字段)上。
- @Validated:可以用在类型、方法和方法参数上,不能用在成员属性(字段)上。
@Validated和@Valid在级联验证功能上的区别
@Valid:用在方法入参上无法单独提供级联验证功能。能够用在成员属性(字段)上,提示验证框架进行级联验证。
@Validated:用在方法入参上无法单独提供级联验证功能。不能用在成员属性(字段)上,也无法提示框架进行级联验证。能配合级联验证注解@Valid进行级联验证。
总结: 通常使用@Validated, 级联验证使用@Valid。
自定义校验注解
自定义校验注解用于基础校验注解不能满足业务需求。
- 自定义效验注解验证密码是否相等
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
/**
* @Description 自定义参数校验注解
* @Documented 注解中的注释加入文档
* @Retention 注解保留阶段 RetentionPolicy.RUNTIME 运行阶段
* @Target 作用目标,注解的使用范围 TYPE:用于描述类、接口(包括注解类型) 或enum声明
* @Constraint 将注解和注解关联类关联到一起
* @author coisini
* @date Aug 10, 2021
* @Version 1.0
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Constraint(validatedBy = PasswordValidator.class)
public @interface PasswordEquals {
int min() default 4;
int max() default 6;
String message() default "passwords are not equal";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
- 自定义校验注解关联类
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
/**
* @Description 自定义校验注解关联类
* ConstraintValidator的第一个参数:注解的类型
* ConstraintValidator的第二个参数:自定义注解修饰的目标的类型
* @author coisini
* @date Aug 10, 2021
* @Version 1.0
*/
public class PasswordValidator implements ConstraintValidator<PasswordEquals, ValidEvt> {
private int min;
private int max;
/**
* 初始化获取注解参数
* @param constraintAnnotation
*/
@Override
public void initialize(PasswordEquals constraintAnnotation) {
this.min = constraintAnnotation.min();
this.max = constraintAnnotation.max();
}
/**
* 校验参数
* @param value
* @param context
* @return
*/
@Override
public boolean isValid(ValidEvt value, ConstraintValidatorContext context) {
String password1 = value.getPassword1();
String password2 = value.getPassword2();
return password1.equals(password2) && this.validLength(password1, password2);
}
/**
* 校验密码长度
* @param password1
* @param password2
* @return
*/
private boolean validLength(String password1, String password2) {
return password1.length() > min && password1.length() < max
&& password2.length() > min && password2.length() < max;
}
}
- 自定义注解校验类
/**
* @Description 自定义注解校验类
* @author coisini
* @date Aug 10, 2021
* @Version 1.0
*/
@Getter
@Builder
@PasswordEquals(min = 1, message = "Incorrect password length or passwords are not equal")
public class ValidEvt {
private String password1;
private String password2;
}
- 参数验证异常统一处理
@ControllerAdvice
public class GlobalExceptionAdvice {
/**
* 参数校验异常处理器
* @return
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public UnifyMessage handleBeanValidation(HttpServletRequest request, MethodArgumentNotValidException e) {
String method = request.getMethod();
String requestUrl = request.getRequestURI();
System.out.println(e);
List<ObjectError> errors = e.getBindingResult().getAllErrors();
String message = formatAllErrorMessages(errors);
return new UnifyMessage(10001, message,method + " " + requestUrl);
}
/**
* 自定义注解校验异常处理器
* @param req
* @param e
* @return
*/
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public UnifyMessage handleConstrainException(HttpServletRequest req, ConstraintViolationException e){
String method = req.getMethod();
String requestUrl = req.getRequestURI();
String message = e.getMessage();
return new UnifyMessage(10001, message,method + " " + requestUrl);
}
/**
* 异常消息拼接
* @param errors
* @return
*/
private String formatAllErrorMessages(List<ObjectError> errors){
StringBuffer errorMsg = new StringBuffer();
errors.forEach(error ->
errorMsg.append(error.getDefaultMessage()).append(";")
);
return errorMsg.toString();
}
}
- 统一消息返回
/**
* @Description 统一消息返回
* @author coisini
* @date Aug 9, 2021
* @Version 1.0
*/
public class UnifyMessage {
private int code;
private String message;
private String requestUrl;
public int getCode() {
return code;
}
public String getMessage() {
return message;
}
public String getRequestUrl() {
return requestUrl;
}
public UnifyMessage(int code, String message, String requestUrl) {
this.code = code;
this.message = message;
this.requestUrl = requestUrl;
}
}
- 测试类
@PostMapping(value = "/test1")
public ValidEvt test1(@RequestBody @Validated ValidEvt evt){
return evt;
}
- 测试结果
- End -
﹀
﹀
﹀
梦想是咸鱼
关注一下吧

SpringBoot - Bean validation 参数校验的更多相关文章
- 测试开发专题:如何在spring-boot中进行参数校验
上文我们讨论了spring-boot如何去获取前端传递过来的参数,那传递过来总不能直接使用,需要对这些参数进行校验,符合程序的要求才会进行下一步的处理,所以本篇文章我们主要讨论spring-boot中 ...
- 1. 不吹不擂,第一篇就能提升你对Bean Validation数据校验的认知
乔丹是我听过的篮球之神,科比是我亲眼见过的篮球之神.本文已被 https://www.yourbatman.cn 收录,里面一并有Spring技术栈.MyBatis.JVM.中间件等小而美的专栏供以免 ...
- SpringBoot 如何进行参数校验,老鸟们都这么玩的!
大家好,我是飘渺. 前几天写了一篇 SpringBoot如何统一后端返回格式?老鸟们都是这样玩的! 阅读效果还不错,而且被很多号主都转载过,今天我们继续第二篇,来聊聊在SprinBoot中如何集成参数 ...
- SpringBoot 如何进行参数校验
为什么需要参数校验 在日常的接口开发中,为了防止非法参数对业务造成影响,经常需要对接口的参数进行校验,例如登录的时候需要校验用户名和密码是否为空,添加用户的时候校验用户邮箱地址.手机号码格式是否正确. ...
- springboot项目--传入参数校验-----SpringBoot开发详解(五)--Controller接收参数以及参数校验----https://blog.csdn.net/qq_31001665/article/details/71075743
https://blog.csdn.net/qq_31001665/article/details/71075743 springboot项目--传入参数校验-----SpringBoot开发详解(五 ...
- SpringBoot Validation参数校验 详解自定义注解规则和分组校验
前言 Hibernate Validator 是 Bean Validation 的参考实现 .Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的 ...
- 【全网最全】springboot整合JSR303参数校验与全局异常处理
一.前言 我们在日常开发中,避不开的就是参数校验,有人说前端不是会在表单中进行校验的吗?在后端中,我们可以直接不管前端怎么样判断过滤,我们后端都需要进行再次判断,为了安全.因为前端很容易拜托,当测试使 ...
- java bean validation 参数验证
一.前言 二.几种解决方案 三.使用bean validation 自带的注解验证 四.自定义bean validation 注解验证 一.前言 在后台开发过程中,对参数的校验成为开发环境不可缺少的一 ...
- javax.validation参数校验
在实体字段加注解: /** * 机构名称 */ @ApiParam(name = "orgName", value = "机构名称") @Size(max = ...
随机推荐
- Nexus3搭建Docker等私服
0.目的 docker私有仓库的搭建,方便后期的CI/CD dotnetcore项目sdk本地缓存,解决微软官方下载缓慢的问题 nuget私有仓库 等 1.环境情况 windows10 Docker ...
- 第6章:深入理解Pod对象
Pod是最小的部署单元,也是后面经常配置的地方,本章节带你熟悉Pod中常见资源配置及参数. 也就是YAML这部分: ... template: metadata: labels: app: web s ...
- 自定义组件开发:使用v-model封装el-pagination组件
1.前言 通过封装el-pagination组件开发自定义分页组件的类似文章网上已经有很多了,但看了一圈,总是不如意,于是决定还是自己动手搞一个. 2.背景 2.1.常规分页处理方法 利用el-pag ...
- Redis和Memcached到底有什么区别?
前言 我们都知道,Redis和Memcached都是内存数据库,它们的访问速度非常之快.但我们在开发过程中,这两个内存数据库,我们到底要如何选择呢?它们的优劣都有哪些?为什么现在看Redis要比Mem ...
- 不同版本docker修改存储位置补充
前言:最近发现yum安装docker,安装的版本不一样,有点蛇皮,虽然存放默认位置都是/var/lib/docker,但是它的配置文件不一样,这里做个补充 对于docker版本是1.13及以下 操作如 ...
- 每日单词 —— cut to the chase
cut to the chase: 词面意思--切奶酪 是美国俚语--开门见山:直奔主题 看一看相关的例句或者电影读白吧! 1. - 嫌疑人:Shall we cut to the chase ? 侦 ...
- Codeforces Round #139 (Div. 2) 题解
vp上古场次ing CF225A Dice Tower 1.题目简述: 有 \(n\) 个骰子被叠在了一起.对于每个骰子上的一个数,与它对面的数的和始终为 \(7\) . 你是小明,你只能从正面看这个 ...
- Codeforces Round#687 Div2 题解
打这场的时候迷迷糊糊的,然后掉分了( A Prison Break: 题面很复杂,但是题意很简单,仅需求出从这个点到四个角的最大的曼哈顿距离即可 #include <bits/stdc++.h& ...
- python encode decode
Python encode()encode() 方法以 encoding 指定的编码格式编码字符串.errors参数可以指定不同的错误处理方案.写法:str.encode(encoding='UTF- ...
- [刘阳Java]_Spring AOP注解详细介绍_第8讲
这节内容非常关键,我们会比较详细地介绍Spring AOP注解的使用 1. 要使用Spring AOP注解,必须满足如下的事项 导入Aspectj的jar.Spring3.0-AOP.jar.aopa ...