詳解Spring注解@Validated 失效分析
Controller 中使用 @Validated
@Validated 注解的作用這里就不多做介紹了,具體用法在網(wǎng)上應(yīng)該有不少。
在之前使用 MVC 架構(gòu)編碼時,通常是將 @Validated 注解或者 @Valid 配置在 Controller 的方法中,如下代碼所示:
@PostMapping("common/set")
public Response<?> setCommonSetting(@RequestBody @Validated SetCommonSettingReqVO reqVO) {
//doSomeThings
return Response.success();
}所以在配置應(yīng)用層校驗時,就想當(dāng)然的按照類似的寫法:
public void addClueTrack(@Validated AddClueTrackCommand command) {
//doSomeThings
}結(jié)果可想而知,@Validated 注解并不生效。
@Validated 是怎么生效的?
竟然不生效,那么就開始分析原因。
首先可以很容易想到,竟然能在方法執(zhí)行前就攔截進行校驗,那么大概率是使用動態(tài)代理。就和 @Transactional 事務(wù)注解一樣,底層都是基于 AOP 實現(xiàn)動態(tài)代理。
接下來為了印證這個想法,就是需要深入看看 Spring 實現(xiàn)的。通過 IDE 可以很方便看到有哪些地方引用了 @Validated 注解:

