2. 程式人生 > >Android中的AOP程式設計

Android中的AOP程式設計

阿新 • • 發佈：2019-01-31

面向切面程式設計（AOP，Aspect-oriented programming）需要把程式邏輯分解成『關注點』（concerns，功能的內聚區域）。這意味著，在 AOP 中，我們不需要顯式的修改就可以向程式碼中新增可執行的程式碼塊。這種程式設計正規化假定『橫切關注點』（cross-cutting concerns，多處程式碼中需要的邏輯，但沒有一個單獨的類來實現）應該只被實現一次，且能夠多次注入到需要該邏輯的地方。

程式碼注入是 AOP 中的重要部分：它在處理上述提及的橫切整個應用的『關注點』時很有用，例如日誌或者效能監控。這種方式，並不如你所想的應用甚少，相反的，每個程式設計師都可以有使用這種注入程式碼能力的場景，這樣可以避免很多痛苦和無奈。

AOP 是一種已經存在了很多年的程式設計正規化。我發現把它應用到 Android 開發中也很有用。經過一番調研後，我認為我們用它可以獲得很多好處和有用的東西。

術語（迷你術語表）

在開始之前，我們先看看需要了解的詞彙：

  • Cross-cutting concerns（橫切關注點）: 儘管面向物件模型中大多數類會實現單一特定的功能，但通常也會開放一些通用的附屬功能給其他類。例如，我們希望在資料訪問層中的類中新增日誌，同時也希望當UI層中一個執行緒進入或者退出呼叫一個方法時新增日誌。儘管每個類都有一個區別於其他類的主要功能，但在程式碼裡，仍然經常需要新增一些相同的附屬功能。

  • Advice（通知）:

    注入到class檔案中的程式碼。典型的 Advice 型別有 before、after 和 around，分別表示在目標方法執行之前、執行後和完全替代目標方法執行的程式碼。 除了在方法中注入程式碼，也可能會對程式碼做其他修改，比如在一個class中增加欄位或者介面。

  • Joint point（連線點）: 程式中可能作為程式碼注入目標的特定的點，例如一個方法呼叫或者方法入口。

  • Pointcut（切入點）: 告訴程式碼注入工具，在何處注入一段特定程式碼的表示式。例如，在哪些 joint points 應用一個特定的 Advice。切入點可以選擇唯一一個，比如執行某一個方法，也可以有多個選擇，比如，標記了一個定義成@DebguTrace 的自定義註解的所有方法。

  • Aspect（切面）: Pointcut 和 Advice 的組合看做切面。例如，我們在應用中通過定義一個 pointcut 和給定恰當的advice，新增一個日誌切面。

  • Weaving（織入）: 注入程式碼（advices）到目標位置（joint points）的過程。

下面這張圖簡要總結了一下上述這些概念。


那麼...我們何時何地應用AOP呢？

一些示例的 cross-cutting concerns 如下：

取決於你所選的其中一種或其他方案 :)。

工具和庫

有一些工具和庫幫助我們使用 AOP:

  • AspectJ: 一個 JavaTM 語言的面向切面程式設計的無縫擴充套件（適用Android）。

  • Javassist for Android: 用於位元組碼操作的知名 java 類庫 Javassist 的 Android 平臺移植版。

  • DexMaker: Dalvik 虛擬機器上，在編譯期或者執行時生成程式碼的 Java API。

  • ASMDEX: 一個類似 ASM 的位元組碼操作庫，執行在Android平臺，操作Dex位元組碼。

為什麼用 AspectJ？

我們下面的例子選用 AspectJ，有以下原因：

  • 功能強大
  • 支援編譯期和載入時程式碼注入
  • 易於使用

示例

比方說，我們要測量一個方法的效能（執行這個方法需要多長時間）。為此我們用一個 @DebugTrace 的註解標記我們的這個方法，並且無需在每個註解過的方法中編寫程式碼，就可以通過 logcat 輸出結果。我們的方法是使用 AspectJ 達到這個目的。

