一、JSR303校验
1.1、概述
JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。
此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。
Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据方便地验证。
为了一统验证框架标准，jsr303规范横空出世了，它定义了一些标准的验证约束，标准毕竟是标准，它不可能定义到所有的验证约束，它只是提供了一些基本的常用的约束，不过它提供了一个可拓展的自定义验证约束。
注:可以使用注解的方式进行验证
1.2、在spring boot使用
gradle引用，hibernate-validator是一个jsr-303的实践
implementation ‘org.springframework.boot:spring-boot-starter-validation‘
compile group: ‘org.hibernate.validator‘, name: ‘hibernate-validator‘, version: ‘6.0.13.Final‘
1.3、JSR 303 基本的校验规则
注意其中大部分注解支持message属性添加描述信息
1.3.1、空检查
@Null 验证对象是否为null@NotNull 验证对象是否不为null, 无法查检长度为0的字符串@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
1.3.2、Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true@AssertFalse 验证 Boolean 对象是否为 false
1.3.3、长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内@Length(min=, max=) Validates that the annotated string is between min and max included.
1.3.4、日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
1.3.5、数值检查
建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null@Min 验证 Number 和 String 对象是否大等于指定的值@Max 验证 Number 和 String 对象是否小等于指定的值@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度@Digits 验证 Number 和 String 的构成是否合法@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。@Range(min=, max=) 被指定的元素必须在合适的范围内@Range(min=10000,max=50000,message=”range.bean.wage”)@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)@CreditCardNumber信用卡验证@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。@ScriptAssert(lang= ,script=, alias=)@URL(protocol=,host=, port=,regexp=, flags=)
1.4、使用示例
增加包引用后，代码中直接使用相关注解即可
package com.github.bjlhx15.gradle.jsr303;import lombok.Data;import javax.validation.constraints.Email;import javax.validation.constraints.NotEmpty;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;@Data ?//lombok 注解public class Order { ???// 必须不为 null, 大小是 10 ???@NotNull(message = "不能为空") ???@Size(min = 10, max = 10) ???private String orderId; ???// 必须不为空 ???@NotEmpty(message = "不能为空") ???private String customer; ???// 必须是一个电子信箱地址 ???@NotNull(message = "邮箱不为空") ???@Email(message = "邮件格式不对") ???private String email; ???// 必须不为空 ???@NotEmpty(message = "不能为空") ???private String address;}比如在Controller用户请求使用@Valid注解即可：
???@RequestMapping("/data") ???public String testDataValid(@Valid Order order){ ???????System.out.println(order); ???????return "resultPage"; ???}1.5、自定义jsr-303校验注解
1.5.1、自定义步骤
• Create a constraint annotation (首先定义一个约束注解)
• Implement a validator(第二步是实现这个验证器)
• Define a default error message(最后添加一条默认的错误消息即可)
注：自定义注解类：message() + groups() + payload() 必须；注解校验器类：继承 ConstraintValidator 类<注解类，注解参数类型> + 两个方法（initialize：初始化操作、isValid：逻辑处理）
1.5.2、自定义注解示例
示例一、身份证长度为15或18位校验
1、定义注解
@Documented@Constraint(validatedBy = { IDConstraintValidator.class })@Target({ElementType.METHOD, ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)public @interface IDValidator { ???//允许为空的属性 ???boolean required() default true; ???//如果校验不通过返回的提示信息 ???String message() default "{id}"; ???Class<?>[] groups() default {}; ???Class<? extends Payload>[] payload() default {};}2、实现验证器
public class IDConstraintValidator implements ConstraintValidator<IDValidator, String> { ???//默认值_false，用于接收注解上自定义的 required ???private boolean required = false; ???//1、初始化方法：通过该方法我们可以拿到我们的注解 ???@Override ???public void initialize(IDValidator idValidator) { ???????//idValidator.required() 接收我们自定义的属性，是否为空 ???????required = idValidator.required(); ???} ???//2、逻辑处理 ???@Override ???public boolean isValid(String id, ConstraintValidatorContext ctx) { ???????//2.1、如果允许为空的话，直接返回结果 ???????if(required){ ???????????int length = id.length(); ???????????if (NumberUtils.isDigits(id) && (length == 15 || length == 18)) { ???????????????return true; ???????????} ???????????return false; ???????}else{ ???????????if(StringUtils.isBlank(id)){ ???????????????return true; ???????????}else{ ???????????????int length = id.length(); ???????????????if (NumberUtils.isDigits(id) && (length == 15 || length == 18)) { ???????????????????return true; ???????????????} ???????????????return false; ???????????} ???????} ???}}3、使用
public class Person { ???@IDValidator(message = "身份证需要15或18位") ???private String id; ???public String getId() { ???????return id; ???} ???public void setId(String id) { ???????this.id = id; ???}}controller使用
???@RequestMapping("/person") ???public String person( ??????????@Valid @RequestBody Person person){ ???????System.out.println(person.toString()); ???????return "resultPage"; ???}返回验证消息。当访问这个接口时，如果参数不符合Model中定义的话，程序中就回抛出400异常，并提示错误信息。
{ ???"timestamp": "2019-01-23T01:29:12.547+0000", ???"status": 400, ???"error": "Bad Request", ???"errors": [ ???????{ ???????????"codes": [ ???????????????"IDValidator.person.ID", ???????????????"IDValidator.ID", ???????????????"IDValidator" ???????????], ???????????"arguments": [ ???????????????{ ???????????????????"codes": [ ???????????????????????"person.ID", ???????????????????????"ID" ???????????????????], ???????????????????"arguments": null, ???????????????????"defaultMessage": "ID", ???????????????????"code": "ID" ???????????????} ???????????], ???????????"defaultMessage": "身份证需要15或18位", ???????????"objectName": "person", ???????????"field": "ID", ???????????"rejectedValue": null, ???????????"bindingFailure": false, ???????????"code": "IDValidator" ???????} ???], ???"message": "Validation failed for object=‘person‘. Error count: 1", ???"path": "/person"}示例二、要验证用户的两次输入密码必须是相同的
参看：https://github.com/bjlhx15/gradle-mvc4/tree/master/demo03-jsr303/
其中指定配置消息：ValidationMessages.properties，也就是全局提示消息，也可以写到注解message处
1.6、分组验证
对同一个Model，我们在增加和修改时对参数的校验也是不一样的，这个时候我们就需要定义分组验证，步骤如下:
1、先定义一个List数组中不能含有null元素的校验注解
package com.github.bjlhx15.gradle.jsr303;/** * @author lihongxu * @desc @link(https://github.com/bjlhx15/gradle-mvc4) * @since 2019/1/23 上午11:07 */import javax.validation.Constraint;import javax.validation.Payload;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.Target;import java.lang.annotation.*;import static java.lang.annotation.ElementType.*;import static java.lang.annotation.ElementType.PARAMETER;import static java.lang.annotation.RetentionPolicy.RUNTIME;/** * 自定义参数校验注解 * 校验 List 集合中是否有null 元素 */@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@Documented@Constraint(validatedBy = ListNotHasNullValidatorImpl.class)////此处指定了注解的实现类为ListNotHasNullValidatorImplpublic @interface ListNotHasNull { ???/** ????* 添加value属性，可以作为校验时的条件,若不需要，可去掉此处定义 ????*/ ???int value() default 0; ???String message() default "List集合中不能含有null元素"; ???Class<?>[] groups() default {}; ???Class<? extends Payload>[] payload() default {}; ???/** ????* 定义List，为了让Bean的一个属性上可以添加多套规则 ????*/ ???@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER}) ???@Retention(RUNTIME) ???@Documented ???@interface List { ???????ListNotHasNull[] value(); ???}}2、List数组中不能含有null元素的校验注解实现
package com.github.bjlhx15.gradle.jsr303;import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import java.util.List;/** * 自定义注解ListNotHasNull 的实现类 * 用于判断List集合中是否含有null元素 */public class ListNotHasNullValidatorImpl implements ConstraintValidator<ListNotHasNull, List> { ???private int value; ???@Override ???public void initialize(ListNotHasNull constraintAnnotation) { ???????//传入value 值，可以在校验中使用 ???????this.value = constraintAnnotation.value(); ???} ???public boolean isValid(List list, ConstraintValidatorContext constraintValidatorContext) { ???????for (Object object : list) { ???????????if (object == null) { ???????????????//如果List集合中含有Null元素，校验失败 ???????????????return false; ???????????} ???????} ???????return true; ???}}3、定义两个空接口，分别代表Person对象的增加校验规则和修改校验规则
/** * 可以在一个Model上面添加多套参数验证规则，此接口定义添加Person模型新增时的参数校验规则 */public interface PersonAddView {}/** * 可以在一个Model上面添加多套参数验证规则，此接口定义添加Person模型修改时的参数校验规则 */public interface PersonModifyView {}4、在Model上添加注解时使用指明所述的分组
package com.github.bjlhx15.gradle.jsr303;import lombok.Data;import lombok.Getter;import lombok.Setter;import javax.validation.constraints.Max;import javax.validation.constraints.Min;import javax.validation.constraints.NotNull;/** * @author lihongxu * @desc @link(https://github.com/bjlhx15/gradle-mvc4) * @since 2019/1/23 上午9:25 */@Matches(field = "password", verifyField = "confirmPassword", ???????message = "{constraint.confirmNewPassword.not.match.newPassword}")public class Person { ???@IDValidator(message = "身份证需要15或18位") ???private String id; ???private String password; ???private String confirmPassword; ???/** ????* 添加groups 属性，说明只在特定的验证规则里面起作用，不加则表示在使用Deafault规则时起作用 ????*/ ???@NotNull(groups = {PersonAddView.class, PersonModifyView.class}, message = "添加、修改用户时名字不能为空" ???)//,payload = ValidateErrorLevel.Info.class) ???@ListNotHasNull.List({ ???????????@ListNotHasNull(groups = {PersonAddView.class}, message = "添加上Name不能为空"), ???????????@ListNotHasNull(groups = {PersonModifyView.class}, message = "修改时Name不能为空")}) ???private String name; ???@NotNull(groups = {PersonAddView.class}, message = "添加用户时地址不能为空") ???private String address; ???@Min(value = 18, groups = {PersonAddView.class}, message = "年龄不能低于18岁") ???@Max(value = 30, groups = {PersonModifyView.class}, message = "年龄不能超过30岁") ???private int age; ???public String getName() { ???????return name; ???} ???public void setName(String name) { ???????this.name = name; ???} ???public String getAddress() { ???????return address; ???} ???public void setAddress(String address) { ???????this.address = address; ???} ???public int getAge() { ???????return age; ???} ???public void setAge(int age) { ???????this.age = age; ???} ???public String getId() { ???????return id; ???} ???public void setId(String id) { ???????this.id = id; ???} ???public String getPassword() { ???????return password; ???} ???public void setPassword(String password) { ???????this.password = password; ???} ???public String getConfirmPassword() { ???????return confirmPassword; ???} ???public void setConfirmPassword(String confirmPassword) { ???????this.confirmPassword = confirmPassword; ???}}5、启用校验，此时启用校验和之前的不同,需要指明启用哪一组规则
???/** ????* 添加一个Person对象 ????* 此处启用PersonAddView 这个验证规则 ????* 备注：此处@Validated(PersonAddView.class) 表示使用PersonAndView这套校验规则，若使用@Valid 则表示使用默认校验规则， ????* 若两个规则同时加上去，则只有第一套起作用 ????*/ ???@RequestMapping(value = "/person", method = RequestMethod.POST) ???public void addPerson(@RequestBody @Validated({PersonAddView.class, Default.class}) Person person) { ???????System.out.println(person.toString()); ???} ???/** ????* 修改Person对象 ????* 此处启用PersonModifyView 这个验证规则 ????*/ ???@RequestMapping(value = "/person", method = RequestMethod.PUT) ???public void modifyPerson(@RequestBody @Validated(value = {PersonModifyView.class}) Person person) { ???????System.out.println(person.toString()); ???}二、Spring validator 方法级别的校验
2.1、概述
JSR和Hibernate validator的校验只能对Object的属性进行校验，不能对单个的参数进行校验，spring 在此基础上进行了扩展，添加了MethodValidationPostProcessor拦截器，可以实现对方法参数的校验。
2.2、具体实现步骤
1、实例化MethodValidationPostProcessor
@Bean ???public MethodValidationPostProcessor methodValidationPostProcessor() { ???????return new MethodValidationPostProcessor(); ???}2、在所要实现方法参数校验的类上面添加@Validated，如下
@RestController@Validatedpublic class ValidateController {3、在方法上面添加校验规则:
@RequestMapping(value = "/test", method = RequestMethod.GET) ???public String paramCheck(@Length(min = 10) @RequestParam String name) { ???????System.out.println(name); ???????return null; ???}当方法上面的参数校验失败,spring 框架就回抛出500异常
{ ???"timestamp": "2019-01-23T03:24:18.250+0000", ???"status": 500, ???"error": "Internal Server Error", ???"message": "paramCheck.arg0: 最小长度为10", ???"path": "/testM"}003-JSR303校验
原文地址：https://www.cnblogs.com/bjlhx/p/10305344.html