随着Android的发展,性能优化、组件化等等不少开发工作不得不在编译的过程中依赖对Java字节码的修改,这就要求我们学会基本的Gradle插件的实现。
但编写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这个函数。
/**
* 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 customTransforms = extension.getTransforms();
List> customTransformsDependencies = extension.getTransformsDependencies();
for (int i = 0, count = customTransforms.size(); i < count; i++) {
Transform transform = customTransforms.get(i);
List
首先我们需要知道,根据Android Moudule类型的不同,分为AppExtension和LibraryExtension,源码将编译过程中的一个个流程封装成若干个Transform,我们自定义插件就是为了在原来流程上添加我们自己的Transform。
例如,我在Application编译流程上添加一个流程,
public class MyPlugin implements Plugin {
@Override
public void apply(Project project) {
AppExtension appExtension = (AppExtension) project.getExtensions().getByName("android");
appExtension.registerTransform(new CustomTransform(project), Collections.EMPTY_LIST);
}
}
根据上述源码可知,自定义的Transform的工作位置在生成dex之前,生成class文件之后,这样,我们就可以在Transform里实现我们的字节码修改了。
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 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 getOutputTypes() {
return super.getOutputTypes();
}
@Override
public Set super QualifiedContent.Scope> getReferencedScopes() {
return TransformManager.EMPTY_SCOPES;
}
@Override
public Map getParameterInputs() {
return super.getParameterInputs();
}
@Override
public boolean isCacheable() {
return true;
}
@Override
public void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
super.transform(transformInvocation);
//自定义工作
}
}
在创建我们自己的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文件
}
}
完成了插件的编写,最后一步是发布插件,参考Gradle官方文档:
https://docs.gradle.org/current/userguide/publishing_overview.html
我们需要在build.gradle里添加发布的参数
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会自动帮我们生成一系列的发布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
愿大家玩得开心。