本文大致分为三个部分。
- AspectJ的语法和使用。
- 通过Jake Wharton大神的开源项目Hugo,实战AspectJ。
- AspectJ面临的问题。
AspectJ能做什么?
通常来说,AOP都是为一些相对基础且固定的需求服务,实际常见的场景大致包括:
- 统计埋点
- 日志打印/打点
- 数据校验
- 行为拦截
- 性能监控
- 动态权限控制
如果你在项目中也有这样的需求(几乎一定有),可以考虑通过AspectJ来实现。
除了织入代码,AspectJ还能为类增加实现接口、添加成员变量,当然这不是本文的重点,感兴趣的小伙伴可以在学习完基础知识后了解相关内容。
环境配置
在Android平台,我们通常使用上文提到的Aspectjx插件来配置AspectJ环境,具体使用是通过AspectJ注解完成。
- 在项目根目录的build.gradle里依赖AspectJX
dependencies {
classpath ‘com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.4’
}
- 在需要支持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() {
}
@Before(“callMethod()”)//③
public void beforeMethodCall(JoinPoint joinPoint) {
Log.e(TAG, “before->” + joinPoint.getTarget().toString()); //④
}
}
我们事先准备好的Animal类中有一个fly方法。
public class Animal {
public void fly() {
Log.e(TAG, “animal fly method:” + this.toString() + “#fly”);
}
}
①处声明了本类是一个AspectJ配置文件。
②处指定了一个代码织入点,注解内的call(* com.wandering.sample.aspectj.Animal.fly(…)) 是一个切点表达式,第一个*号表示返回值可为任意类型,后跟包名+类名+方法名,括号内表示参数列表, … 表示匹配任意个参数,参数类型为任何类型,这个表达式指定了一个时机:在Animal类的fly方法被调用时。
③处声明Advice类型为Before并指定切点为上面callMethod方法所表示的那个切点。
④处为实际织入的代码。
翻译成白话就是说在Animal类的fly方法被调用前插入④处的代码。
编写测试代码并调用fly方法,运行观察日志输出你会发现before->的日志先于animal fly日志被打印,具体可查看sample工程MethodAspect示例。
我们再将APK反编译看一下织入结果。
红色框选部分就是AspectJ为我们织入的代码。
通过上面的例子我们了解了AspectJ的基本用法,但实际上AspectJ的语法可以十分复杂,下面我们来看看具体的语法。
Join Point
上面的例子中少讲了一个连接点的概念,连接点表示可织入代码的点,它属于Pointcut的一部分。由于语法内容较多,实际使用过程中我们可以参考语法手册,我们列出其中一部分Join Point:
Joint Point | 含义 |
---|---|
Method call | 方法被调用 |
Method execution | 方法执行 |
Constructor call | 构造函数被调用 |
Constructor execution | 构造函数执行 |
Static initialization | static 块初始化 |
Field get | 读取属性 |
Field set | 写入属性 |
Handler | 异常处理 |
Method call 和 Method execution的区别常拿来比较,其实就是调用与执行的区别,就拿上面Animal的fly方法举例。demo代码如下:
Animal a = Animal();
a.fly();
如果我们声明的织入点为call,再假设Advice类型是before,则织入后代码结构是这样的。
Animal a = new Animal();
//…我是织入代码
a.fly();
如果我们声明的织入点为execution,则织入后代码结构就成这样了。
public class Animal {
public void fly() {
//…我是织入代码
Log.e(TAG, “animal fly method:” + this.toString() + “#fly”);
}
}
本质上的区别就是织入对象不同,call被织入在指定方法被调用的位置上,而execution被织入到指定的方法内部。
Pointcut
Pointcuts是具体的切入点,基本上Pointcuts 是和 Join Point 相对应的。
Joint Point | Pointcuts 表达式 |
---|---|
Method call | call(MethodPattern) |
Method execution | execution(MethodPattern) |
Constructor call | call(ConstructorPattern) |
Constructor execution | execution(ConstructorPattern) |
Static initialization | staticinitialization(TypePattern) |
Field get | get(FieldPattern) |
Field set | set(FieldPattern) |
Handler | handler(TypePattern) |
除了上面与 Join Point 对应的选择外,Pointcuts 还有其他选择方法。
Pointcuts 表达式 | 说明 |
---|---|
within(TypePattern) | 符合 TypePattern 的代码中的 Join Point |
withincode(MethodPattern) | 在某些方法中的 Join Point |
withincode(ConstructorPattern) | 在某些构造函数中的 Join Point |
cflow(Pointcut) | Pointcut 选择出的切入点 P 的控制流中的所有 Join Point,包括 P 本身 |
cflowbelow(Pointcut) | Pointcut 选择出的切入点 P 的控制流中的所有 Join Point,不包括 P 本身 |
this(Type or Id) | Join Point 所属的 this 对象是否 instanceOf Type 或者 Id 的类型 |
target(Type or Id) | Join Point 所在的对象(例如 call 或 execution 操作符应用的对象)是否 instanceOf Type 或者 Id 的类型 |
args(Type or Id, …) | 方法或构造函数参数的类型 |
if(BooleanExpression) | 满足表达式的 Join Point,表达式只能使用静态属性、Pointcuts 或 Advice 暴露的参数、thisJoinPoint 对象 |
this vs. target
this和target是一个容易混淆的点。
MethodAspect.java
public class MethodAspect {
@Pointcut(“call(* com.wandering.sample.aspectj.Animal.fly(…))”)
public void callMethod() {
Log.e(TAG, “callMethod->”);
}
@Before(“callMethod()”)
public void beforeMethodCall(JoinPoint joinPoint) {
Log.e(TAG, “getTarget->” + joinPoint.getTarget());
Log.e(TAG, “getThis->” + joinPoint.getThis());
}
}
fly调用方:
MainActivity.java
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
Animal animal = new Animal();
animal.fly();
}
运行结果如下:
getTarget->com.wandering.sample.aspectj.Animal@509ddfd
getThis->com.wandering.sample.aspectj.MainActivity@98c38bf
也就是说target指代的是切入点方法的所有者,而this指代的是被织入代码所属类的实例对象。
我们稍加改动,将切点的call改为execution。
运行结果就成这个样子了:
getTarget->com.wandering.sample.aspectj.Animal@509ddfd
getThis->com.wandering.sample.aspectj.Animal@509ddfd
按照上面的分析,与这个结果也是吻合的。
条件运算
Pointcut表达式中还可以使用一些条件判断符,比如 !、&&、||。
以Hugo为例:
Hugo.java
@Pointcut(“within(@hugo.weaving.DebugLog *)”)
public void withinAnnotatedClass() {}
@Pointcut(“execution(!synthetic * *(…)) && withinAnnotatedClass()”)
public void methodInsideAnnotatedType() {}
第一个切点指定范围为包含DebugLog注解的任意类和方法,第二个切点为在第一个切点范围内,且执行非内部类的任意方法。结合起来表述就是任意声明了DebugLog注解的方法。
其中@hugo.weaving.DebugLog *
和!synthetic * *(..)
分别对应上面表格中提到的TypePattern和MethodPattern。
接下来需要了解这些pattern具体的语法,通过语法我们可以写出符合自身需求的表达式。
Pattern类型 | 语法 |
---|---|
MethodPattern | [!] [@Annotation] [public,protected,private] [static] [final] 返回值类型 [类名.]方法名(参数类型列表) [throws 异常类型] |
ConstructorPattern | [!] [@Annotation] [public,protected,private] [final] [类名.]new(参数类型列表) [throws 异常类型] |
FieldPattern | [!] [@Annotation] [public,protected,private] [static] [final] 属性类型 [类名.]属性名 |
TypePattern | 其他 Pattern 涉及到的类型规则也是一样,可以使用 ‘!’、‘’、‘…’、‘+’,‘!’ 表示取反,‘’ 匹配除 . 外的所有字符串,‘*’ 单独使用事表示匹配任意类型,‘…’ 匹配任意字符串,‘…’ 单独使用时表示匹配任意长度任意类型,‘+’ 匹配其自身及子类,还有一个 '…'表示不定个数 |
更多语法参见官网Pointcuts,非常有用。
再看几个例子:
execution(void setUserVisibleHint(…)) && target(android.support.v4.app.Fragment) && args(boolean) — 执行 Fragment 及其子类的 setUserVisibleHint(boolean) 方法时。
execution(void Foo.foo(…)) && cflowbelow(execution(void Foo.foo(…))) — 执行 Foo.foo() 方法中再递归执行 Foo.foo() 时。
if条件
通常情况下,Pointcuts注解的方法参数列表为空,返回值为void,方法体也为空。但是如果表达式中声明了:
- args、target、this等类型参数,则可额外声明参数列表。
- if条件,则方法必须public static boolean。
来看sample示例MethodAspect8:
@Aspect
public class MethodAspect8 {
@Pointcut(“call(boolean .(int)) && args(i) && if()”)
public static boolean someCallWithIfTest(int i, JoinPoint jp) {
// any legal Java expression…
return i > 0 && jp.getSignature().getName().startsWith(“setAge”);
}
@Before(“someCallWithIfTest(i, jp)”)
public void aroundMethodCall(int i, JoinPoint jp) {
Log.e(TAG, "before if ");
}
}
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)
![](https://i-blog.csdnimg.cn/blog_migrate/100a69655e6340e82faf0428d432ecd1.jpeg)
设计模式学习笔记
设计模式系列学习视频
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
帮助,可以扫码获取!!(备注:Android)**
![](https://i-blog.csdnimg.cn/blog_migrate/100a69655e6340e82faf0428d432ecd1.jpeg)
设计模式学习笔记
[外链图片转存中…(img-sw4WYOsn-1712608188203)]
设计模式系列学习视频
[外链图片转存中…(img-CWh315vc-1712608188203)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!