一、環境準備

在專案中新增以下依賴

gradle

org.hibernate:hibernate-validator:5.3.5.Final

maven

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.3.5.Final</version>
</dependency>

如果是SpringBoot專案，只需要引入web的starter即可，裡面包含了所需依賴

二、常用的校驗註解及示例

    //該引數必須為空
    @Null(message = "無需ID")
    private Integer id;

    //根據正則校驗手機號是否是由數字組成
    @Pattern(regexp = "^\\d{11}$", message = "手機格式不正確,不是11位")
    private String telephone;

    //校驗該物件是否為null
    //對於String來說，空字串可通過校驗，所以String應該使用@NotBlank進行校驗，此處僅做示例而已。
    @NotNull(message = "聯絡人不能為空")
    private String friendName;

    //校驗物件是否是空物件，可用於Array,Collection,Map,String
    @NotEmpty(message = "家庭成員不能為空")
    private List families;

    //校驗長度，可以用於Array,Collection,Map,String
    @Size(min = 4, max = 8, message = "使用者名稱長度錯誤 by size")
    //校驗長度，只能用於String
    @Length(min = 4, max = 8, message = "使用者名稱長度錯誤 by length")
    private String username;

    //javax校驗
    @Max(value = 200, message = "年齡一般不會超過200 by max")
    @Min(value = 1, message = "年齡一般不能小於1 by min")
    //hibernate校驗，效果等同
    @Range(min = 0, max = 200, message = "年齡範圍在0-200之間 by range")
    private Integer age;

    //校驗引數是否是False, 相反的是@AssertTrue
    @AssertFalse(message = "使用者初始化無需凍結")
    private Boolean lock;

    //String專用
    @NotBlank(message = "密碼不能為空")
    @Size(min = 6, max = 12, message = "密碼長度不對")
    private String password;

    //使用自定義校驗註解->校驗時間
    @Past(message = "生日只能為以前的時間")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm")
    private Date birth;

    //校驗Email
    @Email(message = "郵件地址不正確")
    private String email;
 

三、校驗類方法中的普通引數

1. 在類上加@Validated註解
2. 在引數上加上校驗註解

以controller層作示例如下：

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {

    /**
     * 校驗請求引數
     */
    @GetMapping
    public String getUser(@Size(min = 5, max = 8, message = "使用者名稱長度超出限制") String username) {
	 return username;       
    }
}
 

四、校驗類方法中的自定義物件

1. 在類上加@Validated註解(同普通引數一樣都需要加)
2. 在引數上加@Valid，(或者加@Validated也是可以的)

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {

    /**
     * 校驗請求中的自定義物件
     */
    @PostMapping
    public UserDTO saveUserOuter(@RequestBody @Valid UserDTO userDTO) {
        return userDTO;
    }

}

3.在自定義物件中的屬性上加上校驗註解

public class UserDTO {

    //該引數必須為空
    @Null(message = "無需ID")
    private Integer id;

    //根據正則校驗手機號是否是由數字組成
    @Pattern(regexp = "^\\d{11}$", message = "手機格式不正確,不是11位")
    private String telephone;

    //校驗該物件是否為null
    //對於String來說，空字串可通過校驗，所以String應該使用@NotBlank進行校驗，此處僅做示例而已。
    @NotNull(message = "聯絡人不能為空")
    private String friendName;

    //校驗物件是否是空物件，可用於Array,Collection,Map,String
    @NotEmpty(message = "家庭成員不能為空")
    private List families;

    //校驗長度，可以用於Array,Collection,Map,String
    @Size(min = 4, max = 8, message = "使用者名稱長度錯誤 by size")
    //校驗長度，只能用於String
    @Length(min = 4, max = 8, message = "使用者名稱長度錯誤 by length")
    private String username;

    //javax校驗
    @Max(value = 200, message = "年齡一般不會超過200 by max")
    @Min(value = 1, message = "年齡一般不能小於1 by min")
    //hibernate校驗，效果等同
    @Range(min = 0, max = 200, message = "年齡範圍在0-200之間 by range")
    private Integer age;

    //校驗引數是否是False, 相反的是@AssertTrue
    @AssertFalse(message = "使用者初始化無需凍結")
    private Boolean lock;

    //String專用
    @NotBlank(message = "密碼不能為空")
    @Size(min = 6, max = 12, message = "密碼長度不對")
    private String password;

    //使用自定義校驗註解->校驗時間
    @Past(message = "生日只能為以前的時間")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm")
    private Date birth;

