深坑啊！同一个Spring AOP的坑，我一天踩了两次！

深坑啊！同一个Spring AOP的坑，我一天踩了两次！-HollisChuang's Blog

前几天，我刚刚发布过一篇文章《自定义注解！绝对是程序员装逼的利器！！》，介绍过如何使用Spring AOP + 自定义注解来提升代码的优雅性。

很多读者看完之后表示用起来很爽，但是后台也有人留言说自己配置了Spring的AOP之后，发现切面不生效。

其实，这个问题我在用的过程中也遇到过，而且还是同一个问题一天之内遇到了两次。

说明这个问题很容易被忽略，并且这个问题带来的后果可能是极其严重的。那么，我们就来简单回顾一下问题是怎么样的。

最初我定义了一个注解，希望可以方便统一的对一些数据库操作做缓存。于是就有了以下代码：

首先，定义一个注解：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Cacheable {

    /**
     * 策略名称，需要保证唯一
     *
     * @return
     */
    public String keyName();

    /**
     * 超时时长，单位：秒
     *
     * @return
     */
    public int expireTime();

}

然后自定义一个切面，对所有使用了该注解的方法进行切面处理：

@Aspect
@Component
public class CacheableAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(FacadeAspect.class);
    @Around("@annotation(com.hollis.cache.Cacheable)")
    public Object cache(ProceedingJoinPoint pjp) throws Throwable {
        // 先查缓存，如果缓存中有值，直接返回。如果缓存中没有，先执行方法，再将返回值存储到缓存中。
    }
}

然后就可以使用该注解了，使用方法如下：

@Component
public class StrategyService extends BaseStrategyService  {

    public PricingResponse getFactor(Map<String, String> pricingParams) {
        // 做一些参数校验，以及异常捕获相关的事情
        return this.loadFactor(tieredPricingParams);
    }

    @Override
    @Cacheable(keyName = "key0001", expireTime = 60 * 60 * 2)
    private PricingResponse loadFactor(Map<String, String> pricingParams) {
        //代码执行
    }
}

以上，对loadFactor方法增加了切面，为了方便使用，我们还定义了一个getFactor方法，设置为public，方便外部调用。

但是，在调试过程中，我发现我们设置在loadFactor方法上面的切面并没有成功，无法执行切面类。

于是开始排查问题具体是什么。

为了排查这个问题，首先是把所有的代码检查一遍，看看切面的代码是不是有问题，有没有可能有手误打错了字之类的。

但是发现都没有。于是就想办法找找问题。

接下来我把loadFactor的访问权限从private改成public，发现没有效果。

然后我尝试着在方法外直接调用loadFactor而不是getFactor。

发现这样做就可以成功的执行到切面里面了。

发现这一现象的时候，我突然恍然大悟，直捶大腿。原来如此，原来如此，就应该是这样的。

我突然就想到了问题的原因。其实原因挺简单的，也是我之前了解到过的原理，但是在问题刚刚发生的时候我并没有想到这里，而是通过debug，发现这个现象之后我才突然想到这个原理。

那么，就来说说为什么会发生这样的问题。

代理的调用方式

我们发现上面的问题关键在于loadFactor方法被调用的方式不同。我们知道，方法的调用通常有以下几种方式：

1、在类内部，通过this进行自调用：

public class SimplePojo implements Pojo {

    public void foo() {
        // this next method invocation is a direct call on the 'this' reference
        this.bar();
    }

    public void bar() {
        // some logic...
    }
}

2、在类外部，通过该类的对象进行调用

public class Main {

    public static void main(String[] args) {
        Pojo pojo = new SimplePojo();
        // this is a direct method call on the 'pojo' reference
        pojo.foo();
    }
}

类关系及调用过程中如下图：



如果是静态方法，也可以通过类直接调用。

3、在类外部，通过该类的代理对象进行调用：

public class Main {

    public static void main(String[] args) {
        ProxyFactory factory = new ProxyFactory(new SimplePojo());
        factory.addInterface(Pojo.class);
        factory.addAdvice(new RetryAdvice());

        Pojo pojo = (Pojo) factory.getProxy();
        // this is a method call on the proxy!
        pojo.foo();
    }
}

类关系及调用过程中如下图：



那么，Spring的AOP其实是第三种调用方式，就是通过代理对象调用，只有这种调用方式，才能够在真正的对象的执行前后，能够让代理对象也执行相关代码，才能起到切面的作用。

而对于使用this的方式调用，这种只是自调用，并不会使用代理对象进行调用，也就无法执行切面类。

那么，我们知道了，想要真正的执行代理，那么就需要通过代理对象进行调用而不是使用this调用的方式。

那么，这个问题的解决办法也就是想办法通过代理对象来调用目标方法即可。

这种问题的解决网上有很多种办法，这里介绍一个相对简单的。其他的更多的办法大家可以在网上找到一些案例。搜索关键词”AOP 自调用”即可。

获取代理对象进行调用

我们需要修改一下前面的StrategyService的代码，修改成以下内容：

@Component
public class StrategyService{

    public PricingResponse getFactor(Map<String, String> pricingParams) {
        // 做一些参数校验，以及异常捕获相关的事情
        // 这里不使用this.loadFactor而是使用AopContext.currentProxy()调用，目的是解决AOP代理不支持方法自调用的问题
        if (AopContext.currentProxy() instanceof StrategyService) {
            return ((StrategyService)AopContext.currentProxy()).loadFactor(tieredPricingParams);
        } else {
            // 部分实现没有被代理过，则直接进行自调用即可
            return loadFactor(tieredPricingParams);
        }
    }

    @Override
    @Cacheable(keyName = "key0001", expireTime = 60 * 60 * 2)
    private PricingResponse loadFactor(Map<String, String> oricingParams) {
        //代码执行
    }
}

即使用AopContext.currentProxy()获取到代理对象，然后通过代理对象调用对应的方法。

还有个地方需要注意，以上方式还需要将Aspect的expose-proxy设置成true。如果是配置文件修改：

 <aop:aspectj-autoproxy proxy-target-class="true" expose-proxy="true"/>

如果是SpringBoot，则修改应用启动入口类的注解：

@EnableAspectJAutoProxy(exposeProxy = true)
public class Application {

}

以上，我们分析并解决了一个Spring AOP不支持方法自调用的问题。

AOP失败这个问题，其实还是很严重的，因为如果发生非预期的失效，那么直接问题就是没有执行切面方法，更严重的后果可能是诸如事务未生效、日志未打印、缓存未查询等各种问题。

所以，还是建议大家看完此文之后，统查一下自己的代码，是否存在方法自调用的情况。这种情况下，任何切面都是无法生效的！

(全文完)

---

扫描二维码，关注作者微信公众号