android gradle plugin 提供了 transform api 用來在 .class to dex 過程中對 class 進行處理，可以理解為一種特殊的 Task，因為 transform 最終也會轉化為 Task 去執行

要實現 transform 需要繼承 com.android.build.api.transform.Transform 並實現其方法，實現了 Transform 以後，要想應用，就調用 project.android.registerTransform()

public class MyTransform extends Transform {
@Override
public String getName() {
// 返回 transform 的名稱，最終的名稱會是 transformClassesWithMyTransformForDebug 這種形式
return "MyTransform";
}

@Override
public Set<QualifiedContent.ContentType> getInputTypes() {
/**
返回需要處理的數據類型 有 下面幾種類型可選
public static final Set<ContentType> CONTENT_CLASS = ImmutableSet.of(CLASSES);
public static final Set<ContentType> CONTENT_JARS = ImmutableSet.of(CLASSES, RESOURCES);
public static final Set<ContentType> CONTENT_RESOURCES = ImmutableSet.of(RESOURCES);
public static final Set<ContentType> CONTENT_NATIVE_LIBS = ImmutableSet.of(NATIVE_LIBS);
public static final Set<ContentType> CONTENT_DEX = ImmutableSet.of(ExtendedContentType.DEX);
public static final Set<ContentType> DATA_BINDING_ARTIFACT = ImmutableSet.of(ExtendedContentType.DATA_BINDING);
*/
return TransformManager.CONTENT_CLASS;
}

@Override
public Set<? super QualifiedContent.Scope> getScopes() {
/**
返回需要處理內容的範圍，有下面幾種類型
PROJECT(1), 只處理項目的內容
SUB_PROJECTS(4), 只處理子項目
EXTERNAL_LIBRARIES(16), 只處理外部庫
TESTED_CODE(32), 只處理當前 variant 對應的測試代碼
PROVIDED_ONLY(64), 處理依賴
@Deprecated
PROJECT_LOCAL_DEPS(2),
@Deprecated
SUB_PROJECTS_LOCAL_DEPS(8);
*/
return Sets.immutableEnumSet(QualifiedContent.Scope.PROJECT);
}

@Override
public boolean isIncremental() {
// 是否增量，如果返回 true，TransformInput 會包括一份修改的文件列表，返回 false，會進行全量編譯，刪除上一次的輸出內容
return false;
}

@Override
void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
// 在這裡處理 class
super.transform(transformInvocation)
// 在 transform 里，如果沒有任何修改，也要把 input 的內容輸出到 output，否則會報錯
for (TransformInput input : transformInvocation.inputs) {
input.directoryInputs.each { dir ->
// 獲取對應的輸出目錄
File output = transformInvocation.outputProvider.getContentLocation(dir.name, dir.contentTypes, dir.scopes, Format.DIRECTORY)
dir.changedFiles // 增量模式下修改的文件
dir.file // 獲取輸入的目錄
FileUtils.copyDirectory(dir.file, output) // input 內容輸出到 output
}
input.jarInputs.each { jar ->
// 獲取對應的輸出 jar
File output = transformInvocation.outputProvider.getContentLocation(jar.name, jar.contentTypes, jar.scopes, Format.JAR)
jar.file // 獲取輸入的 jar 文件
FileUtils.copyFile(jar.file, output) // input 內容輸出到 output
}
}
}
}

// 註冊 transform
android.registerTransform(new MyTransform())

在 transform 中的處理，一般會涉及到 class 文件的修改，操縱位元組碼的工具一般是 javasist 和 asm 居多，這兩個工具在這裡先不介紹了。後面有機會會展開說一下

八、自己寫 plugin

gradle 的插件可以看作是一系列 task 的集合

在 android 工程的 build.gradle 腳本里，第一行就是 apply plugin: com.android.application，這個就是引入 android gradle 插件，插件里有 android 打包相關的 task關於 android gradle plugin 的源碼分析，在後面會講到，現在先看看如何實現一個自己的 plugin

8.1 初始化工程

1. 在 android studio 中創建一個 java module

