AspectJ in Android （一），AspectJ 基础概念

发表于 | 分类于 | | 阅读次数

AspectJ in Android 系列：

AspectJ in Android （一），AspectJ 基础概念

AspectJ in Android （二），AspectJ 语法

AspectJ in Android （三），AspectJ 两种用法以及常见问题

最近项目在做无埋点统计，解决新增功能都需要人工添加埋点的问题，其中使用了 AspectJ 技术。在这过程中发现网上关于 AspectJ 在 Android 中应用的文章比较少，所以自己整理写了 《AspectJ in Android》系列文章，记录自己所学的同时希望读者可以少走一些弯路。

这篇文章主要讲 AspectJ 涉及到的 AOP 编程思想和 AspectJ 的一些基本概念。

AOP

什么是 AOP ？

AOP （Aspect-Oriented Programming），面向切面编程，是一种编程思想。AOP 以切面（aspect）为基础，切面是一种新的模块化机制，用来描述分散在对象、类或函数中的横切关点（crosscutting concern）。

AOP 和我们熟悉的 OOP 面向对象编程只有一字之差，面向对象编程是以对象为基础，把功能抽象成对象模型，优先从对象的属性和行为职责出发，把代码分散到一个个的类中，降低代码的复杂度同时提供复用性。但是在分散代码时会出现重复代码，例如，在两个类的每个方法中加上日志。按照 OOP 的思想，需要在方法中都加入重复的日志代码，也许有人说把日志代码抽象成例外一个日志的类，但是这样的话日志类和两个类都有耦合，而且日志类和这两个的职责没有关联，调用日志类的方法却遍布两个类的方法中。

而 AOP 的思想是把对象的核心职责外的通用逻辑（如日志，性能，校验等）抽象出来，把散布在多个对象多个模块的通用逻辑当作切面，然后动态地把代码插入到类的指定方法、指定位置中，实现 AOP 的核心技术也是代码织入技术，如 AspectJ、Javassist、DexMaker、ASMDex、动态代理等。

所以 AOP 可以说是对 OOP 的补充，OOP 以核心职责为主从纵向划分出一个一个类，AOP 以多个类中通用逻辑为主横向划分出一个一个切面，AOP 让 OOP 立体，去除重复代码，降低耦合并且增加可维护性。

AOP 的主要功能

AOP 是以非核心职责的通用逻辑为主的，所以主要功能是把日志记录、性能统计、安全控制、事务处理、异常处理等代码从业务逻辑代码中划分出来，后面再动态织入到业务逻辑中。所以 AOP 主要用于和业务逻辑相关的通用逻辑：日志记录、性能统计、安全控制、事务处理、异常处理等等。

AOP 概念

Aspect ：切面，一个关注点的模块化，这个关注点可能会横切多个对象。

Join Point ：连接点，程序中可切入的点，例如方法调用时、读取某个变量时。

Pointcut ：切入点，代码注入的位置，其实就是有条件限定的 Join Point，例如只在特定方法中注入代码。

Advice ：在切入点注入的代码，一般有 before、after、around 三种类型。

Target Object ：被一个或多个 aspect 横切拦截操作的目标对象。

Weaving ： 把 Advice 代码织入到目标对象的过程。

Inter-type declarations : 用来给一个类型声明额外的方法或属性。

AspectJ

AspectJ 是使用最为广泛的 AOP 实现方案，适用于 Java 平台，官网地址：http://www.eclipse.org/aspectj/ 。AspectJ 是在静态织入代码，即在编译期注入代码的。

AspectJ 提供了一套全新的语法实现，完全兼容 Java（跟 Java 之间的区别，只是多了一些关键词而已）。同时，还提供了纯 Java 语言的实现，通过注解的方式，完成代码编织的功能。因此我们在使用 AspectJ 的时候有以下两种方式：

  • 使用 AspectJ 的语言进行开发

  • 通过 AspectJ 提供的注解在 Java 语言上开发

