隨著Android的發(fā)展某抓，性能優(yōu)化铅祸、組件化等等不少開發(fā)工作不得不在編譯的過程中依賴對Java字節(jié)碼的修改奈应，這就要求我們學會基本的Gradle插件的實現(xiàn)。
但編寫Android Gradle插件開始會遇到兩個障礙贯涎，
- Groovy語言
- 官方Gradle插件的工作原理
第一個障礙很好解決，因為我們完全可以使用Java編寫慢洋，但是由于Gradle使用的Groovy塘雳，我們需要了解Groovy，以便閱讀其它插件的源碼普筹，所以針對這一點败明，我們可以不用，但是要看得懂太防。
可以過一遍語法特性：
https://www.ibm.com/developerworks/cn/education/java/j-groovy/j-groovy.html
第二個障礙不好解決妻顶，因為這方面的文檔確實很少，需要自己去閱讀源碼，API Source的文檔讳嘱。但是不要被它嚇到幔嗦，這個畢竟是工具，我們只要會用就夠了沥潭，所以我們看幾個關鍵部分邀泉，理解它的工作流程就足夠了。
拿到源碼最快的方式是添加這個依賴
implement 'com.android.tools.build:gradle:x.x.x'
然后我們找到TaskManager.java類叛氨，關注createPostCompilationTasks這個函數(shù)呼渣。
/**
* Creates the post-compilation tasks for the given Variant.
*
* These tasks create the dex file from the .class files, plus optional intermediary steps like
* proguard and jacoco
*/
public void createPostCompilationTasks(
@NonNull TaskFactory tasks,
@NonNull final VariantScope variantScope) {
...
// ----- External Transforms -----
// apply all the external transforms.
List<Transform> customTransforms = extension.getTransforms();
List<List<Object>> customTransformsDependencies = extension.getTransformsDependencies();
for (int i = 0, count = customTransforms.size(); i < count; i++) {
Transform transform = customTransforms.get(i);
List<Object> deps = customTransformsDependencies.get(i);
transformManager
.addTransform(tasks, variantScope, transform)
.ifPresent(t -> {
if (!deps.isEmpty()) {
t.dependsOn(tasks, deps);
}
// if the task is a no-op then we make assemble task depend on it.
if (transform.getScopes().isEmpty()) {
variantScope.getAssembleTask().dependsOn(tasks, t);
}
});
}
...
}
首先我們需要知道，根據(jù)Android Moudule類型的不同寞埠，分為AppExtension和LibraryExtension屁置，源碼將編譯過程中的一個個流程封裝成若干個Transform，我們自定義插件就是為了在原來流程上添加我們自己的Transform仁连。
例如蓝角，我在Application編譯流程上添加一個流程，
public class MyPlugin implements Plugin<Project> {
@Override
public void apply(Project project) {
AppExtension appExtension = (AppExtension) project.getExtensions().getByName("android");
appExtension.registerTransform(new CustomTransform(project), Collections.EMPTY_LIST);
}
}
根據(jù)上述源碼可知饭冬，自定義的Transform的工作位置在生成dex之前使鹅，生成class文件之后，這樣昌抠，我們就可以在Transform里實現(xiàn)我們的字節(jié)碼修改了患朱。
public class CustomTransform extends Transform {
private Logger logger;
private static final FileTime ZERO = FileTime.fromMillis(0);
public CustomTransform(Project project) {
logger = project.getLogger();
}
@Override
public String getName() {
return "CustomTransform";
}
@Override
public Set<QualifiedContent.ContentType> getInputTypes() {
return TransformManager.CONTENT_CLASS;
}
@Override
public Set<? super QualifiedContent.Scope> getScopes() {
return TransformManager.SCOPE_FULL_PROJECT;
}
@Override
public boolean isIncremental() {
return true;
}
@Override
public Set<QualifiedContent.ContentType> getOutputTypes() {
return super.getOutputTypes();
}
@Override
public Set<? super QualifiedContent.Scope> getReferencedScopes() {
return TransformManager.EMPTY_SCOPES;
}
@Override
public Map<String, Object> getParameterInputs() {
return super.getParameterInputs();
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
super.transform(transformInvocation);
//自定義工作
}
}
在創(chuàng)建我們自己的Transform的時候，需要選擇我們的目標文件的類型和范圍炊苫，比如例子中我需要處理整個項目中的class文件裁厅，設置輸入文件類型為TransformManager.CONTENT_CLASS，設置輸入文件范圍為TransformManager.SCOPE_FULL_PROJECT侨艾，這樣我們就能通過transform()中的TransformInvocation.getInputs()攔截到需要處理的文件执虹。
我們代碼源文件生成的class文件在對應的目錄下，依賴庫的class文件在jar包里唠梨，所以TransformInput又分為JarInputs和DirectoryInput袋励，需要分別處理:
for (TransformInput input : inputs) {
for (JarInput jarInput : input.getJarInputs()) {
//處理jar文件
}
for (DirectoryInput directoryInput : input.getDirectoryInputs()) {
//處理目錄下的class文件
}
}
完成了插件的編寫，最后一步是發(fā)布插件当叭，參考Gradle官方文檔：
https://docs.gradle.org/current/userguide/publishing_overview.html
我們需要在build.gradle里添加發(fā)布的參數(shù)
apply plugin: 'maven-publish'
publishing {
publications {
myLibrary(MavenPublication) {
from components.java
groupId = "dong"
artifactId = "myplugin"
version = 1.0
}
}
repositories {
maven {
name = 'myRepo'
url = "../repo"
}
}
}
gradle會自動幫我們生成一系列的發(fā)布Task
按需使用就行了,例如:
buildscript {
repositories {
maven {
url uri("/repo")
}
jcenter()
google()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.4.2'
classpath 'dong:myplugin:1.0'
}
}
apply plugin: 'myplugin'
附簡單示例代碼：
https://github.com/jpdong/ASMPluginSample
愿大家玩得開心茬故。
