Hibernate validation 注解 springmvc 驗證 分組

 

SpringMVC驗證框架Validation特殊用法

 

1. 分組

有的時候，我們對一個實體類需要有多中驗證方式，在不同的情況下使用不同驗證方式，比如說對於一個實體類來的id來說，保存的時候是不需要的，對於更新時是必須的，可以如下配置：

public class UserModel {

    @NotNull(message = "{id.empty}", groups = { First.class })
    private int id;

    @NotNull(message = "{username.empty}", groups = { First.class, Second.class })
    private String username;

    @NotNull(message = "{content.empty}", groups = { First.class, Second.class })
    private String content;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getContent() {
        return content;
    }

    public void setContent(String content) {
        this.content = content;
    }
}
public interface First {
}

public interface Second {
}

通過 groups 對驗證進行分組

在controler中的代碼如下：

@RequestMapping(value = "/save.action", method = RequestMethod.POST)
public String save(@Validated( { Second.class }) UserModel userModel, BindingResult result) {
    if (result.hasErrors()) {
        return "validate/error";
    }
    return "redirect:/success";
}

@RequestMapping(value = "/update.action", method = RequestMethod.POST)
public String update(@Validated( { First.class, Second.class }) UserModel user, BindingResult result) {
    if (result.hasErrors()) {
        return "validate/error";
    }
    return "redirect:/success";
}

2. 組序列

默認情況下，不同組別的約束驗證是無序的，然而在某些情況下，約束驗證的順序卻很重要，如下面兩個例子：（1）第二個組中的約束驗證依賴於一個穩定狀態來運行，而這個穩定狀態是由第一個組來進行驗證的。（2）某個組的驗證比較耗時，CPU 和內存的使用率相對比較大，最優的選擇是將其放在最后進行驗證。因此，在進行組驗證的時候尚需提供一種有序的驗證方式，這就提出了組序列的概念。

一個組可以定義為其他組的序列，使用它進行驗證的時候必須符合該序列規定的順序。在使用組序列驗證的時候，如果序列前邊的組驗證失敗，則后面的組將不再給予驗證。

下例中聲明了組 GroupA.class，GroupB.class 和 Group.class，其中 default，GroupA，GroupB 均為 Group 的序列。

public interface GroupA {
}

public interface GroupB {
}

@GroupSequence( { Default.class, GroupA.class, GroupB.class })
public interface Group {
}

public class User {
    @NotEmpty(message = "firstname may be empty")
    private String firstname;

    @NotEmpty(message = "middlename may be empty", groups = Default.class)
    private String middlename;

    @NotEmpty(message = "lastname may be empty", groups = GroupA.class)
    private String lastname;

    @NotEmpty(message = "country may be empty", groups = GroupB.class)
    private String country;
}

@RequestMapping(value = "/update.action", method = RequestMethod.POST)
public String register(@Validated(Group.class) User user, BindingResult result) {
    if (result.hasErrors()) {
        return "validate/error";
    }
    return "redirect:/success";
}

3. 驗證多個對象

當我們在一個功能處理方法上需要驗證多個模型對象時，需要通過如下形式來獲取驗證結果：

@RequestMapping("/validate/multi")
public String multi(@Valid @ModelAttribute("a") A a, BindingResult aErrors, @Valid @ModelAttribute("b") B b, BindingResult bErrors) {

    if (aErrors.hasErrors()) { //如果a模型對象驗證失敗
        return "validate/error";
    }
    if (bErrors.hasErrors()) { //如果a模型對象驗證失敗
        return "validate/error";
    }
    return "redirect:/success";
}

每一個模型對象后邊都需要跟一個Errors或BindingResult對象來保存驗證結果，其方法體內部可以使用這兩個驗證結果對象來選擇出錯時跳轉的頁面或處理的邏輯。

4. Junit測試

當自定義拓展Validation時，可以使用如下方法進行測試：

@Test
public void testValidate() {
    AnnotationDescriptor<EqualsAny> descriptor = new AnnotationDescriptor<EqualsAny>(EqualsAny.class);
    EqualsAny equalsAny = AnnotationFactory.create(descriptor);
    EqualsAnyValidator equalsAnyValidator = new EqualsAnyValidator();
    equalsAnyValidator.initialize(equalsAny);
    Assert.assertTrue(equalsAnyValidator.isValid("123", null));
}

另外再講一點Spring對自定義JSR-303限制類型支持的新特性，那就是Spring支持往ConstraintValidator里面注入bean對象。例如在EqualsAnyValidator中利用@Resource注解注入其他Bean對象。

 

在使用Validation時，傳遞參數到國際化資源文件properties

 

@NotEmpty(message="{password.empty.error}")
private String password;

資源文件validation_zh_CN.properties中為

