作者：Code猎人
前言
继续上一章节自定义Gradle插件，利用plugin进一步做一些事情
本章节利用Google提供的Transform API 在编译的过程中操作.class文件。
先说一下Transform是什么
gradle从1.5开始，gradle插件包含了一个叫Transform的API，这个API允许第三方插件在class文件转为为dex文件前操作编译好的class文件，这个API的目标是简化自定义类操作，而不必处理Task，并且在操作上提供更大的灵活性。并且可以更加灵活地进行操作。
官方文档：http://google.github.io/android-gradle-dsl/javadoc/
我们接着在上面的demo中继续完成使用Transform API，
在我们自定义的gradle插件的build.gradle中引入transform的包,下面会进行代码注入，就一起引入的其他包
compile 'com.android.tools.build:transform-api:1.5.0'
compile 'javassist:javassist:3.12.1.GA'
compile 'commons-io:commons-io:2.5'
项目地址：TransformPlugin
接下来创建一个类继承Transform 并实现其方法
1package zxy.com.plugin
2
3import com.android.build.api.transform.*
4import com.android.build.gradle.internal.pipeline.TransformManager
5import org.apache.commons.codec.digest.DigestUtils
6import org.apache.commons.io.FileUtils
7import org.gradle.api.Project
8
9public class MyClassTransform extends Transform {
10
11private Project mProject;
12
13public MyClassTransform(Project p) {
14 this.mProject = p;
15}
16
17//transform的名称
18//transformClassesWithMyClassTransformForDebug 运行时的名字
19//transformClassesWith + getName() + For + Debug或Release
20@Override
21public String getName() {
22 return "MyClassTransform";
23}
24
25//需要处理的数据类型，有两种枚举类型
26//CLASSES和RESOURCES，CLASSES代表处理的java的class文件，RESOURCES代表要处理java的资源
27@Override
28public Set getInputTypes() {29 return TransformManager.CONTENT_CLASS;30}3132// 指Transform要操作内容的范围，官方文档Scope有7种类型：3334// EXTERNAL_LIBRARIES 只有外部库35// PROJECT 只有项目内容36// PROJECT_LOCAL_DEPS 只有项目的本地依赖(本地jar)37// PROVIDED_ONLY 只提供本地或远程依赖项38// SUB_PROJECTS 只有子项目。39// SUB_PROJECTS_LOCAL_DEPS 只有子项目的本地依赖项(本地jar)。40// TESTED_CODE 由当前变量(包括依赖项)测试的代码41@Override42public Set getScopes() {43 return TransformManager.SCOPE_FULL_PROJECT;44}4546//指明当前Transform是否支持增量编译47@Override48public boolean isIncremental() {49 return false;50}5152// Transform中的核心方法，53// inputs中是传过来的输入流，其中有两种格式，一种是jar包格式一种是目录格式。54// outputProvider 获取到输出目录，最后将修改的文件复制到输出目录，这一步必须做不然编译会报错55@Override56public void transform(Context context,57 Collection inputs,58 Collection referencedInputs,59 TransformOutputProvider outputProvider,60 boolean isIncremental) throws IOException, TransformException, InterruptedException {61 System.out.println("你愁啥----------------进入transform了--------------")62 //遍历input63 inputs.each { TransformInput input ->64 //遍历文件夹65 input.directoryInputs.each { DirectoryInput directoryInput ->66 //注入代码67 MyInjects.inject(directoryInput.file.absolutePath, mProject)6869 // 获取output目录70 def dest = outputProvider.getContentLocation(directoryInput.name,71 directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)7273 // 将input的目录复制到output指定目录74 FileUtils.copyDirectory(directoryInput.file, dest)75 }7677 遍历jar文件 对jar不操作，但是要输出到out路径78 input.jarInputs.each { JarInput jarInput ->79 // 重命名输出文件(同目录copyFile会冲突)80 def jarName = jarInput.name81 println("jar = " + jarInput.file.getAbsolutePath())82 def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())83 if (jarName.endsWith(".jar")) {84 jarName = jarName.substring(0, jarName.length() - 4)85 }86 def dest = outputProvider.getContentLocation(jarName + md5Name, jarInput.contentTypes, jarInput.scopes, Format.JAR)87 FileUtils.copyFile(jarInput.file, dest)88 }89 }90 System.out.println("瞅你咋地--------------结束transform了----------------")91}9293}在我们自定义的gradle插件的apply方法中注册自定义的Transform,上一章节已经有介绍过apply入口
1def android = project.extensions.getByType(AppExtension)
2//注册一个Transform
3def classTransform = new MyClassTransform(project);
4android.registerTransform(classTransform);BuildConfig这个类大家并不陌生，在项目里会用到，大家知道这个类可以增加我们自定义的属性吗，可是你知道怎么生成的么？
1//我们自定义的
2testCreatJavaConfig{
3str = "动态生成java类的字符串"
4}然后回到我们的自定义的Plugin中,贴一下整个代码
1import com.android.build.gradle.AppExtension
2import com.android.build.gradle.AppPlugin
3import org.gradle.api.Plugin
4import org.gradle.api.Project
5/** 6* @author：xinyu.zhou 7*/
8public class MyPlugin implements Plugin<Project> {
9
10void apply(Project project) {
11 System.out.println("------------------开始----------------------");
12 System.out.println("这是我们的自定义插件!");
13 //AppExtension就是build.gradle中android{...}这一块
14 def android = project.extensions.getByType(AppExtension)
15
16 //注册一个Transform
17 def classTransform = new MyClassTransform(project);
18 android.registerTransform(classTransform);
19
20 //创建一个Extension，名字叫做testCreatJavaConfig 里面可配置的属性参照MyPlguinTestClass
21 project.extensions.create("testCreatJavaConfig", MyPlguinTestClass)
22
23 //生产一个类
24 if (project.plugins.hasPlugin(AppPlugin)) {
25 //获取到Extension，Extension就是 build.gradle中的{}闭包
26 android.applicationVariants.all { variant ->
27 //获取到scope,作用域
28 def variantData = variant.variantData
29 def scope = variantData.scope
30
31 //拿到build.gradle中创建的Extension的值
32 def config = project.extensions.getByName("testCreatJavaConfig");
33
34 //创建一个task
35 def createTaskName = scope.getTaskName("CeShi", "MyTestPlugin")
36 def createTask = project.task(createTaskName)
37 //设置task要执行的任务
38 createTask.doLast {
39 //生成java类
40 createJavaTest(variant, config)
41 }
42 //设置task依赖于生成BuildConfig的task，然后在生成BuildConfig后生成我们的类
43 String generateBuildConfigTaskName = variant.getVariantData().getScope().getGenerateBuildConfigTask().name
44 def generateBuildConfigTask = project.tasks.getByName(generateBuildConfigTaskName)
45 if (generateBuildConfigTask) {
46 createTask.dependsOn generateBuildConfigTask
47 generateBuildConfigTask.finalizedBy createTask
48 }
49 }
50
51 }
52 System.out.println("------------------结束了吗----------------------");
53}
54
55static def void createJavaTest(variant, config) {
56 //要生成的内容
57 def content = """package com.zxy.plugin;5859 public class MyPlguinTestClass {60 public static final String str = "${config.str}";61 }62 """;
63 //获取到BuildConfig类的路径
64 File outputDir = variant.getVariantData().getScope().getBuildConfigSourceOutputDir()
65
66 def javaFile = new File(outputDir, "MyPlguinTestClass.java")
67
68 javaFile.write(content, 'UTF-8');
69}
70 }
71
72class MyPlguinTestClass {
73def str = "默认值";
74}编译一下看一下效果
image
可以看到我在app目录下的build.gradle文件里配置的testCreatJavaConfig 生效了，可以取到str的值
接下来要使用javassist,简单介绍下
- Javassist是一个动态类库，可以用来检查、”动态”修改以及创建 Java类。其功能与jdk自带的反射功能类似，但比反射功能更强大
- ClassPool：javassist的类池，使用ClassPool 类可以跟踪和控制所操作的类,它的工作方式与 JVM 类装载器非常相似，
CtClass：CtClass提供了检查类数据(如字段和方法)以及在类中添加新字段、方法和构造函数、以及改变类、父类和接口的方法。不过，Javassist 并未提供删除类中字段、方法或者构造函数的任何方法。
CtField：用来访问域
CtMethod ：用来访问方法
CtConstructor：用来访问构造器
想了解更多请自行查阅资料
下面我们利用Transform在MainActivity中动态的插入代码,先看一下现在的MainAcitivity
1public class MainActivity extends AppCompatActivity {
2
3@Override
4protected void onCreate(Bundle savedInstanceState) {
5 super.onCreate(savedInstanceState);
6 setContentView(R.layout.activity_main);
7 TextView textView= findViewById(R.id.tv);
8 textView.setText(com.zxy.plugin.MyPlguinTestClass.str);
9}
10}可以看到上面的setText中使用的是我们上面动态生成的类中的字段，看一下怎么利用Transform插入代码，先看一下Transform中代码
1// Transform中的核心方法，
2// inputs中是传过来的输入流，其中有两种格式，一种是jar包格式一种是目录格式。
3// outputProvider 获取到输出目录，最后将修改的文件复制到输出目录，这一步必须做不然编译会报错
4@Override
5public void transform(Context context, 6 Collection inputs, 7 Collection referencedInputs, 8 TransformOutputProvider outputProvider, 9 boolean isIncremental) throws IOException, TransformException, InterruptedException {
10 System.out.println("你愁啥----------------进入transform了--------------")
11 //遍历input
12 inputs.each { TransformInput input ->
13 //遍历文件夹
14 input.directoryInputs.each { DirectoryInput directoryInput ->
15 //注入代码
16 MyInjects.inject(directoryInput.file.absolutePath, mProject)
17
18 // 获取output目录
19 def dest = outputProvider.getContentLocation(directoryInput.name,
20 directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)
21
22 // 将input的目录复制到output指定目录
23 FileUtils.copyDirectory(directoryInput.file, dest)
24 }
25
26 遍历jar文件 对jar不操作，但是要输出到out路径
27 input.jarInputs.each { JarInput jarInput ->
28 // 重命名输出文件(同目录copyFile会冲突)
29 def jarName = jarInput.name30 println("jar = " + jarInput.file.getAbsolutePath())31 def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())
32 if (jarName.endsWith(".jar")) {
33 jarName = jarName.substring(0, jarName.length() - 4)
34 }
35 def dest = outputProvider.getContentLocation(jarName + md5Name, jarInput.contentTypes, jarInput.scopes, Format.JAR)
36 FileUtils.copyFile(jarInput.file, dest)
37 }
38 }
39 System.out.println("瞅你咋地--------------结束transform了----------------")
40}生成代码在MyInjects类中，在这个类中我们传入了两个参数，一个是当前变量的文件夹，一个是当前的工程对象，来看一下代码
1 public class MyInjects {
2//初始化类池
3private final static ClassPool pool = ClassPool.getDefault();
4
5public static void inject(String path,Project project) {
6 //将当前路径加入类池,不然找不到这个类
7 pool.appendClassPath(path);
8 //project.android.bootClasspath 加入android.jar，不然找不到android相关的所有类
9 pool.appendClassPath(project.android.bootClasspath[0].toString());
10 //引入android.os.Bundle包，因为onCreate方法参数有Bundle
11 pool.importPackage("android.os.Bundle");
12
13 File dir = new File(path);
14 if (dir.isDirectory()) {
15 //遍历文件夹
16 dir.eachFileRecurse { File file ->
17 String filePath = file.absolutePath
18 println("filePath = " + filePath)
19 if (file.getName().equals("MainActivity.class")) {
20
21 //获取MainActivity.class
22 CtClass ctClass = pool.getCtClass("com.zxy.plugin.MainActivity");
23 println("ctClass = " + ctClass)
24 //解冻
25 if (ctClass.isFrozen())
26 ctClass.defrost()
27
28 //获取到OnCreate方法
29 CtMethod ctMethod = ctClass.getDeclaredMethod("onCreate")
30
31 println("方法名 = " + ctMethod)
32
33 String insetBeforeStr = """ android.widget.Toast.makeText(this,"WTF emmmmmmm.....我是被插了的Toast代码~!!",android.widget.Toast.LENGTH_SHORT).show();34 """
35 //在方法开头插入代码
36 ctMethod.insertBefore(insetBeforeStr);
37 ctClass.writeFile(path)
38 ctClass.detach()//释放
39 }
40 }
41 }
42
43}
44}通过反编译可以看到我们成功的注入了一个Toast
image
运行效果
image
总结
还是那句话，本章节是让我们了解plugin和javassist结合使用入门，很多插件化等技术都会用到javassist,需要我们更多的深入了解和探索，无论是自定义gradle还是注入代码这些技术都是通往大牛之路的必备技能，有描述错误的地方欢迎童鞋们指出。
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
