Android AOP三剑客之Javassist
2018-11-01 本文已影响19人
Code猎人
前言
本章节更新的慢了些，最近公司多事之秋，今天静下心来把AOP最后入门篇补上，做事还要有头和尾的。
Javassist
Javassist作用是在编译器间修改class文件，与之相似的ASM（热修复框架女娲）也有这个功能，可以让我们直接修改编译后的class二进制代码，首先我们得知道什么时候编译完成，并且我们要赶在class文件被转化为dex文件之前去修改。在Transfrom这个api出来之前，想要在项目被打包成dex之前对class进行操作，必须自定义一个Task，然后插入到predex或者dex之前，在自定义的Task中可以使用javassist或者asm对class进行操作。而Transform则更为方便，Transfrom会有他自己的执行时机，不需要我们插入到某个Task前面。Tranfrom一经注册便会自动添加到Task执行序列中，并且正好是项目被打包成dex之前。
传送门：android-aop-samples
定义JavassistPlugin，固定写法没啥说的
public class JavassistPlugin implements Plugin<Project> {
void apply(Project project) {
System.out.println("------------------开始----------------------");
System.out.println("这是我们的自定义插件!");
//AppExtension就是build.gradle中android{...}这一块
def android = project.extensions.getByType(AppExtension)
//注册一个Transform
def classTransform = new JavassistTransform(project);
android.registerTransform(classTransform);
System.out.println("------------------结束了吗----------------------");
}
}
Transfrom
Gradle是通过一个一个Task执行完成整个流程的，其中肯定也有将所有class打包成dex的task。
（在gradle plugin 1.5 以上和以下版本有些不同）
1.5以下，preDex这个task会将依赖的module编译后的class打包成jar，然后dex这个task则会将所有class打包成dex
1.5以上，preDex和Dex这两个task已经消失，取而代之的是TransfromClassesWithDexForDebug
自定义Transfrom
public class JavassistTransform extends Transform {
private Project mProject;
public JavassistTransform(Project p) {
this.mProject = p;
}
//transform的名称
//transformClassesWithMyClassTransformForDebug 运行时的名字
//transformClassesWith + getName() + For + Debug或Release
@Override
public String getName() {
return "JavassistTransform";
}
//需要处理的数据类型，有两种枚举类型
//CLASSES和RESOURCES，CLASSES代表处理的java的class文件，RESOURCES代表要处理java的资源
@Override
public Set<QualifiedContent.ContentType> getInputTypes() {
return TransformManager.CONTENT_CLASS;
}
// 指Transform要操作内容的范围，官方文档Scope有7种类型：
// EXTERNAL_LIBRARIES 只有外部库
// PROJECT 只有项目内容
// PROJECT_LOCAL_DEPS 只有项目的本地依赖(本地jar)
// PROVIDED_ONLY 只提供本地或远程依赖项
// SUB_PROJECTS 只有子项目。
// SUB_PROJECTS_LOCAL_DEPS 只有子项目的本地依赖项(本地jar)。
// TESTED_CODE 由当前变量(包括依赖项)测试的代码
@Override
public Set<QualifiedContent.Scope> getScopes() {
return TransformManager.SCOPE_FULL_PROJECT;
}
//指明当前Transform是否支持增量编译
@Override
public boolean isIncremental() {
return false;
}
// Transform中的核心方法，
// inputs中是传过来的输入流，其中有两种格式，一种是jar包格式一种是目录格式。
// outputProvider 获取到输出目录，最后将修改的文件复制到输出目录，这一步必须做不然编译会报错
@Override
public void transform(Context context,
Collection<TransformInput> inputs,
Collection<TransformInput> referencedInputs,
TransformOutputProvider outputProvider,
boolean isIncremental) throws IOException, TransformException, InterruptedException {
System.out.println("你愁啥----------------进入transform了--------------")
//遍历input
inputs.each { TransformInput input ->
//遍历文件夹
input.directoryInputs.each { DirectoryInput directoryInput ->
//注入代码
MyInjects.inject(directoryInput.file.absolutePath, mProject)
// 获取output目录
def dest = outputProvider.getContentLocation(directoryInput.name,
directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)
// 将input的目录复制到output指定目录
FileUtils.copyDirectory(directoryInput.file, dest)
}
////遍历jar文件 对jar不操作，但是要输出到out路径
input.jarInputs.each { JarInput jarInput ->
// 重命名输出文件（同目录copyFile会冲突）
def jarName = jarInput.name
println("jar = " + jarInput.file.getAbsolutePath())
def 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)
}
}
System.out.println("瞅你咋地--------------结束transform了----------------")
}
}
主要说下transform干嘛的 ？？？在Transform里处理Task，通过inputs拿到一些东西，处理完毕之后就输出outputs，而下一个Task的inputs则是上一个Task的outputs。
MyInjects.inject（）插入代码
public class MyInjects {
//初始化类池
private final static ClassPool pool = ClassPool.getDefault();
public static void inject(String path, Project project) {
//将当前路径加入类池,不然找不到这个类
pool.appendClassPath(path);
//project.android.bootClasspath 加入android.jar，不然找不到android相关的所有类
pool.appendClassPath(project.android.bootClasspath[0].toString());
//引入android.os.Bundle包，因为onCreate方法参数有Bundle
pool.importPackage("android.os.Bundle");
File dir = new File(path);
if (dir.isDirectory()) {
//遍历文件夹
dir.eachFileRecurse { File file ->
String filePath = file.absolutePath
println("filePath = " + filePath)
if (file.getName().equals("MainActivity.class")) {
//获取MainActivity.class
CtClass ctClass = pool.getCtClass("com.zxy.aop.MainActivity");
println("ctClass = " + ctClass)
//解冻
if (ctClass.isFrozen())
ctClass.defrost()
//获取到OnCreate方法
CtMethod ctMethod = ctClass.getDeclaredMethod("onCreate")
println("方法名 = " + ctMethod)
String insetBeforeStr = """ android.widget.Toast.makeText(this,"WTF emmmmmmm.....我是被插入的Toast代码~!!",android.widget.Toast.LENGTH_LONG).show();
"""
//在方法开头插入代码
ctMethod.insertBefore(insetBeforeStr);
ctClass.writeFile(path)
ctClass.detach()//释放
}
}
}
}
}
运行效果图
看下build/intermediates/transforms/HavassustTransform/MainActivity.class
总结
ClassPool、CtClass、CtMethod核心类的使用在这里展示的很详细。
1、初始化ClassPool设置
2、通过包名取到对应的CtClass
3、通过CtClass取到CtMethod对应的“OnCreate”方法
4、CtMethodi插入代码块，写文件，释放，结束整个注入代码过程。
最后
本章节只是介绍了自定义Transform以及Javassist的三大核心类的使用，通过本章节的学习可以了解apk的编译过程，可以做很多好玩有意义的事情！
