我的简书同步发布:通过自定义Gradle插件修改编译后的class文件

转载请注明出处：【huachao1001的专栏：http://blog.csdn.net/huachao1001】

或许你会觉得没有必要这样做，可是有一种应用场景就是，为每个编译后的class文件添加一行代码。比如：在每个Java类的构造函数中加一句System.out.println("I Love HuaChao!");（PS:莫吐槽~，莫嘲笑~），如果你每次创建一个类的时候都手动加这么一句话，先不谈容易出错，我们说说工作量。或许你觉得，你愿意手动加，那我再跟你提新需求，我现在不要这句代码了，我要的是System.out.println("I Love MaYun!");你给我改去吧~，这时候你会不会想骂人~。忍住！我们上一篇《在AndroidStudio中自定义Gradle插件》不是学过自定义Gradle插件了吗？我们为什么要手动写呢？直接通过Gradle插件来帮我们干！

1 认识Project对象

还记得上一篇文章中，我们自定义的插件类是通过实现Plugin接口，并将org.gradle.api.Project作为模板参数吗？org.gradle.api.Project的实例对象将作为参数传给void apply(Project project)函数。接下来我看看Project类。

根据Gradle官网的介绍，Project是你与Gradle交互的主接口，通过Project你可以通过代码使用所有的Gradle特性，Project与build.gradle是一对一的关系。简单来说，你想要通过代码使用Gradle，通过Project这个入口，就可以啦~

我们先看一个简单的通过Project访问的使用场景：Extension。可能你对Extension不熟悉，但是，我给你看一个你熟悉的内容：

