主要用途
主要用于表單驗證,減輕了代碼量
相關(guān)依賴
implementation 'org.springframework.boot:spring-boot-starter-web'
在Springboot啟動器的web包下包含了javax.validation.Valid所以無需添加多余的依賴
Valid相關(guān)注解的使用方式
1.在相關(guān)的實體類的相關(guān)字段添加用于充當(dāng)驗證條件的注解
示例:
- 字段:
(ps:這里只是為了演示,大家要注意命名規(guī)范)
@NotNull(message = "用戶名不能為空")
@Email(message = "郵箱不正確")
private String username;
- 實體類
@Data
@AllArgsConstructor
@NoArgsConstructor
public class RegisterUser {
@Min(value = 1000000)
@NotNull(message = "ID不能為空")
private Long userId;
@NotNull(message = "用戶名不能為空")
@Email(message = "郵箱不正確")
private String username;
/**
* 教師職稱
*/
private String position;
/**
* 教師所屬教研室
*/
private String office;
}
2.在controller層的方法的要校驗的參數(shù)上添加@Valid注解
@PostMapping("/action/register")
public Result registerByForm(@Valid @RequestBody RegisterUser registerUser){
return userService.register(registerUser);
}
3.編寫全局異常捕捉類
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
private final static String EXCEPTION_MSG_KEY = "Exception message : ";
@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
public Result handleValidException(MethodArgumentNotValidException e){
//日志記錄錯誤信息
log.error(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
//將錯誤信息返回給前臺
return Result.error(103, Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage());
}
}
相關(guān)代碼類
- Result類
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Result<T> {
private Integer code;
private String message;
private T data;
public Result() {
this.code = 200;
this.message = "操作成功";
}
/**
* 用于錯誤處理
* @param code 錯誤碼
* @param message 錯誤提示信息
*/
public Result(Integer code,String message){
this.code = code;
this.message = message;
}
public static Result<String> error(Integer code,String msg){
return new Result<>(code,msg);
}
}
非法字段驗證結(jié)果
相關(guān)注解
@Null 限制只能為null
@NotNull 限制必須不為null
@AssertFalse 限制必須為false
@AssertTrue 限制必須為true
@DecimalMax(value) 限制必須為一個不大于指定值的數(shù)字
@DecimalMin(value) 限制必須為一個不小于指定值的數(shù)字
@Digits(integer,fraction) 限制必須為一個小數(shù)，且整數(shù)部分的位數(shù)不能超過integer，小數(shù)部分的位數(shù)不能超過fraction
@Future 限制必須是一個將來的日期
@Max(value) 限制必須為一個不大于指定值的數(shù)字
@Min(value) 限制必須為一個不小于指定值的數(shù)字
@Past 限制必須是一個過去的日期
@Pattern(value) 限制必須符合指定的正則表達式
@Size(max,min) 限制字符長度必須在min到max之間
@Past 驗證注解的元素值（日期類型）比當(dāng)前時間早
@NotEmpty 驗證注解的元素值不為null且不為空（字符串長度不為0、集合大小不為0）
@NotBlank 驗證注解的元素值不為空（不為null、去除首位空格后長度為0），不同于@NotEmpty，@NotBlank只應(yīng)用于字符串且在比較時會去除字符串的空格
@Email 驗證注解的元素值是Email，也可以通過正則表達式和flag指定自定義的email格式
需要注意每個注解對應(yīng)的數(shù)據(jù)類型
總結(jié)
在表單驗證的時候,要注意Validation的相關(guān)注解要和表單類的字段相對應(yīng),還是會拋出500的異常(因為這個異常不是MethodArgumentNotValidException異常,里面的信息對用戶也沒有實際的作用)
