android那些事--混淆语法

初步了解手动混淆配置的规则

手动添加的配置,一般以”-keep”开头,常用的配置命令分别示例如下:
假设android工程中有一个接口和一个类:

package com.ticktick.example;

public interface TestInterface {
    public void test();
}

public class Test {

    private String mTestString;
    private final int mMinValue;
    private final int mMaxValue;

    public Test( int min, int max){
        mMinValue = min;
        mMaxValue = max;
    }

    public int getMinValue() {
        return mMinValue;
    }

    public int getMaxValue() {
        return mMaxValue;
    }

    public void setTestString(String testStr ) {
        mTestString = testStr;
    }
}

1.不混淆某个类的构造函数

例如不混淆Test类的构造函数

-keepcalssmembers clsss com.ticktick.example.Text{
    public <init>(int,int)
}

2.不混淆某个包下所有的类或者指定的类

例如不混淆package com.ticktick.example下的所有的类/接口

#不混淆这个包下的所有的类
-keep class com.ticktick.example.**{*;}

例如不混淆com.ticktick.example.Text类

-keep class com.ticktick.example.Text{*;}

如果希望不混淆某个接口,则把上述命令的class替换为interface即可.

3.不混淆某个类的特定的函数

例如不混淆com.ticktick.example.Test类中的setTestString函数

-keepclassmembers class com.ticktick.example.Test{
    public void setTestString(java.lang.String);
}

4.不混淆某个类的子类,某个接口的实现

例如不混淆com.ticktick.example.Test的子类

-keep public class * extend com.ticktick.example.Test

例如不混淆com.ticktick.example.TestInterface的实现

-keep class * implements com.ticktick.example.TestInterface{
    public static final com.ticktick.example.TestInterface$Creator *;
}

5.注意第三方依赖包

例如添加android-support-v4.jar依赖包

-libraryjars libs/android-support-v4.jar

-dontwarn android.support.v4.**{*;}
-keep class android.support.v4.**{*;}
-keep interface android.support.v4.**{*;}

注意添加dontwarn,因为默认情况下proguard会检查每一个引用是否正确,但是第三方库里往往有些不会用到的类,没有正确引用,所有如果不配置的话,系统会报错.

ProGuard常用语法

枯涩的语法总是避免不了的.上面的小例子对简单的配置进行了一下描述,下面是详细的语法.

保留 keep的配置

• -keep {Modifier(修饰符)}{class_specification(类规范)} 保护指定的类和类的成员

#例如对一个可执行jar包来说,需要保护main的入口类,对一个类库来说需要保护它的所有public元素
-keep public class MyMain{
    public static void main(java.lang.String[]);
}

• -keepclassmembers {Modifier}{class_specification}
  保护指定类的成员,如果此类也受到保护他们会保护的更好

#例如指定继承了Serizalizable的类的如下成员不被混淆,成员属性和方法,非私有的属性非私有的方法.
-keepclassmembers class * implements java.io.Serializable{
    static final long seriaVersionUID;
    !private <fields>;
    !private <methods>;
    private void writeObject(java.io.ObjectOuputStream);
}

• -keepclasseswithmembers{Modifier}{class_specification}保护指定成员的类,根据成员确定一些将要被保护的类

就是说如果一个类含有以下的成员,那么这个类会被保护

#保护含有main方法的类以及这个类的main方法
-keepclasseswithmembers public class * {
    public static void main(java.lang.String[]);
}

• -keepnames {Modifier}{class_specification} 这个是-keep,allowshrinking {Modifier}{class_specification}的简写.意思是说允许压缩操作,如果在压缩过程中没有被删除,那么类名和该类中的成员的名字会被保护
• -keepclassmembernames {Modifier}{class_specification}如果在压缩过程中没有被删除在保护这个类中的成员

• -keepclasseswithmembers {Modifier}{class_specification}如果在压缩过程中该类没有被删除,同样如果该类中有某个成员字段或者方法,那么保护这个类和这个方法.

• －printseeds{filename}将keep的成员输出到文件或者打印到标准输出流.

代码压缩配置 shrinker配置

