JSR-303数据校验 以及 分组校验

一、关于JSR

JSR是Java Specification Requests的缩写,意思是Java 规范提案。

是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。

任何人都可以提交JSR,以向Java平台增添新的API和服务。

JSR已成为Java界的一个重要标准。

二、关于 JSR-303

JSR-303 用于对 Java Bean 中的字段的值进行验证;

JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation;

JSR-303 为Bean 验证定义了元数据模型和API,默认的元数据模型是通过Annotations来描述的,但是也可以使用XML来重载或者扩展。

三、常用的校验注解

分类:Bean Validation 中内置的 constraint

Constraint详细信息
@AssertTrue被注释的元素必须为 true
@AssertFalse被注释的元素必须为 false
@DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内
@Email被注释的元素必须是电子邮箱地址
@Future被注释的元素必须是一个将来的日期
@Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@NotBlank被注释的字符串的必须非空
@NotEmpty被注释的集合类的必须非空
@Size(max, min)被注释的元素的大小必须在指定的范围内
@Null被注释的元素必须为 null
@NotNull被注释的元素必须不为 null
@Past被注释的元素必须是一个过去的日期
@Pattern(value)被注释的元素必须符合指定的正则表达式

分类:Hibernate Validator 附加的 constraint

Constraint详细信息
@Length被注释的字符串的大小必须在指定的范围内
@URL被注释的元素必须是合法的URL地址
@Range被注释的元素必须在合适的范围内

四、使用过程

1. 添加依赖

<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version>
</dependency>

2. 为bean添加校验注解

@NotBlank(message = "用户名不能为空")
private String userName;@NotNull(message = "邮箱不能为空")
@Email(message = "必须是邮箱地址类型")
private String email;@NotNull(message = "reason信息不可以为空")
@Pattern(regexp = "[1-7]{1}", message = "reason的类型值为1-7中的一个类型")
private String reason;

message属性为校验失败时的提示信息,不添加会提示默认的响应信息。

3. 在需要校验的Controller上加上 @Valid注解

4. 给校验的bean后紧跟一个BindingResult,获取校验的结果

五、分组校验

应用场景:同一字段在不同业务逻辑下的校验规则是不同的

例如:

  • 添加数据时:实体类的 id 字段一定是的(因为 id 字段要由数据库主键自增添加)
  • 修改数据时:实体类的 id 字段一定是非空的(因为要通过 id 查找到要修改的实体)

基于以上业务逻辑,我们在对应的实体字段上添加注解:

属性groups将字段的校验进行分组,在字段brandId进行属于不同业务的操作时,采用不同的校验规则,如:上面规定了在修改时,brandId字段不为空,在添加时,brandId字段必为空。

1. 创建分组——建两个接口,作为添加及修改的标识

2.在使用JSR303注解时添加group属性

上图介绍的group属性,其值为一个数组,可以添加多个分组

3.在添加及编辑操作时使用@Validated注解并指定其value值

注意:由于注解内指定了该接口的校验分组,所以该注解只会校验group为该类型的属性值,所以没有指定相同group的属性值不会被校验。

例如下面这个例子,由于执行添加业务的接口已经有@Validated注解并指定其value值为AddGroup.class,所以在进行添加业务时,只会对brandId进行是否为空的校验,而不会对name字段进行校验:

如需要对name字段进行校验,需要按如下方法为name字段添加分组:

JSR-303数据校验 以及 分组校验

一、关于JSR

JSR是Java Specification Requests的缩写,意思是Java 规范提案。

是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。

任何人都可以提交JSR,以向Java平台增添新的API和服务。

JSR已成为Java界的一个重要标准。

二、关于 JSR-303

JSR-303 用于对 Java Bean 中的字段的值进行验证;

JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation;

JSR-303 为Bean 验证定义了元数据模型和API,默认的元数据模型是通过Annotations来描述的,但是也可以使用XML来重载或者扩展。

三、常用的校验注解

分类:Bean Validation 中内置的 constraint

Constraint详细信息
@AssertTrue被注释的元素必须为 true
@AssertFalse被注释的元素必须为 false
@DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内
@Email被注释的元素必须是电子邮箱地址
@Future被注释的元素必须是一个将来的日期
@Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@NotBlank被注释的字符串的必须非空
@NotEmpty被注释的集合类的必须非空
@Size(max, min)被注释的元素的大小必须在指定的范围内
@Null被注释的元素必须为 null
@NotNull被注释的元素必须不为 null
@Past被注释的元素必须是一个过去的日期
@Pattern(value)被注释的元素必须符合指定的正则表达式

分类:Hibernate Validator 附加的 constraint

Constraint详细信息
@Length被注释的字符串的大小必须在指定的范围内
@URL被注释的元素必须是合法的URL地址
@Range被注释的元素必须在合适的范围内

四、使用过程

1. 添加依赖

<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>2.0.1.Final</version>
</dependency>

2. 为bean添加校验注解

@NotBlank(message = "用户名不能为空")
private String userName;@NotNull(message = "邮箱不能为空")
@Email(message = "必须是邮箱地址类型")
private String email;@NotNull(message = "reason信息不可以为空")
@Pattern(regexp = "[1-7]{1}", message = "reason的类型值为1-7中的一个类型")
private String reason;

message属性为校验失败时的提示信息,不添加会提示默认的响应信息。

3. 在需要校验的Controller上加上 @Valid注解

4. 给校验的bean后紧跟一个BindingResult,获取校验的结果

五、分组校验

应用场景:同一字段在不同业务逻辑下的校验规则是不同的

例如:

  • 添加数据时:实体类的 id 字段一定是的(因为 id 字段要由数据库主键自增添加)
  • 修改数据时:实体类的 id 字段一定是非空的(因为要通过 id 查找到要修改的实体)

基于以上业务逻辑,我们在对应的实体字段上添加注解:

属性groups将字段的校验进行分组,在字段brandId进行属于不同业务的操作时,采用不同的校验规则,如:上面规定了在修改时,brandId字段不为空,在添加时,brandId字段必为空。

1. 创建分组——建两个接口,作为添加及修改的标识

2.在使用JSR303注解时添加group属性

上图介绍的group属性,其值为一个数组,可以添加多个分组

3.在添加及编辑操作时使用@Validated注解并指定其value值

注意:由于注解内指定了该接口的校验分组,所以该注解只会校验group为该类型的属性值,所以没有指定相同group的属性值不会被校验。

例如下面这个例子,由于执行添加业务的接口已经有@Validated注解并指定其value值为AddGroup.class,所以在进行添加业务时,只会对brandId进行是否为空的校验,而不会对name字段进行校验:

如需要对name字段进行校验,需要按如下方法为name字段添加分组: