SpringBoot2.x—方法参数/返回值的注解版校验(解决方法内事务不生效)

SpringMVC可以使用Validation bean验证框架去校验Controller层请求参数是否符合要求。但是如何在Service层或者dao层去统一的校验方法参数或返回值呢？

注解版参数校验

在书写业务逻辑（service/dao）时，有时会书写大量的参数或返回值校验（例如非空判断），一般有如下两种方式：

  • 采用if...else标签进行校验。即编程式的业务参数校验，将业务逻辑与参数判断整合在一起。
  • 采用注解的方式进行校验，即声明式的业务参数校验。使得业务代码和数据校验解耦。

通过注解来校验service或dao层的方法参数，便是Spring AOP的一种体现。

简易使用流程

环境：SpringBoot2.x，JDK8

import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.NotNull;
import javax.validation.groups.Default;
@Validated(Default.class)
public interface IAccount {
    @NotNull  //返回值不能为null
    String say(@NotNull Integer id, @NotNull String desc);
}

@Service
public class AccountImpl implements IAccount {
    
    public String say(Integer id, String desc) {
        System.out.println(String.format("The id is [%s] ,The desc is [%s]", id, desc));
        return null;
    }
}

@RestController
public class AopController {
    @Autowired
    private IAccount account;

    @RequestMapping("/test")
    public void test1(){
        account.say(1,null);
    }
}

返回结果：

2019-11-18 13:45:12,439 ERROR [33568] [http-nio-8082-exec-1] [] (DirectJDKLog.java:175): Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is javax.validation.ConstraintViolationException: say.desc: 不能为null] with root cause
javax.validation.ConstraintViolationException: say.desc: 不能为null
    at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:116)
    at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
    at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:688)
    at com.tellme.Impl.AccountImpl$$EnhancerBySpringCGLIB$$c934e438.say(<generated>)
    at com.tellme.controller.AopController.test1(AopController.java:32)

若是校验不通过，可以借助全局异常统一处理。可以在ConstraintViolationException的getConstraintViolations方法获取到错误信息。

企业使用流程

上面的例子，我们已经了解到可以通过注解的形式（Spring+AOP）来校验参数、方法值。但是我们应该了解其使用的一些细节。

  1. 若service无接口，那么MethodValidation是否生效。

因为是在Bean初始化时，在后置处理器上解析MethodValidationPostProcessor标签。生成代理对象，所以若service无接口时，会生成cglib代理，依旧可以在方法级别上生效。

  1. 校验注解（@NotNull）可以写在实现类上吗？
public interface IAccount {
    String say( Integer id,  String desc);
}

@Validated(Default.class)
@Service
public class AccountImpl implements IAccount {
    public @NotNull String say(@NotNull Integer id, String desc) {
        System.out.println(String.format("The id is [%s] ,The desc is [%s]", id, desc));
        return null;
    }
}

异常原因：重写另一个方法的方法不能重新定义参数的约束规则。

javax.validation.ConstraintDeclarationException: HV000151: A method overriding another method must not redefine the parameter constraint configuration, but method AccountImpl

在上述异常中，我们可以把握住两条基本信息：
（1）重写方法不能重新定义参数的约束规则；
（2）重写方法可以重写定义返回值的约束规则！并且@Validated注解可以定义在子类上。

public interface IAccount {
    String say(@NotNull Integer id, @NotNull String desc);
}

@Validated(Default.class)
@Service
public class AccountImpl implements IAccount {
    public @NotNull String say(Integer id, String desc) {
        System.out.println(String.format("The id is [%s] ,The desc is [%s]", id, desc));
        return null;
    }
}

返回结果：返回值不能为null（可以看到子类的返回值注解生效）。

javax.validation.ConstraintViolationException: say.<return value>: 不能为null
  1. 对参数对象的校验
public interface IAccount {
    String sayPerson(@NotNull @Valid Person person);
}

@Validated(Default.class)
@Service
public class AccountImpl implements IAccount {
    @Override
    public String sayPerson(Person person) {
        return JSON.toJSONString(person);
    }
}

@RestController
public class AopController {
    @Autowired
    private IAccount account;
    @RequestMapping("/test2")
    public void test2() {
        account.sayPerson(null);
    }
}

