一、概述

JSR-303 是 Java EE 6 中的一项子规范,叫做 Bean Validation,官方参考实现是hibernate Validator。此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。spring MVC 3.x 之中也大力支持 JSR-303,可以在控制器中对表单提交的数据方便地验证。

JSR 303 用于对java Bean 中的字段的值进行验证,使得验证逻辑从业务代码中脱离出来。它是一个运行时的数据验证框架,在验证之后验证的错误信息会被马上返回。

使用场景:一般用于表单提交页面。

注：实现方式为通过使用注解进行验证

二、项目依赖及配置

Maven项目依赖

<!-- 表单验证 -->
<dependency>
  <groupId>org.hibernate</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>6.0.13.Final</version>
</dependency>

spring-web.xml配置（可参考https://blog.csdn.net/Black1499/article/details/83961684）

<!--JSR303 验证-->
<bean id="myValidator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
    <property name="providerClass" value="org.hibernate.validator.HibernateValidator" />
    <property name="validationMessageSource" ref="messageSource" />
</bean>

三、基本校验规则

1.空检查

@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

2.Booelan检查

@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false

3.长度检查

@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.

4.日期检查

@Past 验证 Date 和 Calendar 对象是否在当前时间之前,验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ,验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则,被注释的元素符合制定的正则表达式,regexp:正则表达式 flags: 指定 Pattern.Flag 的数组,表示正则表达式的相关选项。

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=)

四、快速使用

实体类，直接在字段上面使用JSR303为我们提供的注解

public class Book {

    @Min(0)
    private int id;

    @NotBlank(message = "asdffasdfasfd")
    private String name;

    @DateTimeFormat(pattern = "yyyy-MM-dd")//用于格式转换
    @NotNull
    @Past
    private Date writeDate;

    @NotNull(message = "我是存在的！！！！")
    private Employee employee;


    @DecimalMin(value = "10.00",message = "最低价格")
    private float price;

    @NotBlank
    @Pattern(regexp = "^[0-9]{11}$")
    private String phone;

    @Email
    private String email;

    @NotNull
    List list;
	
	// ...省略get/set函数
}

MVC后台Controller

@Controller
public class BookController {

    @PostMapping("/addBook")
    // 注意这里一定要使用@valid注解，否则jsr303验证不起作用
    // BindingResult为错误信息，可以查看源代码进行理解
    public String addBook(@Valid Book book, BindingResult result){
        if(result.hasErrors()){
            return "bookForm";
        }
        return "正确的页面";
    }

    @GetMapping("/bookForm")
    public String bookForm(Model model){
        model.addAttribute("book", new Book());
        return "bookForm";
    }
}

前台jsp

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<form:form action="/addBook" method="post" modelAttribute="book">
    <%--form:input为接收用户输入--%>
    <%--form:errors为输入错误时，后台返回的错误信息（来自注解中的message）--%>
    <label>名称</label>
    <form:input path="name" value="${book.name}" />
    <form:errors path="name"/><br/>
    
    <label>价格</label>
    <form:input path="price" value="${book.price}"/>
    <form:errors path="price"/><br/>
    <input type="submit"/>
</form:form>
</body>
</html>

下面我们尝试输入一些错误的信息，看看页面会有什么效果。

正确信息：

错误信息：

这就是jsr303的使用是不是非常的简单？

五、自定义jsr303注解

有些时候jsr303为我们提供的注解并不能解决我们的需求，比如我们需要验证一个11位长度的手机号时，我们会使用这样的方式

@NotBlank
@Pattern(regexp = "^[0-9]{11}$")
private String phone;

每次我们都要为这个字段加上两个注解，还要写正则表达式，十分累赘，写一个时无所谓，当实体类过多时，而且都有这个字段时，就会十分麻烦。这时我们可以自己为这个验证写个注解，可以复用。

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {CellPhoneValid.class })// 注意点一
public @interface CellPhone {

	//下面三条属性不能乱改，可能会报错

    // 错误时信息
    String message() default "格式不正确，应该是11位";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };
}

// 继承ConstraintValidator<T,String>接口，注意点二
class CellPhoneValid implements ConstraintValidator<CellPhone,String>{
    @Override
    public void initialize(CellPhone constraintAnnotation) { //注意点三
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
		// 直接在这里面写上我们的验证逻辑即可
        return value!=null && Pattern.matches("^[0-9]{11}", value);
    }
}

下面我们来使用一下看看有没有效果

@CellPhone
private String phone;

表单

<form:form action="/addBook" method="post" modelAttribute="book">
    <%--form:input为接收用户输入--%>
    <%--form:errors为输入错误时，后台返回的错误信息（来自注解中的message）--%>
    <label>名称</label>
    <form:input path="name" value="${book.name}" />
    <form:errors path="name"/><br/>

    <label>价格</label>
    <form:input path="price" value="${book.price}"/>
    <form:errors path="price"/><br/>

    <label>号码</label>
    <form:input path="phone" value="${book.phone}"/>
    <form:errors path="phone"/><br/>

    <input type="submit"/>
</form:form>

输入错误信息时

详解JSR303表单验证