我們看下在底層到底發生了什麼：

  • 我們在編譯過程中增加一個新的步驟處理註解。
  • 註解的方法內會生成和注入必要的樣板程式碼。

在此，我必須要提到當我研究這些時，發現了Jake Wharton’s Hugo Library 這個專案，支援做同樣的事情。因此，我重構了我的程式碼，看上去和它類似。儘管，我的程式碼是一個更加原始和簡化的版本（順便提一下，通過看這個專案的程式碼，我學到了很多）。


工程結構

我們會把一個簡單的示例應用拆分成兩個 modules，第一個包含我們的 Android App 程式碼，第二個是一個 Android Library 工程，使用 AspectJ 織入程式碼（程式碼注入）。

你可能會想知道為什麼我們用一個 Android Library 工程，而不是用一個純的 Java Library：原因是為了使 AspectJ 能在 Android 上執行，我們必須在編譯時做一些 hook。這隻能使用 andorid-library gradle 外掛完成。（先不要為此擔心，後面我會給出更多細節。）

建立註解

首先我們建立我們的Java註解。這個註解週期宣告在 class 檔案上（RetentionPolicy.CLASS），可以註解建構函式和方法（ElementType.CONSTRUCTOR 和 ElementType.METHOD）。因此，我們的 DebugTrace.java 檔案看上是這樣的：

@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.CONSTRUCTOR, ElementType.METHOD })
public @interface DebugTrace {}

我們的效能監控計時類

我已經建立了一個簡單的計時類，包含 start/stop 方法。下面是 StopWatch.java 檔案:

/**
 * Class representing a StopWatch for measuring time.
 */
public class StopWatch {
  private long startTime;
  private long endTime;
  private long elapsedTime;

  public StopWatch() {
    //empty
  }

  private void reset() {
    startTime = 0;
    endTime = 0;
    elapsedTime = 0;
  }

  public void start() {
    reset();
    startTime = System.nanoTime();
  }

  public void stop() {
    if (startTime != 0) {
      endTime = System.nanoTime();
      elapsedTime = endTime - startTime;
    } else {
      reset();
    }
  }

  public long getTotalTimeMillis() {
    return (elapsedTime != 0) ? TimeUnit.NANOSECONDS.toMillis(endTime - startTime) : 0;
  }
}

DebugLog 類

我只是包裝了一下 “android.util.Log”，因為我首先想到的是向 android log 中增加更多的實用功能。下面是程式碼：

/**
 * Wrapper around {@link android.util.Log}
 */
public class DebugLog {

  private DebugLog() {}

  /**
   * Send a debug log message
   *
   * @param tag Source of a log message.
   * @param message The message you would like logged.
   */
  public static void log(String tag, String message) {
    Log.d(tag, message);
  }
}

Aspect 類

現在是時候建立我們的 Aspect 類（TraceAspect.java）了。Aspect 類負責管理註解的處理和程式碼織入。

/**
 * Aspect representing the cross cutting-concern: Method and Constructor Tracing.
 */
@Aspect
public class TraceAspect {

  private static final String POINTCUT_METHOD =
      "execution(@org.android10.gintonic.annotation.DebugTrace * *(..))";

  private static final String POINTCUT_CONSTRUCTOR =
      "execution(@org.android10.gintonic.annotation.DebugTrace *.new(..))";

  @Pointcut(POINTCUT_METHOD)
  public void methodAnnotatedWithDebugTrace() {}

  @Pointcut(POINTCUT_CONSTRUCTOR)
  public void constructorAnnotatedDebugTrace() {}

  @Around("methodAnnotatedWithDebugTrace() || constructorAnnotatedDebugTrace()")
  public Object weaveJoinPoint(ProceedingJoinPoint joinPoint) throws Throwable {
    MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
    String className = methodSignature.getDeclaringType().getSimpleName();
    String methodName = methodSignature.getName();

    final StopWatch stopWatch = new StopWatch();
    stopWatch.start();
    Object result = joinPoint.proceed();
    stopWatch.stop();

    DebugLog.log(className, buildLogMessage(methodName, stopWatch.getTotalTimeMillis()));

    return result;
  }

