AOP实现方法调用的跟踪
如果你开始阅读这篇文章,说明你对AOP的概念并不陌生,当然这只是我个人的一个期望,因为只是介绍AOP的概念就能写很长的一大段,但这并不是此文的目的。此文的目的更多的是介绍AOP的应用,或者说是主要介绍实现方法调用跟踪的实现,概念的东西只会做简短的介绍。如果对概念已经很了解了,或使用方式也已熟知,请跳到最后,那才是重点
1.AOP使用场景
撸码的过程中,我们常遇到要在方法执行前加判断(比如权限判断,入参的非空判断),或者打一些日志(如记录方法的执行时间,入参,耗时,抛出的异常)。传统的做法是将相应的逻辑写在方法内的开头和结尾,这种方式写法随意,侵入代码,耦合性高,逻辑复用性不强,而且存在多处时,维护成本也比较高。这个时候AOP就特别适合处理这种场景。
2.AOP实践:实现方法的调用跟踪
Spring提供了很好的AOP的实现,实现的有些过于强大,以致于衍生出很多概念,我们只针对我们将要实现的功能做介绍,对Spring AOP的强大功能特别感兴趣的可以去翻阅官方文档(提供了特别灵活的配置)。下面我们将一步步的实现方法的调用跟踪。
(1)添加Spring 配置
既然使用Spring,配置文件是一定少不了的
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd"
default-autowire="byName">
<aop:aspectj-autoproxy expose-proxy="true"/>
<context:annotation-config />
<context:component-scan base-package="com.github.ipolaris.aop"/>
<bean class="com.github.ipolaris.aop.tracker.utils.SpringAppContext"></bean>
</beans>
都是一些常用的配置,特别值得注意的是
<aop:aspectj-autoproxy expose-proxy="true"/>
,添加此配置声明自动为spring容器中那些配置@AspectJ切面的bean创建代理,织入切面。proxy-target-class属性,默认为false,表示使用jdk动态代理织入增强,当配置为<aop:aspectj-autoproxy poxy-target-class="true"/>
时,表示使用CGLib动态代理技术织入增强。不过即使proxy-target-class设置为false,如果目标类没有声明接口,则spring将自动使用CGLib动态代理。expose-proxy大部分的场景声明为true会更“保险”一些,避免开发过程中踩坑,它的作用是使AopContext.currentProxy()能拿到当前的代理。spring加入AOP的支持,必要的jar包也是必不可少aspectjrt,aspectjweaver,cglib(具体版本暂时不用关心,最后提供的源码地址,这些问题一应得到解决)
(2)配置切面,切点,通知类型(概念不清的,可留言或自寻搜索)
@Component
@Aspect
public class AspectDemo {
/**
* 定义切点
*/
@Pointcut("execution(* *.target(..))")
public void aspectPoint(){}
/**
* 方法执行前
* @param joinPoint
*/
@Before("aspectPoint()")
public void beforeMethod(JoinPoint joinPoint){
System.out.println("before");
}
/**
* 方法执行后
* @param joinPoint
* @param retVal
*/
@AfterReturning(pointcut = "aspectPoint()", returning = "retVal")
public void afterMethod(JoinPoint joinPoint, Object retVal){
System.out.println("after");
}
/**
* 方法抛出异常
* @param joinPoint
* @param exception
*/
@AfterThrowing(pointcut = "aspectPoint()", throwing = "exception")
public void afterMethodException(JoinPoint joinPoint, Throwable exception){
System.out.printf("afterMethodException");
}
}
@Aspect 配置了切面, @Pointcut 配置了切点,@Before、@AfterReturning、@AfterThrowing配置了通知类型。这个切点干的一件事就是拦截所有方法名为target的方法(近似的使用场景为我们想在所有数据库的save方法执行之前进行一些操作),在方法执行前后输出了一些信息。
关于切点的定义可以定义的很强大,也可以定义的很复杂,如果上述的代码尚未满足你的需求,除了execution,其他的切入点指示符,请参考官方文档,总会找到一款你想要的。
我们再定义个简单的类,让这个切面有用武之地
@Service
public class DemoService {
public void target(){
System.out.println("target");
}
}
当我们执行target方法时,就会输出
before
target
after
Process finished with exit code 0
有个注意点:既然我们让spring帮我们实现了AOP,那么我们的类一定要交由Spring来管理,所以一定要加上@Service或@Component注解。
讲AOP,不得不说的一个问题就是动态代理的问题,动态代理这个问题有两年编程经验的人应该都明白(尚不说理解深浅):JDK动态代理,CGLib动态代理。说白了就是你想执行某个类的某个方法,你调用的并不是这个直接的对象,你拿到的是一个代理类,由这个代理类来执行目标类对应的方法。这里就衍生出了一个问题:我在一个对象里调用自身的一个方法(比如this.的方式去调用),为什么AOP切不到(其实能切到,但是成本比较高,这是另外一个问题)?用一个简单的图来说明一下这个问题。
切面其实是织入在了代理类上,所以当我们调用目标类自身的方法时,就发现并没有执行我们在通知里定义的逻辑。这个时候如果不甘心,一定想切到的话,可以使用AopContext.currentProxy()拿到代理类,执行对应的方法。
通过上述的编码,我们已经实现了对具体方法的跟踪,但是如果你还觉得麻烦,那么问题来了,有没有相对简单的方式?接下来的就是重点了,请移步https://github.com/iPolaris/ipolaris-aop-tracker ,此项目已经将切面实现好了,你只需要通过在类上添加注解,在注解里告知你的逻辑实现类,配置的这一套都省了。具体的逻辑请移步。