一、原理
Google從Android Gradle 1.5.0開(kāi)始，提供了Transform API。通過(guò)TransformAPI，允許第三方以插件（Plugin）的形式，在Android應(yīng)用程序打包成.dex文件之前的編譯過(guò)程中操作.class文件。我們只要實(shí)現(xiàn)一套Transform，去遍歷所有.class文件的所有方法，然后進(jìn)行修改（在特定listener的回調(diào)方法中插入埋點(diǎn)代碼），最后再對(duì)源文件進(jìn)行替換，即可達(dá)到插入代碼的目的。
二、Gradle Transform
它是在.class轉(zhuǎn)化為.dex期間用來(lái)修改.class文件的一套標(biāo)準(zhǔn)API。比較經(jīng)典的應(yīng)用是做字節(jié)碼插樁、代碼注入等。主要功能就是把輸入的.class轉(zhuǎn)化成目標(biāo)字節(jié)碼文件。
-
TransformInput 輸入文件的一個(gè)抽象包含兩個(gè)部分
- DirectoryInput 集合 是指以源碼方式參與項(xiàng)目編譯的所有目錄結(jié)構(gòu)以及目錄下的源文件
- JarInput 集合 是指以jar包（包含aar）參與編譯的所有本地jar以及遠(yuǎn)程jar包
TransformOutoutProvider Transform的輸出，通過(guò)他可以獲取輸出路徑等。
三、寫(xiě)一個(gè)Tranform ，把所有文件拷貝到輸出目錄
1.創(chuàng)建一個(gè)項(xiàng)目
2.創(chuàng)建一個(gè) Android Library module，名稱叫做plugin
3.清空plugin/build.gradle里面所有的內(nèi)容，改成如下所示
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
implementation gradleApi()
implementation localGroovy()
implementation 'com.android.tools.build:gradle:3.1.3'
}
repositories {
jcenter()
}
uploadArchives{
repositories.mavenDeployer{
//本地倉(cāng)庫(kù)路徑，放到項(xiàng)目根目錄下的repo的文件為列
repository(url:uri('../repo'))
//groupId 自行定義
pom.groupId = 'com.sensorsdata'
//artifactId
pom.artifactId = 'autotrack.android'
//插件版本號(hào)
pom.version = '1.0.2'
}
}
4.刪除plugin/src/main目錄下所有的文件
5.新建groovy目錄
插件是groovy語(yǔ)言開(kāi)發(fā)的，需要放到groovy目錄下。在groovy目錄下創(chuàng)建一個(gè)package，比如：com.sensorsdata.analytics.android.plugin。
6.在com.sensorsdata.analytics.android.plugin下創(chuàng)建SensorsAnalyticsTransform.groovy類。
package com.sensorsdata.analytics.android.plugin;
import com.android.build.api.transform.Context
import com.android.build.api.transform.DirectoryInput
import com.android.build.api.transform.Format
import com.android.build.api.transform.JarInput
import com.android.build.api.transform.QualifiedContent
import com.android.build.api.transform.Transform
import com.android.build.api.transform.TransformException
import com.android.build.api.transform.TransformInput
import com.android.build.api.transform.TransformOutputProvider
import com.android.build.gradle.internal.pipeline.TransformManager
import com.android.utils.FileUtils
import org.apache.commons.codec.digest.DigestUtils
import org.gradle.api.Project
class SensorsAnalyticsTransform extends Transform{
private static Project project
public SensorsAnalyticsTransform(Project project){
this.project = project
}
//這個(gè)是任務(wù)Task的名稱
@Override
String getName() {
return "SensorsAnalyticsAutoTrack"
}
/**
* 需要處理的數(shù)據(jù)類型，有兩種枚舉類型
*TransformManager.CONTENT_CLASS 代表處理java的class文件
* TransformManager.CONTENT_RESOURCES 代表java的資源文件
* @return
*/
@Override
Set<QualifiedContent.ContentType> getInputTypes() {
return TransformManager.CONTENT_CLASS
}
/**
*
* PROJECT 只處理當(dāng)前項(xiàng)目
* SUB——POROJECT 只處理子項(xiàng)目
* PROJECT-LOCAL-DEPS 只處理項(xiàng)目中的本地依賴 例如 jar，aar
* SUB_PROJECTS_LOCAL_DECPS 只處理子項(xiàng)目的本地依賴
* EXTERNAL_LIBRARIES 只處理外部項(xiàng)目
* PROVIDED_ONLY 只處理本地或以provided形式引入的依賴庫(kù)
* TESTED_CODE 測(cè)試代碼
* TransformManager.SCOPE_FULL_PROJECT
* @return
*/
@Override
Set<? super QualifiedContent.Scope> getScopes() {
return TransformManager.SCOPE_FULL_PROJECT
}
//是否增量構(gòu)建
@Override
boolean isIncremental() {
return false
}
static void printCopyRight(){
println()
println("#########################################")
println("######### ###########")
println("######### ###########")
println("######### AZY ###########")
println("######### ###########")
println("######### ###########")
println("#########################################")
println()
}
@Override
void transform(Context context, Collection<TransformInput> inputs, Collection<TransformInput> referencedInputs, TransformOutputProvider outputProvider, boolean isIncremental) throws IOException, TransformException, InterruptedException {
printCopyRight()
//Transform的Inputs有兩種類型，一種是目錄，一種是jar包，要分開(kāi)遍歷
inputs.each {TransformInput input ->
//遍歷目錄
input.directoryInputs.each { DirectoryInput directoryInput ->
//獲取output目錄
def dest = outputProvider.getContentLocation(directoryInput.name,directoryInput.contentTypes,directoryInput.scopes,
Format.DIRECTORY)
//將input目錄復(fù)制到output目錄
FileUtils.copyDirectory(directoryInput.file,dest)
}
//遍歷jar
input.jarInputs.each { JarInput jarInput ->
//重命名輸出文件
def jarName = jarInput.name
def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())
if(jarName.endsWith(".jar")){
jarName = jarName.substring(0,jarName.length() - 4)
}
File copyJarFile = jarInput.file
//生成輸出路徑
def dest = outputProvider.getContentLocation(jarName+md5Name,
jarInput.contentTypes,jarInput.scopes,Format.JAR)
//將input的目錄復(fù)制到output指定目錄
FileUtils.copyFile(copyJarFile,dest)
}
}
}
}
注意：自定義Transform即使什么都不做，也需要把輸入文件拷貝到目標(biāo)目錄下，否則下一個(gè)Task就沒(méi)有TransformInput了。如果我們什么都不做，那么打包的時(shí)候apk中缺少.class文件。
7.新建SensorsAnalyticsPlugin類，用來(lái)注冊(cè)SensorsAnalyticsTransform
package com.sensorsdata.analytics.android.plugin
import com.android.build.gradle.AppExtension
import org.gradle.api.Plugin
import org.gradle.api.Project
public class SensorsAnalyticsPlugin implements Plugin<Project>{
@Override
void apply(Project project) {
AppExtension appExtension = project.extensions.findByType(AppExtension.class)
appExtension.registerTransform(new SensorsAnalyticsTransform(project))
}
}
8.創(chuàng)建properties文件
在plugin/src/main目錄下新建目錄resources/META-INF/gradle-plugins（這是三個(gè)文件夾）,然后此目錄下創(chuàng)建一個(gè)文件：com.sensorsdata.android.properties，com.sensorsdata.android是用來(lái)指定我們的插件名稱的。也就是apply plugin 'com.sensorsdata.android'。文件具體類容如下(一般是包名+類名)
implementation-class=com.sensorsdata.analytics.android.plugin.SensorsAnalyticsPlugin
9.執(zhí)行plugin的uploadArchives任務(wù)構(gòu)建plugin，如下圖
執(zhí)行成功之后可以在項(xiàng)目跟路徑下查看repo文件夾
10.修改根目錄下的build.gradle文件，添加對(duì)應(yīng)的插件（添加備注“//新增”兩處）
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
repositories {
google()
jcenter()
//新增
maven{
url uri('repo')
}
}
dependencies {
classpath 'com.android.tools.build:gradle:3.6.2'
//新增
classpath 'com.sensorsdata:autotrack.android:1.0.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
google()
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
11.在app/build.gradle文件中聲明使用插件
12.通過(guò)執(zhí)行命令：./gradlew assembleDebug
如果編譯沒(méi)有出錯(cuò)，可以看到Transform中的日志打印，也可以查看對(duì)一個(gè)的輸入文件。
四、遇到的問(wèn)題
1.把plugin 寫(xiě)成pulgin
2.把resources/META-INF/gradle-plugins 三個(gè)文件夾，寫(xiě)出了一個(gè)文件夾resources.META-INF.gradle-plugins 導(dǎo)致app中 apply 插件時(shí)候找不到對(duì)應(yīng)的插件。花了我4.5個(gè)小時(shí)找這個(gè)問(wèn)題。
./gradlew compileDebug --stacktrace. 查看具體報(bào)錯(cuò)信息
最后附上源碼地址 http://github.com/yangzai100/AutoTrackTransformProject