• -dontshrink 声明不压缩文件.默认情况下,除了-keep相关指定的类,其它所有的没有被引用到的类都会被删除,每次优化(optimizate)操作之后也会执行一次压缩操作,因为每次优化操作可能删除一部分不在需要的类.
• -printusage{filename} 将被删除的元素输出到文件,或者打印到保准输出流
• whyareyoukeeping {class_specification} 打印为什么吗一个类或类的成员被保护,这对检查一个输出文件中的类的结果有帮助.

代码优化配置 optimizate配置

• -dontoptimize 声明不优化的文件.默认情况下,优化选项是开启的,并且所有的优化都是在字节码层进行的.
• -optimizations 更加细粒度的声明优化开启或者关闭.
• -optimizationpasses n 指定执行几次优化,默认情况只执行一次优化,执行多次优化可以提高优化的效果.但是如果执行一次优化之后没有效果,就会停止优化,剩下的设置次数不在执行.

混淆配置 obfuscate配置

• -dontobfuscate 声明不混淆 默认情况下,混淆是开启的.除了keep配置中的类其它的类或者类的成员混淆后会改成随机简短的名字
• printmapping{filename} 指定输出新旧元素名的对照表的文件,可以通过在build.gradle中的配置,进行自动保存.这个在异常追踪的时候非常有用可以参考这个粗暴接触混淆
• -applymapping {filename}指定重用一个已经写好的map文件作为新旧元素名的映射.元素名已经存在的就按照该文件中的配置进行,对于没存在的就重新赋一个新的名字
• obfuscationdictionary {filename}指定一个文本文件用来生成混淆后的名字.默认情况下混淆后的名字一般为a,b,c.通过这个选项配置的字典文件,可以使用一些非英文字符做为类名,成员名,方法名.需要注意的是添加了字典并不会显著提高混淆的效果，只不过是更不利与人类的阅读。正常的编译器会自动处理他们，并且输出出来的jar包也可以轻易的换个字典再重新混淆一次。最有用的做法一般是选择已经在类文件中存在的字符串做字典，这样可以稍微压缩包的体积。

#查找字典文件的格式：一行一个单词，空行忽略，重复忽略
# 这里巧妙地使用java中的关键字作字典，混淆之后的代码更加不利于阅读
#
# This obfuscation dictionary contains reserved Java keywords. They can't
# be used in Java source files, but they can be used in compiled class files.
# Note that this hardly improves the obfuscation. Decent decompilers can
# automatically replace reserved keywords, and the effect can fairly simply be
# undone by obfuscating again with simpler names.
# Usage:
#     java -jar proguard.jar ..... -obfuscationdictionary keywords.txt
#
do
if
for
int
new
try
byte
case
char
else
goto
long
this
void
break
catch
class
const
final
float
short
super
throw
while
double
import
native
public
return
static
switch
throws
boolean
default
extends
finally
package
private
abstract
continue
strictfp
volatile
interface
protected
transient
implements
instanceof
synchronized

• -classobfuscationdictionary {filename}指定一个混淆类名的字典,字典格式与-obfuscationdictionary相同
• -packageobfuscationdictionary {filename}指定一个混淆包名的字段
• -oberloadaggressively 混淆的时候大量使用重载,多个方法名使用同一个混淆名,但是它们的方法签名不同,这可以使包的体积减小一部分也可以加大理解难度.

不过这个配置有一定的限制

Sun的JDK1.2上会报异常
Sun JRE 1.4上重载一些方法之后会导致序列化失败
Sun JRE 1.5上pack200 tool重载一些类之后会报错
java.lang.reflect.Proxy类不能处理重载的方法

