Spring Boot 實現各種參數校驗及實現原理,非常實用!
本文會詳細介紹Spring Validation
各種場景下的最佳實踐及其實現原理,死磕到底!
簡單使用
Java API
規範 (JSR303
) 定義了Bean
校驗的標準validation-api
,但沒有提供實現。hibernate validation
是對這個規範的實現,並增加了校驗註解如@Email
、@Length
等。Spring Validation
是對hibernate validation
的二次封裝,用於支持spring mvc
參數自動校驗。接下來,我們以spring-boot
項目爲例,介紹Spring Validation
的使用。
引入依賴
如果spring-boot
版本小於2.3.x
,spring-boot-starter-web
會自動傳入hibernate-validator
依賴。如果spring-boot
版本大於2.3.x
,則需要手動引入依賴:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1.Final</version>
</dependency>
對於web
服務來說,爲防止非法參數對業務造成影響,在Controller
層一定要做參數校驗的!大部分情況下,請求參數分爲如下兩種形式:
-
POST
、PUT
請求,使用requestBody
傳遞參數; -
GET
請求,使用requestParam/PathVariable
傳遞參數。
下面我們簡單介紹下requestBody
和requestParam/PathVariable
的參數校驗實戰!
requestBody
參數校驗
POST
、PUT
請求一般會使用requestBody
傳遞參數,這種情況下,後端使用 ** DTO 對象**進行接收。**只要給 DTO 對象加上@Validated
註解就能實現自動參數校驗 **。比如,有一個保存User
的接口,要求userName
長度是2-10
,account
和password
字段長度是6-20
。如果校驗失敗,會拋出MethodArgumentNotValidException
異常,Spring
默認會將其轉爲400(Bad Request)
請求。
DTO 表示數據傳輸對象(Data Transfer Object),用於服務器和客戶端之間交互傳輸使用的。在 spring-web 項目中可以表示用於接收請求參數的Bean
對象。
- 在**
DTO
字段上聲明約束註解**
@Data
public class UserDTO {
private Long userId;
@NotNull
@Length(min = 2, max = 10)
private String userName;
@NotNull
@Length(min = 6, max = 20)
private String account;
@NotNull
@Length(min = 6, max = 20)
private String password;
}
- 在方法參數上聲明校驗註解
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated UserDTO userDTO) {
return Result.ok();
}
這種情況下,使用**@Valid
和@Validated
都可以**。
requestParam/PathVariable
參數校驗
GET
請求一般會使用requestParam/PathVariable
傳參。如果參數比較多 (比如超過 6 個),還是推薦使用DTO
對象接收。否則,推薦將一個個參數平鋪到方法入參中。在這種情況下,** 必須在Controller
類上標註@Validated
註解,並在入參上聲明約束註解 (如@Min
等)**。如果校驗失敗,會拋出ConstraintViolationException
異常。代碼示例如下:
@RequestMapping("/api/user")
@RestController
@Validated
public class UserController {
@GetMapping("{userId}")
public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
UserDTO userDTO = new UserDTO();
userDTO.setUserId(userId);
userDTO.setAccount("11111111111111111");
userDTO.setUserName("xixi");
userDTO.setAccount("11111111111111111");
return Result.ok(userDTO);
}
@GetMapping("getByAccount")
public Result getByAccount(@Length(min = 6, max = 20) @NotNull String account) {
UserDTO userDTO = new UserDTO();
userDTO.setUserId(10000000000000003L);
userDTO.setAccount(account);
userDTO.setUserName("xixi");
userDTO.setAccount("11111111111111111");
return Result.ok(userDTO);
}
}
統一異常處理
前面說過,如果校驗失敗,會拋出MethodArgumentNotValidException
或者ConstraintViolationException
異常。在實際項目開發中,通常會用統一異常處理來返回一個更友好的提示。比如我們系統要求無論發送什麼異常,http
的狀態碼必須返回200
,由業務碼去區分系統的異常情況。
@RestControllerAdvice
public class CommonExceptionHandler {
@ExceptionHandler({MethodArgumentNotValidException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
BindingResult bindingResult = ex.getBindingResult();
StringBuilder sb = new StringBuilder("校驗失敗:");
for (FieldError fieldError : bindingResult.getFieldErrors()) {
sb.append(fieldError.getField()).append(":").append(fieldError.getDefaultMessage()).append(", ");
}
String msg = sb.toString();
return Result.fail(BusinessCode.參數校驗失敗, msg);
}
@ExceptionHandler({ConstraintViolationException.class})
@ResponseStatus(HttpStatus.OK)
@ResponseBody
public Result handleConstraintViolationException(ConstraintViolationException ex) {
return Result.fail(BusinessCode.參數校驗失敗, ex.getMessage());
}
}
進階使用
分組校驗
在實際項目中,可能多個方法需要使用同一個DTO
類來接收參數,而不同方法的校驗規則很可能是不一樣的。這個時候,簡單地在DTO
類的字段上加約束註解無法解決這個問題。因此,spring-validation
支持了分組校驗的功能,專門用來解決這類問題。還是上面的例子,比如保存User
的時候,UserId
是可空的,但是更新User
的時候,UserId
的值必須>=10000000000000000L
;其它字段的校驗規則在兩種情況下一樣。這個時候使用分組校驗的代碼示例如下:
- 約束註解上聲明適用的分組信息**
groups
**
@Data
public class UserDTO {
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String userName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String account;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String password;
public interface Save {
}
public interface Update {
}
}
@Validated
註解上指定校驗分組
@PostMapping("/save")
public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
return Result.ok();
}
@PostMapping("/update")
public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
return Result.ok();
}
嵌套校驗
前面的示例中,DTO
類裏面的字段都是基本數據類型
和String
類型。但是實際場景中,有可能某個字段也是一個對象,這種情況先,可以使用嵌套校驗
。
比如,上面保存User
信息的時候同時還帶有Job
信息。需要注意的是,此時**DTO
類的對應字段必須標記@Valid
註解**。
@Data
public class UserDTO {
@Min(value = 10000000000000000L, groups = Update.class)
private Long userId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String userName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String account;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 6, max = 20, groups = {Save.class, Update.class})
private String password;
@NotNull(groups = {Save.class, Update.class})
@Valid
private Job job;
@Data
public static class Job {
@Min(value = 1, groups = Update.class)
private Long jobId;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String jobName;
@NotNull(groups = {Save.class, Update.class})
@Length(min = 2, max = 10, groups = {Save.class, Update.class})
private String position;
}
public interface Save {
}
public interface Update {
}
}
嵌套校驗可以結合分組校驗一起使用。還有就是嵌套集合校驗
會對集合裏面的每一項都進行校驗,例如List<Job>
字段會對這個list
裏面的每一個Job
對象都進行校驗。
集合校驗
如果請求體直接傳遞了json
數組給後臺,並希望對數組中的每一項都進行參數校驗。此時,如果我們直接使用java.util.Collection
下的list
或者set
來接收數據,參數校驗並不會生效!我們可以使用自定義list
集合來接收參數:
- 包裝**
List
類型,並聲明@Valid
註解**
public class ValidationList<E> implements List<E> {
@Delegate
@Valid
public List<E> list = new ArrayList<>();
@Override
public String toString() {
return list.toString();
}
}
@Delegate
註解受lombok
版本限制,1.18.6
以上版本可支持。如果校驗不通過,會拋出NotReadablePropertyException
,同樣可以使用統一異常進行處理。
比如,我們需要一次性保存多個User
對象,Controller
層的方法可以這麼寫:
@PostMapping("/saveList")
public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) {
return Result.ok();
}
自定義校驗
業務需求總是比框架提供的這些簡單校驗要複雜的多,我們可以自定義校驗來滿足我們的需求。自定義spring validation
非常簡單,假設我們自定義加密id
(由數字或者a-f
的字母組成,32-256
長度)校驗,主要分爲兩步:
- 自定義約束註解
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {EncryptIdValidator.class})
public @interface EncryptId {
String message() default "加密id格式錯誤";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
- 實現
ConstraintValidator
接口編寫約束校驗器
public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> {
private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$");
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (value != null) {
Matcher matcher = PATTERN.matcher(value);
return matcher.find();
}
return true;
}
}
這樣我們就可以使用@EncryptId
進行參數校驗了!
編程式校驗
上面的示例都是基於註解
來實現自動校驗的,在某些情況下,我們可能希望以編程方式
調用驗證。這個時候可以注入javax.validation.Validator
對象,然後再調用其api
。
@Autowired
private javax.validation.Validator globalValidator;
@PostMapping("/saveWithCodingValidate")
public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) {
Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);
if (validate.isEmpty()) {
} else {
for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {
System.out.println(userDTOConstraintViolation);
}
}
return Result.ok();
}
快速失敗 (Fail Fast)
Spring Validation
默認會校驗完所有字段,然後才拋出異常。可以通過一些簡單的配置,開啓Fali Fast
模式,一旦校驗失敗就立即返回。
@Bean
public Validator validator() {
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
.failFast(true)
.buildValidatorFactory();
return validatorFactory.getValidator();
}
@Valid
和@Validated
區別
實現原理
requestBody
參數校驗實現原理
在spring-mvc
中,RequestResponseBodyMethodProcessor
是用於解析@RequestBody
標註的參數以及處理@ResponseBody
標註方法的返回值的。顯然,執行參數校驗的邏輯肯定就在解析參數的方法resolveArgument()
中:
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
@Override
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
parameter = parameter.nestedIfOptional();
Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
String name = Conventions.getVariableNameForParameter(parameter);
if (binderFactory != null) {
WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
if (arg != null) {
validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
}
}
if (mavContainer != null) {
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
}
}
return adaptArgumentIfNecessary(arg, parameter);
}
}
可以看到,resolveArgument()
調用了validateIfApplicable()
進行參數校驗。
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
Annotation[] annotations = parameter.getParameterAnnotations();
for (Annotation ann : annotations) {
Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
binder.validate(validationHints);
break;
}
}
}
看到這裏,大家應該能明白爲什麼這種場景下@Validated
、@Valid
兩個註解可以混用。我們接下來繼續看WebDataBinder.validate()
實現。
@Override
public void validate(Object target, Errors errors, Object... validationHints) {
if (this.targetValidator != null) {
processConstraintViolations(
this.targetValidator.validate(target, asValidationGroups(validationHints)), errors);
}
}
最終發現底層最終還是調用了Hibernate Validator
進行真正的校驗處理。
方法級別的參數校驗實現原理
上面提到的將參數一個個平鋪到方法參數中,然後在每個參數前面聲明約束註解
的校驗方式,就是方法級別的參數校驗。實際上,這種方式可用於任何Spring Bean
的方法上,比如Controller
/Service
等。其底層實現原理就是**AOP
,具體來說是通過MethodValidationPostProcessor
動態註冊AOP
切面,然後使用MethodValidationInterceptor
對切點方法織入增強**。
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean {
@Override
public void afterPropertiesSet() {
Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
}
protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
}
}
接着看一下MethodValidationInterceptor
:
public class MethodValidationInterceptor implements MethodInterceptor {
@Override
public Object invoke(MethodInvocation invocation) throws Throwable {
if (isFactoryBeanMetadataMethod(invocation.getMethod())) {
return invocation.proceed();
}
Class<?>[] groups = determineValidationGroups(invocation);
ExecutableValidator execVal = this.validator.forExecutables();
Method methodToValidate = invocation.getMethod();
Set<ConstraintViolation<Object>> result;
try {
result = execVal.validateParameters(
invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
}
catch (IllegalArgumentException ex) {
...
}
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
Object returnValue = invocation.proceed();
result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
return returnValue;
}
}
實際上,不管是**requestBody參數校驗
還是方法級別的校驗
,最終都是調用Hibernate Validator
執行校驗,Spring Validation
只是做了一層封裝**。
作者:夜盡天明_
https://juejin.cn/post/6856541106626363399
本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源:https://mp.weixin.qq.com/s/JEATI5wYUF9ocHa45Li-bA