  /**
   * Create a log message.
   *
   * @param methodName A string with the method name.
   * @param methodDuration Duration of the method in milliseconds.
   * @return A string representing message.
   */
  private static String buildLogMessage(String methodName, long methodDuration) {
    StringBuilder message = new StringBuilder();
    message.append("Gintonic --> ");
    message.append(methodName);
    message.append(" --> ");
    message.append("[");
    message.append(methodDuration);
    message.append("ms");
    message.append("]");

    return message.toString();
  }
}

幾個在此提到的重點：

  • 我們聲明瞭兩個作為 pointcuts 的 public 方法，篩選出所有通過 “org.android10.gintonic.annotation.DebugTrace” 註解的方法和建構函式。
  • 我們使用 “@Around” 註解定義了“weaveJointPoint(ProceedingJoinPoint joinPoint)”方法,使我們的程式碼注入在使用"@DebugTrace"註解的地方生效。
  • “Object result = joinPoint.proceed();”這行程式碼是被註解的方法執行的地方。因此，在此之前，我們啟動我們的計時類計時，在這之後，停止計時。
  • 最後，我們構造日誌資訊，用 Android Log 輸出。

使 AspectJ 執行在 Anroid 上

現在，所有程式碼都可以正常工作了，但是，如果我們編譯我們的例子，我們並沒有看到任何事情發生。原因是我們必須使用 AspectJ 的編譯器（ajc，一個java編譯器的擴充套件）對所有受 aspect 影響的類進行織入。這就是為什麼，我之前提到的，我們需要在 gradle 的編譯 task 中增加一些額外配置，使之能正確編譯執行。

我們的 build.gradle 檔案如下：

import com.android.build.gradle.LibraryPlugin
import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath 'com.android.tools.build:gradle:0.12.+'
    classpath 'org.aspectj:aspectjtools:1.8.1'
  }
}

apply plugin: 'android-library'

repositories {
  mavenCentral()
}

dependencies {
  compile 'org.aspectj:aspectjrt:1.8.1'
}

android {
  compileSdkVersion 19
  buildToolsVersion '19.1.0'

  lintOptions {
    abortOnError false
  }
}

android.libraryVariants.all { variant ->
  LibraryPlugin plugin = project.plugins.getPlugin(LibraryPlugin)
  JavaCompile javaCompile = variant.javaCompile
  javaCompile.doLast {
    String[] args = ["-showWeaveInfo",
                     "-1.5",
                     "-inpath", javaCompile.destinationDir.toString(),
                     "-aspectpath", javaCompile.classpath.asPath,
                     "-d", javaCompile.destinationDir.toString(),
                     "-classpath", javaCompile.classpath.asPath,
                     "-bootclasspath", plugin.project.android.bootClasspath.join(
        File.pathSeparator)]

    MessageHandler handler = new MessageHandler(true);
    new Main().run(args, handler)

    def log = project.logger
    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:
        case IMessage.INFO:
          log.info message.message, message.thrown
          break;
        case IMessage.DEBUG:
          log.debug message.message, message.thrown
          break;
      }
    }
  }
}

我們的測試方法

