歡迎閱讀系列文章
Android aop切點表達式(execution)
Android aop Advice(通知、增強)
Android aop(AspectJ)查看新的代理類
Android aop AspectJX與第三方庫沖突的解決方案
Android AOP面向切面編程詳解
防止按鈕連續點擊
Android aop工作原理
項目需求描述
我想類似于這樣的個人中心的界面,大家都不會陌生吧。那幾個有箭頭的地方都是可以點擊進行頁面跳轉的,但是需要先判斷用戶是否登錄,如果已經登錄,則正常跳轉,如果沒有登錄,則跳轉到登錄頁面先登錄,但凡是有注冊,登錄的APP,這樣的操作,大家應該都很熟悉吧。一般情況下,我們的邏輯是這樣的...
/**
* 跳轉到我的關注頁面
*/
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);
}
}
這段代碼確實沒有任何問題,也完全符合我們的需求,也就是在所有需要判斷登錄的地方去if else做重復的邏輯操作,但是如果這樣的判斷有10多處,甚至幾十處,我們就得重復很多次這樣的體力勞動,或者有一天需求變動,我們估計要改動多處,想想都可怕。而且類似的還有網絡判斷,權限管理,Log日志的統一管理這樣的問題。那么,我們也沒有更優雅的方式來解決這一類的問題呢,答案是有的,煩請各位接著往下看。
先給出我解決了上述問題之后的代碼
/**
* 跳轉到我的關注頁面
*/
@CheckLogin
public void toMyAttention() {
Intent intent = new Intent(this, WaitReceivingActivity.class);
startActivity(intent);
}
大家也看到了,代碼變得簡潔了,而且重復的操作越多,優勢越明顯,更重要的是,方便需求改變時候的修改,便于維護。在這里,我通過一個@CheckLogin注解的方式就去除了判斷登錄這樣的操作,這是什么個情況?這就是今天為大家帶來的Android AOP(面向切面編程)詳解。接下來,我先為大家帶來AOP的一些基礎概念,再來講解具體的實現方式。
什么是AOP
AOP是Aspect Oriented Programming的縮寫,即『面向切面編程』。它和我們平時接觸到的OOP都是編程的不同思想,OOP,即『面向對象編程』,它提倡的是將功能模塊化,對象化,而AOP的思想,則不太一樣,它提倡的是針對同一類問題的統一處理,通過預編譯方式和運行期動態代理實現程序功能的統一維護的一種技術。AOP是OOP的延續,是軟件開發中的一個熱點,也是Spring框架中的一個重要內容,是函數式編程的一種衍生范型。利用AOP可以對業務邏輯的各個部分進行隔離,從而使得業務邏輯各部分之間的耦合度降低,提高程序的可重用性,同時提高了開發的效率。
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。
基礎概念
Aspect 切面:切面是切入點和通知的集合。
PointCut 切入點:切入點是指那些通過使用一些特定的表達式過濾出來的想要切入Advice的連接點。
Advice 通知:通知是向切點中注入的代碼實現方法。
Joint Point 連接點:所有的目標方法都是連接點.
Weaving 編織:主要是在編譯期使用AJC將切面的代碼注入到目標中, 并生成出代碼混合過的.class的過程.
實踐步驟
1、在android studio中直接配置AspectJ,這個配置很重要,如果失敗,后面就無法成功,先貼出我的配置,在app的build.gradle中做如下配置
apply plugin: 'com.android.application'
import org.aspectj.bridge.IMessage
import org.aspectj.bridge.MessageHandler
import org.aspectj.tools.ajc.Main
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.aspectj:aspectjtools:1.8.9'
classpath 'org.aspectj:aspectjweaver:1.8.9'
}
}
repositories {
mavenCentral()
}
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;
}
}
}
}
android {
compileSdkVersion 25
buildToolsVersion "25.0.2"
defaultConfig {
applicationId "com.zx.aopdemo"
minSdkVersion 17
targetSdkVersion 25
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile 'com.android.support:appcompat-v7:25.3.1'
compile 'com.android.support.constraint:constraint-layout:1.0.2'
compile 'org.aspectj:aspectjrt:1.8.9'
testCompile 'junit:junit:4.12'
}
為什么這么配置?因為AspectJ是對java的擴展,而且是完全兼容java的。但是編譯時得用Aspect專門的編譯器,這里的配置就是使用Aspect的編譯器,單獨加入aspectj依賴是不行的。到這里準備工作已完成,可以開始看看具體實現了。
注意:這種自定義Gradle插件的方式很麻煩,容易出錯,不再推薦使用這種方式,推薦滬江的集成方案aspectjx
2、創建切面AspectJ
用來處理觸發切面的回調
@Aspect
public class CheckLoginAspectJ {
private static final String TAG = "CheckLogin";
/**
* 找到處理的切點
* * *(..) 可以處理CheckLogin這個類所有的方法
*/
@Pointcut("execution(@com.zx.aopdemo.login.CheckLogin * *(..))")
public void executionCheckLogin() {
}
/**
* 處理切面
*
* @param joinPoint
* @return
*/
@Around("executionCheckLogin()")
public Object checkLogin(ProceedingJoinPoint joinPoint) throws Throwable {
Log.i(TAG, "checkLogin: ");
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
CheckLogin checkLogin = signature.getMethod().getAnnotation(CheckLogin.class);
if (checkLogin != null) {
Context context = (Context) joinPoint.getThis();
if (MyApplication.isLogin) {
Log.i(TAG, "checkLogin: 登錄成功 ");
return joinPoint.proceed();
} else {
Log.i(TAG, "checkLogin: 請登錄");
Toast.makeText(context, "請登錄", Toast.LENGTH_SHORT).show();
return null;
}
}
return joinPoint.proceed();
}
}
這里要使用Aspect的編譯器編譯必須給類打上標注,@Aspect。
還有這里的Pointcut注解,就是切點,即觸發該類的條件。里面的字符串如下
在Pointcut這里,我使用了execution,也就是以方法執行時為切點,觸發Aspect類。而execution里面的字符串是觸發條件,也是具體的切點。我來解釋一下參數的構成。“execution(@com.zx.aopdemo.login.CheckLogin * *(..))”這個條件是所有加了CheckLogin注解的方法或屬性都會是切點,范圍比較廣。
- **:表示是任意包名
- ..:表示任意類型任意多個參數
“com.zx.aopdemo.login.CheckLogin”這是我的項目包名下需要指定類的絕對路徑。再來看看@Around,Around是指JPoint執行前或執行后被觸發,除了Around還有其他幾種方式。
類型 | 描述 |
---|---|
Before | 前置通知, 在目標執行之前執行通知 |
After | 后置通知, 目標執行后執行通知 |
Around | 環繞通知, 在目標執行中執行通知, 控制目標執行時機 |
AfterReturning | 后置返回通知, 目標返回時執行通知 |
AfterThrowing | 異常通知, 目標拋出異常時執行通知 |
創建完Aspect類之后,還需要一個注解類,它的作用是:哪里需要做切點,那么哪里就用注解標注一下,這樣方便快捷。
3、創建注解類
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 {
}
4、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()方法。然后會執行
如下方法
/**
* 處理切面
*
* @param joinPoint
* @return
*/
@Around("executionCheckLogin()")
public Object checkLogin(ProceedingJoinPoint joinPoint) throws Throwable {
Log.i(TAG, "checkLogin: ");
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
CheckLogin checkLogin = signature.getMethod().getAnnotation(CheckLogin.class);
if (checkLogin != null) {
Context context = (Context) joinPoint.getThis();
if (MyApplication.isLogin) {
Log.i(TAG, "checkLogin: 登錄成功 ");
return joinPoint.proceed();
} else {
Log.i(TAG, "checkLogin: 請登錄");
Toast.makeText(context, "請登錄", Toast.LENGTH_SHORT).show();
return null;
}
}
return joinPoint.proceed();
}
如果使用的是以方法相關為切點,那么使用MethodSignature來接收joinPoint的Signature。如果是屬性或其他的,那么可以使用Signature類來接收。之后可以使用Signature來獲取注解類。,那么通過jointPoint.getThis()獲取使用該注解的的上下文對象
GitHub地址(歡迎下載完整Demo)
https://github.com/zhouxu88/AOPDemo
參考如下文章,感謝作者:
aspect-oriented-programming-in-android