快捷導(dǎo)航

關(guān)于@Valid注解大全以及用法規(guī)范

更新時間：2022年01月26日 11:42:57 作者：通尼渣渣

這篇文章主要介紹了關(guān)于@Valid注解大全以及用法規(guī)范，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

@Valid注解大全及用法規(guī)范

注解	描述
@AssertFalse	帶注解的元素必須為false，支持boolean/Boolean
@AssertTrue	帶注解的元素必須為true，支持boolean/Boolean
@DecimalMax	帶注解的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@DecimalMin	帶注解的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@Digits	帶注解的元素必須是一個可接受范圍內(nèi)的數(shù)字
@Future	帶注解的元素必須是將來的某個時刻、日期或時間
@Max	帶注解的元素必須是一個數(shù)字，其值必須小于等于指定的最大值
@Min	帶注解的元素必須是一個數(shù)字，其值必須大于等于指定的最小值
@NotNull	帶注解的元素不能是Null
@Null	帶注解的元素必須是Null
@Past	帶注解的元素必須是過去的某個時刻、日期或時間
@Pattern	帶注解的元素必須符合指定的正則表達式
@Size	帶注解的元素必須大于等于指定的最小值，小于等于指定的最大值
@Email	帶注解的元素必須是格式良好的電子郵箱地址
@NotEmpty	帶注解的元素不能是空，String類型不能為null，Array、Map不能為空，切size/length大于0
@NotBlank	字符串不能為空、空字符串、全空格
@URL	字符串必須是一個URL

@Valid注解規(guī)范用戶請求的參數(shù)

業(yè)務(wù)場景

對于一個用戶的注冊操作（Post請求），往往涉及到賬號（username）、密碼（password）的Post提交：

//用戶發(fā)送POST請求創(chuàng)建新的用戶
@PostMapping
public User create(@RequestBody User user){
? ? /**
? ? ? ? 一些數(shù)據(jù)持久化操作，如：寫入數(shù)據(jù)庫
? ? **/
? ? //打印用戶提交的信息
? ? System.out.println(user.getId());
? ? System.out.println(user.getUsername());
? ? System.out.println(user.getPassword());
? ? System.out.println(user.getBirthday());
? ? return user;
}

業(yè)務(wù)出現(xiàn)的問題

但用戶往往會不小心提交了空的密碼來注冊，這是不允許的，因此我們往往需要對用戶提交的密碼信息進行空判斷，常見的方法是直接進行if語句的空判斷：

//用戶發(fā)送POST請求創(chuàng)建新的用戶
@PostMapping
public User create(@RequestBody User user){
? ? if( StringUtils.isBlank(user.getPassword())){
? ? ? ? //用戶輸入密碼為空，進行異常處理
? ? }
? ? /**
? ? ? ? 一些數(shù)據(jù)持久化操作，如：寫入數(shù)據(jù)庫
? ? **/
? ? //打印用戶提交的信息
? ? System.out.println(user.getId());
? ? System.out.println(user.getUsername());
? ? System.out.println(user.getPassword());
? ? System.out.println(user.getBirthday());
? ? return user;
}

以上方法看似行得通，但一旦Post的方法變多，則需要對每個Post請求都進行一次if判斷是否為空，代碼變得冗余，而且一旦修改一個地方，所有if語句都需要修改，可維護性就變得很差。

優(yōu)化的解決方案

那么，有沒有一種方法可以一勞永逸、既沒有大量代碼冗余，可維護性又好呢？這時 javax.validation包下的@Valid注解就派上用場了。

1.首先，我們在實體類User.java中的密碼（password）屬性加上@NotBlank注解（hibernate.validator.constraints包）

import org.hibernate.validator.constraints.NotBlank;
public class User {
? ? public interface UserSimpleView{}
? ? public interface UserDetailView extends UserSimpleView{}
? ? private String username;
? ? //給該屬性加入NotBlank非空的約束
? ? @NotBlank
? ? private String password;
? ? private String id;
? ? private Date birthday;
? ? public Date getBirthday() {
? ? ? ? return birthday;
? ? }
? ? public void setBirthday(Date birthday) {
? ? ? ? this.birthday = birthday;
? ? }
? ? @JsonView(UserSimpleView.class)
? ? public String getId() {
? ? ? ? return id;
? ? }
? ? public void setId(String id) {
? ? ? ? this.id = id;
? ? }
? ? @JsonView(UserSimpleView.class)
? ? public String getUsername() {
? ? ? ? return username;
? ? }
? ? public void setUsername(String username) {
? ? ? ? this.username = username;
? ? }
? ? @JsonView(UserDetailView.class)
? ? public String getPassword() {
? ? ? ? return password;
? ? }
? ? public void setPassword(String password) {
? ? ? ? this.password = password;
? ? }
}

2.我們在Controller類的Post方法的參數(shù)中加入@Valid注解，并使用BindingResult將錯誤信息作為日志打印到后臺

@PostMapping
public User create(@Valid @RequestBody User user,
? ? ? ? ? ? ? ? ? ? ? ?BindingResult errors){
? ? if (errors.hasErrors()){
? ? ? ? //異常處理
? ? ? ? errors.getAllErrors().stream().forEach(error -> System.out.println(error.getDefaultMessage()));
? ? }
? ? user.setId("1");
? ? System.out.println(user.getId());
? ? System.out.println(user.getUsername());
? ? System.out.println(user.getPassword());
? ? System.out.println(user.getBirthday());
? ? return user;
}

3.這時，當我們向服務(wù)器Post提交空的密碼信息時，后臺會打印出錯誤信息：