返回结果：若是对象为null，则返回异常，证明参数注解生效。

javax.validation.ConstraintViolationException: sayPerson.person: 不能为null
  1. 循环依赖问题

MethodValidation原理显然是AOP。和事务一样：若本类的A方法调用本类带有校验注解的B方法，那么B方法的方法校验注解不会生效。

public interface IAccount {
    String say(@NotNull Integer id, @NotNull String desc);
    String sayTo();
}

@Validated(Default.class)
@Service
public class AccountImpl implements IAccount {
    public @NotNull String say(Integer id, String desc) {
        System.out.println(String.format("The id is [%s] ,The desc is [%s]", id, desc));
        return null;
    }
    @Override
    public String sayTo() {
        return say(1, "内部调用");
    }
}

@RestController
public class AopController {
    @Autowired
    private IAccount account;
    @RequestMapping("/test4")
    public void test4(){
        account.sayTo();
    }
}

执行方法，say()方法虽然返回null，但是并未抛出异常。即校验注解未生效！

推荐方式：

  1. 启动类加上@EnableAspectJAutoProxy(exposeProxy = true)开启事务的AOP通知。

  2. 配置类上将methodValidationPostProcessor和@Async都可以使用AopContext。

@Component
public class ModifyExposeProxy2BeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    /**
     * 修改后置处理器的BeanDefinition对象。
     * @param beanFactory
     * @throws BeansException
     */
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        //修改service层注解的BeanPostProcessor
        BeanDefinition methodValidationPostProcessor = beanFactory.getBeanDefinition("methodValidationPostProcessor");
        methodValidationPostProcessor.getPropertyValues().add("exposeProxy",true);
        //修改@Async的BeanPostProcessor
        BeanDefinition beanDefinition = beanFactory.getBeanDefinition(TaskManagementConfigUtils.ASYNC_ANNOTATION_PROCESSOR_BEAN_NAME);
        beanDefinition.getPropertyValues().add("exposeProxy", true);
    }
}

注意点

  • 请不要在异步线程里使用AopContext.currentProxy()；
  • AopContext.currentProxy()不能使用在非代理对象所在方法体内；
@Validated(Default.class)
@Service
public class AccountImpl implements IAccount {
    public @NotNull String say(Integer id, String desc) {
        System.out.println(String.format("The id is [%s] ,The desc is [%s]", id, desc));
        return null;
    }
    @Override
    public String sayTo() {
        //获取当前对象的代理对象
        IAccount account = IAccount.class.cast(AopContext.currentProxy());
        return account .say(1, "内部调用");
    }
}

核心原理

它是Spring提供的基于Method的JSR校验的核心处理器。它可以让约束作用在入参和返回值上。

注意：若是方法级别注解校验生效的话，那么必须在类级别上使用@Validated标注。

若是想了解BeanPostProcessor Spring Bean的后置处理器，请点击...

而MethodValidationPostProcessor正是BeanPostProcessor的一种实现，它委托JSR-303提供程序，用于带注释的方法执行方法级别的验证。

它作为一种普通的BeanPostProcessor，其作用便是在Bean初始化时解析标签，增加数据校验的功能，最终生成一个代理对象。

public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessor
        implements InitializingBean {
    //解析带有@validated标签的类对象
    private Class<? extends Annotation> validatedAnnotationType = Validated.class;

    @Nullable
    private Validator validator;

   //设置自定义-生效的标签，必须是Annotation的子类
    public void setValidatedAnnotationType(Class<? extends Annotation> validatedAnnotationType) {
        Assert.notNull(validatedAnnotationType, "'validatedAnnotationType' must not be null");
        this.validatedAnnotationType = validatedAnnotationType;
    }

    //可以自己传入一个Validator。推荐使用定制化的LocalValidatorFactoryBean
    public void setValidator(Validator validator) {
        // Unwrap to the native Validator with forExecutables support
        if (validator instanceof LocalValidatorFactoryBean) {
            this.validator = ((LocalValidatorFactoryBean) validator).getValidator();
        }
        else if (validator instanceof SpringValidatorAdapter) {
            this.validator = validator.unwrap(Validator.class);
        }
        else {
            this.validator = validator;
        }
    }

    //也可以传入一个ValidatorFactory
    public void setValidatorFactory(ValidatorFactory validatorFactory) {
        this.validator = validatorFactory.getValidator();
    }
      
    //Pointcut(切点)使用的是AnnotationMatchingPointcut。
    //生成的advisor，而advice则是MethodValidationInterceptor。
    @Override
    public void afterPropertiesSet() {
        Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
        this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
    }

    //而advice则是给@Validation类进行增强的。
    protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
        return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
    }
}