• -useuniqueclassmembernames 指定相同的混淆名对应相同的方法名,不同的混淆名对应不同的方法名.如果不设置这个选项,同一个类中将会有很多方法映射到相同的方法名.这项配置会稍微增加输出文件中的代码,但是它能够保证 保存下来的mapping文件能够在随后的增量混淆中继续被遵守,避免重新命名.比如说两个接口拥有同名的方法和相同的签名,如果没有这个配置,在第一次打包混淆之后它们两个方法可能会被赋予不同的混淆名.如果下一次添加代码有一个类同时实现了这两个接口,那么混淆的时候必然会将两个混淆后的方法名统一起来.这样就必须要改混淆文件其中一处的配置,也就不能保证前后两次混淆的mapping文件一致了(如果想用一份mappping文件迭代更新的话,这项配置比较有用).
• －dontusemixedcaseclassnames 指定在混淆的时候不使用大小写混用的类名.默认情况下混淆后的类名可能同时包含大写字母和小写字母.这样的jar并没有什么问题,只有在大小写不敏感的window系统上解压时,才会涉及问题.因为大小写不区分,可能会导致部分文件在解压的时候相互覆盖.
• -keeppackagenames{package_filter} 声明不混淆指定的包名,配置的过滤器是逗号隔开的一组包名.包名可以包含? *通配符,并且可以在前面加!否定符
• -flatternpackagenames{packagename} 所有重命名的包都重新打包,并把所有的类移动到packagename包下面.如果没有指定packagename或者packagename为”“,那么所有的类都会被移动到根目录下.
• -repackageclasses{package_name} 所有重新命名类都重新打包,并把它们移动到指定的packagename目录下.这项配置会覆盖-flatternpackagehierarchy的配置.他可以使代码体积更小,并且更加难以理解.

需要注意的是如果需要从目录中读取资源文件,移动包的位置可能会导致异常.如果出现这个问题,就不要用这个配置了.

• -keepattributes{attribute_filter} 指定受保护的属性.可以有一个或者多个该配置项,每个配置后面跟随的是java虚拟机和proguard支持的attribute(具体支持的属性先看这里),两个属性之间用逗号分隔.属性名可以使用通配符,或者! 将某个属性排除在外.当混淆一个类库的时候至少要保持InnerClasses,Exceptions,Signature属性.为了跟踪异常信息,需要把SourceFile,LineNumberTable两个属性保留.如果代码中有用到注解,需要Annotion属性.

#可以分开写
-keepattributes SourceFile, LineNumberTable
-keepattributes *Annotation*
-keepattributes EnclosingMethod
# 可以直接写在一行
-keepattributes Exceptions, InnerClasses, Signature, Deprecated,
                SourceFile, LineNumberTable, *Annotation*, EnclosingMethod

• -keepparameternames 指定被保护的方法的参数类型和参数名不被混淆.这项配置在混淆一些类库的时候特别有用,因为根据IDE提示的参数名和参数类型,开发者可以根据语意获得一些信息.
• -adaptclassstrings{classfilter}指定字符串常量如果与类名相同,也需要被混淆.如果没有加classfilter,所有的符合要求的字符串常量都会被混淆;如果带classfilter,只有在匹配的类中的字符串常量才会受此影响.例如在你的代码中有大量的类名对应的字符串的hard-code,并且不想保留它们的本名,那就可以利用哦这项配置来完成.
• -adaptresourcefileanmes{file_filter} 如果资源文件与某类同名,那么混淆后资源文件被命名为与之对应的类的混淆名.不加file_filter的情况下,所有资源文件都受此影响,加了file_filter的情况只有匹配的类才受此类的影响.
• －adaptresourcefilecontents{file_filter}指定资源文件的中的类名随混淆后的名字更新.根据被混淆的名字的前后映射关系,更新文件中对应的包名和类名.

普通配置

• -berbose 声明在处理过程中输出更多信息,添加这项配置之后,如果处理过程中出现异常,会输出整个StackTrace而不是一条简单的异常说明.
• -dontwarn {class_filter}声明不输出那些未找到的引用和一些错误,继续混淆.配置中的class_filter是一串正则表达式.

通配符匹配规则

?      匹配单个字符
*      匹配类名中的任何部分,但不包含额外的包名
**    匹配类名中的任何部分,并且可以包含额外的包名
%    匹配任何基础类型的类型名
...    匹配认识数量 任意类型的参数
<init>   匹配任何构造器
<ifield>  匹配任何字段名
*(当用在类内部时)   匹配任何字段和方法
$     指内部类