背景

??本篇文章基于《網(wǎng)易樂得無埋點數(shù)據(jù)收集SDK》總結(jié)而成，關(guān)于網(wǎng)易樂得無埋點數(shù)據(jù)采集SDK的功能介紹以及技術(shù)總結(jié)后續(xù)會有文章進(jìn)行闡述，本篇單講SDK中用到的Android端AOP的實現(xiàn)。

??隨著流量紅利時代過去，精細(xì)化運營時代的開始，網(wǎng)易樂得開始構(gòu)建自己的大數(shù)據(jù)平臺。其中，客戶端數(shù)據(jù)采集是第一步。傳統(tǒng)收集數(shù)據(jù)的方式是埋點，這種方式依賴開發(fā)，采集時效慢，數(shù)據(jù)采集代碼與業(yè)務(wù)代碼不解藕。

??為了實現(xiàn)非侵入的，全量的數(shù)據(jù)采集，AOP成了關(guān)鍵，數(shù)據(jù)收集SDK探索和實現(xiàn)了一種Android上AOP的方式。

目錄

• 一、Android AOP
  ?1.1 什么是AOP
  ?1.2 Android AOP方式概述
  ?1.3 Android AOP方式對比選擇
• 二、AOP應(yīng)用情景
  ?2.1 Fragment生命周期
  ?2.2 用戶點擊事件
  ?2.3 彈窗事件
• 三、AOP實現(xiàn)概述
• 四、插樁入口
  ?4.1 Android打包流程說明
  ?4.2 插樁入口
  ?4.3 hook dx.jar獲得插樁入口
• 五、bytecode manipulation
  ?5.1 ASM庫簡要介紹
  ?5.2 字節(jié)碼基礎(chǔ)
  ?5.3 bytecode manipulation實踐
• 六、總結(jié)

一、Android AOP

1.1 什么是AOP

??面向切向編程（Aspect Oriented Programming），相對于面向?qū)ο缶幊?#xff08;ObjectOriented Programming）而言。
??OOP的精髓是把功能或問題模塊化，每個模塊處理自己的家務(wù)事。但在現(xiàn)實世界中，并不是所有問題都能完美得劃分到模塊中，有些功能是橫跨并嵌入眾多模塊里的，比如下圖所示的例子。

圖1-1 AOP概念說明示例

??上圖是一個APP模塊結(jié)構(gòu)示例，按照照OOP的思想劃分為“視圖交互”，“業(yè)務(wù)邏輯”，“網(wǎng)絡(luò)”等三個模塊，而現(xiàn)在假設(shè)想要對所有模塊的每個方法耗時（性能監(jiān)控模塊）進(jìn)行統(tǒng)計。這個性能監(jiān)控模塊的功能就是需要橫跨并嵌入眾多模塊里的，這就是典型的AOP的應(yīng)用場景。

??AOP的目標(biāo)是把這些橫跨并嵌入眾多模塊里的功能（如監(jiān)控每個方法的性能） 集中起來，放到一個統(tǒng)一的地方來控制和管理。如果說，OOP如果是把問題劃分到單個模塊的話，那么AOP就是把涉及到眾多模塊的某一類問題進(jìn)行統(tǒng)一管理。

??我們在開發(fā)無埋點數(shù)據(jù)收集是同樣也遇到了很多需要橫跨并嵌入眾多模塊里的場景，這些場景將在第二章（AOP應(yīng)用情景）進(jìn)行介紹。下面我們調(diào)研下Android AOP的實現(xiàn)方式。

1.2 Android AOP方式概述

??AOP從實現(xiàn)原理上可以分為運行時AOP和編譯時AOP，對于Android來講運行時AOP的實現(xiàn)主要是hook某些關(guān)鍵方法，編譯時AOP主要是在Apk打包過程中對class文件的字節(jié)碼進(jìn)行掃描更改。Android主流的aop 框架有：

• Dexposed，Xposed等（運行時）
• aspactJ（編譯時）

??除此之外，還有一些非框架的但是能幫助我們實現(xiàn) AOP的工具類庫：

• java的動態(tài)代理機(jī)制(對java接口有效)
• ASM,javassit等字節(jié)碼操作類庫
• (偏方)DexMaker:Dalvik 虛擬機(jī)上，在編譯期或者運行時生成代碼的 Java API。
• (偏方)ASMDEX(一個類似 ASM 的字節(jié)碼操作庫，運行在Android平臺，操作Dex字節(jié)碼)

1.3 Android AOP方式對比選擇

