Gradle自定義Plugin插件和ASM修改字節(jié)碼

前言

先介紹一下 AOPASM 的概念诈乒,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 员帮、XposedDexposed 等。

這里我們主要介紹一下在自定義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 文件配置

uploadArchives.png

配置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)的類。

properties.png

生成插件

我們?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

代碼傳送門椒惨,拿走不謝^^!

文章到這里就全部講述完啦潮罪,若有其他需要交流的可以留言哦领斥!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末嫉到,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子月洛,更是在濱河造成了極大的恐慌何恶,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,589評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件嚼黔,死亡現(xiàn)場(chǎng)離奇詭異细层,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)唬涧,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,615評(píng)論 3 396
  • 文/潘曉璐 我一進(jìn)店門疫赎,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人碎节,你說我怎么就攤上這事捧搞。” “怎么了狮荔?”我有些...
    開封第一講書人閱讀 165,933評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵胎撇,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我殖氏,道長(zhǎng)晚树,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,976評(píng)論 1 295
  • 正文 為了忘掉前任雅采,我火速辦了婚禮爵憎,結(jié)果婚禮上慨亲,老公的妹妹穿的比我還像新娘。我一直安慰自己纲堵,他們只是感情好巡雨,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,999評(píng)論 6 393
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著席函,像睡著了一般铐望。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上茂附,一...
    開封第一講書人閱讀 51,775評(píng)論 1 307
  • 那天正蛙,我揣著相機(jī)與錄音,去河邊找鬼营曼。 笑死乒验,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蒂阱。 我是一名探鬼主播锻全,決...
    沈念sama閱讀 40,474評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼录煤!你這毒婦竟也來了鳄厌?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,359評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤妈踊,失蹤者是張志新(化名)和其女友劉穎了嚎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體廊营,經(jīng)...
    沈念sama閱讀 45,854評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡歪泳,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,007評(píng)論 3 338
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了露筒。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片呐伞。...
    茶點(diǎn)故事閱讀 40,146評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖慎式,靈堂內(nèi)的尸體忽然破棺而出荸哟,到底是詐尸還是另有隱情,我是刑警寧澤瞬捕,帶...
    沈念sama閱讀 35,826評(píng)論 5 346
  • 正文 年R本政府宣布鞍历,位于F島的核電站,受9級(jí)特大地震影響肪虎,放射性物質(zhì)發(fā)生泄漏劣砍。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,484評(píng)論 3 331
  • 文/蒙蒙 一扇救、第九天 我趴在偏房一處隱蔽的房頂上張望刑枝。 院中可真熱鬧香嗓,春花似錦、人聲如沸装畅。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,029評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)掠兄。三九已至像云,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蚂夕,已是汗流浹背迅诬。 一陣腳步聲響...
    開封第一講書人閱讀 33,153評(píng)論 1 272
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留婿牍,地道東北人侈贷。 一個(gè)月前我還...
    沈念sama閱讀 48,420評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像等脂,于是被迫代替她去往敵國(guó)和親俏蛮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,107評(píng)論 2 356

推薦閱讀更多精彩內(nèi)容