其中一個類名一下就引起了我的注意 MethodValidationPostProcessor,熟悉 Spring 的小伙伴應(yīng)該知道,Spring 中有很多 BeanPostProcessor 用于擴展 Bean,Aop 便是基于此實現(xiàn)動態(tài)代理的。點進去一看,果不其然:
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessor
implements InitializingBean {
private Class<? extends Annotation> validatedAnnotationType = Validated.class;
@Nullable
private Validator validator;
//...
@Override
public void afterPropertiesSet() {
//創(chuàng)建切點
Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
}
protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
//創(chuàng)建攔截器
return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
}
}
public class AnnotationMatchingPointcut implements Pointcut {
private final ClassFilter classFilter;
private final MethodMatcher methodMatcher;
public AnnotationMatchingPointcut(Class<? extends Annotation> classAnnotationType, boolean checkInherited) {
//切點只針對類級別
this.classFilter = new AnnotationClassFilter(classAnnotationType, checkInherited);
this.methodMatcher = MethodMatcher.TRUE;
}
//...
}MethodValidationPostProcessor 中創(chuàng)建了一個切點,過濾類上添加了 @Validated 的 Bean,只要滿足此條件,就會根據(jù) MethodValidationInterceptor 生成對應(yīng)的代理類。嗯,和 @Transactional 的實現(xiàn)原理差不多。
ok,看到這里我就在應(yīng)用服務(wù)實現(xiàn)上添加了 @Validated 注解,那么此時注解生效了嗎?哈哈,進度條還沒過半呢??
理論上類上加上 @Validated 注解,應(yīng)該會生成動態(tài)代理類的,竟然沒成功進行參數(shù)校驗,我能想到的原因有二:
1. MethodValidationPostProcessor 沒注入到 BeanFactory 中,所以沒生成對應(yīng)的代理類 2. MethodValidationInterceptor 對還有其他需要滿足的條件,而目前還未滿足
這里先劇透一下,答案是 2 ??
MethodValidationInterceptor需要滿足什么條件
竟然答案是2,那這里就先講一下 MethodValidationInterceptor,MethodValidationPostProcessor 是怎么注冊到容器的咱們后面再來講。
ExecutableValidatorpublic class MethodValidationInterceptor implements MethodInterceptor {
private final Validator validator;
@Override
@Nullable
public Object invoke(MethodInvocation invocation) throws Throwable {
// Standard Bean Validation 1.1 API
ExecutableValidator execVal = this.validator.forExecutables();
Method methodToValidate = invocation.getMethod();
Set<ConstraintViolation<Object>> result;
//獲取類本身的實例(非代理類),請記住這里,這里就是和 Controller 最大的區(qū)別
Object target = invocation.getThis();
Assert.state(target != null, "Target must not be null");
try {
//執(zhí)行參數(shù)校驗,校驗的是當(dāng)前類,也就是說校驗的是 Bean 對應(yīng)的類
result = execVal.validateParameters(target, methodToValidate, invocation.getArguments(), groups);
}
catch (IllegalArgumentException ex) {
//doSomeThings
}
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
//執(zhí)行方法
Object returnValue = invocation.proceed();
//校驗返回值
result = execVal.validateReturnValue(target, methodToValidate, returnValue, groups);
if (!result.isEmpty()) {
throw new ConstraintViolationException(result);
}
return returnValue;
}
}接下來就要看看 ExecutableValidator.validateParameters 這個方法是如何實現(xiàn)的,為了方便閱讀,這里我只保留了部分核心代碼。根據(jù)包名我們大概也能猜到 ExecutableValidator.validateParameters 是 hibernate-validator 包提供的方法,而 @Validated 注解是由 Spring 提供的,所以不生效也就正常了。接下來我們繼續(xù)往下走,我這里只貼部分核心的代碼,中間的棧路徑可以根據(jù)以下這個路徑往下走:
/**
* --> org.hibernate.validator.internal.engine.ValidatorImpl#validateParameters
* --> org.hibernate.validator.internal.metadata.BeanMetaDataManager#getBeanMetaData
* --> org.hibernate.validator.internal.metadata.BeanMetaDataManagerImpl#createBeanMetaData
* --> org.hibernate.validator.internal.metadata.BeanMetaDataManagerImpl#getBeanConfigurationForHierarchy
* --> org.hibernate.validator.internal.metadata.provider.MetaDataProvider#getBeanConfiguration
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#retrieveBeanConfiguration
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#getFieldMetaData
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#findPropertyMetaData
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#findConstraints
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#findCascadingMetaData
* <-- ...
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#getMethodMetaData
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#getConstructorMetaData
* --> org.hibernate.validator.internal.metadata.provider.AnnotationMetaDataProvider#getClassLevelConstraints
* <-- ...
* --> org.hibernate.validator.internal.metadata.aggregated.BeanMetaData#hasConstraints
* --> org.hibernate.validator.internal.engine.ValidatorImpl#validateParametersInContext
*
*/
public class ValidatorImpl implements Validator, ExecutableValidator {
@Override
public final <T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, Class<?>... groups) {
Contracts.assertNotNull( beanType, MESSAGES.beanTypeCannotBeNull() );
sanityCheckPropertyPath( propertyName );
sanityCheckGroups( groups );
//獲取 bean 及其父類、超類的
BeanMetaData<T> rootBeanMetaData = beanMetaDataManager.getBeanMetaData( beanType );
//判斷該 bean 是否有約束
if ( !rootBeanMetaData.hasConstraints() ) {
return Collections.emptySet();
}
PathImpl propertyPath = PathImpl.createPathFromString( propertyName );
BaseBeanValidationContext<T> validationContext = getValidationContextBuilder().forValidateValue( beanType, rootBeanMetaData, propertyPath );
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
//校驗參數(shù)
return validateValueInContext(validationContext, value, propertyPath, validationOrder);
}
//...
}
當(dāng)我調(diào)試到 rootBeanMetaData.hasConstraints() 時,判斷沒有約束,然后就直接返回了沒有進行參數(shù)校驗。我就想說看看是如何判斷 Bean 是否有約束的,于是就返回上層進入 beanMetaDataManager.getBeanMetaData 中看,結(jié)果發(fā)現(xiàn)里面的代碼有夠復(fù)雜的??
public class AnnotationMetaDataProvider implements MetaDataProvider {
//獲取類上所有的約束條件
private <T> BeanConfiguration<T> retrieveBeanConfiguration(Class<T> beanClass) {
//獲取字段上的約束條件
Set<ConstrainedElement> constrainedElements = getFieldMetaData( beanClass );
//獲取方法上的約束條件(包括參數(shù)、返回值)
constrainedElements.addAll( getMethodMetaData( beanClass ) );
//獲取構(gòu)造函數(shù)
constrainedElements.addAll( getConstructorMetaData( beanClass ) );
//獲取類上的約束條件
Set<MetaConstraint<?>> classLevelConstraints = getClassLevelConstraints( beanClass );
if ( !classLevelConstraints.isEmpty() ) {
ConstrainedType classLevelMetaData =
new ConstrainedType(ConfigurationSource.ANNOTATION, beanClass, classLevelConstraints);
constrainedElements.add( classLevelMetaData );
}
return new BeanConfiguration<>(ConfigurationSource.ANNOTATION, beanClass, constrainedElements, getDefaultGroupSequence( beanClass ), getDefaultGroupSequenceProvider( beanClass ));
}
//查找約束注解
protected <A extends Annotation> List<ConstraintDescriptorImpl<?>> findConstraintAnnotations(Constrainable constrainable, A annotation, ConstraintLocationKind type) {
//如果包含 "jdk.internal" and "java" 下的注解,則直接不進行校驗
if ( constraintCreationContext.getConstraintHelper().isJdkAnnotation( annotation.annotationType() ) ) {
return Collections.emptyList();
}
List<Annotation> constraints = newArrayList();
Class<? extends Annotation> annotationType = annotation.annotationType();
//判斷是否有約束條件,也就我們經(jīng)常配置的 @NotNull,@Min 這類注解
if ( constraintCreationContext.getConstraintHelper().isConstraintAnnotation( annotationType ) ) {
constraints.add( annotation );
}
//這個沒用過,暫時跳過
else if ( constraintCreationContext.getConstraintHelper().isMultiValueConstraint( annotationType ) ) {
constraints.addAll( constraintCreationContext.getConstraintHelper().getConstraintsFromMultiValueConstraint( annotation ) );
}
return constraints.stream()
.map( c -> buildConstraintDescriptor( constrainable, c, type ) )
.collect( Collectors.toList() );
}
//構(gòu)建級聯(lián)元數(shù)據(jù)構(gòu)造器,也就是我們常用的 @Valid,在 Bean 中如果我們要對對象屬性進行校驗,
//需要在該屬性上添加 @Valid,此處便是如此
private CascadingMetaDataBuilder getCascadingMetaData(JavaBeanAnnotatedElement annotatedElement, Map<TypeVariable<?>, CascadingMetaDataBuilder> containerElementTypesCascadingMetaData) {
return CascadingMetaDataBuilder.annotatedObject( annotatedElement.getType(), annotatedElement.isAnnotationPresent( Valid.class ),
containerElementTypesCascadingMetaData, getGroupConversions( annotatedElement.getAnnotatedType() ) );
}
}
順著上面的棧路徑一直往下走,最終發(fā)現(xiàn)最核心的幾個方法是 getFieldMetaData、getMethodMetaData、getConstructorMetaData、getClassLevelConstraints,這個幾方法都是用于獲取約束和級聯(lián)元數(shù)據(jù)。那么里面到底是怎么獲取約束元數(shù)據(jù)的呢,咱繼續(xù)往里鉆,可以看到最終調(diào)用了 findConstraintAnnotations 獲取約束元數(shù)據(jù),也就是我們平時用到的 @NotNull,@Min 等注解,通過 getCascadingMetaData 獲取級聯(lián)元數(shù)據(jù),也就是 @Valid 注解??吹竭@,是不是很容易就能想到,知道我加上 @Valid 就能成功校驗了呢?
于是我嘗試了一波,果然沒問題。嗯~ 長見識了??。由于時間有限,ValidatorImpl.validateParametersInContext() 方法我就沒有深入進去看了。感興趣的小伙伴可以自行去看看!!??
那么 Controller 為啥直接添加@Validated 或者 @Valid 就可以呢?
明白了在應(yīng)用服務(wù)實現(xiàn),準(zhǔn)確的說應(yīng)該是普通 Bean 中應(yīng)該怎么配置之 @Validated 和 @Valid 使其生效之后,我就很好奇為啥 Controller 只需要單獨在方法上配置 @Validated 或者 @Valid 就能成功校驗?zāi)兀?/p>
還記得上面通過 IDE 查看應(yīng)用 @Validated 注解的類時,我們發(fā)現(xiàn)了 MethodValidationPostProcessor,還有另外幾個類一看就很像 Controller 參數(shù)解析相關(guān)的類:

