java bean validation 參數驗證

 一、前言

二、幾種解決方案

三、使用bean validation 自帶的注解驗證

四、自定義bean validation 注解驗證

 

 

一、前言

　　在后台開發過程中，對參數的校驗成為開發環境不可缺少的一個環節。比如參數不能為null，email那么必須符合email的格式，如果手動進行if判斷或者寫正則表達式判斷無意開發效率太慢，在時間、成本、質量的博弈中必然會落后。所以把校驗層抽象出來是必然的結果，下面說下幾種解決方案。

二、幾種解決方案

　　1、struts2的valid可以通過配置xml，xml中描述規則和返回的信息，這種方式比較麻煩、開發效率低，不推薦

　　2、validation bean 是基於JSR-303標准開發出來的，使用注解方式實現，及其方便，但是這只是一個接口，沒有具體實現.Hibernate Validator是一個hibernate獨立的包，可以直接引用，他實現了validation bean同時有做了擴展，比較強大 ，實現圖如下：

　　　　

　　　　點此查看中文官方手冊

　　　3、oval 是一個可擴展的Java對象數據驗證框架，驗證的規則可以通過配置文件、Annotation、POJOs 進行設定。可以使用純 Java 語言、JavaScript 、Groovy 、BeanShell 等進行規則的編寫，本次不過多講解

三、bean validation 框架驗證介紹

　　bean validation 包放在maven上維護,最新包的坐標如下：

?

1 2 3 4 5

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

　　 點擊這里查看最新的坐標地址

　　 下載之后打開這個包，有個package叫constraints，里面放的就是驗證的的注解：

　　 

　　 下面開始用代碼實踐一下：

　　 1、定義一個待驗證的bean:Student.java

package com.shishang;

import javax.validation.constraints.*;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.Date;

public class Student implements Serializable {


    @NotNull(message = "名字不能為空")
    private String name;

    @Size(min = 6,max = 30,message = "地址應該在6-30字符之間")
    private String address;

    @DecimalMax(value = "100.00",message = "體重有些超標哦")
    @DecimalMin(value = "60.00",message = "多吃點飯吧")
    private BigDecimal weight;

    private String friendName;
    @AssertTrue
    private Boolean isHaveFriend(){
        return friendName != null?true:false;
    }

    @Future(message = "生日必須在當前實踐之前")
    private Date birthday;

    @Pattern(regexp = "^(.+)@(.+)$",message = "郵箱的格式不合法")
    private String email;


    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 BigDecimal getWeight() {
        return weight;
    }

    public void setWeight(BigDecimal weight) {
        this.weight = weight;
    }

    public String getFriendName() {
        return friendName;
    }

    public void setFriendName(String friendName) {
        this.friendName = friendName;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

     2、測試類:StudentTest.java

package com.use;  2 
import javax.validation.ConstraintViolation;  4 import javax.validation.Validation;  5 import javax.validation.Validator;  6 import javax.validation.ValidatorFactory;  7 import java.io.Serializable;  8 import java.math.BigDecimal;  9 import java.util.ArrayList; 10 import java.util.Date; 11 import java.util.List; 12 import java.util.Set; 13 
public class StudentTest implements Serializable { 15     public static void main(String[] args) { 16         Student xiaoming = getBean(); 17         List<String> validate = validate(xiaoming); 18         validate.forEach(row -> { 19  System.out.println(row.toString()); 20  }); 21 
 } 23 
    private static Student getBean() { 25         Student bean = new Student(); 26         bean.setName(null); 27         bean.setAddress("北京"); 28         bean.setBirthday(new Date()); 29         bean.setFriendName(null); 30         bean.setWeight(new BigDecimal(30)); 31         bean.setEmail("xiaogangfan163.com"); 32         return bean; 33  } 34 
    private static ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); 36 
    public static <T> List<String> validate(T t) { 38         Validator validator = factory.getValidator(); 39         Set<ConstraintViolation<T>> constraintViolations = validator.validate(t); 40 
        List<String> messageList = new ArrayList<>(); 42         for (ConstraintViolation<T> constraintViolation : constraintViolations) { 43  messageList.add(constraintViolation.getMessage()); 44  } 45         return messageList; 46  } 47 }

     3、運行testValidation()方法，輸處如下：

地址應該在6-30字符之間
郵箱的格式不合法
生日必須在當前時間之前
多吃點飯吧
名字不能為空 

     4、總結 

• 像@NotNull、@Size等比較簡單也易於理解，不多說
• 因為bean validation只提供了接口並未實現，使用時需要加上一個provider的包，例如hibernate-validator
• @Pattern 因為這個是正則，所以能做的事情比較多，比如中文還是數字、郵箱、長度等等都可以做
• @AssertTRue 這個與其他的校驗注解有着本質的區別，這個注解適用於多個字段。例子中isHaveFriend方法依賴friendName字段校驗
• 驗證的api是經過我加工了一下，這樣可以批量返回校驗的信息
• 有時我們需要的注解可能沒有提供，這時候就需要自定義注解，寫實現類，下面說一下自定義注解的使用

 

四、自定義bean validation 注解驗證

　　有時框架自帶的沒法滿足我們的需求，這時就需要自己動手豐衣足食了，恩恩 ，這個不難，下面說下。

　　這個例子驗證字符串是大寫還是小寫約束標注，代碼如下:

　　1、枚舉類型CaseMode, 來表示大寫或小寫模式

package com.defineconstrain;

/**
 * created by xiaogangfan
 * on 16/10/25.
 */
public enum CaseMode {
    UPPER,
    LOWER;
}

　　2、定義一個CheckCase的約束標注 

package com.defineconstrain;

/**
 * created by xiaogangfan
 * on 16/10/25.
 */
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {

    String message() default "{com.mycompany.constraints.checkcase}";

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

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

    CaseMode value();

}

 　　3、約束條件CheckCase的驗證器

package com.defineconstrain;

/**
 * created by xiaogangfan
 * on 16/10/25.
 */
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {

    private CaseMode caseMode;

    public void initialize(CheckCase constraintAnnotation) {
        this.caseMode = constraintAnnotation.value();
    }

    public boolean isValid(String object, ConstraintValidatorContext constraintContext) {

        if (object == null)
            return true;

        if (caseMode == CaseMode.UPPER)
            return object.equals(object.toUpperCase());
        else
            return object.equals(object.toLowerCase());
    }

}

　　4、在Student.java中增加一個屬性

@CheckCase(value = CaseMode.LOWER,message = "名字的拼音需要小寫")
    private String spellName;

　　5、在StudentTest.java的getBean()方法中增加一行

bean.setSpellName("XIAOGANGFAN");

　　6、運行testValidation()方法，輸處如下：

地址應該在6-30字符之間
郵箱的格式不合法
生日必須在當前時間之前
多吃點飯吧
名字的拼音需要小寫
名字不能為空

　　7、說明新增的約束生效了，大功告成

代碼下載地址：[e-mail]:xiaogangfan/vaidation.git

命令： git clone [e-mail]:xiaogangfan/vaidation.git