??Dexposed，Xposed的缺陷很明顯，xposed需要root權(quán)限，Dexposed只對部分系統(tǒng)版本有效。
??與之相比aspactJ沒有這些缺點，但是aspactJ作為一個AOP的框架來講對于我們來講太重了，不僅方法數(shù)大增，而且還有一堆a(bǔ)spactJ的依賴要引入項目中（這些代碼定義了aspactJ框架諸如切點等概念）。更重要的是我們的目標(biāo)僅僅是按照一些簡單的切點（用戶點擊等）收集數(shù)據(jù)，而不是將整個項目開發(fā)從OOP過渡到AOP。
??AspactJ對于我們想要實現(xiàn)的數(shù)據(jù)收集需求太重了，但是這種編譯期操作class文件字節(jié)碼實現(xiàn)AOP的方式對我們來說是合適的。
??因此我們實現(xiàn)Android上AOP的方式確定為：

• 采用編譯時的字節(jié)碼操作的做法
• 自己hook Android編譯打包流程并借助ASM庫對項目字節(jié)碼文件進(jìn)行統(tǒng)一掃描，過濾以及修改。

??在具體講解實現(xiàn)技術(shù)之前，先看一下無埋點數(shù)據(jù)收集需求遇到的三個需要AOP的場景。

二、AOP應(yīng)用情景

??下面舉出數(shù)據(jù)收集SDK通過修改字節(jié)碼進(jìn)行AOP的三個應(yīng)用情景，其中情景一和二的字節(jié)碼修改是方法級別的，情景三的字節(jié)碼修改是指令級別的。

2.1 Fragment生命周期

說明

??收集頁面數(shù)據(jù)時發(fā)現(xiàn)有些fragment是希望當(dāng)作頁面來看待，并且計算pv的(如首頁用fragmen實現(xiàn)的tab)。而fragment的頁面顯示／隱藏事件需要根據(jù)：

onResume() onPause() onHiddenChanged(boolean hidden) setUserVisibleHint(boolean isVisibleToUser)

??這四個方法綜合得出。
??也就是說當(dāng)項目中任一一個Fragment發(fā)生如上狀態(tài)變化，我們都要拿到這個時機(jī)，并上報相關(guān)頁面事件,也就是對Fragment的這幾個方法進(jìn)行AOP。
??做法是：

• 對項目中所有代碼進(jìn)行掃描，篩選出所有Fragment的子類
• 對這些篩選出來的類的的onResumed，onPaused，onHiddenChanged，setFragmentUserVisibleHint這幾個方法的字節(jié)碼進(jìn)行修改，添加上類似回調(diào)的邏輯
• 這樣在項目中任何一個Fragment的這些回調(diào)觸發(fā)的時候我們都可以得到通知，也即對Fragment的這幾個切點進(jìn)行了AOP。

示例

??假設(shè)我們有一個Fragment1（空類，內(nèi)部什么代碼也沒有）

public class Fragment1 extends Fragment {}

??經(jīng)過掃描修改字節(jié)碼后變?yōu)?#xff1a;

public class Fragment1 extends Fragment {@TransformedDCSDKpublic void onResume() {super.onResume();Monitor.onFragmentResumed(this);}@TransformedDCSDKpublic void onPause() {super.onPause();Monitor.onFragmentPaused(this);}@TransformedDCSDKpublic void onHiddenChanged(boolean var1) {super.onHiddenChanged(var1);Monitor.onFragmentHiddenChanged(this, var1);}@TransformedDCSDKpublic void setUserVisibleHint(boolean var1) {super.setUserVisibleHint(var1);Monitor.setFragmentUserVisibleHint(this, var1);} }

注：

Monitor.onFragmentResumed等函數(shù)用于上報頁面事件

@TransformedDCSDK 注解標(biāo)記方法被數(shù)據(jù)收集SDK進(jìn)行了字節(jié)碼修改

2.2 用戶點擊事件

說明

??點擊事件是分析用戶行為的一個重要事件，Android中的點擊事件回調(diào)大多是View.OnClickListener的onClick方法（當(dāng)然還有一部分是DialogInterface.OnClickListener或者重寫OnTouchEvent自己封裝的點擊）。
??也就是說當(dāng)項目中任一一個控件被點擊（觸發(fā)了OnClickListener），我們都要拿到這個時機(jī)，并上報點擊事件。也就是對View.OnClickListener的onClick方法進(jìn)行AOP。做法是：

• 對項目中所有代碼進(jìn)行掃描，篩選出所有實現(xiàn)View.OnClickListener接口的類（匿名or不匿名）
• 對onClick方法的字節(jié)碼進(jìn)行修改，添加回調(diào)。
• 達(dá)到的效果就是當(dāng)APP中任何一個View被點擊時，我們都可以在捕捉到這個時機(jī)，并且上報相關(guān)點擊事件。

示例

??假設(shè)有個實現(xiàn)接口的類

