一、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" }