Android面向切面編程框架(AspectJ 講解)

安裝AspectJ

Android上的ApsectJ開發由幾部分組成,AspectJ gradle插件,ApsectJ依賴,還有 AspectJ編譯器。
首先安裝AspectJ編譯器很簡單,就跟安裝JAVA環境一樣,
下載鏈接:http://www.eclipse.org/downloads/download.php?file=/tools/aspectj/aspectj-1.9.0.jar
目前最新的已經更新到1.9.1了。如果你電腦已經有JAVA環境的話直接運行這個jar包就行,
在安裝完畢後需要配置環境變量到 aspectj的bin目錄下,這裏不贅述

export PATH="$PATH:~/Library/Android/sdk/platform-tools"
export PATH="$PATH:/usr/local/opt/gradle/gradle-4.1/bin"
export PATH="$PATH:~/Library/Android/sdk/ndk-bundle"
export PATH="$PATH:~/Library/flutter/bin"
export PATH="$PATH:~/Library/kotlinc/bin"
export PATH="$PATH:~/Library/AspectJ/bin" <- AspectJ的PATH
配置完後運行 ajc -v 應該可以看到對應輸出

AspectJ Compiler 1.9.1 (1.9.1 - Built:  2018 at 17:52:10 GMT)

贈送源碼:https://github.com/yugu88/MagicWX

《最完整的Android逆向知識體系》


配置Android Gradle增加AspectJ依賴

首先需要把 AspectJ 依賴加到 gradle根目錄中,

buildscript {
    repositories {
        maven { url 'https://maven.google.com' }
        maven { url 'https://jitpack.io' }
        jcenter()
        google()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.2.1'
        classpath 'org.aspectj:aspectjtools:1.9.1'
        classpath 'org.aspectj:aspectjweaver:1.9.1'
    }
}

然後在項目app目錄的build.gradle需要添加以下內容,

import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main

apply plugin: 'com.android.application'


android {

    ...

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    implementation 'org.aspectj:aspectjrt:1.9.1'
}

final def log = project.logger
final def variants = project.android.applicationVariants
variants.all { variant ->
    if (!variant.buildType.isDebuggable()) {
        log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
        return
    }

    JavaCompile javaCompile = variant.javaCompile
    javaCompile.doLast {
        String[] args = ["-showWeaveInfo",
                         "-1.8",
                         "-inpath", javaCompile.destinationDir.toString(),
                         "-aspectpath", javaCompile.classpath.asPath,
                         "-d", javaCompile.destinationDir.toString(),
                         "-classpath", javaCompile.classpath.asPath,
                         "-bootclasspath", project.android.bootClasspath.join(File.pathSeparator)]
        log.debug "ajc args: " + Arrays.toString(args)

        MessageHandler handler = new MessageHandler(true)
        new Main().run(args, handler)
        for (IMessage message : handler.getMessages(null, true)) {
            switch (message.getKind()) {
                case IMessage.ABORT:
                case IMessage.ERROR:
                case IMessage.FAIL:
                    log.error message.message, message.thrown
                    break
                case IMessage.WARNING:
                    log.warn message.message, message.thrown
                    break
                case IMessage.INFO:
                    log.info message.message, message.thrown
                    break
                case IMessage.DEBUG:
                    log.debug message.message, message.thrown
                    break
            }
        }
    }
}

創建AspectJ代碼

下面這部分代碼看起來會一臉懵逼,不過目前先不用管具體的語法含義,
先跑起來環境,然後再結合理論慢慢在修改代碼中感受就能快速的上手AOP了。
以一個HelloWorld爲例子,我們的MainActivity中啥事情不幹,只有基本的生命週期方法。

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

    @Override
    protected void onStart() {
        super.onStart();
    }
}

現在我們要寫一個AspectJ類。
這個類要做的事情是告訴ACJ編譯器,要在MainActivity中的每個方法前面打印一行log,輸出當前執行的是哪個方法,

@Aspect
public class AspectTest {

    @Pointcut("execution(* phoenix.com.helloaspectj.MainActivity.**(..))")
    public void executeAspectJ() {
    } // 注意*號後面必須有空格