    //校驗Email
    @Email(message = "郵件地址不正確")
    private String email;

	//setter  getter ....
}

五、關於@Valid和@Validated的區別聯絡

一直對@Valid和@Validated這兩個註解非常疑惑，不知道怎麼區分和使用。

1.包位置

• @Valid: javax.validation， 是javax，也是就是jsr303中定義的規範註解
• @Validated: org.springframework.validation.annotation， 是spring自己封裝的註解。

2.功能
@Valid就不用說了，是jsr303的規範。我們開啟@Validated的原始碼，可以看到以下注釋，

Variant of JSR-303's {@link javax.validation.Valid}, supporting the
specification of validation groups. Designed for convenient use with
Spring's JSR-303 support but not JSR-303 specific.

大致意思就是說@Validated是@Valid的一個變種，擴充套件了@Valid的功能，支援group分組校驗的寫法。
那麼我們對於@Valid和@Validated就可以這麼理解：

1. 能用@Valid的地方通常可以用@Validated替代。
2. 需要使用分組校驗的時候使用@Validated註解。

六、分組校驗

我們有一個使用者DTO,其中有id,username兩個屬性。當儲存時，id不需要有值，由資料庫自動生成，我們使用@Null註解校驗。當更新時，id需要有值，根據ID去更新使用者名稱，我們使用@NotNull註解校驗。無論是儲存使用者還是更新使用者，都需要校驗使用者名稱，我們使用@NotBlank註解校驗。

UserGroupValidDTO

public class UserGroupValidDTO {

    public interface SaveGroup extends Default {}

    public interface UpdateGroup extends Default {}

    @Null(groups = {SaveGroup.class}, message = "不需要傳入使用者ID")
    @NotNull(groups = {UpdateGroup.class}, message = "使用者ID不能為空")
    private Integer id;

    @NotBlank(message = "使用者名稱不能為空")
    private String username;
    
    //Setter Getter ...
}

定義相應型別的公開介面(SaveGroup,UpdateGroup)，給每個校驗註解指定groups屬性，如果不指定則預設為javax.validation.groups.Default.class。

我們讓SaveGroup和UpdateGroup繼承了Default, 那麼三個介面之間的關係類似如下：

save --> SaveGroup |-->id  @Null
                   |-->Default --> username @NotBlank
                   
update--> UpdateGroup |-->id @NotNull
                      |-->Default --> username @NotBlank

UserController

@Validated
@RestController
@RequestMapping(value = "/user")
public class UserController {
    /**
     * 分組校驗：儲存使用者，不能傳ID
     */
    @PostMapping("/save")
    public void validSaveUser(@RequestBody @Validated(value = UserGroupValidDTO.SaveGroup.class) UserGroupValidDTO userDTO) {
        //save user
    }

    /**
     * 分組校驗：更新使用者資訊，需要傳ID
     */
    @PostMapping("/update")
    public void validUpdateUser(@RequestBody @Validated(value = UserGroupValidDTO.UpdateGroup.class) UserGroupValidDTO userDTO) {
        //update user
    }

}

在方法引數的物件上加@Validated屬性，填寫Value為對應的介面的class即可，這時候訪問不同的介面就會進行不同的校驗了。

七、自定義校驗註解

有時候預設提供的校驗註解無法滿足我們的需要，我們需要自定義。例如現有校驗註解不支援java8中的LocalDateTime。那麼接下來我們自定義一個校驗LocalDateTime的註解。該註解判斷傳入的時間是否是一個過去的時間。

1.建立校驗註解

/**
 * @author [email protected]
 * @date 2017/12/29 下午7:24
 * @desc ${DESCRIPTION}.
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PastTimeValidate.class)
public @interface PastDate {

    String message();

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

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

}

2.編寫校驗規則
校驗規則也就是列舉PastDate中指定的validateBy屬性

/**
 * @author [email protected]
 * @date 2017/12/29 下午7:28
 * @desc .
 */
@CommonsLog
public class PastTimeValidate implements ConstraintValidator<PastDate, LocalDateTime> {

   @Override
   public void initialize(PastDate constraintAnnotation) {
      log.info("init enum PastDate");
   }

   @Override
   public boolean isValid(LocalDateTime localDateTime, ConstraintValidatorContext context) {
      return localDateTime.isBefore(LocalDateTime.now()) ? true : false;
   }
}

寫完這些，我們就可以像@Past對Date校驗一樣使用@PastDate對LocalDateTime進行校驗了。

可以參考我的github專案檢視完整示例，示例中額外包含了校驗異常的捕捉方式。