@Validated可以幫助我們對(duì)接口的請(qǐng)求參數(shù)進(jìn)行判斷蕴茴,幫助我們對(duì)參數(shù)進(jìn)行約束劝评,可以用在類、方法和屬性上倦淀。
常用的參數(shù)注解示例:
import javax.validation.constraints.*;
import java.util.Date;
// 帶注釋的元素只能為null
@Null(message = "用戶名有誤")
// 帶注釋的元素不能為null
@NotNull(message = "用戶名有誤")
// 帶注釋的元素不能為null 也不能為空 CharSequence類型計(jì)算字符序列的長(zhǎng)度 Collection類型評(píng)估集合大小 Map類型估計(jì)映射大小 Array類型評(píng)估數(shù)組長(zhǎng)度
@NotEmpty(message = "用戶名有誤")
// 帶注釋的元素不能為null 并且必須至少包含一個(gè)非空白字符
@NotBlank(message = "用戶名有誤")
String username;
// 帶注釋的元素必須為false蒋畜。支持的類型有 boolean 和 boolean null的元素被認(rèn)為是有效的
@AssertFalse(message = "該用戶為會(huì)員")
// 帶注釋的元素必須為true。支持的類型有 boolean 和 boolean null的元素被認(rèn)為是有效的
@AssertTrue(message = "該用戶非會(huì)員")
Boolean VIP;
// 帶注釋的元素必須是一個(gè)數(shù)字撞叽,其值必須小于或等于指定的最大值 支持的類型有:BigDecimal姻成、BigInteger、CharSequence愿棋、byte科展、short、int糠雨、long及其各自的包裝器 null的元素被認(rèn)為是有效的
@DecimalMax(value = "130", message = "年齡有誤")
// 帶注釋的元素必須是一個(gè)數(shù)字才睹,其值必須大于或等于指定的最小值 支持的類型有:BigDecimal、BigInteger、CharSequence琅攘、byte垮庐、short、int坞琴、long及其各自的包裝器 null的元素被認(rèn)為是有效的
@DecimalMin(value = "0", message = "年齡有誤")
/*
帶注釋的元素必須是可接受范圍內(nèi)的數(shù)字 支持的類型有:BigDecimal哨查、BigInteger、CharSequence置济、byte解恰、short、int和long浙于,并且它們各自的包裝類型 null的元素被認(rèn)為是有效的
integer 返回此數(shù)字可接受的最大整數(shù)位數(shù)
fraction 返回此數(shù)字可接受的最小整數(shù)位數(shù)
*/
@Digits(integer = 3, fraction = 1, message = "年齡有誤")
// 帶注釋的元素必須是一個(gè)數(shù)字护盈,其值必須小于或等于指定的最大值。支持的類型包括:BigDecimal羞酗、BigInteger腐宋、byte、short檀轨、int和long胸竞,并且它們各自的包裝類型
@Max(value = 130, message = "年齡有誤")
// 帶注釋的元素必須是一個(gè)數(shù)字,其值必須大于或等于指定的最小值参萄。支持的類型包括:BigDecimal卫枝、BigInteger、byte讹挎、short校赤、int和long,并且它們各自的包裝類型
@Min(value = 0, message = "年齡有誤")
// 帶注釋的元素必須是一個(gè)嚴(yán)格的負(fù)數(shù) 即0被視為無(wú)效值 支持的類型包括:BigDecimal筒溃、BigInteger马篮、byte、short怜奖、int浑测、long、float歪玲、double以及它們各自的包裝類型
@Negative
// 帶注釋的元素必須是一個(gè)嚴(yán)格意義上的正數(shù) 即0被視為無(wú)效值 支持的類型包括:BigDecimal迁央、BigInteger、byte滥崩、short岖圈、int、long夭委、float幅狮、double以及它們各自的包裝類型
@Positive
// 帶注釋的元素必須是負(fù)數(shù)或0 支持的類型包括:BigDecimal、BigInteger株灸、byte崇摄、short、int慌烧、long逐抑、float、double以及它們各自的包裝類型
@NegativeOrZero
// 帶注釋的元素必須是正數(shù)或0 支持的類型包括:BigDecimal屹蚊、BigInteger厕氨、byte、short汹粤、int命斧、long、float嘱兼、double以及它們各自的包裝類型
@PositiveOrZero
/*
帶注釋的元素大小必須介于指定的邊界(包括邊界)之間国葬。
min 返回大小元素必須大于或等于
max 返回大小元素必須小于或等于
*/
@Size(min = 0, max = 100)
Integer age;
// 字符串必須是格式正確的電子郵件地址。構(gòu)成有效電子郵件地址的確切語(yǔ)義留給雅加達(dá)Bean驗(yàn)證提供商芹壕。接受CharSequence類型 null的元素被認(rèn)為是有效的
@Email(message = "郵箱格式有誤")
String Email;
// 帶注釋的元素必須是將來(lái)的即時(shí)汇四、日期或時(shí)間 支持的類型包括:Date、Calendar踢涌、LocalDate通孽、LocalDateTime、LocalTime睁壁、MonthDay背苦、OffsetDateTime、OffsetTime堡僻、Year糠惫、YearMonth、ZonedDateTime
@Future(message = "預(yù)定時(shí)間有誤")
// 帶注釋的元素必須是過(guò)去的即時(shí)钉疫、日期或時(shí)間 支持的類型包括:Date硼讽、Calendar、LocalDate牲阁、LocalDateTime固阁、LocalTime、MonthDay城菊、OffsetDateTime备燃、OffsetTime、Year凌唬、YearMonth并齐、ZonedDateTime
@Past
Date scheduledTime;
// 帶注釋的元素必須與指定的正則表達(dá)式匹配。正則表達(dá)式遵循Java正則表達(dá)式約定請(qǐng) null元素被認(rèn)為是有效的
@Pattern(regexp = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手機(jī)號(hào)碼有誤")
Integer mobilePhoneNumber;
上述示例一個(gè)元素上有多個(gè)注解僅為展示作用,實(shí)際編寫(xiě)代碼是一個(gè)足以况褪,但是像
@Max
和@Min
等有的注解可以組合使用
使用該注解需要做一個(gè)全局異常捕捉撕贞,不使用全局異常捕捉報(bào)錯(cuò):
2023-06-06 16:24:00.000 WARN 9796 --- [nio-8080-exec-3] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public java.lang.String com.iyunfish.shoujifeng.advice.UserVO: [Field error in object 'UserVO' on field 'username': rejected value [null]; codes [NotBlank.UserVO.username,NotBlank.username,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [UserVO.username,username]; arguments []; default message [username]]; default message [用戶名有誤]] ]
不太好看并且也不實(shí)用,所以需要添加異常捕捉并且記錄下問(wèn)題并打印日志
import com.iyunfish.shoujifeng.response.Response;
import org.springframework.http.HttpStatus;
import org.springframework.validation.*;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/********************************************************************************
** date:2023/06/06
** description&desc:全局休息控制器建議
*********************************************************************************/
@ControllerAdvice
public class GlobalRestControllerAdvice {
/**
* 處理@Validated參數(shù)校驗(yàn)失敗異常
*
* @param exception 異常類
* @return {@link Response }<{@link String }>
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public Response<String> exceptionHandler(MethodArgumentNotValidException exception) {
BindingResult result = exception.getBindingResult();
StringBuilder stringBuilder = new StringBuilder();
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
errors.forEach(p -> {
FieldError fieldError = (FieldError) p;
stringBuilder.append(fieldError.getDefaultMessage());
});
}
return Response.fail(stringBuilder.toString());
}
}