AspectJ in Android 系列:
AspectJ in Android (一),AspectJ 基礎概念
AspectJ in Android (二),AspectJ 語法
AspectJ in Android (三),AspectJ 兩種用法以及常見問題
前面兩篇文章介紹了 AspectJ 的基礎概念以及基于注解開發方式的語法,這篇文章總結了 AspectJ 的兩種用法和 android-aspectjx 插件的常見問題。
AspectJ 的兩種用法
我覺得以 Pointcut 切入點作為區分,AspectJ 有兩種用法:(1)用自定義注解修飾切入點,精確控制切入點,屬于侵入式;(2)不需要在切入點代碼中做任何修改,屬于非侵入式。
侵入式
侵入式用法,一般會使用自定義注解,以此作為選擇切入點的規則。
下面以 JakeWharton 大神的 hugo 為例,分析自定義注解 AOP 的使用。hugo 是用于在開發環境中打印方法調用信息的,只會打印注解修飾的方法。
首先看下新增的自定義注解:
@Target({TYPE, METHOD, CONSTRUCTOR}) @Retention(CLASS)
public @interface DebugLog {
}
上面定義了@DebugLog
注解,可以修飾類、接口、方法和構造函數,可在 Class 文件中保留,編譯期可用。更多關于 Java 注解的內容,請看之前的文章 探索注解之注解的基本概念。
再看 hugo 的切面代碼,代碼說明在注釋中:
@Aspect
public class Hugo {
private static volatile boolean enabled = true;
@Pointcut("within(@hugo.weaving.DebugLog *)")
public void withinAnnotatedClass() {} // @DebugLog 修飾的類、接口的 Join Point
// synthetic 是內部類編譯后添加的修飾語,所以 !synthetic 表示非內部類的
@Pointcut("execution(!synthetic * *(..)) && withinAnnotatedClass()")
public void methodInsideAnnotatedType() {} // 執行 @DebugLog 修飾的類、接口中的方法,不包括內部類中方法
@Pointcut("execution(!synthetic *.new(..)) && withinAnnotatedClass()")
public void constructorInsideAnnotatedType() {} // 執行 @DebugLog 修飾的類中的構造函數,不包括內部類的構造函數
@Pointcut("execution(@hugo.weaving.DebugLog * *(..)) || methodInsideAnnotatedType()")
public void method() {} // 執行 @DebugLog 修飾的方法,或者 @DebugLog 修飾的類、接口中的方法
@Pointcut("execution(@hugo.weaving.DebugLog *.new(..)) || constructorInsideAnnotatedType()")
public void constructor() {} // 執行 @DebugLog 修飾的構造函數,或者 @DebugLog 修飾的類中的構造函數
...
@Around("method() || constructor()")
public Object logAndExecute(ProceedingJoinPoint joinPoint) throws Throwable {
enterMethod(joinPoint); // 打印切入點方法名、參數列表
long startNanos = System.nanoTime();
Object result = joinPoint.proceed(); // 調用原來的方法
long stopNanos = System.nanoTime();
long lengthMillis = TimeUnit.NANOSECONDS.toMillis(stopNanos - startNanos);
exitMethod(joinPoint, result, lengthMillis); // 打印切入點方法名、返回值、方法執行時間
return result;
}
...
從上面代碼可以看出 hugo 是以 @DebugLog 作為選擇切入點的條件,只需要用 @DebugLog 注解類或者方法就可以打印方法調用的信息。
所以,可以看出侵入式 AspectJ 的特點:
需要自定義注解
切入點需要添加注解,會侵入切入點代碼
不需要修改 Aspect 切面代碼,就可以隨意修改切入點
非侵入式
非侵入式,就是不需要使用額外的注解來修飾切入點,不用修改切入點的代碼。
最近項目中在調研無埋點數據上報,不需要每次新增功能時都添加埋點代碼,這種場景適合非侵入式的 AOP,我們采用的是 AspectJ 技術來實現。數據上報一般包括頁面和事件統計,下面以 Activity、Fragment 頁面統計以及點擊事件統計為例,分析非侵入式 Aspectj 在 Android 項目中的使用。
Activity 頁面統計
首先需要明白的一點是:AspectJ 無法在 Activity 中織入代碼,因為 Activity 屬于 android.jar,是安卓平臺代碼,Class 文件不會在編譯時打包進 apk 中。但是項目中繼承自 Activity 的子類可以作為切入點,因為編譯期會變成 Class 文件。
網上一些統計 Activity 例子是這樣:
@Before("execution(* android.app.Activity+.on**(..))")
public void onActivityMethodBefore(JoinPoint joinPoint) throws Throwable {
...
}
上面的代碼是以 Activity 及其子類的 onXX 方法作為切入點,但是 Activity 類是無法切入的,而 Activity 的子類的話只能切入重寫的 onXX 方法。
所以這種寫法其實有兩個問題:(1)如果 BaseActivity 和 其子類 XXActivity 都重寫了 onPause 方法,那么兩個方法都會織入 AOP 代碼,所以 XXActivity 執行 onPause 方法時,會調用兩次數據統計的 AOP 代碼;(2)如果 XXActivity 沒有重寫 onDestroy 方法,那么就 XXActivity.onDestroy 方法就無法作為切入點。
我覺得有兩種方式比較合理:
- 項目中有個 BaseActivity 作為所有 Activity 的基類,而且 BaseActivity 重寫了 Activity 的所有 onXX 方法時,可以以 BaseActivity 作為切入點。
Pointcut 表達式:execution(* BaseActivity.on**(..))
- 使用 Android API 的 Application.ActivityLifecycleCallbacks,可以監聽應用中所有 Activity 生命周期的變化,這也更為通用。
Fragment 頁面統計
公司項目中使用的是 support-v4 包中的 Fragment,support-v4 會作為依賴一起編譯打包進 apk,所以可以直接切入 Fragment 中。
需要統計的 Fragment 的顯示與隱藏,不過不能僅僅依靠 onResume/onPause 兩個來判斷,在使用 Fragment Tab 時,tab 切換觸發的回調是 onHiddenChanged 方法,而 ViewPager 中切換 Fragment 時觸發的是 setUserVisibleHint,所以需要切入這四個方法。
@Pointcut("execution(void onHiddenChanged(boolean)) && within(android.support.v4.app.Fragment) && target(fragment) && args(hidden)")
public void onHiddenChanged(Fragment fragment, boolean hidden) {}
@Pointcut("execution(void setUserVisibleHint(..)) && within(android.support.v4.app.Fragment) && target(fragment) && args(visible)")
public void setUserVisibleHint(Fragment fragment, boolean visible) {}
@Pointcut("execution(void onResume()) && within(android.support.v4.app.Fragment) && target(fragment)")
public void onResume(Fragment fragment) {}
@Pointcut("execution(void onPause()) && within(android.support.v4.app.Fragment) && target(fragment)")
public void onPause(Fragment fragment) {}
Click 事件統計
這里只是以普通的 View 的點擊事件統計為例,這里的點擊事件是指點擊某 View 后會執行點擊回調這種,所以只需要關注 OnClickListener 即可。
很容易寫出下面代碼:
@Pointcut("execution(void android.view.View.OnClickListener.onClick(..)) && args(view)")
public void onClick(View view) {}
但是上面的 Pointcut 其實是不全面的,setOnClickListener(new OnClickListener() {...}) 這種匿名內部類寫法時沒問題,如果是實現 OnClickListener 接口的類則無法切入。所以應該加上 OnClickListener 的子類,使用 OnClickListener+
。
@Pointcut("execution(void android.view.View.OnClickListener+.onClick(..)) && args(view)")
public void onClick(View view) {}
這種寫法還可以監聽到 ButterKnife 的點擊事件,因為 ButterKnife 使用一個實現了 OnClickListener 的抽象接口。
所以,從上面三個示例可以看出非侵入式 AspectJ 的特點:
不需要額外的自定義注解
不會侵入切入點代碼
很難精確控制切入點,需要修改切入點時,必須修改切面代碼
android-aspectjx 插件的常見問題
AspectJ 在 Android 項目中使用需要額外處理,在第一篇文章引入 AspectJ 有到使用的國人寫開源插件 gradle_plugin_android_aspectjx,該插件利用了 Gradle 的 Transforms API 用 AspectJ tools 對所有 class 進行處理。
下面是個人在使用遇到的一些問題,總結下避免大家走彎路:
includeJarFilter 和 excludeJarFilter 的使用
默認不做任何配置的話,會遍歷項目編譯后所有的 .class 文件和依賴的第三方庫進行處理。不過可以通過 includeJarFilter 和 excludeJarFilter 過濾縮小范圍。
aspectjx {
//includes the libs that you want to weave
includeJarFilter 'universal-image-loader', 'AspectJX-Demo/library'
//excludes the libs that you don't want to weave
excludeJarFilter 'universal-image-loader'
}
編譯過程中可以通過 gradle 輸出看出使用 AspectJ 處理的第三方庫:
aspect start..........
excludeJar:::XXXX
includeJar:::XXXX
.
.
.
aspect do work..........
aspect jar merging..........
aspect done...................
需要注意的切面代碼和需要作為切入點的第三方庫必須 include,如果切面代碼是在 library module 中,沒有 include 的話,運行時會出現找不到 aspectOf()
方法的異常。
切入點代碼可以混淆
代碼是在編譯階段織入,所以混淆是不會有影響的,只有在運行時你需要通過類名,方法名去做一些事情的時候才不能混淆,比如用到了反射技術等。任何在編譯階段植入代碼的 AOP 方案混淆都不會受影響,和混淆無關。而在運行時的 AOP 方案就會受混淆影響。
暫不支持 Java 9 以上平臺
其他問題請看插件的文檔和 Issues。
AspectJ 系列文章到此就結束了,有什么疑問和建議歡迎在下面留言。