在MethodValidationPostProcessor源码中，可以看到，其主要作用是定位到切点（pointcut），并获取到advisor（advice和pointcut）。所以，拦截的主要逻辑在advice中，即MethodValidationInterceptor中。

public class MethodValidationInterceptor implements MethodInterceptor {
    //比较器
    private final Validator validator;


   //若没有指定比较器，则使用默认的比较器
    public MethodValidationInterceptor() {
        this(Validation.buildDefaultValidatorFactory());
    }
    //根据上送的ValidatorFactory获取比较器
    public MethodValidationInterceptor(ValidatorFactory validatorFactory) {
        this(validatorFactory.getValidator());
    }
    //获取上送的比较器
    public MethodValidationInterceptor(Validator validator) {
        this.validator = validator;
    }


    @Override
    @SuppressWarnings("unchecked")
    public Object invoke(MethodInvocation invocation) throws Throwable {
        // Avoid Validator invocation on FactoryBean.getObjectType/isSingleton
      //若是FactoryBean.getObject()方法，则不去拦截。
        if (isFactoryBeanMetadataMethod(invocation.getMethod())) {
            return invocation.proceed();
        }

        Class<?>[] groups = determineValidationGroups(invocation);

        // Standard Bean Validation 1.1 API
        ExecutableValidator execVal = this.validator.forExecutables();
        Method methodToValidate = invocation.getMethod();
        //若是生成错误消息result，最终存放在该set中。
        Set<ConstraintViolation<Object>> result;

        try {
          //校验方法入参
            result = execVal.validateParameters(
                    invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
        }
        catch (IllegalArgumentException ex) {
            // 此处回退一步，找到桥接方法后再来一次
            methodToValidate = BridgeMethodResolver.findBridgedMethod(
                    ClassUtils.getMostSpecificMethod(invocation.getMethod(), invocation.getThis().getClass()));
            result = execVal.validateParameters(
                    invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
        }
        if (!result.isEmpty()) {
            throw new ConstraintViolationException(result);
        }
        //执行目标方法，拿到返回值，再去校验这个返回值
        Object returnValue = invocation.proceed();
        //校验返回值
        result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
        //若是Set集合不为空，则将异常抛出
        if (!result.isEmpty()) {
            throw new ConstraintViolationException(result);
        }
        //返回返回值
        return returnValue;
    }

   //检测出方法级别的@Validated。在里面拿到分组信息
    protected Class<?>[] determineValidationGroups(MethodInvocation invocation) {
        Validated validatedAnn = AnnotationUtils.findAnnotation(invocation.getMethod(), Validated.class);
        if (validatedAnn == null) {
            validatedAnn = AnnotationUtils.findAnnotation(invocation.getThis().getClass(), Validated.class);
        }
        return (validatedAnn != null ? validatedAnn.value() : new Class<?>[0]);
    }

}

推荐阅读

1. Spring方法级别数据校验：@Validated + MethodValidationPostProcessor优雅的完成数据校验动作

2. 从@Async案例找到Spring框架的bug：exposeProxy=true不生效原因大剖析+最佳解决方案【享学Spring】

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 160,444评论 4赞 365
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,867评论 1赞 298
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 110,157评论 0赞 248
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,312评论 0赞 214
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,673评论 3赞 289
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,802评论 1赞 223
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 32,010评论 2赞 315
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,743评论 0赞 204
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,470评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,696评论 2赞 250
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,187评论 1赞 262
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,538评论 3赞 258
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,188评论 3赞 240
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,127评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,902评论 0赞 198
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,889评论 2赞 283
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,741评论 2赞 274