public class MyOnClickListener implements OnClickListener {public void onClick(View v) {//此處代表點擊發(fā)生時的業(yè)務(wù)邏輯} }

經(jīng)過掃描修改字節(jié)碼后變?yōu)?#xff1a;

public class MyOnClickListener implements OnClickListener {@TransformedDCSDKpublic void onClick(View v) {if (!Monitor.onViewClick(v)) {//此處代表點擊發(fā)生時的業(yè)務(wù)邏輯}} }

注：

Monitor.onViewClick函數(shù)里面包含上報點擊事件的邏輯

可以通過Monitor.onViewClick的返回值控制原有業(yè)務(wù)邏輯是否執(zhí)行，基本都是執(zhí)行的，只有在特殊模式下（圈選）數(shù)據(jù)收集SDK才會忽略原有邏輯

2.3 彈窗事件

說明

??彈窗顯示/關(guān)閉事件，當(dāng)然彈窗的實現(xiàn)可以是Dialog，PopupWindow，View甚至Activity，這里僅以Dialog為例。
??當(dāng)項目中任意一個地方彈出/關(guān)閉Dialog，我們都要拿到這個時機(jī)，即對Dialog.show/dismiss/hide這幾個方法進(jìn)行AOP。做法是：

• 對項目中所有代碼進(jìn)行掃描，篩選出所有字節(jié)碼指令中有調(diào)用Dialog.show/dismiss/hide的地方
• 字節(jié)碼指令替換，替換成一段回調(diào)邏輯。
• 這樣APP中所有Dialog的顯示/關(guān)閉時，我們都可以在這時進(jìn)行一些收集數(shù)據(jù)的操作。

示例

??假設(shè)項目中有一個代碼（例如方法）塊如下，其中某處調(diào)用了dialog.show()

某個方法 {//其他代碼dialog.show()//其他代碼 }

經(jīng)過掃描修改字節(jié)碼后變?yōu)?/p> 某個方法 {//其他代碼Monitor.showDialog(dialog)//其他代碼 }

注：Monitor.showDialog除了調(diào)用dialog.show()還進(jìn)行一些數(shù)據(jù)收集邏輯

三、AOP實現(xiàn)概述

??第二章 （AOP應(yīng)用情景）簡單地列舉了AOP在三種應(yīng)用情景中達(dá)到的效果，下面介紹AOP的實現(xiàn)，實現(xiàn)的大致流程如下圖所示：

圖3-1 Android AOP實現(xiàn)流程

關(guān)鍵有以下幾點：

A、字節(jié)碼插樁入口（圖3-1 中1，3兩個環(huán)節(jié)）。
??我們知道Android程序從Java源代碼到可執(zhí)行的Apk包，中間有（但不止有）兩個環(huán)節(jié)：

• javac：將源文件編譯成class格式的文件
• dex：將class格式的文件匯總到dex格式的文件中

??我們要想對字節(jié)碼進(jìn)行修改，只需要在javac之后，dex之前對class文件進(jìn)行字節(jié)碼掃描，并按照一定規(guī)則進(jìn)行過濾及修改就可以了，這樣修改過后的字節(jié)碼就會在后續(xù)的dex打包環(huán)節(jié)被打到apk中，這就是我們的插樁入口（更具體的后面還會詳述）。

B、bytecode manipulate（上圖3-1 中第二個環(huán)節(jié)），這個環(huán)節(jié)主要做：

字節(jié)碼掃描，并按照一定規(guī)則進(jìn)行過濾出哪些類的class文件需要進(jìn)行字節(jié)碼修改

對篩選出來的類進(jìn)行字節(jié)碼修改操作

??最后B步驟修改過字節(jié)碼的class文件，將連同資源文件，一起打入Apk中，得到最終可以在Android平臺可以運行的APP。

??下面分別就插樁入口和ASM字節(jié)碼操作兩個方面進(jìn)行詳述。

四、插樁入口

??如 第三章（AOP實現(xiàn)概述）所述，我們在Android 打包流程的javac之后，dex之前獲得字節(jié)碼插樁入口。

4.1 Android打包流程說明

??完整的Android 打包流程如下圖所示：

圖4-1 Android打包流程

??說明：

• 圖4-1中“dex”節(jié)點，表示將class文件打包到dex文件的過程，其輸入包括1.項目java源文件經(jīng)過javac后生成的class文件以及2.第三方依賴的class文件兩種，這些class文件都是我們進(jìn)行字節(jié)碼掃描以及修改的目標(biāo)。

• 具體來說，進(jìn)行圖4-1中dex任務(wù)是一個叫dx.jar的jar包，存在于Android SDK的sdk/build-tools/22.0.1/lib/dx.jar目錄中，通過類似 :

  java dx.jar com.android.dx.command.Main --dex --num-threads=4 —-output output.jar input.jar

  的命令，進(jìn)行將class文件打包為dex文件的步驟。

• 從上面的演示命令可以看出，dex任務(wù)是啟動一個java進(jìn)程，執(zhí)行dx.jar中com.android.dx.command.Main類(當(dāng)然對于multidex的項目入口可能不是這個類，這個再說)的main()方法進(jìn)行dex任務(wù)，具體完成class到dex轉(zhuǎn)化的是這個方法：

private static boolean processClass(String name,byte[] bytes) {//內(nèi)容省略 }

??方法processClass的第二個參數(shù)是一個byte[]，這就是class文件的二進(jìn)制數(shù)據(jù)（class文件是一種緊湊的8位字節(jié)的二進(jìn)制流文件， 各個數(shù)據(jù)項按順序緊密的從前向后排列， 相鄰的項［包括字節(jié)碼指令］之間沒有間隙），我們就是通過對這個二進(jìn)制數(shù)據(jù)進(jìn)行掃描，按照一定規(guī)則過濾以及字節(jié)碼修改達(dá)到第二部分所描述的AOP情景。

4.2 插樁入口

??那么我們怎么獲得插樁入口呢？

入口一：transform api

??對于Android Gradle Plugin 版本在1.5.0及以上的情況，Google官方提供了transformapi用作字節(jié)碼插樁的入口。此處的Android Gradle Plugin 版本指的是build.gradle dependencies的如下配置：

compile 'com.android.tools.build:gradle:1.5.0'

此處1.5.0即為Android Build Gradle Plugin 版本。

關(guān)于transform api如何使用就不詳細(xì)介紹了，

可自行查看API，

參考熱修復(fù)項目Nuwa的gradle插樁插件（使用transfrom api實現(xiàn)）

入口二：hook dx.jar

??那么對于Android Build Gradle Plugin 版本在1.5.0以下的情況呢？
??下面我們介紹一種不依賴transform api而獲得插樁入口的方法，暫且稱為 hook dx.jar吧。

提示：具體使用可以考慮綜合這兩種方式，首先檢查build環(huán)境是否支持transform api（反射檢查類com.android.build.gradle.BaseExtension是否有registerTransform這個方法即可）然后決定使用哪種方式的插樁入口。

4.3 hook dx.jar獲得插樁入口

??hook dx.jar 即是在圖4-1中的dex步驟進(jìn)行hook，具體來講就是hook 4.1節(jié)介紹的dx.jar中com.android.dx.command.Main.processClass方法，將這個方法的字節(jié)碼更改為：

private static boolean processClass(String name,byte[] bytes) {bytes＝掃描并修改（bytes）；// Hook點//原有邏輯省略}

注：這種方式獲得插樁入口也可參見博客《APM之原理篇》

??如何在一個標(biāo)準(zhǔn)的java進(jìn)程（記得么？dex任務(wù)是啟動一個java進(jìn)程，執(zhí)行dx.jar中com.android.dx.command.Main類的main()方法進(jìn)行dex任務(wù)）中對特定方法進(jìn)行字節(jié)碼插樁？

??這就需要運用Java1.5引入的Instrumentation機(jī)制。

java Instrumentation

??java Instrumentation指的是可以用獨立于應(yīng)用程序之外的代理（agent）程序來監(jiān)測和協(xié)助運行在JVM上的應(yīng)用程序。這種監(jiān)測和協(xié)助包括但不限于獲取JVM運行時狀態(tài)，替換和修改類定義等。
??Instrumentation 的最大作用就是類定義的動態(tài)改變和操作。

Java Instrumentation兩種使用方式：

• 方式一(java 1.5+)：
  開發(fā)者可以在一個普通 Java 程序（帶有 main 函數(shù)的 Java 類）運行時，通過?– javaagent?參數(shù)指定一個特定的 jar 文件(agent.jar)（包含 Instrumentation 代理）來啟動 Instrumentation 的代理程序。例如:

  java -javaagent agent.jar dex.jar com.android.dx.command.Main --dex …........

  如此，則在目標(biāo)main函數(shù)執(zhí)行之前，執(zhí)行agent jar包指定類的 premain方法 ：

  premain(String args, Instrumentation inst)

• 方式二(java 1.6+)：

  VirtualMachine.loadAgent(agent.jar) VirtualMachine vm = VirtualMachine.attach(pid); vm.loadAgent(jarFilePath, args);

  此時，將執(zhí)行agent jar包指定類的 agentmain方法：

  agentmain(String args, Instrumentation inst)

說明：

• 關(guān)于上述代碼中出現(xiàn)的agent.jar?
  ??這里的agent就是一個包含一些指定信息的jar包，就像OSGI的插件jar包一樣，在jar包的META-INF/MANIFEST.MF中添加如下信息：

  Manifest-Version: 1.0 Agent-Class: XXXXX Premain-Class: XXXXX Can-Redefine-Classes: true Can-Retransform-Classes: true

  ??這個jar包就成了agent jar包，其中Agent-Class指向具有agentmain(String args, Instrumentation inst)方法的類，Premain-Class指向具有premain(String args, Instrumentation inst)的類。

• 關(guān)于premain(String args, Instrumentation inst)？
  ??第二個參數(shù)，Instumentation 類有個方法

  addTransformer(ClassFileTransformer transformer,boolean canRetransform)

  ??而一旦為Instrumentation inst添加了ClassFileTransformer：

  ClassFileTransformer c=new ClassFileTransformer() inst.addTransformer(c,true);

  ??那么以后這個jvm進(jìn)程中再有任何類的加載定義，都會出發(fā)此ClassFileTransformer的transform方法

  byte[] transform( ClassLoader loader,String className,Class classBeingRedefined,ProtectionDomain protectionDomain,byte[] classfileBuffer)throwsIllegalClassFormatException;

  ??其中，參數(shù)byte[] classfileBuffer是類的class文件數(shù)據(jù)，對它進(jìn)行修改就可以達(dá)到在一個標(biāo)準(zhǔn)的java進(jìn)程中對特定方法進(jìn)行字節(jié)碼插樁的目的。

hook dx.jar獲得插樁入口的完整流程

完整流程如下圖所示：

圖4-2 hook dx.jar流程圖

注：apply plugin: 'bytecodeplugin'中的bytecodeplugin是我們用于字節(jié)碼插樁的gradle插件

A. 通過任意方式（as界面內(nèi)點擊／命令gradle build等）都會啟動圖4-2所描述的build流程。

B. 通過Java Instrumentation機(jī)制，為獲得插樁入口，對于apk build過程進(jìn)行了兩處插樁（即hook），圖4-2中標(biāo)紅部分：

• 在build進(jìn)程，對ProcessBuilder.start()方法進(jìn)行插樁
  ProcessBuilder類是J2SE 1.5在java.lang中新添加的一個新類，此類用于創(chuàng)建操作系統(tǒng)進(jìn)程，它提供一種啟動和管理進(jìn)程的方法，start方法就是開始創(chuàng)建一個進(jìn)程,對它進(jìn)行插樁，使得通過下面方式啟動dx.jar進(jìn)程執(zhí)行dex任務(wù)時：

  java dex.jar com.android.dx.command.Main --dex …........

  增加參數(shù)-javaagent agent.jar，使得dex進(jìn)程也可以使用Java Instrumentation機(jī)制進(jìn)行字節(jié)碼插樁

• 在dex進(jìn)程
  對我們的目標(biāo)方法com.android.dx.command.Main.processClasses進(jìn)行字節(jié)碼插入，從而實現(xiàn)打入apk的每一個項目中的類都按照我們制定的規(guī)則進(jìn)行過濾及字節(jié)碼修改。

C. 圖4-2左側(cè)build進(jìn)程使用Instrumentation的方式時之前敘述過的VirtualMachine.loadAgent方式（方式二），dex進(jìn)程中的方式則是-javaagent agent.jar方式（方式一）。

??由此，我們獲得了進(jìn)行字節(jié)碼插樁的入口，下面我們就使用ASM庫的API，對項目中的每一個類進(jìn)行掃描，過濾，及字節(jié)碼修改。

五、bytecode manipulation

??在這一部分我們以第二部分描述的情景二的應(yīng)用場景為例，對View.OnClickListener的onClick方法進(jìn)行字節(jié)碼修改。在實踐bytecode manipulation時需要一些關(guān)于字節(jié)碼以及ASM的基礎(chǔ)知識需要了解。因此本部分組織結(jié)構(gòu)如下：

• 首先介紹一下我們用來操縱字節(jié)碼的類庫ASM
• 然后介紹一些關(guān)于字節(jié)碼的基本知識
• 最后實踐對View.OnClickListener的onClick方法進(jìn)行bytecode manipulation

5.1 ASM庫簡要介紹

簡介

??ASM是一個java字節(jié)碼操縱框架，它能被用來動態(tài)生成類或者增強(qiáng)既有類的功能。ASM 可以直接產(chǎn)生二進(jìn)制 class 文件，也可以在類被加載入 Java 虛擬機(jī)之前動態(tài)改變類行為。類似功能的工具庫還有javassist，BCEL等。
??那么為什么選擇ASM呢？
??ASM與同類工具庫（這里以javassist為例）相比：

A. 較難使用，API非常底層，貼近字節(jié)碼層面，需要字節(jié)碼知識及虛擬機(jī)相關(guān)知識
B. ASM更快更高效，Javassist實現(xiàn)機(jī)制中包括了反射，所以更慢。下表是使用不同工具庫生成同一個類的耗時比較

Framework First time Later times

Javassist	257	5.2
BCEL	473	5.5
ASM	62.4	1.1

C. ASM庫更加強(qiáng)大靈活，比如可以感知細(xì)到字節(jié)碼指令層次（第二部分情景三中的場景）

總結(jié)起來，ASM雖然不太容易使用，但是功能強(qiáng)大效率高值得挑戰(zhàn)。

關(guān)于ASM庫的使用可以參考手冊，下面對其API進(jìn)行簡要介紹：

ASM API簡介

??ASM（core api） 按照visitor模式按照class文件結(jié)構(gòu)依次訪問class文件的每一部分，有如下幾個重要的visitor。

ClassVisitor

按照class文件格式，按次序訪問類文件每一部分，如下：

public abstract class ClassVisitor { public ClassVisitor(int api); public ClassVisitor(int api, ClassVisitor cv); public void visit(int version, int access, String name, String signature, String superName, String[] interfaces); public void visitSource(String source, String debug); public void visitOuterClass(String owner, String name, String desc); AnnotationVisitor visitAnnotation(String desc, boolean visible); public void visitAttribute(Attribute attr); public void visitInnerClass(String name, String outerName, String innerName, int access); public FieldVisitor visitField(int access, String name, String desc, String signature, Object value); public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions); void visitEnd(); }

與之對應(yīng)的class文件格式為：

圖5-1 class文件格式

重點看ClassVisitor的如下幾個方法：

• visit：按照圖5-1中描述的?class文件格式，讀出“class類名”（this_class的指向），“父類名”（super_class的指向），“實現(xiàn)的接口（數(shù)組）”（interfaces的指向）等信息
• visitField：訪問字段，即訪問圖5-1?class文件格式中的“field_info”,訪問字?jǐn)嗟倪壿嬑薪o另外一種visitor（FieldVisitor）
• visitField：訪問方法，即訪問圖5-1?class文件格式中的“method_info”,訪問方法的邏輯委托給另外一種visitor（MethodVisitor）

其他方法可參考前面推薦的ASM手冊，下面介紹一下負(fù)責(zé)訪問方法的MethodVisitor。

MethodVisitor

按以下次序訪問一個方法：

visitAnnotationDefault? ( visitAnnotation | visitParameterAnnotation | visitAttribute )* ( visitCode( visitTryCatchBlock | visitLabel | visitFrame | visitXxxInsn | visitLocalVariable | visitLineNumber )*visitMaxs )? visitEnd

注：上述出現(xiàn)的“＊”表示出現(xiàn)“0+”次，“？”表示出現(xiàn)“0/1”次。 含義可類比正則式元字符。

下面說明幾個比較關(guān)鍵的visit方法：

• visitCode()：開始訪問方法體內(nèi)的代碼
• visitTryCatchBlock：訪問方法的try catch block
• visitLocalVariable：指令，訪問局部變量表里面的某個局部變量（關(guān)于局部變量表后面會有介紹）
• visitXxxInsn：指令，表示class文件方法體里面的字節(jié)碼指令（如：IADD，ICONST_0，ARETURN等等字節(jié)碼指令），完整的字節(jié)碼指令表可參考維基百科。
• visitLabel(Label label)：如果方法體中有跳轉(zhuǎn)指令，字節(jié)碼指令中會出現(xiàn)label，所謂label可以近似看成行號的標(biāo)記（并不是），指示跳轉(zhuǎn)指令將要跳轉(zhuǎn)到哪里
• visitFrame：記錄當(dāng)前棧幀（棧幀結(jié)構(gòu)將在后面有介紹）狀態(tài)，用于Class文件加載時的校驗
• visitMaxs：指定當(dāng)前方法的棧幀中，局部變量表和操作數(shù)棧的大小。（java棧大小是javac之后就確定了的）

簡單介紹了asm庫后，由于使用ASM還需要對字節(jié)碼有一定的了解，故在實踐之前再介紹一些關(guān)于字節(jié)碼的基礎(chǔ)知識：

5.2 字節(jié)碼基礎(chǔ)

概念

關(guān)于字節(jié)碼，有以下概念定義比較重要：

• 全限定名（Internal names）:
  全限定名即為全類名中的“.”,換為“/”，舉例： 類android.widget.AdapterView.OnItemClickListener的全限定名為： android/widget/AdapterView$OnItemClickListener
• 描述符(descriptors)：
  1.類型描述符，如下圖所示：

圖5-2 java類型描述符

如圖5-2所示，在class文件中類型 boolean用“Z”描述，數(shù)組用“［”描述（多維數(shù)組可疊加）,那么我們最常見的自定義引用類型呢？“L全限定名；”.例如:
Android中的android.view.View類，描述符為“Landroid/view/View;”

2.方法描述符的組織結(jié)構(gòu)為：

（參數(shù)類型描述符）返回值描述符

其中無返回值void用“V”代替,舉例：

方法boolean onGroupClick(ExpandableListView parent, View v, int groupPosition, long id) 　的描述符如下： (Landroid/widget/ExpandableListView;Landroid/view/View;IJ)Z

執(zhí)行引擎

jvm執(zhí)行引擎用于執(zhí)行字節(jié)碼，如下圖

圖5-3 字節(jié)碼執(zhí)行引擎棧幀結(jié)構(gòu)

??如圖5-3所示，縱向來看有三個線程，其中每一個線程內(nèi)部都有一個棧結(jié)構(gòu)（即通常所說的“堆棧”中的虛擬機(jī)棧），棧中的每一個元素（一幀）稱為一個棧幀（stack frame）。棧幀與我們寫的方法一一對應(yīng)，每個方法的調(diào)用／return對應(yīng)線程中的一個棧幀的入棧／出棧。

??方法體中各種字節(jié)碼指令的執(zhí)行都在棧幀中完成，下面介紹下棧幀中兩個比較重要的部分：

• 局部變量表：
  故名思義，存儲當(dāng)前方法中的局部變量，包括方法的入?yún)ⅰＶ档米⒁獾氖蔷植孔兞勘淼牡谝粋€槽位存放的是this。還拿方法onGroupClick舉例： boolean onGroupClick(ExpandableListView parent, View v, int groupPosition, long id) 剛進(jìn)入此方法時，局部變量表的槽位狀態(tài)如下：

Slot Number value

0	this
1	ExpandableListView parent
2	View v
3	int groupPosition
4	long id

• 操作數(shù)棧：
  字節(jié)碼指令執(zhí)行的工作臺。下面用指令iadd（int類型加）執(zhí)行時操作數(shù)棧的變化進(jìn)行舉例：

圖5-4 執(zhí)行iadd指令時操作數(shù)棧的狀態(tài)變化

例如，方法體中有語句如下：

1+1

• 在執(zhí)行iadd之前需要先壓兩個“1”到操作數(shù)棧（因為iadd指令需要兩個操作數(shù)，執(zhí)行后產(chǎn)生一個操作數(shù)）
• 從常量池中（“1”為int常量）經(jīng)過兩個iconst_1后操作數(shù)棧的狀態(tài)如圖5-4中所示“操作數(shù)棧狀態(tài)1”
• 執(zhí)行iadd，將兩個“1”彈出，交給ALU相加，把結(jié)果“2”入棧，操作數(shù)棧的狀態(tài)如圖5-4中所示“操作數(shù)棧狀態(tài)2”

5.3 bytecode manipulation實踐

我們來實踐第二部分情景二描述的AOP，即修改所有View.OnClickListener的OnClick方法的字節(jié)碼。流程如下圖所示：

圖5-5 AOP 控件點擊實現(xiàn)流程

對上圖中三個步驟的詳細(xì)說明：

步驟一：

ASM的ClassVisitor對所有類的class文件進(jìn)行掃描，在visit方法中得到當(dāng)前類實現(xiàn)了哪些接口，判斷這些接口中是否包含全限定名為“android/view/View$OnClickListener”的接口。如果有，證明當(dāng)前類是View.OnClickListener，進(jìn)行步驟二，否則終止掃描；

步驟二：

ClassVisitor每掃描到一個方法時，在visitMethod中進(jìn)行如下判定：

此方法的名字是否為"onClick"

此方法的描述符是否為"(Landroid/view/View;)V"

如果全部判定通過，則證明本次掃描到的方法是View.OnClickListener的onClick方法，然后將
將掃描邏輯交給MethodVisitor，進(jìn)行字節(jié)碼的修改（步驟三）。

步驟三：修改onClick方法的字節(jié)碼

假設(shè)待修改的onClick方法如下：

public void onClick(View v) {System.out.println("test");//代表方法中原有的代碼（邏輯） }

修改之后需要變成：

public void onClick(View v) {if(!Monitor.onViewClick(v)) {System.out.println("test");//代表方法中原有的代碼（邏輯）}}

即:
??進(jìn)入方法之后先執(zhí)行Monitor.onViewClick(v)（里面是數(shù)據(jù)收集邏輯），然后根據(jù)返回值決定是執(zhí)行原有onClick方法內(nèi)的邏輯，還是說直接返回。下面是修改之后onClick方法的字節(jié)碼：

public onClick(Landroid/view/View;)VALOAD 1//插入的字節(jié)碼，將index為1的局部變量（入?yún)）壓入操作數(shù)棧INVOKESTATIC com/netease/lede/bytecode/monitor/Monitor.onViewClick (Landroid/view/View;)Z//插入的字節(jié)碼，調(diào)用方法Monitor.onViewClick(v)，將返回值（true/false）壓入操作數(shù)棧IFEQ L0//插入的字節(jié)碼,如果操作數(shù)棧棧頂為0（if條件為false），則跳轉(zhuǎn)到lable L0，執(zhí)行原有邏輯RETURN//插入的字節(jié)碼，上條指令判斷不滿足（即操作數(shù)棧棧頂為1（true）），直接返回L0LINENUMBER 11 L0FRAME SAMEGETSTATIC java/lang/System.out : Ljava/io/PrintStream;LDC "test"INVOKEVIRTUAL java/io/PrintStream.println (Ljava/lang/String;)VL1LINENUMBER 12 L1RETURNL2LOCALVARIABLE this Lcom/netease/caipiao/datacollection/bytecode/ViewOnclickListener; L0 L2 0LOCALVARIABLE v Landroid/view/View; L0 L2 1MAXSTACK = 2//操作數(shù)棧最大為2MAXLOCALS = 2//局部變量表最大為2

如上圖所示，插入的字節(jié)碼主要是前面四行（圖中已經(jīng)用注釋的形式做了標(biāo)記），圖中的字節(jié)碼指令可以參照下表：

字節(jié)碼指令 說明 指令入?yún)?/tr>

ALOAD	將引用類型的對象從局部變量表load到操作數(shù)棧	局部變量表index
INVOKESTATIC	調(diào)用類方法（即靜態(tài)方法）	1.類全限定名 2.方法描述符
INVOKEVIRTUAL	調(diào)用對象方法	1.類全限定名 2.方法描述符
IFEQ	檢查操作數(shù)棧棧定位置是否為０	跳轉(zhuǎn)Lable（棧頂為0時跳轉(zhuǎn)）
RETURN	無返回值返回（操作數(shù)棧無彈棧操作）	?
IRETURN	返回int值（操作數(shù)棧將棧頂int值彈棧）	?
GETSTATIC	獲取類字段（靜態(tài)成員變量）	1.類全限定名，2.字段類型描述符
LDC	從常量池取int,float,String等常量到操作數(shù)棧頂	常量值
MAXSTACK	操作數(shù)棧最大容量（javac編譯時確定）	?
MAXLOCALS	局部變量表最大容量(javac編譯時確定)

具體插入的代碼是字節(jié)碼代碼的前四行，邏輯比較簡單：

進(jìn)入方法之后先執(zhí)行Monitor.onViewClick(v)
ALOAD 1：將index為1的局部變量（入?yún)）壓入操作數(shù)棧
INVOKESTATIC com/netease/lede/bytecode/monitor/Monitor.onViewClick (Landroid/view/View;)Z：
調(diào)用方法Monitor.onViewClick(v)(消耗ALOAD 1壓入的操作數(shù))，并將返回值（true/false）壓入操作數(shù)棧

根據(jù)返回值決定跳轉(zhuǎn)
IFEQ L0：
如果操作數(shù)棧棧頂為0（if條件為false），則跳轉(zhuǎn)到lable L0，執(zhí)行原有邏輯
RETURN：上條指令判斷不滿足（即操作數(shù)棧棧頂為1（true）），直接返回

注：值得注意的是MAXSTACK，MAXLOCALS 兩個值在javac生成的class文件就已經(jīng)固定，即，棧內(nèi)存大小已經(jīng)確定（有別于堆內(nèi)存可以在運行時動態(tài)申請/釋放）。

如此，經(jīng)過上述三個步驟，我們完成了第二部分情景二描述的AOP實踐。

六、總結(jié)

文章寫的比較長，下面對主要的幾點進(jìn)行總結(jié)：

??首先介紹了AOP的概念，已及在Android平臺的主流框架，面對無埋點數(shù)據(jù)收集的需求，這些現(xiàn)有的都不太合適因此需要自己動手實現(xiàn)，
??然后，簡單列舉了無埋點數(shù)據(jù)收集SDK中需要AOP的應(yīng)用情景
??最后介紹了實現(xiàn)的技術(shù)細(xì)節(jié)，主要有兩點：

通過hook dx.jar的方式獲得插樁入口（可以和transfrom api配合使用）

使用ASM庫修改字節(jié)碼，此部分簡要介紹了關(guān)于字節(jié)碼的一些基本概念以及執(zhí)行引擎，最后以View.OnClickListener為例進(jìn)行了實踐。

原文地址：　http://www.jianshu.com/p/c202853059b4

總結(jié)

以上是生活随笔為你收集整理的Android AOP之字节码插桩的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。