前言
先介紹一下 AOP
和 ASM
的概念诈乒,AOP
是一種面向切面編程罩扇,通過預(yù)編譯方式和運(yùn)行期動(dòng)態(tài)代理實(shí)現(xiàn)程序功能的統(tǒng)一維護(hù)的一種技術(shù)。和面向?qū)ο缶幊?的 OOP
相同怕磨。ASM
是一個(gè)框架可以看作 AOP
的工具喂饥,當(dāng)然 AOP
也有其他工具,比如用的比較多的 AspectJ
肠鲫、Javassist
员帮、Xposed
和 Dexposed
等。
這里我們主要介紹一下在自定義Plugin
使用的ASM
:
ASM是一個(gè)通用的
Java
字節(jié)碼操作和分析框架导饲。它可以直接以二進(jìn)制形式用于修改現(xiàn)有類或動(dòng)態(tài)生成類捞高。ASM
提供了一些常見的字節(jié)碼轉(zhuǎn)換和分析算法,可以從中構(gòu)建定制的復(fù)雜轉(zhuǎn)換和代碼分析工具渣锦。ASM
提供與其他Java字
節(jié)碼框架類似的功能硝岗,但側(cè)重于性能。因?yàn)樗脑O(shè)計(jì)和實(shí)現(xiàn)是盡可能的小和盡可能快袋毙,所以它非常適合在動(dòng)態(tài)系統(tǒng)中使用(但當(dāng)然也可以以靜態(tài)方式使用型檀,例如在編譯器中)。
自定義plugin開發(fā)
Gradle
從1.5開始听盖,Gradle
插件包含了一個(gè)叫Transform
的API贱除,這個(gè)API允許第三方插件在class
文件轉(zhuǎn)為為dex
文件前操作編譯好的class
文件,這個(gè)API的目標(biāo)是簡(jiǎn)化自定義類操作媳溺,而不必處理Task
月幌,并且在操作上提供更大的靈活性。并且可以更加靈活地進(jìn)行操作悬蔽。官方文檔:http://google.github.io/android-gradle-dsl/javadoc/
創(chuàng)建插件
在 AndroidStudio
中創(chuàng)建一個(gè)純凈的Module
扯躺,刪除 res
文件夾和 AndroidManifest.xml
文件。
Gradle會(huì)默認(rèn)在配置初始化前蝎困,編譯buildSrc這個(gè)項(xiàng)目录语,可以是java、groovy禾乘、kotlin項(xiàng)目澎埠,并把項(xiàng)目配置到classpath下。所以如果Module
命名為 buildSrc
那么不需要在 Project
級(jí)別的 build.gradle
文件中使用 classpath
引入始藕,也不需要在 app
級(jí)別的 build.gradle
文件中使用 apply plugin:
進(jìn)行應(yīng)用蒲稳。
下面我們介紹的是自定義的 Plugin
插件氮趋,是編譯之后需要引入項(xiàng)目的。
類繼承
Plugin
public class AmsPlugin implements Plugin<Project> {
@Override
public void apply(@NonNull Project project) {
AppExtension appExtension = project.getExtensions().findByType(AppExtension.class);
assert appExtension != null;
//注冊(cè)task任務(wù)
appExtension.registerTransform(new AmsTransform(project));
}
}
public class AmsTransform extends Transform{
/***部分代碼省略***/
}
build.gradle
文件配置
配置
properties
在 /src/main/resources/META-INF/gradle-plugins
目錄下創(chuàng)建xxx.properties
文件江耀,這個(gè) xxx
就是以后項(xiàng)目build.gradle
文件中需要apply
的插件名稱剩胁。
implementation-class=com.tzx.ams.plugin.AmsPlugin
com.tzx.ams.plugin.AmsPlugin
就是插件對(duì)應(yīng)的類。
生成插件
我們?cè)趫?zhí)行 uploadArchives
的任務(wù)的時(shí)候就在我們對(duì)于的倉(cāng)庫(kù)生成了我們需要的插件祥国。
在項(xiàng)目中引入插件
項(xiàng)目的根
build.gradle
配置
buildscript {
repositories {
maven {//添加repo本地倉(cāng)庫(kù)
url uri("repo")
}
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.5.3'
//添加插件依賴
classpath 'com.tzx.ams:ams-plugin:1.0.0'
}
}
項(xiàng)目的
build.gradle
配置
apply plugin: 'com.android.application'
apply plugin: 'amsplugin'
/***部分代碼省略***/
plugin自定義配置
配置類
public class AmsConfig {
//日志開關(guān)
public boolean isDebug;
//class包含str則不處理
public String[] filterContainsClassStr;
//class以str開頭則不處理
public String[] filterstartsWithClassStr;
//攔截在這個(gè)文件中聲明的class
public String filterClassFile;
public List<String> filterClassNameList;
//需要進(jìn)行注入的method
public String amsMethodFile;
//需要進(jìn)行注入的method對(duì)應(yīng)的tag
public String amsMethodTag;
public List<Pair<String, String>> amsMethodFileList;
}
創(chuàng)建
AmsConfig
的類對(duì)象
public class AmsPlugin implements Plugin<Project> {
@Override
public void apply(@NonNull Project project) {
AppExtension appExtension = project.getExtensions().findByType(AppExtension.class);
assert appExtension != null;
//注冊(cè)優(yōu)先于task任務(wù)的添加
project.getExtensions().create("AmsConfig", AmsConfig.class);
appExtension.registerTransform(new AmsTransform(project));
}
}
build.gradle
文件中定義配置(如果gradle中沒有定義昵观,那么會(huì)反射構(gòu)造一個(gè)對(duì)象)
apply plugin: 'com.android.application'
apply plugin: 'amsplugin'
AmsConfig{
isDebug = true
filterContainsClassStr = ["R.class", ".R\$"]
filterstartsWithClassStr = ["android"]
filterClassFile = "amsfilterclass.text"http://build.gradle相同目錄級(jí)別的文件名
amsMethodFile = "amsmethods.text"http://build.gradle相同目錄級(jí)別的文件名
amsMethodTag = "TEST"
}
獲取
gradle
中定義的配置
AmsConfig amsConfig = (AmsConfig) this.project.getExtensions().getByName(AmsConfig.class.getSimpleName());
//配置文件的獲取
String projectDri = this.project.getProjectDir().getAbsolutePath()
String fileName = projectDri + File.separatorChar + amsConfig.filterClassFile;
這個(gè) amsConfig
在使用的時(shí)候不用判空,如果調(diào)用project.getExtensions().create
添加了那么就會(huì)反射構(gòu)造出這個(gè)對(duì)象舌稀。如果gradle
文件中定義了啊犬,那么這個(gè)對(duì)象就會(huì)被賦與相應(yīng)的屬性值。
如果在獲取的時(shí)候壁查,沒有被create
那么就會(huì)跑出一下異常:
* Where:
Build file '/Users/tanzx/AndroidStudioWorkSpace/GitHub/AmsDemo/app/build.gradle' line: 3
* What went wrong:
A problem occurred evaluating project ':app'.
> Could not find method AmsConfig() for arguments [build_5n6idkxwtmzfflm5k30ynjblo$_run_closure1@2cf1f355] on project ':app' of type org.gradle.api.Project
文章到這里就全部講述完啦潮罪,若有其他需要交流的可以留言哦!领斥!