我們新增一個測試方法，來使用我們炫酷的 aspect 註解。我已經在主 Activity 類中增加了一個方法用來測試。看下程式碼：

  @DebugTrace
  private void testAnnotatedMethod() {
    try {
      Thread.sleep(10);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }

執行我們的應用

我們用 gradle 命令編譯部署我們的 app 到 android 裝置或者模擬器上：

gradlew clean build installDebug

If we open the logcat and execute our sample, we will see a debug log with:
如果我們開啟 logcat，執行我們的例子，會看到一條 debug 日誌：

Gintonic --> testAnnotatedMethod --> [10ms]

我們的第一個使用 AOP 的 Androd 應用可以工作了！
你可以用 Dex Dump 或者任何其他的逆向工具反編譯 apk 檔案，看一下生成和注入的程式碼。

回顧

回顧總結如下：

  • 我們已經對面向切面程式設計（AOP）這一正規化有了初步體驗。
  • 程式碼注入是 AOP 中的重要部分。
  • AspectJ 是在 Android 應用中進行程式碼織入的強大且易用的工具。
  • 我們已經使用 AOP 能力建立了一個可以工作的示例。

結論

面向切面程式設計很強大。通過正確使用，你可以在開發你的 Android 應用時，避免在『cross-cutting concerns』處複製大量程式碼，比如我們在示例中看到的效能監控部分。我非常鼓勵你嘗試一下，你會發現它非常有用。

我希望你能喜歡這篇文章，文章的目的是分享我學到的東西，所以，歡迎評論和反饋，如果能 fork 程式碼玩一下就更好了。

我確信我們能在示例 app 的 AOP 模組裡增加些有趣的東西，歡迎提出你的想法;)。

原始碼

資源



文／mao眼（簡書作者）
原文連結：http://www.jianshu.com/p/0fa8073fd144
著作權歸作者所有，轉載請聯絡作者獲得授權，並標註“簡書作者”。

相關推薦

Spring --13.Spring中AOP程式設計（註解方式）

1、基於註解AOP入門案例 1.2、建立工程引入依賴 pom.xml <dependencies> <dependency> <groupId>org.springframework</groupId&

Spring --12.Spring中AOP程式設計（XML方式）

1、AOP入門案例 1.1、建立工程並引入依賴 工程為com.day03 依賴如下： <!--依賴--> <dependencies> <dependency> <groupId>or

Android中JNI程式設計的那些事兒 【轉】

後續可能為需要加入一些特定的模組到android中，所以JNI還需繼續熟悉起來 首先說明，Android系統不允許一個純粹使用C/C++的程式出現，它要求必須是通過Java程式碼嵌入Native C/C++——即通過JNI的方式來使用本地（Native）程式碼。因此

Android中NFC程式設計

Android NFC的相關資源，需求和設定 你可以在Android的NFC支援頁面找到相關的API文件和NFC的示例程式碼: 接下來該怎麼做呢？通常需要硬體的支援（手機支援NFC）和新增你的應用的許可權。 這需要你修改你的AndroidManifest.xml檔案，將

Android中的AOP程式設計之AspectJ實戰實現資料埋點

文章背景 最近在給某某銀行做專案的時，涉及到了資料埋點，效能監控等問題，那我們起先想到的有兩種方案，方案之一就是藉助第三方，比如友盟、Bugly等，由於專案是部署在銀行的網路框架之內的，所以該方案不可行。另外一種方案是就是給每一個方法裡面資料打點，然後寫入S

Android中的AOP程式設計

面向切面程式設計（AOP，Aspect-oriented programming）需要把程式邏輯分解成『關注點』（concerns，功能的內聚區域）。這意味著，在 AOP 中，我們不需要顯式的修改就可以向程式碼中新增可執行的程式碼塊。這種程式設計正規化假定『橫切關注點』（c

響應式程式設計在Android 中的一些探索

    響應式在前端領域已經變得十分流行，很多主流框架都採用響應式來進行頁面的展示重新整理。本文主要是探索一下響應式在移動端Android上的一些實踐，包括對響應式思想的理解，以及目前Android上實現響應式的一些手段，最後聊聊響應式在Android開發上的一些應用。

.NET Core中實現AOP程式設計

AOP全稱Aspect Oriented Progarmming(面向切面程式設計)，其實AOP對ASP.NET程式設計師來說一點都不神祕，你也許早就通過Filter來完成一些通用的功能，例如你使用Authorization Filter來攔截所有的使用者請求，驗證Http Header中是否有合法的toke

