AOP這個(gè)東西也是聽(tīng)了由來(lái)已久了域仇,是時(shí)候去會(huì)一會(huì)他了靠汁,首先我們先拋開(kāi)那些很牛逼的既可以AOP,又可以HotFix的這些個(gè)框架健提,先來(lái)看一看職責(zé)專一的AspectJ是怎么玩的。
我們需要注意到如下的問(wèn)題:
首先安卓的AOP的實(shí)現(xiàn)方式大致有如下的三種:
- APT (annotation processing tool) 我們基本可以看到的大部分的很多插件包括但不僅限于butterKnife伟叛, Dagger2私痹,eventBus等都是通過(guò)APT的形式進(jìn)行切面編程的。之前的文章java注解就是通過(guò)這種方式去實(shí)現(xiàn)的
- javassist 熱修復(fù)框架和instant run就是借用的這種方式
- AspectJ JK大神的Hugo就是使用的這個(gè)相比更方便统刮,我們可以實(shí)行精確的定位紊遵,不需要我們?cè)俚巾?xiàng)目中去增加標(biāo)注,直接可以把我們需要變動(dòng)的方法進(jìn)行修改
我們就來(lái)具體的看一下AspectJ在Android studio中的使用侥蒙,
- 區(qū)別于Spring AOP和eclipse的AspectJ插件暗膜,在Android studio至今還沒(méi)有官方的一個(gè)AspectJ的規(guī)范出來(lái),現(xiàn)行的AS中的AspectJ的使用都是來(lái)源于如下的這篇文章
http://fernandocejas.com/2014/08/03/aspect-oriented-programming-in-android/ - 首先我們需要在我們的項(xiàng)目中新建一個(gè)module鞭衩,作為android-library依賴学搜。
在我們app module的build.gradle文件中,我們需要添加如下一些東西:
buildscript {
repositories {
mavenCentral()
}
dependencies {
//以當(dāng)前最新的1.8.10為準(zhǔn)
classpath 'org.aspectj:aspectjtools:1.8.10'
}
}
dependencies {
//依賴新建的aop library
compile project(':firstaop')
...
}
//以下整個(gè)這一段就是增加的ajc的編譯器(專門(mén)的aspectJ的編譯器)
final def log = project.logger
final def variants = project.android.applicationVariants
variants.all { variant ->
JavaCompile javaCompile = variant.javaCompile
javaCompile.doLast {
String[] args = ["-showWeaveInfo",
"-1.8", //兼容java版本
"-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-lib這個(gè)module的build.gradle也要做以下大同小異的變動(dòng):
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.2'
classpath 'org.aspectj:aspectjtools:1.8.10'
}
}
dependencies {
compile 'org.aspectj:aspectjrt:1.8.10'
}
android.libraryVariants.all { variant ->
LibraryPlugin plugin = project.plugins.getPlugin(LibraryPlugin)
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", 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;
}
}
}
}
基本和app module的一樣论衍,就是需要去dependency aspectjrt這個(gè)包瑞佩,以及gradle的task中多了LibraryPlugin這個(gè)東西,至此我們的配置基本上已經(jīng)完結(jié)了坯台。
3. 然后我們就可以在lib的module中新建aspect的相關(guān)類(lèi)了炬丸,新建如下一個(gè)aspect類(lèi)
我們先定義如下的一些靜態(tài)字符串,用來(lái)匹配我們想要切入的方法
//這一段的意思是匹配所有以Util結(jié)尾的類(lèi)的所有方法蜒蕾,以及所有的ViewGroup的子類(lèi)的所有方法稠炬,這里涉及到的this和target的問(wèn)題我們之后再講
private static final String POINTCUT_METHOD =
"(execution(* ..Util.(..)) || execution( ..ViewGroup+.(..))) && target(Object) && this(Object)";
//匹配所有的以Activity結(jié)尾的類(lèi)的所有方法
private static final String TEST_EXECUTION = "execution(* ..Activity.(..))";
//匹配調(diào)用MainActivity中以on開(kāi)頭的方法所在的方法,注意此處是調(diào)用(匹配指定類(lèi)的時(shí)候一定要指明完整的路徑)
private static final String TEST_CALL = "call( org.ding.multithingsdebugdemo.MainActivity.on(..))";
//除開(kāi)在Util結(jié)尾的類(lèi)的show方法中調(diào)用了Util結(jié)尾的類(lèi)的方法之外的方法
private static final String TEST_WITHIN = "call( ..Util.(..)) && !withincode( ..Util.show(..))";
其中最最麻煩的就是adpectJ的語(yǔ)法咪啡,比較復(fù)雜首启,且經(jīng)過(guò)實(shí)際驗(yàn)證有如下的一些語(yǔ)法的坑:
> 1. 要么就只寫(xiě)方法名,如果需要攔截指定類(lèi)的方法名撤摸,或者是指定部分類(lèi)的方法名闽坡,那么一定要把包名寫(xiě)全。你可以選擇直接寫(xiě)包名的形式(org.ding.Util.show(..))愁溜,也可以選擇選擇部分包名的形式(*..*Util.show(..))
2. +緊跟在類(lèi)名后面疾嗅,代表所有的這個(gè)類(lèi)的子類(lèi)
3. target和this,后面都跟著具體的數(shù)據(jù)class類(lèi)型冕象,可以是Object代承,也可以是具體的類(lèi)名,且不支持通配符渐扮。
同時(shí)论悴,在execution時(shí)掖棉,target和this是一樣;在call時(shí)膀估,target表示這個(gè)方法的調(diào)用類(lèi)幔亥,this表示這個(gè)調(diào)用這個(gè)方法所在的類(lèi)。
target可以攔截所有對(duì)象的子類(lèi)察纯,(舉個(gè)例子帕棉,這兩個(gè)我們一般都是與前面的匹配條件&&來(lái)使用,target(A)表示在滿足前面的條件情況下饼记,方法的調(diào)用類(lèi)是A或者是A的子類(lèi)香伴。shis(A)表示在A類(lèi)中又滿足前面的條件。
4. execution是方法的內(nèi)部具则,call是調(diào)用這個(gè)方法的地方
5. 一段匹配語(yǔ)段不能同時(shí)用在around即纲,和before或者after,就是說(shuō)用了around博肋,不能用在before或者after低斋,before和after可以連用
6. withincode后面跟方法,within后面跟類(lèi)匪凡,同樣的這兩個(gè)東西也是緊跟著前面的方法 && 來(lái)使用拔稳,表示在滿足前面的匹配條件的同時(shí)包含后面的方法/包含后面這個(gè)類(lèi)以及其子類(lèi)
7. 到目前為止,withincode和within貌似只能和call一起連用锹雏,看到eclipse官方上的asepctj的官方例子中有和execution的連用,暫時(shí)無(wú)法實(shí)現(xiàn)术奖。
8. within或者是withincode后面跟的方法名或者是類(lèi)名一定要指明類(lèi)礁遵,意思不是要指定類(lèi),而是要給出類(lèi)的匹配采记,可以指定可以通配
4. 然后我們可以去創(chuàng)建一些方法佣耐,來(lái)進(jìn)行方法的截取了,就拿上面的一種匹配段來(lái)作為例子:
//我們先要把這個(gè)匹配靜態(tài)字符串用pointcut標(biāo)注起來(lái)給這個(gè)空方法
@Pointcut(TEST_WITHIN)
public void testExecution() {
}
//然后我們可以把這個(gè)空方法直接放在after或者before或者around中唧龄,我們也可以直接在這些關(guān)鍵字后面直接寫(xiě)上匹配段代碼
@After("testExecution()")
public void getActivityMethod1(JoinPoint point) throws Throwable {
//獲取截取的方法名
Log.e("xxxxx", "MethodSignature) joinPoint.getSignature() : " + point.getSignature().getName());
Log.e("xxxxxx", "taeget : " + point.getTarget());
Log.e("xxxxxx", "this : " + point.getThis());
Log.e("xxxxxx", "11111");
Log.e("xxxxxx", "22222");
}
/**
* 跟before和after不同的是兼砖,around方法是發(fā)生在方法的內(nèi)部的,而before和after是發(fā)生在方法的外部的既棺,所以around標(biāo)注的傳參可以是ProceedingJoinPoint類(lèi)型讽挟,
*/
@Around("methodAnnotated()")
public Object weaveJoinPoint(ProceedingJoinPoint joinPoint) throws Throwable {
if (currentObject == null) {
currentObject = joinPoint.getTarget();
}
//調(diào)用原方法的執(zhí)行。
Object result = joinPoint.proceed();
//獲取方法信息對(duì)象
MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
String className;
//獲取當(dāng)前對(duì)象丸冕,通過(guò)反射獲取類(lèi)別詳細(xì)信息
className = joinPoint.getThis().getClass().getName();
String methodName = methodSignature.getName();
return result;
}
------
我們也可以通過(guò)標(biāo)注的方式去做aspect的aop
1. 好處是我們不用再去通過(guò)復(fù)雜的abstractProcessor繼承這種apt的方式然后去截取來(lái)做處理耽梅,這種標(biāo)注的方式比apt的方式略微的簡(jiǎn)單一點(diǎn)。
2. 首先我們依然創(chuàng)建一個(gè)標(biāo)注類(lèi)胖烛,這個(gè)是和apt的步驟一樣的:
/**
- 表明被注釋的方法將被跟蹤并且將會(huì)與Aspect程序中截獲該注釋的Advise關(guān)聯(lián)
*/
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.CONSTRUCTOR, ElementType.METHOD })
public @interface DebugTrace {}
3. 然后需要?jiǎng)?chuàng)建一個(gè)aspect類(lèi)眼姐,跟上面的基本相同诅迷,就是靜態(tài)字符串不同,語(yǔ)法如下:
//org.ding.DebugTrace標(biāo)注的所有方法
private static final String POINTCUT_METHOD =
"execution(@org.ding.DebugTrace * *(..))";
//org.ding.DebugTrace標(biāo)注的所有的new方法
private static final String POINTCUT_CONSTRUCTOR =
"execution(@org.ding.DebugTrace * *.new(..))";
** 注:**
1. 不同于eclipse有專門(mén)的aspectJ插件众旗,Android studio由于沒(méi)有aspect插件罢杉,沒(méi)有直接的aspect的關(guān)鍵字,直接導(dǎo)致了我們的@aspect標(biāo)注的類(lèi)沒(méi)有檢錯(cuò)功能贡歧,所以一旦有aspect語(yǔ)法問(wèn)題直接會(huì)導(dǎo)致無(wú)法編譯出該aspect相關(guān)類(lèi)滩租,所以你所有YY的好像可以做到的攔截全都會(huì)失效,意思就是一旦一個(gè)aspect標(biāo)注類(lèi)中由aspect文法錯(cuò)誤會(huì)直接導(dǎo)致整個(gè)aspect類(lèi)無(wú)法ajc編譯
2. 這個(gè)人的aspectJ系列還是不錯(cuò)的
http://blog.csdn.net/zl3450341/article/details/7673938