java后端验证 bean validation 框架

来源:互联网 发布:淘宝店主房贷收入证明 编辑:程序博客网 时间:2024/06/06 17:20

1. bean validation规范

    JSR303 规范(Bean Validation 规范)提供了对 Java EE 和 Java SE 中的 Java Bean 进行验证的方式。该规范主要使用注解的方式来实现对 Java Bean 的验证功能,并且这种方式会覆盖使用 XML 形式的验证描述符,从而使验证逻辑从业务代码中分离出来。Hibernate Validator 4.0 是 JSR303 规范的参考实现。

2. maven引用(当前最新版本如下)

<!-- https://mvnrepository.com/artifact/javax.validation/validation-api --><dependency>    <groupId>javax.validation</groupId>    <artifactId>validation-api</artifactId>    <version>2.0.0.Final</version></dependency>

3. 内嵌约束注解
    Bean Validation 中内置的 constraint:

约束注解名称约束注解说明@Null验证对象是否为空@NotNull验证对象是否为非空@AssertTrue验证 Boolean 对象是否为 true@AssertFalse验证 Boolean 对象是否为 false@Min验证 Number 和 String 对象是否大等于指定的值@Max验证 Number 和 String 对象是否小等于指定的值@DecimalMin验证 Number 和 String 对象是否大等于指定的值,小数存在精度@DecimalMax验证 Number 和 String 对象是否小等于指定的值,小数存在精度@Size验证对象(Array,Collection,Map,String)长度是否在给定的范围之内@Digits验证 Number 和 String 的构成是否合法@Past验证 Date 和 Calendar 对象是否在当前时间之前@Future验证 Date 和 Calendar 对象是否在当前时间之后@Pattern验证 String 对象是否符合正则表达式的规则

    Hibernate Validator 附加的 constraint:

@Email验证对象是否为邮箱地址@Length(min=,max=)验证对象长度是否在指定范围内@NotEmpty验证字符串非空@Range(min=,max=,message=)验证 对象必须在合适范围内@NotBlank(message =)验证字符串非null且长度大于0

    约束注解应用的目标元素类型包括 METHOD, FIELD, TYPE, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER。METHOD 约束相关的 getter 方法;FIELD 约束相关的属性;TYPE 约束具体的 Java Bean;ANNOTATION_TYPE 用在组合约束中;该规范同样也支持对参数(PARAMETER)和构造器(CONSTRUCTOR)的约束。

4.  验证示例

    以下为SysUser类的定义及对其字段的验证:

public class SysUser{        private Integer id;        @NotBlank(message = "姓名不能为空",groups = SysValidate.NAME.class)        @Size(min = 1,max = 10,message="姓名长度1~10")         private String iname;        @NotBlank(message = "密码不能为空")        @Size(min=6,message="密码长度不能小于6")        private String password;        @Email(message = "电子邮件验证不通过",groups = Default.class)        private String email;        @Pattern(regexp = "^\\s*|((13[0-9]{1})|(14[0-9]{1})|(15[0-9]{1})|(17[0-9]{1})|(18[0-9]{1}))+\\d{8}$",message = "手机号验证不通过")// 验证为空字符串或手机号码        private String mobile;        @NotNull(message = "人员状态不能为空")// 对Integer类型不能使用@NotBlank验证        private Integer state;}

    在类中引用SysUser,则需要对SysUser类引用处添加注解@Valid如下代码段,否则验证无效。

public class SysUserInfo{    @Valid    private SysUser sysUser;    public SysUser getSysUser() {         return sysUser;     }     public void setSysUser(SysUser sysUser) {         this.sysUser = sysUser;     }  }

    在Controller层的验证需要添加注解@Validated如下代码段,否则验证无效。

@RequestMapping(value = "/save", method = RequestMethod.POST)@ResponseBodypublic FormResult<Object> save(@Validated(SysValidate.NAME.class) SysUser sysUser, @Validated SysUserInfo sysUserInfo) throws UnsupportedEncodingException {    FormResult<Object> result = new FormResult<>();    ......    return result;}

5. 组验证
    以上代码中的SysValidate类定义如下:
public class SysValidate {    public   interface NAME{};    public   interface SIZE{};    public   interface PASSWORD{};}

    在SysUser中字段验证时添加组,如对姓名的验证添加SysValidate.NAME.class,不添加组则默认Default.class同电子邮件字段, 则在Controller引用中使用@Validated(SysValidate.NAME.class)时只对组别为SysValidate.NAME.class的字段进行验证。

6. 验证前提
    Bean Validation 规范规定在对 Java Bean 进行约束验证前,目标元素必须满足以下条件:
        a.如果验证的是属性(getter 方法),那么必须遵从 Java Bean 的命名习惯(JavaBeans 规范);
        b.静态的字段和方法不能进行约束验证;
        c.约束适用于接口和基类;
        d.约束注解定义的目标元素可以是字段、属性或者类型等;
        e.可以在类或者接口上使用约束验证,它将对该类或实现该接口的实例进行状态验证;
        f.字段和属性均可以使用约束验证,但是不能将相同的约束重复声明在字段和相关属性(字段的 getter 方法)上。

7. 结束
   Bean Validation 规范中的两个特性:多值约束和组合约束;两个概念:组和组序列;具有可扩展性。
   具体内容查看:https://www.ibm.com/developerworks/cn/java/j-lo-beanvalid/。


原创粉丝点击