AOP面向切面編程在Android中的使用

時間 2019-11-30

原文原文鏈接

GitHub地址（歡迎下載完整Demo）java

https://github.com/ganchuanpu/AOPDemoandroid

項目需求描述git

我想相似於這樣的我的中心的界面，你們都不會陌生吧。那幾個有箭頭的地方都是能夠點擊進行頁面跳轉的，可是須要先判斷用戶是否登陸，若是已經登陸，則正常跳轉，若是沒有登陸，則跳轉到登陸頁面先登陸，但凡有註冊，登陸的APP，這樣的操做，你們應該都很熟悉吧。通常狀況下，咱們的邏輯是這樣的…github

/**
  * 跳轉到個人關注頁面
*/
public void toMyAttention() {
     // 判斷當前用戶是否登陸
     if(LoginHelper.isLogin(this)) {
         // 若是登陸才跳轉，進入個人關注頁面
         Intent intent = new Intent(this, WaitReceivingActivity.class);
         startActivity(intent);
     }else{
       //跳轉到登陸頁面，先登陸
         Intent intent = new Intent(this, LoginActivity.class);
         startActivity(intent);
     }
}

重複的體力勞動，想一想均可怕。並且相似的還有網絡判斷，權限管理，Log日誌的統一管理這樣的問題。那麼，咱們也沒有更優雅的方式來解決這一類的問題呢，答案是有的。編程

先給出我解決了上述問題以後的代碼網絡

/**
    *  跳轉到個人關注頁面
    */
    @CheckLogin
    public void toMyAttention() {
         Intent intent = new Intent(this, WaitReceivingActivity.class);
         startActivity(intent);
    }

AspectJ

AspectJ其實是對AOP編程思想的一個實踐，AOP雖然是一種思想，但就好像OOP中的Java同樣，一些先行者也開發了一套語言來支持AOP。目前用得比較火的就是AspectJ了，它是一種幾乎和Java徹底同樣的語言，並且徹底兼容Java（AspectJ應該就是一種擴展Java，但它不是像Groovy那樣的拓展。）。固然，除了使用AspectJ特殊的語言外，AspectJ還支持原生的Java，只要加上對應的AspectJ註解就好。因此，使用AspectJ有兩種方法：
- 徹底使用AspectJ的語言。這語言一點也不難，和Java幾乎同樣，也能在AspectJ中調用Java的任何類庫。AspectJ只是多了一些關鍵詞罷了。
- 或者使用純Java語言開發，而後使用AspectJ註解，簡稱@AspectJ。app

基礎概念
- Aspect 切面：切面是切入點和通知的集合。maven

PointCut 切入點：切入點是指那些經過使用一些特定的表達式過濾出來的想要切入Advice的鏈接點。ide
Advice 通知：通知是向切點中注入的代碼實現方法。gradle
Joint Point 鏈接點：全部的目標方法都是鏈接點.
Weaving 編織：主要是在編譯期使用AJC將切面的代碼注入到目標中, 並生成出代碼混合過的.class的過程.

實踐步驟

一、在android studio中直接配置AspectJ,這個配置很重要，若是失敗，後面就沒法成功，先貼出個人配置,在app的build.gradle中作以下配置

 1 apply plugin: 'com.android.application'
 2 import org.aspectj.bridge.IMessage
 3 import org.aspectj.bridge.MessageHandler
 4 import org.aspectj.tools.ajc.Main
 5 
 6 buildscript {
 7     repositories {
 8         mavenCentral()
 9     }
10     dependencies {
11         classpath 'org.aspectj:aspectjtools:1.8.9'
12         classpath 'org.aspectj:aspectjweaver:1.8.9'
13     }
14 }
15 repositories {
16     mavenCentral()
17 }
18 final def log = project.logger
19 final def variants = project.android.applicationVariants
20 variants.all { variant ->
21     if (!variant.buildType.isDebuggable()) {
22         log.debug("Skipping non-debuggable build type '${variant.buildType.name}'.")
23         return;
24     }
25 
26     JavaCompile javaCompile = variant.javaCompile
27     javaCompile.doLast {
28         String[] args = ["-showWeaveInfo",
29                          "-1.8",
30                          "-inpath", javaCompile.destinationDir.toString(),
31                          "-aspectpath", javaCompile.classpath.asPath,
32                          "-d", javaCompile.destinationDir.toString(),
33                          "-classpath", javaCompile.classpath.asPath,
34                          "-bootclasspath", project.android.bootClasspath.join(File.pathSeparator)]
35         log.debug "ajc args: " + Arrays.toString(args)
36 
37         MessageHandler handler = new MessageHandler(true);
38         new Main().run(args, handler);
39         for (IMessage message : handler.getMessages(null, true)) {
40             switch (message.getKind()) {
41                 case IMessage.ABORT:
42                 case IMessage.ERROR:
43                 case IMessage.FAIL:
44                     log.error message.message, message.thrown
45                     break;
46                 case IMessage.WARNING:
47                     log.warn message.message, message.thrown
48                     break;
49                 case IMessage.INFO:
50                     log.info message.message, message.thrown
51                     break;
52                 case IMessage.DEBUG:
53                     log.debug message.message, message.thrown
54                     break;
55             }
56         }
57     }
58 }
59 
60 android {
61     compileSdkVersion 25
62     buildToolsVersion "25.0.2"
63     defaultConfig {
64         applicationId "com.zx.aopdemo"
65         minSdkVersion 17
66         targetSdkVersion 25
67         versionCode 1
68         versionName "1.0"
69         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
70     }
71     buildTypes {
72         release {
73             minifyEnabled false
74             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
75         }
76     }
77 }
78 
79 dependencies {
80     compile fileTree(dir: 'libs', include: ['*.jar'])
81     androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
82         exclude group: 'com.android.support', module: 'support-annotations'
83     })
84     compile 'com.android.support:appcompat-v7:25.3.1'
85     compile 'com.android.support.constraint:constraint-layout:1.0.2'
86     compile 'org.aspectj:aspectjrt:1.8.9'
87     testCompile 'junit:junit:4.12'
88 }

