@Valid注解怎么規范使用

這篇文章主要介紹“@Valid注解怎么規范使用”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“@Valid注解怎么規范使用”文章能幫助大家解決問題。

@Valid注解大全及用法規范

@Valid注解規范用戶請求的參數

業務場景

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

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

業務出現的問題

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

//用戶發送POST請求創建新的用戶
@PostMapping
public User create(@RequestBody User user){
    if( StringUtils.isBlank(user.getPassword())){
        //用戶輸入密碼為空，進行異常處理
    }
    /**
        一些數據持久化操作，如：寫入數據庫
    **/
    //打印用戶提交的信息
    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語句都需要修改，可維護性就變得很差。

優化的解決方案

那么，有沒有一種方法可以一勞永逸、既沒有大量代碼冗余，可維護性又好呢？這時 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方法的參數中加入@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.這時，當我們向服務器Post提交空的密碼信息時，后臺會打印出錯誤信息：

may not be empty

關于“@Valid注解怎么規范使用”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。