響應式程式設計在Android中的應用

響應式程式設計簡介 響應式程式設計是一種基於非同步資料流概念的程式設計模式。資料流就像一條河：它可以被觀測，被過濾，被操作，或者為新的消費者與另外一條流合併為一條新的流。 響應式程式設計的一個關鍵概念是事件。事件可以被等待，可以觸發過程，也可以

AOP在Android中的應用

官網地址：https://fernandocejas.com/2014/08/03/aspect-oriented-programming-in-android/ OOP （面向物件程式設計）針對業務處理過程的實體及其屬性和行為進行抽象封裝，以獲得更加清晰高效的邏輯單元

android面向切面AOP程式設計精華總結

AspectJ語法 1.Join Points JPoints就是程式執行時的一些執行點。 最經常使用的是call和execution的執行點。 2.Pointcuts 怎麼從一堆一堆的JPoints中選擇自己想要的JPoints呢？恩，這

springmvc中aop對controller切面程式設計

概述： 最近在開發一個基礎應用服務系統，利用加密的token標識來校驗訪問者的身份。幾乎每一個介面都需要校驗token。故打算採用aop面向切面程式設計，一次性對所有介面進行身份認證； 遇見的問題： 切面配置沒有問題的情況下，junit單元測試呼叫co

深入淺出RxJava四-在Android中使用響應式程式設計

原文連結 在第1，2，3篇中，我大概介紹了RxJava是怎麼使用的。下面我會介紹如何在Android中使用RxJava. RxAndroid RxAndroid是RxJava的一個針對Android平臺的擴充套件。它包含了一些能夠簡化Android開發的工

Android中的網路程式設計-黃俊東-專題視訊課程

Android中的網路程式設計—1902人已學習 課程介紹        剔除繁雜的理論，注重實踐，深入淺出講解Android中的網路程式設計課程收益    每一個學員都能系統地掌握Android中的網

使用AspectJ在Android中實現Aop

開題 上一篇文章Android Aop預研中介紹了Aop的各種實現方式，並且在最後提到，選擇AspectJ作為合適的開發方式。這篇文章通過我自己編寫的一個例子，來說明AspectJ的使用。 可以這樣說，上面的文章將我所要介紹的大部分關於AOP的內容都包含

面向切面程式設計在android中的應用（Aspect Oriented Programming in android）

面向切面程式設計在android中的應用Aspect Oriented Programming in android project背景在我們實際的Android專案開發中經常碰到的一個問題就是Token過期的處理問題。客戶端的很多介面都要依賴Token，對Token過期處理

Android中的網路程式設計

AsyncHttpClient特性: (1)採用非同步http請求，並通過匿名內部類處理回撥結果 (2)http請求獨立在UI主執行緒之外 (3)採用執行緒池來處理併發請求 (4)採用RequestParams類建立GET/POST引數 (5)不需要第三方包即可支援Multipart fil

Java/Android中的網路程式設計--（上）

網路是20世紀最偉大的發明之一，眾多的裝置可以以有線或者無線的方式連入整個網際網路，進而互相通訊。為了更好的開發、管理、接入網路，科學家設計了通訊協議，將整個網路架構分為7層（4層），並規範了每一層的功能。 網路分層 早期的OSI參考模型將網路分為7層：應用層、表示層、會

Android中的線程

開發者 又是 ace appcompat 技術 ted unknown 消息通知 設計模型 本文轉自：http://www.jianshu.com/p/d59b3cce2b54 如何理解線程 在操作系統中，線程是操作系統調度的最小單元，同時線程又是一種受限的系統資源，即

Android中getDrawable和getColor過時的替代方法

this logs con 知識 log launcher 16px ase spa 版權聲明：本文為博主原創文章，未經博主允許不得轉載。 前言 Android SDK 升級到 23 之後，getDrawable和getColor方法提示過時。 解決方案 getRe