我在這幾個類上各打了一個斷點,最終進入的是 AbstractMessageConverterMethodArgumentResolver。
ok,那就看看他是怎么實現(xiàn)的,這里只貼了很參數(shù)校驗相關(guān)的方法:
public abstract class AbstractMessageConverterMethodArgumentResolver implements HandlerMethodArgumentResolver {
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
Annotation[] annotations = parameter.getParameterAnnotations();
for (Annotation ann : annotations) {
//獲取分組信息
Object[] validationHints = ValidationAnnotationUtils.determineValidationHints(ann);
if (validationHints != null) {
//進行校驗
binder.validate(validationHints);
break;
}
}
}
}
public abstract class ValidationAnnotationUtils {
@Nullable
public static Object[] determineValidationHints(Annotation ann) {
Class<? extends Annotation> annotationType = ann.annotationType();
String annotationName = annotationType.getName();
//如果是 @valid 注解直接返回一個空數(shù)組
if ("javax.validation.Valid".equals(annotationName)) {
return EMPTY_OBJECT_ARRAY;
}
//如果是 @validated 則返回其分組信息
Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
if (validatedAnn != null) {
Object hints = validatedAnn.value();
return convertValidationHints(hints);
}
if (annotationType.getSimpleName().startsWith("Valid")) {
Object hints = AnnotationUtils.getValue(ann);
return convertValidationHints(hints);
}
return null;
}
}
public class DataBinder implements PropertyEditorRegistry, TypeConverter {
public void validate(Object... validationHints) {
//此處是關(guān)鍵所在,這里獲取的是參數(shù)!??!和普通的 Bean 獲取到的卻是 Bean 本身
Object target = getTarget();
Assert.state(target != null, "No target to validate");
BindingResult bindingResult = getBindingResult();
// Call each validator with the same binding result
for (Validator validator : getValidators()) {
if (!ObjectUtils.isEmpty(validationHints) && validator instanceof SmartValidator) {
((SmartValidator) validator).validate(target, bindingResult, validationHints);
}
else if (validator != null) {
validator.validate(target, bindingResult);
}
}
}
}可以看到,對于 Controller 不論是直接在參數(shù)上加上 @Validated 或者 @Valid 注解,都會進入到校驗方法,而且校驗的就是參數(shù)?。?!而 Bean 校驗的卻是 Bean 本身?。。?/strong>
MethodValidationPostProcessor 和 AbstractMessageConverterMethodArgumentResolver 是怎么被注冊到 BeanFactory 的?
明白了 @Validated 的攔截實現(xiàn)的原理后,那么就只剩最后一個問題了,MethodValidationPostProcessor 和 AbstractMessageConverterMethodArgumentResolver 是怎么被注冊到 BeanFactory 的。
其實不用看源碼大概有也能猜到是 Spring Boot 自動裝配的。為了印證一下,我還是貼一下源碼:
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ExecutableValidator.class)
@ConditionalOnResource(resources = "classpath:META-INF/services/javax.validation.spi.ValidationProvider")
@Import(PrimaryDefaultValidatorPostProcessor.class)
public class ValidationAutoConfiguration {
//...
@Bean
@ConditionalOnMissingBean
public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, @Lazy Validator validator, ObjectProvider<MethodValidationExcludeFilter> excludeFilters) {
FilteredMethodValidationPostProcessor processor = new FilteredMethodValidationPostProcessor(excludeFilters.orderedStream());
boolean proxyTargetClass = environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true);
processor.setProxyTargetClass(proxyTargetClass);
processor.setValidator(validator);
return processor;
}
}另外就是 AbstractMessageConverterMethodArgumentResolver 的幾個實現(xiàn)類,均由 RequestMappingHandlerAdapter 實例化,而 RequestMappingHandlerAdapter 大家知道有 WebMvcAutoConfiguration 自動裝配,時間原因,這就不看了。

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
implements BeanFactoryAware, InitializingBean {
private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<>(30);
// Annotation-based argument resolution
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
resolvers.add(new RequestParamMapMethodArgumentResolver());
resolvers.add(new PathVariableMethodArgumentResolver());
resolvers.add(new PathVariableMapMethodArgumentResolver());
resolvers.add(new MatrixVariableMethodArgumentResolver());
resolvers.add(new MatrixVariableMapMethodArgumentResolver());
resolvers.add(new ServletModelAttributeMethodProcessor(false));
resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters(), this.requestResponseBodyAdvice));
resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
resolvers.add(new RequestHeaderMapMethodArgumentResolver());
resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
resolvers.add(new SessionAttributeMethodArgumentResolver());
resolvers.add(new RequestAttributeMethodArgumentResolver());
// Type-based argument resolution
resolvers.add(new ServletRequestMethodArgumentResolver());
resolvers.add(new ServletResponseMethodArgumentResolver());
resolvers.add(new HttpEntityMethodProcessor(getMessageConverters(), this.requestResponseBodyAdvice));
resolvers.add(new RedirectAttributesMethodArgumentResolver());
resolvers.add(new ModelMethodProcessor());
resolvers.add(new MapMethodProcessor());
resolvers.add(new ErrorsMethodArgumentResolver());
resolvers.add(new SessionStatusMethodArgumentResolver());
resolvers.add(new UriComponentsBuilderMethodArgumentResolver());
if (KotlinDetector.isKotlinPresent()) {
resolvers.add(new ContinuationHandlerMethodArgumentResolver());
}
// Custom arguments
if (getCustomArgumentResolvers() != null) {
resolvers.addAll(getCustomArgumentResolvers());
}
// Catch-all
resolvers.add(new PrincipalMethodArgumentResolver());
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
resolvers.add(new ServletModelAttributeMethodProcessor(true));
return resolvers;
}
}小結(jié)
1、在普通 Bean 中如果要通過注解的方式使用 hibernate-validator 進行校驗的話,需要在類上添加 @Validated 注解,同時在方法上添加 @Valid 注解?;蛘咭部梢灾苯邮褂?@NotNull 等注解。
2、普通 Bean 使用 @Validated 是通過動態(tài)代理完成的。具體的攔截器便是他 MethodValidationInterceptor。
3、Controller 層之所以能 @Validated 和 @Valid 二選一,是因為校驗的是參數(shù)本身,而普通 Bean 校驗的是 Bean 本身。
4、至此,相信大家就不會沒配置好 @Validated 導(dǎo)致失效了。
到此這篇關(guān)于詳解Spring注解@Validated 失效分析的文章就介紹到這了,更多相關(guān)Spring注解@Validated失效內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
spring boot 測試單元修改數(shù)據(jù)庫不成功的解決
這篇文章主要介紹了spring boot 測試單元修改數(shù)據(jù)庫不成功的解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09
Spring-boot oauth2使用RestTemplate進行后臺自動登錄的實現(xiàn)
這篇文章主要介紹了Spring-boot oauth2使用RestTemplate進行后臺自動登錄的實現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
解讀Spring定義Bean的兩種方式:<bean>和@Bean
這篇文章主要介紹了Spring定義Bean的兩種方式:<bean>和@Bean,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-04-04

