知識(shí)點(diǎn)來(lái)源:這個(gè)知識(shí)點(diǎn)第一次知道是在一次無(wú)意之間看到一個(gè)高級(jí)工程師的售賣課程臀防,花一分錢試聽(tīng)了一堂JVM虛擬機(jī)相關(guān)的課程才知道還能這樣玩兒出花來(lái)咽笼,接下來(lái)進(jìn)入正題:
1. 想要徹底了解這個(gè)知識(shí)點(diǎn)首先要掌握JVM虛擬機(jī)對(duì)于內(nèi)存分配和線程中線程私有區(qū)域棧內(nèi)方法執(zhí)行的流程。
上圖中主要理解Threads中JVM Stacks里面虛擬機(jī)棧的作用和意義粘昨,了解了第一點(diǎn)后可以做到通過(guò)字節(jié)碼在編譯時(shí)期通過(guò)工具asm進(jìn)行編譯時(shí)期代碼里面插入新代碼的需求
2. 了解熟悉gradle插件開(kāi)發(fā),因?yàn)槲覀冏罱K的目的是在android中使用該功能進(jìn)行編譯時(shí)期對(duì)特定方法或者類文件進(jìn)行處理操作,所以插件是必然的檀夹,主要目的就是通過(guò)gradle的自動(dòng)編譯將我們java文件編譯出來(lái)的.class文件進(jìn)行替換成我們處理之后的文件,最終由編譯器轉(zhuǎn)換成.dex文件生成apk策橘,自定義插件有多種方式炸渡,只要理解了gradle插件的含義和作用以及開(kāi)發(fā)方式,用哪一種我覺(jué)得根據(jù)需求而定(我這使用buildSrc本地項(xiàng)目使用的方式)
上圖中我們通過(guò)gradle插件化操作的點(diǎn)就是在 .class Files---->dex----->.dex files的過(guò)程中替換 .class文件丽已。谷歌為我們提供了完整的API對(duì)這一步驟做處理----[Transform]
3. Transform可谷歌百度深入了解蚌堵,此處給出超鏈接也不一定是最好的,只是個(gè)人閱讀的沛婴。
根據(jù)下圖可以看出我們自定義Transform始終是在系統(tǒng)的Transform之前先做編譯處理吼畏,如果大家有關(guān)注過(guò)android編譯過(guò)程,可以發(fā)現(xiàn)整個(gè)過(guò)程中有很多帶有Transform文字樣式在里面的名字嘁灯,其實(shí)就是相應(yīng)的系統(tǒng)Transform而已泻蚊,至于名字都是通過(guò)規(guī)則拼接的。
4. 最后一點(diǎn)ASM丑婿,整個(gè)工具是用于插入字節(jié)碼操作的工具性雄,這里就貼出目前最新版本, commons依賴下面有很多利于簡(jiǎn)化開(kāi)發(fā)的工具没卸,具體可自行百度。
implementation 'org.ow2.asm:asm:7.0'
implementation 'org.ow2.asm:asm-commons:7.0'
5. 實(shí)戰(zhàn):
- 接下來(lái)就是項(xiàng)目實(shí)戰(zhàn)環(huán)節(jié)秒旋,目的在demo方法代碼中插入一個(gè)Toast方法约计,打印一句話。
- 創(chuàng)建一個(gè)全新的項(xiàng)目:GradleToASMStakeDemo(此過(guò)程完全忽略)
- 在項(xiàng)目中創(chuàng)建一個(gè)lib模塊(此過(guò)程也完全忽略)迁筛,創(chuàng)建模塊以buildSrc命名煤蚌,切記名字一定是這個(gè)。
- 對(duì)buildSrc模塊進(jìn)行改造细卧,使它成為我們的gradle插件模塊:
刪除除了主目錄結(jié)構(gòu)的所有文件和build.gradle文件(所謂主目錄結(jié)構(gòu)就是src/main/java/包名文件夾)
創(chuàng)建resources目錄铺然,該目錄與main目錄在同一級(jí),然后在resources中穿件META-INF--->gradle-plugins--->項(xiàng)目包名.properties文件酒甸,真?zhèn)€文件創(chuàng)建完整結(jié)構(gòu)如下圖:
4. 接下來(lái)配置配置buildSrc
- 首先build.gradle文件配置:
apply plugin: 'java-library' //整個(gè)插件用Java編寫(xiě)魄健,如果喜歡用groovy可以導(dǎo)入groovy的相關(guān)依賴
// 當(dāng)前開(kāi)發(fā)編譯版本
compileJava {
sourceCompatibility = 1.8
targetCompatibility = 1.8
options.encoding = "UTF-8"
}
//開(kāi)發(fā)文件結(jié)構(gòu)
sourceSets {
main {
java {
srcDir 'src/main/java'
}
resources {
srcDir 'src/main/resources'
}
}
}
//獲取遠(yuǎn)程庫(kù)的倉(cāng)庫(kù)地址
repositories {
jcenter()
mavenCentral()
maven { url "https://dl.google.com/dl/android/maven2/" }
}
//開(kāi)發(fā)插件需要的庫(kù)
dependencies {
implementation gradleApi()
implementation localGroovy()
implementation 'com.android.tools.build:gradle:3.6.2'
implementation 'org.ow2.asm:asm:7.0'
implementation 'org.ow2.asm:asm-commons:7.0'
}
- 然后是 .properties文件,此文件可以簡(jiǎn)單理解成AndroidManifest.xml文件插勤,作用就是注冊(cè)該插件沽瘦。
implementation-class=com.kylin.gradle.buildsrc.TestPlugin,
- 接下來(lái)就是實(shí)現(xiàn)插件代碼邏輯了农尖,在java文件夾下面創(chuàng)建一個(gè)TestPlugin的java文件析恋,該類繼承于Plugin<Project> ,作為gradle插件開(kāi)發(fā)的入口盛卡,實(shí)現(xiàn)唯一必須實(shí)現(xiàn)方法apply助隧,簡(jiǎn)單打印一句話就可以在我們編譯同步的時(shí)候看到我們所打印的東西,當(dāng)然還需要依賴該插件滑沧。
- 使用gradle插件并村,使用很簡(jiǎn)單,只需要在我們項(xiàng)目下的build.gradle文件中依賴即可滓技,就想我們依賴application一樣哩牍,注意此處依賴使用的是包名,然后編譯就可以看到我們上面在apply方法中打印的東西了令漂。
apply plugin: 'com.kylin.gradle.buildsrc' //使用gradle自定義插件
5. 注冊(cè)我們自己的Transform類文件膝昆,注冊(cè)此文件需要獲取到我們AppExtension對(duì)象
AppExtension byType = project.getExtensions().getByType(AppExtension.class);
byType.registerTransform(new TestTransform());
接下來(lái)創(chuàng)建我們的TestTransform文件,具體方法定義代碼中有注釋:
/**
* @Description:Transform在編譯過(guò)程中.class文件轉(zhuǎn)換成.dex的時(shí)候觸發(fā)(.class -->transform-->.dex)
* @Auther: wangqi
* CreateTime: 2020/4/16.
*/
public class TestTransform extends Transform {
@Override
public void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
super.transform(transformInvocation);
//當(dāng)前是否是增量編譯(由isIncremental() 方法的返回和當(dāng)前編譯是否有增量基礎(chǔ))
boolean isIncremental = transformInvocation.isIncremental();
//消費(fèi)型輸入叠必,可以從中獲取jar包和class文件夾路徑荚孵。需要輸出給下一個(gè)任務(wù)
Collection<TransformInput> inputs = transformInvocation.getInputs();
//OutputProvider管理輸出路徑,如果消費(fèi)型輸入為空纬朝,你會(huì)發(fā)現(xiàn)OutputProvider == null
TransformOutputProvider outputProvider = transformInvocation.getOutputProvider();
for (TransformInput input : inputs) {
//Failed resolution of: Landroidx/appcompat/R$drawable;(不遍歷處理的話會(huì)出現(xiàn)這個(gè)bug)
for (JarInput jarInput : input.getJarInputs()) {
File dest = outputProvider.getContentLocation(
jarInput.getFile().getAbsolutePath(),
jarInput.getContentTypes(),
jarInput.getScopes(),
Format.JAR);
//將修改過(guò)的字節(jié)碼copy到dest收叶,就可以實(shí)現(xiàn)編譯期間干預(yù)字節(jié)碼的目的了
FileUtils.copyFile(jarInput.getFile(), dest);
}
for (DirectoryInput directoryInput : input.getDirectoryInputs()) {
FileUtils.copyDirectory(
directoryInput.getFile(),
outputProvider.getContentLocation(directoryInput.getName(), getInputTypes(), getScopes(), Format.DIRECTORY));
File dest = outputProvider.getContentLocation(directoryInput.getName(),
directoryInput.getContentTypes(), directoryInput.getScopes(),
Format.DIRECTORY);
// 插樁
// replaceFileClass(directoryInput.getFile());
//將修改過(guò)的字節(jié)碼copy到dest,就可以實(shí)現(xiàn)編譯期間干預(yù)字節(jié)碼的目的了, 此目的就是把我們修改之后的文件按照android編譯要求放置到本來(lái)該放置的位置玄组,以助于apk打包滔驾。
FileUtils.copyDirectory(directoryInput.getFile(), dest);
System.out.println("dest: " + dest);
}
}
}
@Override
public String getName() {
return "kylin0628";
}
/**
* 篩選需要處理的文件
* 代表了所有jar包,文件夾中俄讹,aar包中的.class文件和標(biāo)準(zhǔn)的java源文件哆致,我們都進(jìn)行篩選。
*
* @return
*/
@Override
public Set<QualifiedContent.ContentType> getInputTypes() {
return TransformManager.CONTENT_CLASS;
}
/**
* 插件作用域設(shè)置
* TransformManager.SCOPE_FULL_PROJECT 插件作用域真?zhèn)€項(xiàng)目
*
* @return
*/
@Override
public Set<? super QualifiedContent.Scope> getScopes() {
return TransformManager.PROJECT_ONLY;
}
/**
* 是否支持增量編譯
*
* @return
*/
@Override
public boolean isIncremental() {
return false;
}
}
- 前面步驟主要是實(shí)現(xiàn)了gradle插件自動(dòng)化的幫助我們把改變之后的文件塞到android編譯過(guò)程中對(duì)應(yīng)的位置患膛,接下來(lái)就是要進(jìn)行我們的字節(jié)碼處理文件核心------->利用ASM工具實(shí)現(xiàn)字節(jié)碼插樁操作
- 插樁主要分以下幾步:
1. 讀取.class文件(FileInputStream ->ClassReader)
2. 寫(xiě)入讀取的流文件(ClassWriter ->FileOutputStream)
3. 寫(xiě)入文件后對(duì)文件進(jìn)行加工處理(ASM-->XxxClassVisitor)
4. 通過(guò)自定義Visitor實(shí)現(xiàn)相應(yīng)的方法處理摊阀,注解處理,內(nèi)部類等處理操作
5. 具體操作就是先通過(guò)javap命令把字節(jié)碼.class文件反編譯成字節(jié)碼踪蹬,然后按照visitor提供的方法把你要添加的代碼寫(xiě)入代碼中胞此。具體可以下載demo
字節(jié)碼反編譯技巧:Idea或Android Studio查看字節(jié)碼當(dāng)然還有ASM的插件,但是感覺(jué)不好用跃捣,還不如這個(gè)擴(kuò)展來(lái)的簡(jiǎn)單方便漱牵。
gradle插件調(diào)試,在開(kāi)發(fā)過(guò)程中肯定免不了打斷點(diǎn)看數(shù)據(jù):
- IntelliJ(Android Studio)
Edit Configurations
點(diǎn)擊+
找到Remote
點(diǎn)擊創(chuàng)建遠(yuǎn)程配置- 填寫(xiě)信息.
Name
自定義, 默認(rèn)遠(yuǎn)程調(diào)試localhost:5005
Search sources using module's classpath
選擇需要調(diào)試的插件模塊- 命令行執(zhí)行任務(wù)調(diào)試:
./gradlew tasks -Dorg.gradle.debug=true --no-daemon
,等待連接調(diào)試- 源代碼斷點(diǎn), 選擇剛創(chuàng)建的調(diào)試配置, 點(diǎn)擊
Debug Xxx(Shift+F9)
- 點(diǎn)擊同步代碼的??疚漆,調(diào)試斷點(diǎn)酣胀,將在源碼斷點(diǎn)處停下來(lái)。