因为最终的目的其实都是需要在字节码文件中织入我们自己定义的切面代码，不管使用哪种方式接入 AspectJ，都需要使用 AspectJ 提供的代码编译工具 ajc 进行编译。

在 Android Studio 上一般使用注解的方式使用 AspectJ，因为 Android Studio 没有 AspectJ 插件，无法识别 AspectJ 的语法（不过在 Intellij IDEA 收费版上可以使用 AspectJ 插件），所以后面的语法说明和示例都是以注解的实现方式。

引入 AspectJ

在 Android 上集成 AspectJ 比较麻烦，推荐使用 Github 上开源的 Gradle 插件 – Android Aspectjx。该插件是利用 Gradle 的 Transform API 在项目 class 文件打包成 dex 之前进入代码织入。

首先在项目根目录的build.gradle中添加 gradle 插件依赖：

1
2
3
dependencies {
    classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:1.0.10'
}

然后在 app 模块的 build.gradle 添加 AspectJ 的依赖：

1
2
3
4
5
apply plugin: 'android-aspectjx'
dependencies {
    compile 'org.aspectj:aspectjrt:1.8.10'
}

如果把 AspectJ 代码单独放到一个 library module 的话，library module 还需要添加 compile 'org.aspectj:aspectjrt:1.8.+' 依赖。

下面是使用 android-aspectjx 插件需要注意的点：

  1. android-aspectjx 插件是 使用在 application module 的插件，只能在编译 application module 的过程中织入代码。

  2. AspectJ 的原理是在编译期注入代码，所以切面只能是项目代码、依赖的 jar 或 aar，不能注入 Android 平台 android.jar。例如，可以在 support 包的 Fragment 中注入代码，但是无法在 Activity 中注入代码，只能注入项目的继承自 Activity 的 XXActivity。

  3. android-aspectjx 默认会遍历项目编译后所有的 .class 文件和依赖的第三方库去查找符合织入条件的切点，为了提升效率，可以加入过滤条件，具体见 Android Aspectjx 的文档。

AspectJ 示例

下面先不考虑 AspectJ 的语法，先看下简单使用 AspectJ 的示例。在 Fragment 的 onResume 和 onPause 时打印 log 信息，新建一个 FragmentAspect 类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class FragmentAspect {
    private static final String TAG = "FragmentAspect";
    @Pointcut("execution(void android.support.v4.app.Fragment.onResume()) && target(fragment)")
    public void onResume(Fragment fragment) {}
    @Pointcut("execution(void android.support.v4.app.Fragment.onPause()) && target(fragment)")
    public void onPause(Fragment fragment) {}
    @Before("onResume(fragment)")
    public void beforeOnResume(Fragment fragment) {
        Log.d(TAG, fragment.getClass().getSimpleName() + " onResume");
    }
    @Before("onPause(fragment)")
    public void beforeOnPause(Fragment fragment) {
        Log.d(TAG, fragment.getClass().getSimpleName() + " onPause");
    }
}

这样编译后就可以修改在 support-v4 包中的 Fragment 类文件，通过 AspectJ 动态织入后的类会在/build/intermediates/transforms/AspectTransform/debug/jars/1/1f/aspected.jar 。

反编译后会发现 jar 包中有 Fragment 的代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class Fragment implements ComponentCallbacks, OnCreateContextMenuListener {
    ...
    @CallSuper
    public void onResume() {
        FragmentAspect.aspectOf().beforeOnResume(this);
        this.mCalled = true;
    }
    ...
    @CallSuper
    public void onPause() {
        FragmentAspect.aspectOf().beforeOnPause(this);
        this.mCalled = true;
    }
    ...
}

可以发现在两个方法前加上了打印 log 的方法，这正是 AspectJ 在日志记录上的一个简单示例。

这篇文章就到这里，下篇文章详细地介绍 AspectJ 的语法。

END
Johnny Shieh wechat
我的公众号，不只有技术，还有咖啡和彩蛋！