Proguard源码分析(三)Seed文件
Seed文件就是保持住的类文件,直白一点就是不被混淆的文件,他主要是通过printSeeds() 方法实现
这里我们要引入一个类ClassVisitor 。这个我们要区分ClassPoolVisitor
ClassPoolVisitor可以看成是ClassVisitor的组合,
也就是说我们单纯看代码实现的时候可以只关注ClassVisitor。先看下seed的输出文件:
1:com.test.Test
2:com.test.Test: java.lang.String publicP
3:com.test.Test: com.test.Test2 test2
4:com.test.Test: Test()
5:com.test.Test: void function_public()
第一行是类的keep标志,通过KeptClassFilter来实现(代码在SeedPrinter里)KeptClassFilter 是一个类访问者
public void visitProgramClass(ProgramClass programClass)
{
if (KeepMarker.isKept(programClass))
{
classVisitor.visitProgramClass(programClass);
}
}
可以看到SeedPrinter 通过KeepMarker.isKept 标识是否访问类
这里的classVisitor的实现类是SimpleClassPrinter printer = new SimpleClassPrinter(false, ps);
功能就是将class打印到文件中,这里我们并不关注,来跟一下KeepMarker.isKept
public static boolean isKept(VisitorAccepter visitorAccepter)
{
// We're also checking for the constant in NoSideEffectMethodMarker,
// to keep things simple.
Object visitorInfo =
MethodLinker.lastVisitorAccepter(visitorAccepter).getVisitorInfo();
return visitorInfo == KEPT ||
visitorInfo == NoSideEffectMethodMarker.KEPT_BUT_NO_SIDE_EFFECTS;
}
这里isKept 传递的参数是VisitorAccepter,类名还是很直观的大概就是被访问者,它的实现类就是所有的类型元素,例如,类,注解,变量,属性,常量等等。
public interface VisitorAccepter
{
/**
* Gets the visitor information of the visitor accepter.
*/
public Object getVisitorInfo();
/**
* Sets the visitor information of the visitor accepter.
*/
public void setVisitorInfo(Object visitorInfo);
}
我们可以看出来,被访问者存储一些访问数据让另外一些访问者使用~
那个它又是在什么地方传入的数据呢~？
我们在ProgramClazz 里面打印堆栈信息:>>>ProgramClass.java:proguard.classfile.ProgramClass.setVisitorInfo()
>>>ClassCleaner.java:proguard.classfile.visitor.ClassCleaner.clean()
>>>ClassCleaner.java:proguard.classfile.visitor.ClassCleaner.visitProgramClass()
>>>ProgramClass.java:proguard.classfile.ProgramClass.accept()
>>>ClassPool.java:proguard.classfile.ClassPool.classesAccept()
>>>DescriptorKeepChecker.java:proguard.DescriptorKeepChecker.checkClassSpecifications()
>>>Initializer.java:proguard.Initializer.execute()
>>>ProGuard.java:proguard.ProGuard.initialize()
>>>ProGuard.java:proguard.ProGuard.execute()
可见是在初始化的时候设置了参数。我们尝试一下吧初始化步骤去掉,不出所料,最后的种子文件是空白。ClassCleaner我们看成初始化的一部分。也就是清除掉这些访问数据,这是个好习惯,就像程序开始时候的清数据一样。
设置keep信息在
new DescriptorKeepChecker(programClassPool,
libraryClassPool,
descriptorKeepNotePrinter).checkClassSpecifications(configuration.keep);
这个方法中。
最终通过
KeepMarker keepMarker = new KeepMarker();
ClassPoolVisitor classPoolvisitor =
ClassSpecificationVisitorFactory.createClassPoolVisitor(keepSpecifications,
keepMarker,
keepMarker,
false,
true,
true);
// Mark the seeds.
programClassPool.accept(classPoolvisitor);
libraryClassPool.accept(classPoolvisitor);
keepMarker对象来访问对象池。
public void visitProgramClass(ProgramClass programClass)
{
markAsKept(programClass);
}
做法很简单,设置一个KEPT常量visitorAccepter.setVisitorInfo(KEPT);那么它又是如何标记那些类适合用keep访问者访问的呢？答案就在静态工厂类:
ClassSpecificationVisitorFactory.createClassPoolVisitor构造类池访问对象中,
MultiClassPoolVisitor multiClassPoolVisitor = new MultiClassPoolVisitor();
if (keepClassSpecifications != null)
{
for (int index = 0; index < keepClassSpecifications.size(); index++)
{
KeepClassSpecification keepClassSpecification =
(KeepClassSpecification)keepClassSpecifications.get(index);
if ((shrinking && !keepClassSpecification.allowShrinking) ||
(optimizing && !keepClassSpecification.allowOptimization) ||
(obfuscating && !keepClassSpecification.allowObfuscation))
{
multiClassPoolVisitor.addClassPoolVisitor(
createClassPoolVisitor(keepClassSpecification,
classVisitor,
memberVisitor));
}
}
}
return multiClassPoolVisitor;
我们之前说过multiClassPoolVisitor 是ClassPoolVisitor是实现类,multiClassPoolVisitor又是ClassPoolVisitor的组合类,也就是 ClassVisitor的组合,看源码的时候可以不关注它,所以我们直接看重点
createClassPoolVisitor(keepClassSpecification,
classVisitor,
memberVisitor)
这个方法返回的实现类是NamedClassVisitor
public class NamedClassVisitor implements ClassPoolVisitor
是一个类池对象,
public void visitClassPool(ClassPool classPool)
{
classPool.classAccept(name, classVisitor);
}
可见NamedClassVisitor 最重要的就是name 参数，String className = classSpecification.className; 这个参数由keep文件中的-keep参数指定,这下相信大家都有点明白,但是又有些混乱,因为代码的跳跃实在是太大了。先不急,我们来看下 NamedClassVisitor 里面的classVisitor 参数,它是一个ClassAccessFilter 类，它的作用是对于可被设置的方法进行内部的visitor访问,ClassAccessFilter 的visitor参数是在
ClassSpecificationVisitorFactory.createCombinedClassVisitor中生成的,
其中调用了createClassPoolVisitor 方法中的
ClassVisitor classVisitor, MemberVisitor memberVisitor
这两个参数实现类就是KeepMarker keepMarker = new KeepMarker();
这个类。绕了半天我们又绕了回来。我们慮一下这个思路,
我们的目的是为了输出seed文件。而这个文件的输出跟proguard配置中的keep参数有直接的关系，在Proguard进行初始化操作的时 候,会对对应的类中设置访问对象信息VisitInfo,这是通过KeepMaker访问者来标记的,打印的时候将判断是否含有这个标记对象做为是否打印 的依据。