爲何這麼配置?由於AspectJ是對java的擴展，並且是徹底兼容java的。可是編譯時得用Aspect專門的編譯器，這裏的配置就是使用Aspect的編譯器，單獨加入aspectj依賴是不行的。到這裏準備工做已完成，能夠開始看看具體實現了。

二、建立切面AspectJ
用來處理觸發切面的回調

 1 @Aspect
 2 public class CheckLoginAspectJ {
 3     private static final String TAG = "CheckLogin";
 4 
 5     /**
 6      * 找處處理的切點
 7      * * *(..)  能夠處理CheckLogin這個類全部的方法
 8      */
 9     @Pointcut("execution(@com.zx.aopdemo.login.CheckLogin  * *(..))")
10     public void executionCheckLogin() {
11     }
12 
13     /**
14      * 處理切面
15      *
16      * @param joinPoint
17      * @return
18      */
19     @Around("executionCheckLogin()")
20     public Object checkLogin(ProceedingJoinPoint joinPoint) throws Throwable {
21         Log.i(TAG, "checkLogin: ");
22         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
23         CheckLogin checkLogin = signature.getMethod().getAnnotation(CheckLogin.class);
24         if (checkLogin != null) {
25             Context context = (Context) joinPoint.getThis();
26             if (MyApplication.isLogin) {
27                 Log.i(TAG, "checkLogin: 登陸成功 ");
28                 return joinPoint.proceed();
29             } else {
30                 Log.i(TAG, "checkLogin: 請登陸");
31                 Toast.makeText(context, "請登陸", Toast.LENGTH_SHORT).show();
32                 return null;
33             }
34         }
35         return joinPoint.proceed();
36     }
37 }

這裏要使用Aspect的編譯器編譯必須給類打上標註，@Aspect。
還有這裏的Pointcut註解，就是切點，即觸發該類的條件。裏面的字符串以下

在Pointcut這裏，我使用了execution，也就是以方法執行時爲切點，觸發Aspect類。而execution裏面的字符串是觸發條件，也是具體的切點。我來解釋一下參數的構成。「execution(@com.zx.aopdemo.login.CheckLogin * *(..))」這個條件是全部加了CheckLogin註解的方法或屬性都會是切點，範圍比較廣。

**：表示是任意包名
..：表示任意類型任意多個參數

「com.zx.aopdemo.login.CheckLogin」這是個人項目包名下須要指定類的絕對路徑。再來看看@Around,Around是指JPoint執行前或執行後被觸發，除了Around還有其餘幾種方式。

建立完Aspect類以後，還須要一個註解類，它的做用是：哪裏須要作切點，那麼哪裏就用註解標註一下，這樣方便快捷。

三、建立註解類

package com.zx.aopdemo.login;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD) //能夠註解在方法 上
@Retention(RetentionPolicy.RUNTIME) //運行時（執行時）存在
public @interface CheckLogin {
}

四、Activity使用登陸的註解

public class LoginActivity extends AppCompatActivity implements View.OnClickListener, RadioGroup.OnCheckedChangeListener {

    private RadioGroup radioGroup;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_login);

       test();
    }

    @CheckLogin
   public void test(){  
        Log.i("tag","判斷是否登陸");  
    }

test()方法執行時就是一個切點。在執行test()時，會回調上面的CheckLoginAspectJ類的executionCheckLogin()方法。而後會執行
以下方法

 1 /**
 2      * 處理切面
 3      *
 4      * @param joinPoint
 5      * @return
 6      */
 7     @Around("executionCheckLogin()")
 8     public Object checkLogin(ProceedingJoinPoint joinPoint) throws Throwable {
 9         Log.i(TAG, "checkLogin: ");
10         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
11         CheckLogin checkLogin = signature.getMethod().getAnnotation(CheckLogin.class);
12         if (checkLogin != null) {
13             Context context = (Context) joinPoint.getThis();
14             if (MyApplication.isLogin) {
15                 Log.i(TAG, "checkLogin: 登陸成功 ");
16                 return joinPoint.proceed();
17             } else {
18                 Log.i(TAG, "checkLogin: 請登陸");
19                 Toast.makeText(context, "請登陸", Toast.LENGTH_SHORT).show();
20                 return null;
21             }
22         }
23         return joinPoint.proceed();
24     }