android {compileSdkVersion 24buildToolsVersion "24.0.0"defaultConfig {applicationId "com.hc.hcplugin"minSdkVersion 15targetSdkVersion 24versionCode 1versionName "1.0"}buildTypes {release {minifyEnabled falseproguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'}}
}

上面的这些你是不是很熟悉呢？你有没有想过，上面的android{}、compileSdkVersion、defaultConfig {}等等这些设置是如何被Android的Gradle插件读取的呢？想必你已经想到了，没错，就是通过Extension。下面我们自定义一个Extension，感受一下~。首先，定义两个Groovy类：Address和HCExtension.注意：为了避免引入插件问题，以下代码全部放入buildsrc模块的build.gradle文件中:

class Address{String province=nullString city=null
}
class HCExtension{String myName = null;}

再新建一个Plugin(同样也放入build.gradle中)：

class TestExtensionPlugin implements Plugin<Project> {@Overridevoid apply(Project project) {project.extensions.create('hc', HCExtension);project.extensions.create('address', Address);project.task('readExtension') << {def address=project['address']println project['hc'].myNameprintln address.province+" "+address.city}}
}

接下来就是把你的配置放进去啦(同样也放入build.gradle中)：

apply plugin: TestExtensionPluginhc {address{province "HuBei"city "WuHan"}myName "huachao"}

稍微解释一下，apply plugin: TestExtensionPlugin这一行会导致直接执行TestExtensionPlugin类的apply方法。所以，hc{}这个块必须放在apply plugin: TestExtensionPlugin之后，因为在没有执行project.extensions.create('hc', HCExtension);之前，使用hc{}会报错！address{}也是同理。另外，补充一下：project.extensions相当于project.getExtensions()即返回的是ExtensionContainer对象，而ExtensionContainer对象的create方法就是把hc{}与HCExtension对应起来。其他通过project.的方式也是同样的道理。再看看project.task('readExtension')，这是创建一个task。相当于在build.gradle文件中的task xxx <<{}只不过这里是通过代码的方式动态创建.

此时你的buildsrc模块中的build.gradle文件应该如下：

apply plugin: 'groovy'dependencies {compile gradleApi()//gradle sdkcompile localGroovy()//groovy sdkcompile 'com.android.tools.build:gradle:2.1.0'
}repositories {jcenter()
}
class Address{String province=nullString city=null
}
class HCExtension{String myName = null;}class TestExtensionPlugin implements Plugin<Project> {@Overridevoid apply(Project project) {project.extensions.create('hc', HCExtension);project.extensions.create('address', Address);project.task('readExtension') << {def address=project['address']println project['hc'].myNameprintln address.province+" "+address.city}}
}apply plugin: TestExtensionPluginhc {address{province "HuBei"city "WuHan"}myName "huachao"}

点击buildsrc模块中的readExtension如下图：

看看打印信息

···
:buildsrc:readExtension
huachao
HuBei WuHan···

关于Project对象先介绍到这里，更多内容请查看官方网站：https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html

2 修改编译后的class

接下来回到我们的主题，我们需要修改class文件，首先我们得知道什么时候编译完成，并且我们要赶在class文件被转化为dex文件之前去修改。从1.5.0-beta1开始，android的gradle插件引入了com.android.build.api.transform.Transform，可以点击 http://tools.android.com/tech-docs/new-build-system/transform-api 查看相关内容。Transform每次都是将一个输入进行处理，然后将处理结果输出，而输出的结果将会作为另一个Transform的输入，过程如下：

注意，输出地址不是由你任意指定的。而是根据输入的内容、作用范围等由TransformOutputProvider生成，比如，你要获取输出路径：

 String dest = outputProvider.getContentLocation(directoryInput.name,directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)

Transform是一个抽象类，我们先自定义一个Transform，如下：

package com.hc.pluginimport com.android.build.api.transform.*
import com.android.build.gradle.internal.pipeline.TransformManager
import org.apache.commons.codec.digest.DigestUtils
import org.apache.commons.io.FileUtils
import org.gradle.api.Project/*** Created by HuaChao on 2016/7/4.*/
public class MyTransform extends Transform {Project project// 构造函数，我们将Project保存下来备用public MyTransform(Project project) {this.project = project}// 设置我们自定义的Transform对应的Task名称// 类似：TransformClassesWithPreDexForXXX@OverrideString getName() {return "MyTrans"}// 指定输入的类型，通过这里的设定，可以指定我们要处理的文件类型//这样确保其他类型的文件不会传入@OverrideSet<QualifiedContent.ContentType> getInputTypes() {return TransformManager.CONTENT_CLASS}// 指定Transform的作用范围@OverrideSet<QualifiedContent.Scope> getScopes() {return TransformManager.SCOPE_FULL_PROJECT}@Overrideboolean isIncremental() {return false}//具体的处理@Overridevoid transform(Context context, Collection<TransformInput> inputs,Collection<TransformInput> referencedInputs,TransformOutputProvider outputProvider, boolean isIncremental)throws IOException, TransformException, InterruptedException {}
}

看到函数transform,我们还没有具体实现这个函数。这个函数就是具体如何处理输入和输出。可以运行一下看看，注意，这里的运行时直接编译执行我们的apk，而不是像之前那样直接rebuild，因为rebuild并没有执行到编译这一步。由于我们没有实现transform这个函数，导致没有输出！使得整个过程中断了！最终导致apk运行时找不到MainActivity，所以会报错。接下来我们去实现以下这个函数，我们啥也不干，就是把输入内容写入到作为输出内容，不做任何处理，（下面代码参考自这里）：

@Override
void transform(Context context, Collection<TransformInput> inputs,Collection<TransformInput> referencedInputs,TransformOutputProvider outputProvider, boolean isIncremental)throws IOException, TransformException, InterruptedException {// Transform的inputs有两种类型，一种是目录，一种是jar包，要分开遍历inputs.each {TransformInput input ->//对类型为“文件夹”的input进行遍历input.directoryInputs.each {DirectoryInput directoryInput->//文件夹里面包含的是我们手写的类以及R.class、BuildConfig.class以及R$XXX.class等// 获取output目录def dest = outputProvider.getContentLocation(directoryInput.name,directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)// 将input的目录复制到output指定目录FileUtils.copyDirectory(directoryInput.file, dest)}//对类型为jar文件的input进行遍历input.jarInputs.each {JarInput jarInput->//jar文件一般是第三方依赖库jar文件// 重命名输出文件（同目录copyFile会冲突）def jarName = jarInput.namedef md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())if(jarName.endsWith(".jar")) {jarName = jarName.substring(0,jarName.length()-4)}//生成输出路径def dest = outputProvider.getContentLocation(jarName+md5Name, jarInput.contentTypes, jarInput.scopes, Format.JAR)//将输入内容复制到输出FileUtils.copyFile(jarInput.file, dest)}}
}

注意input的类型，分为”文件夹”和“jar文件”，”文件夹”里面的就是我们写的类对应的class文件，jar文件一般为第三方库。此时，能成功运行，但是我们还没有注入代码呢~，下面我们看看如何注入代码~

3 Javassist

要修改class字节码，我们要是自己手动改二进制文件，有点困难，好在有Javassist这个库，可以让我们直接修改编译后的class二进制代码。关于Javassist的使用，这里不介绍，可以自行搜索。要使用到Javassist，我们得在buildsrc模块下的build.gradle添加依赖包：

compile 'org.javassist:javassist:3.20.0-GA'

使用Javassist也很简单，首先拿到ClassPool对象，通过ClassPool获取已经编译好的类，如：

ClassPool pool = ClassPool.getDefault();
CtClass cc = pool.get("com.hc.MyClass");
cc.setSuperclass(pool.get("com.hc.ParentClass"));
cc.writeFile();

上面代码就实现了修改MyClass类的父类为ParentClass.

要获取字节码以及加载为Class对象，如下：

byte[] b = cc.toBytecode();
Class clazz = cc.toClass();

前面提到，我们自己创建的Java类编译后是放入到文件夹里面的，因此，我们只需针对这个文件夹里面的class文件进行修改即可，新建一个Groovy类：

package com.hc.pluginimport javassist.ClassPool
import javassist.CtClass
import javassist.CtConstructor
public class MyInject {private static ClassPool pool = ClassPool.getDefault()private static String injectStr = "System.out.println(\"I Love HuaChao\" ); ";public static void injectDir(String path, String packageName) {pool.appendClassPath(path)File dir = new File(path)if (dir.isDirectory()) {dir.eachFileRecurse { File file ->String filePath = file.absolutePath//确保当前文件是class文件，并且不是系统自动生成的class文件if (filePath.endsWith(".class")&& !filePath.contains('R$')&& !filePath.contains('R.class')&& !filePath.contains("BuildConfig.class")) {// 判断当前目录是否是在我们的应用包里面int index = filePath.indexOf(packageName);boolean isMyPackage = index != -1;if (isMyPackage) {int end = filePath.length() - 6 // .class = 6String className = filePath.substring(index, end).replace('\\', '.').replace('/', '.')//开始修改class文件CtClass c = pool.getCtClass(className)if (c.isFrozen()) {c.defrost()}CtConstructor[] cts = c.getDeclaredConstructors() if (cts == null || cts.length == 0) {//手动创建一个构造函数CtConstructor constructor = new CtConstructor(new CtClass[0], c)constructor.insertBeforeBody(injectStr)c.addConstructor(constructor)} else {cts[0].insertBeforeBody(injectStr)}c.writeFile(path)c.detach()}}}}}}

然后就是在 transform函数中，针对“文件夹”里面的class进行注入，而jar文件类型的input依然不做处理。transform函数如下：

 @Override
void transform(Context context, Collection<TransformInput> inputs,Collection<TransformInput> referencedInputs,TransformOutputProvider outputProvider, boolean isIncremental)throws IOException, TransformException, InterruptedException {// Transform的inputs有两种类型，一种是目录，一种是jar包，要分开遍历inputs.each { TransformInput input ->//对类型为“文件夹”的input进行遍历input.directoryInputs.each { DirectoryInput directoryInput ->//文件夹里面包含的是我们手写的类以及R.class、BuildConfig.class以及R$XXX.class等MyInject.injectDir(directoryInput.file.absolutePath,"com\\hc\\hcplugin")// 获取output目录def dest = outputProvider.getContentLocation(directoryInput.name,directoryInput.contentTypes, directoryInput.scopes,Format.DIRECTORY)// 将input的目录复制到output指定目录FileUtils.copyDirectory(directoryInput.file, dest)}//对类型为jar文件的input进行遍历input.jarInputs.each { JarInput jarInput ->//jar文件一般是第三方依赖库jar文件// 重命名输出文件（同目录copyFile会冲突）def jarName = jarInput.namedef md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())if (jarName.endsWith(".jar")) {jarName = jarName.substring(0, jarName.length() - 4)}//生成输出路径def dest = outputProvider.getContentLocation(jarName + md5Name,jarInput.contentTypes, jarInput.scopes, Format.JAR)//将输入内容复制到输出FileUtils.copyFile(jarInput.file, dest)}}
}

大功告成，接下来测试一下，在app模块中，新建一个Test类，在MainActivity中调用new Test()；

Test.java

package com.hc.hcplugin;/*** Created by HuaChao on 2016/7/4.*/
public class Test {}

MainActivity.java

package com.hc.hcplugin;import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;public class MainActivity extends AppCompatActivity {@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);Log.e("--->", "===================");new Test();Log.e("--->", "===================");}}

运行结果如下：

第一个打印是MainActivity的构造函数打印的，第二个是Test的构造函数打印的。看到这里，或许你想说，这有什么用啊？难道搞半天就为了打印这么一句话？其实，真的很有用，如果你看过关于热补丁相关内容，你就知道，还真的需要对每个类加上System.out.println(xxx)。不信你看：

https://mp.weixin.qq.com/s?__biz=MzI1MTA1MzM2Nw==&mid=400118620&idx=1&sn=b4fdd5055731290eef12ad0d17f39d4a&scene=1&srcid=1106Imu9ZgwybID13e7y2nEi#wechat_redirect

附上源码：http://download.csdn.net/download/huachao1001/9567113

通过自定义Gradle插件修改编译后的class文件相关推荐

【Android Gradle 插件】自定义 Gradle 插件优化图片 ① ( Android 中的 WebP 图片格式使用 | WebP 格式转换 | WebP 参考文档 )
文章目录一.Android 中的 WebP 图片格式使用二.WebP 格式转换三.WebP 参考文档 Android Plugin DSL Reference 参考文档 : Android St ...
Android如何自定义Gradle插件
Android-如何自定义gradle插件自定义gradle插件可以实现定制自己的构建流程,以达到复用目的: ##1. 自定义插件方式自定义插件有三种方式添加脚步在你的app项目的build. ...
Android组件化开发实践（九）：自定义Gradle插件
本文紧接着前一章Android组件化开发实践(八):组件生命周期如何实现自动注册管理,主要讲解怎么通过自定义插件来实现组件生命周期的自动注册管理. 1. 采用groovy创建插件新建一个Java L ...
自定义Gradle插件之Hello World
自定义Gradle插件之"Hello World" 0.新建一个用于开发这个插件的文件夹 1.确定Plugin id Plugin id一般定义为java 包名. 由字母和数字及& ...
【错误记录】自定义 Gradle 插件报错 ( Could not find implementation class x for plugin x specified in jar:file )
文章目录一.报错信息二.解决方案一.报错信息参考 [Android Gradle 插件]自定义 Gradle 插件模块 ④ ( META-INF 中声明自定义插件的核心类 | 在应用中依赖本地 ...
Android 自定义gradle插件
android自定义gradle插件的步骤 1.首先我们新建一个android项目 2.然后新建一个android module a.删除一些不需要的文件目录,然后新建groovy,resources ...
创建第一个适用于Android的自定义Gradle插件-第2部分：在构建时生成资源
A hands on tutorial to get started with adding custom functionality to your Android builds using Kot ...
c#:Reflector+Reflexil 修改编译后的dll/exe文件
原文:c#:Reflector+Reflexil 修改编译后的dll/exe文件不知道大家有没有这样的经历:现场实施时测试出一个bug,明明知道某个dll/exe文件只要修改一二行代码即可,但手头没 ...
使用AndroidStudio创建自定义gradle插件并被引用实战例子
项目中引入自定义Gradle plugin一般有三种方法: 直接写在 build.gradle中. plugin源码放到rootProjectDir/buildSrc/src/main/groovy目 ...

通过自定义Gradle插件修改编译后的class文件

1 认识Project对象

2 修改编译后的class

3 Javassist

通过自定义Gradle插件修改编译后的class文件相关推荐

最新文章

热门文章