password.empty.error=password不能為空

實際開發中，很多參數都是要驗證非空的，如果每個參數都單獨加個錯誤描述，是很麻煩的。properties雖支持“{}”的寫法傳遞參數，但使用JSR-303注解無法實現傳遞參數。我想了個辦法可通過自定義注解方式實現。

 

首先，建立個自定義的@NotEmpty注解：

package com.itkt.payment.core.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

import com.itkt.payment.core.handler.NotEmptyValidator;

@Retention(RetentionPolicy.RUNTIME)
@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER })
@Constraint(validatedBy = { NotEmptyValidator.class })
public @interface NotEmpty {

    String field() default "";

    String message() default "{com.itkt.payment.core.handler.NotEmpty.message}";

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

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

自定義的NotEmpty注解中，我們新加了field字段，用於標識字段名稱。

然后，建立NotNullValidator實現類：

package com.itkt.payment.core.handler;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

import com.itkt.payment.core.annotation.NotNull;

public class NotNullValidator implements ConstraintValidator<NotNull, Object> {

    @Override
    public void initialize(NotNull annotation) {
    }

    @Override
    public boolean isValid(Object str, ConstraintValidatorContext constraintValidatorContext) {
        return str != null;
    }

}

之后，在資源文件validation_zh_CN.properties中，改變寫法：

password.empty.error={field}不能為空

最后，我們就可以在User類中使用自定義的NotEmpty注解：

@NotEmpty(field = "password", message = "{password.empty.error}")
private String password;

 

實際上，國際化資源文件本身支持從JSR-303注解中獲取屬性的參數值的，例如從@Length注解中，獲取min和max屬性的值：

username.length.error=用戶名長度必須在{min}-{max}之間

之所以自帶的@NotEmpty注解無法實現，是因為沒有一個屬性能傳遞字段名，所以通過自定義@NotEmpty注解來拓展個field字段。

 

 

@AssertTrue   //用於boolean字段，該字段只能為true   

@AssertFalse //該字段的值只能為false   

@CreditCardNumber //對信用卡號進行一個大致的驗證   

@DecimalMax //只能小於或等於該值   

@DecimalMin //只能大於或等於該值   

@Digits (integer= 2 ,fraction= 20 ) //檢查是否是一種數字的整數、分數,小數位數的數字。   

@Email //檢查是否是一個有效的email地址   

@Future //檢查該字段的日期是否是屬於將來的日期   

@Length (min=,max=) //檢查所屬的字段的長度是否在min和max之間,只能用於字符串   

@Max //該字段的值只能小於或等於該值   

@Min //該字段的值只能大於或等於該值   

@NotNull //不能為null   

@NotBlank //不能為空，檢查時會將空格忽略   

@NotEmpty //不能為空，這里的空是指空字符串   

@Null //檢查該字段為空   

@Past //檢查該字段的日期是在過去   

@Size (min=, max=) //檢查該字段的size是否在min和max之間，可以是字符串、數組、集合、Map等   

@URL (protocol=,host,port) //檢查是否是一個有效的URL，如果提供了protocol，host等，則該URL還需滿足提供的條件   

@Valid //該注解只要用於字段為一個包含其他對象的集合或map或數組的字段，或該字段直接為一個其他對象的引用，   

       //這樣在檢查當前對象的同時也會檢查該字段所引用的對象  

以下是分類
Bean Validation 中內置的 constraint
 
@Null     被注釋的元素必須為 null
@NotNull     被注釋的元素必須不為 null
@AssertTrue     被注釋的元素必須為 true
@AssertFalse     被注釋的元素必須為 false
@Min(value)     被注釋的元素必須是一個數字，其值必須大於等於指定的最小值
@Max(value)     被注釋的元素必須是一個數字，其值必須小於等於指定的最大值
@DecimalMin(value)     被注釋的元素必須是一個數字，其值必須大於等於指定的最小值
@DecimalMax(value)     被注釋的元素必須是一個數字，其值必須小於等於指定的最大值
@Size(max=, min=)     被注釋的元素的大小必須在指定的范圍內
@Digits (integer, fraction)     被注釋的元素必須是一個數字，其值必須在可接受的范圍內
@Past     被注釋的元素必須是一個過去的日期
@Future     被注釋的元素必須是一個將來的日期
@Pattern(regex=,flag=)     被注釋的元素必須符合指定的正則表達式

Hibernate Validator 附加的 constraint
@NotBlank(message =)   驗證字符串非null，且長度必須大於0
@Email     被注釋的元素必須是電子郵箱地址
@Length(min=,max=)     被注釋的字符串的大小必須在指定的范圍內
@NotEmpty     被注釋的字符串的必須非空
@Range(min=,max=,message=)     被注釋的元素必須在合適的范圍內