Android AspectJ详解

在Android平台，常用的是hujiang的一个aspectjx插件，它的工作原理是：通过Gradle Transform，在class文件生成后至dex文件生成前，遍历并匹配所有符合AspectJ文件中声明的切点，然后将事先声明好的代码在切点前后织入。

通过描述可知，整个过程发生在编译期，是一种静态织入方式，所以会增加一定的编译时长，但几乎不会影响程序的运行时效率。

---

本文大致分为三个部分。

1. AspectJ的语法和使用。
2. 通过Jake Wharton大神的开源项目Hugo，实战AspectJ。
3. AspectJ面临的问题。

AspectJ能做什么？

通常来说，AOP都是为一些相对基础且固定的需求服务，实际常见的场景大致包括：

• 统计埋点
• 日志打印/打点
• 数据校验
• 行为拦截
• 性能监控
• 动态权限控制

如果你在项目中也有这样的需求（几乎一定有），可以考虑通过AspectJ来实现。

除了织入代码，AspectJ还能为类增加实现接口、添加成员变量，当然这不是本文的重点，感兴趣的小伙伴可以在学习完基础知识后了解相关内容。

环境配置

在Android平台，我们通常使用上文提到的Aspectjx插件来配置AspectJ环境，具体使用是通过AspectJ注解完成。

1. 在项目根目录的build.gradle里依赖AspectJX

dependencies {
classpath ‘com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.4’
}

2. 在需要支持AspectJ的module的build.gradle文件中声明插件。

apply plugin: ‘android-aspectjx’

在编译阶段AspectJ会遍历工程中所有class文件（包括第三方类库的class）寻找符合条件的切入点，为加快这个过程或缩小代码织入范围，我们可以使用exclude排除掉指定包名的class。

app/build.gradle

aspectjx {
//排除所有package路径中包含android.support的class文件及库（jar文件）
exclude ‘android.support’
}

在debug阶段我们更注重编译速度，可以关闭代码织入。

app/build.gradle

aspectjx {
//关闭AspectJX功能
enabled false
}

但目前最新的2.0.4版本的插件有bug，如果关闭AspectJ，则会导致工程内所有class不能打入APK中，运行会出现各种ClassNotFoundException，已经有Issue提出但尚未解决（坑货）。笔者尝试将版本回退到2.0.0版本，发现无此问题。如果你目前也有动态关闭的需求，建议不要使用最新版本。

基本语法

环境配置完成后，我们需要用AspectJ注解编写切面代码。

• @Aspect 用它声明一个类，表示一个需要执行的切面。
• @Pointcut 声明一个切点。
• @Before/@After/@Around/…（统称为Advice类型） 声明在切点前、后、中执行切面代码。

这么说你可能有点蒙，我们换个角度解释。

假设你是一个AOP框架的设计者，最先需要理清的其基本组成要素。既然需要做代码织入那是不是一定得配置代码的织入点呢？这个织入点就是Pointcut，有了织入点我们还需要指定具体织入的代码，这个代码写在哪里呢？就是写在以@Before/@After/@Around注解的方法体内。有了织入点和织入代码，还需要告诉框架自己是一个面向切面的配置文件，这就需要使用@Aspect声明在类上。

我们举个简单的栗子，全部示例参考github sample_aspectj。

@Aspect //①
public class MethodAspect {

@Pointcut(“call(* com.wandering.sample.aspectj.Animal.fly(…))”)//②
public void callMethod() {
}