springcloud工作笔记094---springcloud项目后端验证_hibernate validator后端校验字段_介绍了解
技术交流QQ群【JAVA,C++,Python,.NET,BigData,AI】：170933152
springboot使用hibernate validator校验
目录
- 一、参数校验
- 二、hibernate validator校验demo
- 三、hibernate的校验模式
- 1、普通模式（默认是这个模式）
- 2、快速失败返回模式
- 四、hibernate的两种校验
- 1、请求参数校验
- 2、GET参数校验(@RequestParam参数校验)
- a.此时需要使用MethodValidationPostProcessor 的Bean：
- b.方法所在的Controller上加注解@Validated
- c.返回验证信息提示
- d.验证
- 3、model校验
- 4、对象级联校验
- 5、分组校验
- a、分组
- b、组序列
- 五、自定义验证器
- 六、常见的注解
- 七、参考资料
返回目录
一、参数校验
在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等，写这些与业务逻辑关系不大的代码个人感觉有两个麻烦：
- 验证代码繁琐，重复劳动
- 方法内代码显得冗长
- 每次要看哪些参数验证是否完整，需要去翻阅验证逻辑代码
hibernate validator（官方文档）提供了一套比较完善、便捷的验证实现方式。
spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖。
返回目录
二、hibernate validator校验demo
先来看一个简单的demo，添加了Validator的注解：
import org.hibernate.validator.constraints.NotBlank;import javax.validation.constraints.AssertFalse; import javax.validation.constraints.Pattern;
@Getter
@Setter
@NoArgsConstructor
public class DemoModel {@NotBlank(message="用户名不能为空")private String userName;@NotBlank(message="年龄不能为空")@Pattern(regexp="^[0-9]{1,2}$",message="年龄不正确")private String age;@AssertFalse(message = "必须为false")private Boolean isFalse;/*** 如果是空，则不校验，如果不为空，则校验*/@Pattern(regexp="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",message="出生日期格式不正确")private String birthday;
}
POST接口验证，BindingResult是验证不通过的结果集合：
@RequestMapping("/demo2")public void demo2(@RequestBody @Valid DemoModel demo, BindingResult result){if(result.hasErrors()){for (ObjectError error : result.getAllErrors()) {System.out.println(error.getDefaultMessage());}}}
POST请求传入的参数：{"userName":"dd","age":120,"isFalse":true,"birthday":"21010-21-12"}
输出结果：
出生日期格式不正确
必须为false
年龄不正确
参数验证非常方便，字段上注解+验证不通过提示信息即可代替手写一大堆的非空和字段限制验证代码。下面深入了解下参数校验的玩法。
本文地址：http://www.cnblogs.com/mr-yang-localhost/p/7812038.html
返回目录
三、hibernate的校验模式
细心的读者肯定发现了：上面例子中一次性返回了所有验证不通过的集合，通常按顺序验证到第一个字段不符合验证要求时，就可以直接拒绝请求了。Hibernate Validator有以下两种验证模式：
返回目录
1、普通模式（默认是这个模式）
普通模式(会校验完所有的属性，然后返回所有的验证失败信息)
返回目录
2、快速失败返回模式
快速失败返回模式(只要有一个验证失败，则返回)
两种验证模式配置方式：（参考官方文档）
failFast：true 快速失败返回模式 false 普通模式
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().failFast( true ).buildValidatorFactory(); Validator validator = validatorFactory.getValidator();
和 （hibernate.validator.fail_fast：true 快速失败返回模式 false 普通模式）
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory(); Validator validator = validatorFactory.getValidator();
返回目录
四、hibernate的两种校验
配置hibernate Validator为快速失败返回模式：
@Configuration
public class ValidatorConfiguration {@Beanpublic Validator validator(){ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory();Validator validator = validatorFactory.getValidator();return validator;}
}
返回目录
1、请求参数校验
如demo里示例的，验证请求参数时，在@RequestBody DemoModel demo之间加注解 @Valid，然后后面加BindindResult即可；多个参数的，可以加多个@Valid和BindingResult，如：
public void test()(@RequestBody @Valid DemoModel demo, BindingResult result)
public void test()(@RequestBody @Valid DemoModel demo, BindingResult result,@RequestBody @Valid DemoModel demo2, BindingResult result2)
@RequestMapping("/demo2")public void demo2(@RequestBody @Valid DemoModel demo, BindingResult result){if(result.hasErrors()){for (ObjectError error : result.getAllErrors()) {System.out.println(error.getDefaultMessage());}}}
返回目录
2、GET参数校验(@RequestParam参数校验)
使用校验bean的方式，没有办法校验RequestParam的内容，一般在处理Get请求(或参数比较少)的时候，会使用下面这样的代码：
@RequestMapping(value = "/demo3", method = RequestMethod.GET)public void demo3(@RequestParam(name = "grade", required = true) int grade,@RequestParam(name = "classroom", required = true) int classroom) {System.out.println(grade + "," + classroom);}
使用@Valid注解，对RequestParam对应的参数进行注解，是无效的，需要使用@Validated注解来使得验证生效。如下所示：
返回目录
a.此时需要使用MethodValidationPostProcessor 的Bean：
@Beanpublic MethodValidationPostProcessor methodValidationPostProcessor() {/**默认是普通模式，会返回所有的验证不通过信息集合*/return new MethodValidationPostProcessor();}
或 可对MethodValidationPostProcessor 进行设置Validator（因为此时不是用的Validator进行验证，Validator的配置不起作用）
@Beanpublic MethodValidationPostProcessor methodValidationPostProcessor() {MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();/**设置validator模式为快速失败返回*/postProcessor.setValidator(validator());return postProcessor;}@Beanpublic Validator validator(){ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory();Validator validator = validatorFactory.getValidator();return validator;}
返回目录
b.方法所在的Controller上加注解@Validated
@RequestMapping("/validation")
@RestController
@Validated
public class ValidationController {/**如果只有少数对象，直接把参数写到Controller层，然后在Controller层进行验证就可以了。*/@RequestMapping(value = "/demo3", method = RequestMethod.GET)public void demo3(@Range(min = 1, max = 9, message = "年级只能从1-9")@RequestParam(name = "grade", required = true)int grade,@Min(value = 1, message = "班级最小只能1")@Max(value = 99, message = "班级最大只能99")@RequestParam(name = "classroom", required = true)int classroom) {System.out.println(grade + "," + classroom);}
}
返回目录
c.返回验证信息提示
可以看到：验证不通过时，抛出了ConstraintViolationException异常，使用同一捕获异常处理：
@ControllerAdvice
@Component
public class GlobalExceptionHandler {@ExceptionHandler@ResponseBody@ResponseStatus(HttpStatus.BAD_REQUEST)public String handle(ValidationException exception) {if(exception instanceof ConstraintViolationException){ConstraintViolationException exs = (ConstraintViolationException) exception;Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();for (ConstraintViolation<?> item : violations) {/**打印验证不通过的信息*/System.out.println(item.getMessage());}}return "bad request, " ;}
}
返回目录
d.验证
浏览器服务请求地址：http://localhost:8080/validation/demo3?grade=18&classroom=888
没有配置快速失败返回的MethodValidationPostProcessor 时输出信息如下：
年级只能从1-9班级最大只能99
配置了快速失败返回的MethodValidationPostProcessor 时输出信息如下：
年级只能从1-9
浏览器服务请求地址：http://localhost:8080/validation/demo3?grade=0&classroom=0
没有配置快速失败返回的MethodValidationPostProcessor 时输出信息如下：
年级只能从1-9 班级最小只能1
配置了快速失败返回的MethodValidationPostProcessor 时输出信息如下：
年级只能从1-9
返回目录
3、model校验
待校验的model：
@Data
public class Demo2 {@Length(min = 5, max = 17, message = "length长度在[5,17]之间")private String length;/**@Size不能验证Integer，适用于String, Collection, Map and arrays*/@Size(min = 1, max = 3, message = "size在[1,3]之间")private String age;@Range(min = 150, max = 250, message = "range在[150,250]之间")private int high;@Size(min = 3,max = 5,message = "list的Size在[3,5]")private List<String> list;
}
验证model，以下全部验证通过：
@Autowiredprivate Validator validator;@RequestMapping("/demo3")public void demo3(){Demo2 demo2 = new Demo2();demo2.setAge("111");demo2.setHigh(150);demo2.setLength("ABCDE");demo2.setList(new ArrayList<String>(){{add("111");add("222");add("333");}});Set<ConstraintViolation<Demo2>> violationSet = validator.validate(demo2);for (ConstraintViolation<Demo2> model : violationSet) {System.out.println(model.getMessage());}}
返回目录
4、对象级联校验
对象内部包含另一个对象作为属性，属性上加@Valid，可以验证作为属性的对象内部的验证：（验证Demo2示例时，可以验证Demo2的字段）
@Data
public class Demo2 {@Size(min = 3,max = 5,message = "list的Size在[3,5]")private List<String> list;@NotNull@Validprivate Demo3 demo3;
}@Data
public class Demo3 {@Length(min = 5, max = 17, message = "length长度在[5,17]之间")private String extField;
}
级联校验：
/**前面配置了快速失败返回的Bean*/@Autowiredprivate Validator validator;@RequestMapping("/demo3")public void demo3(){Demo2 demo2 = new Demo2();demo2.setList(new ArrayList<String>(){{add("111");add("222");add("333");}});Demo3 demo3 = new Demo3();demo3.setExtField("22");demo2.setDemo3(demo3);Set<ConstraintViolation<Demo2>> violationSet = validator.validate(demo2);for (ConstraintViolation<Demo2> model : violationSet) {System.out.println(model.getMessage());}}
可以校验Demo3的extField字段。
返回目录
5、分组校验
结论：分组顺序校验时，按指定的分组先后顺序进行验证，前面的验证不通过，后面的分组就不行验证。
有这样一种场景，新增用户信息的时候，不需要验证userId（因为系统生成）；修改的时候需要验证userId，这时候可用用户到validator的分组验证功能。
设置validator为普通验证模式（"hibernate.validator.fail_fast", "false"），用到的验证GroupA、GroupB和model：
GroupA、GroupB：
public interface GroupA {
}public interface GroupB {
}
验证model：Person
@Data
public class Person {@NotBlank@Range(min = 1,max = Integer.MAX_VALUE,message = "必须大于0",groups = {GroupA.class})/**用户id*/private Integer userId;@NotBlank@Length(min = 4,max = 20,message = "必须在[4,20]",groups = {GroupB.class})/**用户名*/private String userName;@NotBlank@Range(min = 0,max = 100,message = "年龄必须在[0,100]",groups={Default.class})/**年龄*/private Integer age;@Range(min = 0,max = 2,message = "性别必须在[0,2]",groups = {GroupB.class})/**性别 0：未知；1：男；2：女*/private Integer sex;
}
如上Person所示，3个分组分别验证字段如下：
- GroupA验证字段userId；
- GroupB验证字段userName、sex；
- Default验证字段age(Default是Validator自带的默认分组)
返回目录
a、分组
只验证GroupA、GroupB标记的分组：
@RequestMapping("/demo5")
public void demo5(){Person p = new Person();/**GroupA验证不通过*/p.setUserId(-12);/**GroupA验证通过*///p.setUserId(12);p.setUserName("a");p.setAge(110);p.setSex(5);Set<ConstraintViolation<Person>> validate = validator.validate(p, GroupA.class, GroupB.class);for (ConstraintViolation<Person> item : validate) {System.out.println(item);}
}
或
@RequestMapping("/demo6")public void demo6(@Validated({GroupA.class, GroupB.class}) Person p, BindingResult result){if(result.hasErrors()){List<ObjectError> allErrors = result.getAllErrors();for (ObjectError error : allErrors) {System.out.println(error);}}}
GroupA、GroupB、Default都验证不通过的情况：
验证信息如下所示：
ConstraintViolationImpl{interpolatedMessage='必须在[4,20]', propertyPath=userName, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='必须在[4,20]'}
ConstraintViolationImpl{interpolatedMessage='必须大于0', propertyPath=userId, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='必须大于0'}
ConstraintViolationImpl{interpolatedMessage='性别必须在[0,2]', propertyPath=sex, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='性别必须在[0,2]'}
GroupA验证通过、GroupB、Default验证不通过的情况：
验证信息如下所示：
ConstraintViolationImpl{interpolatedMessage='必须在[4,20]', propertyPath=userName, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='必须在[4,20]'}
ConstraintViolationImpl{interpolatedMessage='性别必须在[0,2]', propertyPath=sex, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='性别必须在[0,2]'}
返回目录
b、组序列
除了按组指定是否验证之外，还可以指定组的验证顺序，前面组验证不通过的，后面组不进行验证：
指定组的序列（GroupA》GroupB》Default）：
@GroupSequence({GroupA.class, GroupB.class, Default.class})
public interface GroupOrder {
}
测试demo：
@RequestMapping("/demo7")public void demo7(){Person p = new Person();/**GroupA验证不通过*///p.setUserId(-12);/**GroupA验证通过*/p.setUserId(12);p.setUserName("a");p.setAge(110);p.setSex(5);Set<ConstraintViolation<Person>> validate = validator.validate(p, GroupOrder.class);for (ConstraintViolation<Person> item : validate) {System.out.println(item);}}
或
@RequestMapping("/demo8")public void demo8(@Validated({GroupOrder.class}) Person p, BindingResult result){if(result.hasErrors()){List<ObjectError> allErrors = result.getAllErrors();for (ObjectError error : allErrors) {System.out.println(error);}}}
GroupA、GroupB、Default都验证不通过的情况：
验证信息如下所示：
ConstraintViolationImpl{interpolatedMessage='必须大于0', propertyPath=userId, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='必须大于0'}
GroupA验证通过、GroupB、Default验证不通过的情况：
验证信息如下所示：
ConstraintViolationImpl{interpolatedMessage='必须在[4,20]', propertyPath=userName, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='必须在[4,20]'}
ConstraintViolationImpl{interpolatedMessage='性别必须在[0,2]', propertyPath=sex, rootBeanClass=class validator.demo.project.model.Person, messageTemplate='性别必须在[0,2]'}
结论：分组顺序校验时，按指定的分组先后顺序进行验证，前面的验证不通过，后面的分组就不行验证。
返回目录
五、自定义验证器
一般情况，自定义验证可以解决很多问题。但也有无法满足情况的时候，此时，我们可以实现validator的接口，自定义自己需要的验证器。
如下所示，实现了一个自定义的大小写验证器：
public enum CaseMode {UPPER,LOWER;
}@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {String message() default "";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};CaseMode value();
}public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {private CaseMode caseMode;public void initialize(CheckCase checkCase) {this.caseMode = checkCase.value();}public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {if (s == null) {return true;}if (caseMode == CaseMode.UPPER) {return s.equals(s.toUpperCase());} else {return s.equals(s.toLowerCase());}}
}
要验证的Model：
public class Demo{@CheckCase(value = CaseMode.LOWER,message = "userName必须是小写")private String userName;public String getUserName() {return userName;}public void setUserName(String userName) {this.userName = userName;}}
validator配置：
@Beanpublic Validator validator(){ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ).configure().addProperty( "hibernate.validator.fail_fast", "true" ).buildValidatorFactory();Validator validator = validatorFactory.getValidator();return validator;}
验证测试：
@RequestMapping("/demo4")public void demo4(){Demo demo = new Demo();demo.setUserName("userName");Set<ConstraintViolation<Demo>> validate = validator.validate(demo);for (ConstraintViolation<Demo> dem : validate) {System.out.println(dem.getMessage());}}
输出结果：
userName必须是小写
返回目录
六、常见的注解
Bean Validation 中内置的 constraint
@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(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator 附加的 constraint
@NotBlank(message =) 验证字符串非null，且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
//大于0.01，不包含0.01 @NotNull @DecimalMin(value = "0.01", inclusive = false) private Integer greaterThan;//大于等于0.01 @NotNull @DecimalMin(value = "0.01", inclusive = true) private BigDecimal greatOrEqualThan;@Length(min = 1, max = 20, message = "message不能为空") //不能将Length错用成Range //@Range(min = 1, max = 20, message = "message不能为空") private String message;
返回目录
七、参考资料
参考资料：
http://docs.jboss.org/hibernate/validator/4.2/reference/zh-CN/html_single/#validator-gettingstarted
springcloud工作笔记094---springcloud项目后端验证_hibernate validator后端校验字段_介绍了解相关推荐
- springcloud工作笔记095---springcloud项目后端验证_hibernate validator后端校验字段_自己实现_快速开发
1. 在开发中经常需要写一些字段校验的代码,比如字段非空,字段长度限制,邮箱格式验证等等,写这些与业务逻辑关系不大的代码个人感觉有两个麻烦: 验证代码繁琐,重复劳动 方法内代码显得冗长 每次要看哪些参 ...
- springcloud工作笔记098---springcloud多项目包扫描问题
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 多个项目的时候,比如: cn.gov.credream.scgateway cn.gov.cred ...
- SpringCloud工作笔记103---Mybatis-plus使用注解 @TableField(exist = false) 注明非数据库字段属性
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 Mybatis-plus 这个mybatis包,可以使用,挺不错. TableField(exis ...
- springcloud工作笔记101---强大的代码自动提示工具_aiXcoder智能编程_以及开源java工具大全_提升开发效率
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 软件开发进入AI时代了,你有自己的「AI编程同伴」了吗? 凭我的「aiXcoder智能编程助手」专 ...
- SpringCloud工作笔记054---事物处理_MySQL的四种事务隔离级别_以及修改Mysql默认隔离级别
JAVA技术交流QQ群:170933152 Mysql修改默认隔离级别: MySQL mysql默认的事务处理级别是'REPEATABLE-READ',也就是可重复读 1.查看当前会话隔离级别 sel ...
- 《SpringCloud》笔记二：项目导入
所有课程的学习及相关资料都是源自b站黑马程序员 感谢黑马程序员给予我们新手的无私帮助,感谢!!! 黑马程序员-----yyds 开始之前一定要先在IDEA的插件商店里面下载lombok插件!!!! 文 ...
- SpringCloud工作笔记0104---SpringCloud和SpringCloudAlibaba的区别
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 Spring Cloud Alibaba是Spring cloud的子项目,符合SpringClo ...
- SpringCloud工作笔记085---SpringBoot项目中防止跨站脚本攻击功能添加
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 一:什么是XSS XSS攻击全称跨站脚本攻击,是一种在web应用中的计算机安全漏洞,它允许恶意we ...
- SpringCloud工作笔记083---Idea中启动多个项目的时候_内存调整_节省内存
技术交流QQ群[JAVA,C++,Python,.NET,BigData,AI]:170933152 如果你跟我们一样一下子启动10几个项目,那内存10几个G就没了, 可以这样调整 项目采用 spri ...
最新文章
- Nat. Biotech.|药物设计的AI生成模型
- 初识50个Linux命令
- c语言数码管连续加一,各位大神，如何用C语言实现在数码管上实现1234同时亮
- 谈谈如何利用 valgrind 排查内存错误
- 电脑护眼设置：蓝色光波过滤
- CodeForces:372(div1)div373(div2)
- 【编程训练-考研上机模拟】综合模拟2-2019浙大上机模拟（晴神）
- 实战演练：PostgreSQL在线扩容
- emmc linux 识别分区_linux下给U盘分区并制作文件系统
- 纯CSS实现页签切换效果
- 2. laravel 创建第一条路由
- Python之猜数字游戏
- flash在线拍照并上传
- android 2k 屏幕 字体模糊,2k显示器上的字体模糊
- 背景图片虚化的效果的css样式的实现
- VM虚拟机中 localhost login_虚拟机VM VirtualBox的安装和使用
- 四、子弹类的创建，飞机子弹发射与无用子弹的销毁（雷霆战机）
- Linux之父-林纳斯 配置命令基操
- SQL Server 2008性能故障排查（三）——I/O
- P1455 搭配购买