2. 在 src/main 目錄下創建 groovy 目錄，然後創建自己的包名和插件類

3. 在 src/main 目錄下創建 resources/META-INFO/gradle-plugins 目錄，創建 ,myplugin.properties 文件，文件里內容是

implementation-class=com.zy.plugin.MyPlugin // 這裡是自己的插件類

4. 修改 build.gradle 文件

// 引入 groovy 和 java 插件
apply plugin: groovy
apply plugin: java

buildscript {
repositories {
mavenLocal()
maven { url http://depot.sankuai.com/nexus/content/groups/public/ }
maven { url https://maven.google.com }
jcenter()
}
}

repositories {
mavenLocal()
maven {
url "http://mvn.dianpingoa.com/android-nova"
}
maven {
url http://depot.sankuai.com/nexus/content/groups/public/
}
maven { url https://maven.google.com }
}

dependencies {
compile gradleApi()
compile localGroovy()
compile com.android.tools.build:gradle:3.0.1
}

現在為止，項目結構是這個樣子的

8.2 創建 Plugin

在剛才創建的插件類里，就可以寫插件的代碼了。插件類繼承 Plugin，並實現 apply 介面，apply 就是在 build.gradle 里 apply plugin xxx 的時候要調用的介面了

插件開發可以使用 groovy 和 java，使用 groovy 的話可以有更多的語法糖，開發起來更方便一些

package com.zy.plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class MyPlugin implements Plugin<Project> {

@Override
void apply(Project project) {
println("apply my plugin")
}
}

8.3 創建插件的 task

我們再定義一個 task 類 MyTask，繼承自 DefaultTask，簡單的輸出一些信息

package com.zy.plugin

import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

class MyTask extends DefaultTask {

@TaskAction
void action() {
println(my task run)
}
}

然後在 plugin 中註冊這個 task

class MyPlugin implements Plugin<Project> {

@Override
void apply(Project project) {
println("apply my plugin")
project.tasks.create("mytask", MyTask.class)
}
}

8.4 本地安裝插件

這樣一個簡單的插件就開發好了，如何使用呢

我們首先需要在 build.gradle 中引入 maven 插件，並且配置 install 相關的屬性

apply plugin: maven

install {
repositories.mavenInstaller {
pom.version = 0.0.1 // 配置插件版本號
pom.artifactId = myplugin // 配置插件標識
pom.groupId = com.zy.plugin // 配置插件組織
}
}

之後執行 ./gradlew install 便會把插件安裝在本地 maven 倉庫

之後在使用的地方引入我們插件的 classpath

classpath com.zy.plugin:myplugin:0.0.1

之後載入插件

apply plugin; myplugin // 這裡的 myplugin 是前面說的 myplugin.properties 的名字

然後運行 ./gradlew tasks --all | grep mytask，就可以看到我們在 plugin 里新增的 task 了

./gradlew mytasks 就可以執行 task 了

8.5 打包發布

在插件 build.gradle 里新增上傳的配置如下

uploadArchives {
repositories {
mavenDeployer {
repository(url: "mavenUrl")
pom.version = 0.0.1
pom.artifactId = myplugin
}
}
}

運行 ./gradlew uploadArchives 就可以了

8.6 調試插件

那麼開發插件的時候如何調試呢？

1.首先在 as 中新增一個 remote 配置

2.之後在執行 task 的時候增加下面的參數

./gradlew app:mytask -Dorg.gradle.debug=true

此時可以看到 gradle 在等待 debug 進程連接

3.之後在插件代碼中打好斷點，在 as 中點擊 debug 按鈕，就可以調試插件代碼了

九、重點總結

其中一定要掌握的如下：

1. gradle dsl 查詢地址 https://docs.gradle.org/current/dsl/index.html
2. android gradle plugin dsl 查詢地址 http://google.github.io/android-gradle-dsl/current/
3. gradle 構建生命周期和回調
4. implementation / api
5. flavor
6. 自定義 Task
7. 自定義 Transform 和 自定義插件可以作為擴展內容

推薦閱讀：