    @Before("executeAspectJ()")
    public void beforeAspectJ(JoinPoint joinPoint) throws Throwable  {
        Log.d(”tag“, "injected -> " + joinPoint.toShortString());
    }
}

第一次接觸AspectJ的看到這段代碼有點摸不着頭腦,解釋一下幾個註解的意思,
@Aspect: 告訴ACJ編譯器這是個AspectJ類
@PointCut: PointCut是AspectJ中的一個概念,跟它一起的另一個概念是 JoinPoint,這兩個概念一起描述要注入的切面
@Before: 表示要注入的位置,常用的有 Before/After/Around,分別表示在執行前,執行後,和取代原方法

這裏@PointCut註解後的參數表示的意思是對 MainActivity中的所有方法進行注入,參數用的是正則匹配語法。
下面看看這段代碼執行的結果

16:04:56.611 22823-22823/? D/tag: injected -> execution(MainActivity.onCreate(..))
16:04:56.661 22823-22823/? D/tag: injected -> execution(MainActivity.onStart())

看到雖然我們沒有在MainActivity中寫入log打印語句,但是通過AspectJ實現了,在MainActivity兩個生命週期執行前插入了我們自己的log。

嚴格的說使用方式有兩種,隨便網上搜一下都能找到,例子就不多舉了,隨便體驗一個簡單,有了直接的感受就好。

本篇主要目的還是讓新手快速上手並親身體會,關鍵 讓你知道我們開發的時候用AspectJ來乾點啥。。

(知識點很簡單,主要還是消除大家心裏的疑惑,帶着疑惑很難接受新知識)---這也是我的一個學習方法。


Pointcuts 示例

以下示例表示在aspectjx插件下,相同包是指同一個aar/jar包,AspectJ常規配置下不同包不能執行“execution”織入

execution

    execution(* com.howtodoinjava.EmployeeManager.*( .. ))
    匹配EmployeeManger接口中所有的方法
    execution(* EmployeeManager.*( .. ))
    當切面方法和EmployeeManager接口在相同的包下時,匹配EmployeeManger接口中所有的方法
    execution(public * EmployeeManager.*(..))
    當切面方法和EmployeeManager接口在相同的包下時,匹配EmployeeManager接口的所有public方法
    execution(public EmployeeDTO EmployeeManager.*(..))
    匹配EmployeeManager接口中權限爲public並返回類型爲EmployeeDTO的所有方法。
    execution(public EmployeeDTO EmployeeManager.*(EmployeeDTO, ..))
    匹配EmployeeManager接口中權限爲public並返回類型爲EmployeeDTO,第一個參數爲EmployeeDTO類型的所有方法。
    execution(public EmployeeDTO EmployeeManager.*(EmployeeDTO, Integer))
    匹配EmployeeManager接口中權限爲public、返回類型爲EmployeeDTO,參數定義爲EmployeeDTO,Integer的所有方法。
    "execution(@com.xyz.service.BehaviorTrace * *(..))"
    匹配註解爲"@com.xyz.service.BehaviorTrace",返回值爲任意類型,任意包名下的任意方法。

within

任意連接點:包括類/對象初始化塊,field,方法,構造器

    within(com.xyz.service.*)
    com.xyz.service包下任意連接點
    within(com.xyz.service..*)
    com.xyz.service包或子包下任意連接點
    within(TestAspect)
    TestAspect類下的任意連接點
    within(@com.xyz.service.BehavioClass *)
    持有com.xyz.service.BehavioClass註解的任意連接點

主要應用場景:(重點)

  • 數據統計
  • 日誌記錄
  • 用戶行爲統計
  • 應用性能統計
  • 數據校驗
  • 行爲攔截
  • 無侵入的在宿主中插入一些代碼,
  • 做日誌埋點
  • 性能監控
  • 動態權限控制
  • 代碼調試

AspectJ 只是 AOP 的一種手段,類似的還有用 asm 去修改字節碼。

AOP之所以會有越來越多的人去了解。

  • 第一,非常好的去耦合。
  • 第二,可以用AOP來實現無痕埋點,數據收集,甚至修改SDK中動不了的代碼。

暫不支持 Java 9 以上平臺

其他問題請看插件的文檔和 Issues。

贈送源碼:https://github.com/yugu88/MagicWX

《最完整的Android逆向知識體系》

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章