關于@Valid注解大全以及用法規(guī)范
@Valid注解大全及用法規(guī)范
| 注解 | 描述 |
| @AssertFalse | 帶注解的元素必須為false,支持boolean/Boolean |
| @AssertTrue | 帶注解的元素必須為true,支持boolean/Boolean |
| @DecimalMax | 帶注解的元素必須是一個數字,其值必須小于等于指定的最大值 |
| @DecimalMin | 帶注解的元素必須是一個數字,其值必須大于等于指定的最小值 |
| @Digits | 帶注解的元素必須是一個可接受范圍內的數字 |
| @Future | 帶注解的元素必須是將來的某個時刻、日期或時間 |
| @Max | 帶注解的元素必須是一個數字,其值必須小于等于指定的最大值 |
| @Min | 帶注解的元素必須是一個數字,其值必須大于等于指定的最小值 |
| @NotNull | 帶注解的元素不能是Null |
| @Null | 帶注解的元素必須是Null |
| @Past | 帶注解的元素必須是過去的某個時刻、日期或時間 |
| @Pattern | 帶注解的元素必須符合指定的正則表達式 |
| @Size | 帶注解的元素必須大于等于指定的最小值,小于等于指定的最大值 |
| 帶注解的元素必須是格式良好的電子郵箱地址 | |
| @NotEmpty | 帶注解的元素不能是空,String類型不能為null,Array、Map不能為空,切size/length大于0 |
| @NotBlank | 字符串不能為空、空字符串、全空格 |
| @URL | 字符串必須是一個URL |
@Valid注解規(guī)范用戶請求的參數
業(yè)務場景
對于一個用戶的注冊操作(Post請求),往往涉及到賬號(username)、密碼(password)的Post提交:
//用戶發(fā)送POST請求創(chuàng)建新的用戶
@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;
}業(yè)務出現(xiàn)的問題
但用戶往往會不小心提交了空的密碼來注冊,這是不允許的,因此我們往往需要對用戶提交的密碼信息進行空判斷,常見的方法是直接進行if語句的空判斷:
//用戶發(fā)送POST請求創(chuàng)建新的用戶
@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語句都需要修改,可維護性就變得很差。
優(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方法的參數中加入@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
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
基于JWT的spring boot權限驗證技術實現(xiàn)教程
這篇文章主要給大家介紹了關于基于JWT的spring boot權限驗證技術實現(xiàn)的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-11-11
Spring AI集成DeepSeek三步搞定Java智能應用的詳細過程
本文介紹了如何使用SpringAI集成DeepSeek,一個國內頂尖的多模態(tài)大模型,SpringAI提供了一套統(tǒng)一的接口,簡化了與不同AI模型的集成,通過配置文件和簡單的接口調用,開發(fā)者可以方便地使用DeepSeek進行數學推理、代碼生成等任務,感興趣的朋友一起看看吧2025-03-03
mybatisplus 多表關聯(lián)條件分頁查詢的實現(xiàn)
本文主要介紹了mybatisplus 多表關聯(lián)條件分頁查詢的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2025-01-01
關于IDEA 2020使用 mybatis-log-plugin插件的問題
這篇文章主要介紹了關于IDEA 2020使用 mybatis-log-plugin插件的問題,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-11-11

