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