ProGaurd官方文档学习笔记（一）

柔情只为你懂 2022-07-14 02:14 236阅读 0赞

## ProGaurd官方文档学习笔记（一） ##

#### ProGuard（混淆器） ####

ProGaurd包含了4个步骤：shrinker(压缩),optimizer(优化),obfuscator(混淆)和perverifier(预验证)。

如下图：

![image][]

input jar需要经过shrinker,optimize,obfuscated和preverify四个步骤。

对于library jar，ProGuard使用的library jar的时候会对适当的地方进行重构，一般保持不变，所以一般library jar不需要经过4个步骤。

--------------------

**ProGuard的四个步骤**

*  shrinker(压缩)
    
    ProGuard是从开始的入口开始递归，决定哪些类和类的成员被使用。不关心没有使用的类和成员。(可以过滤没有使用的类及类中的成员变量和方法)
 *  optimize(优化)
    
    深度优化代码，如：修改类和方法的进入权限，public改为private；修改关键字static，final等；没有使用到的参数移除等。
 *  obfuscate(混淆)
    
    对类及类成员使用简单的名字进行重命名。减小代码体积。
 *  preverify(预验证)
    
    保证输出的jar包的安全。

--------------------

**Input/Output Options**

*  \-include filename(也可以写成 @filename)
    
    读取文件中的配置选项
 *  \-basedirectory
    
    读取目录中的文件配置
 *  \-injars class\_path
    
    指定项目中的输入的jars(或者wars,ears,zips,directories)路径，这些jars将处理后输出。
 *  \-outjars class\_path
    
    指定项目中输出的jars路径。注意：输出文件路径不要覆盖出入文件路径。
 *  \-libraryjars class\_path
    
    library jar不会被包含在output jar中，可能提高optimization(优化)的结果。
 *  \-skipnonpubliclibraryclasses
    
    读取library jar时跳过non-public的类。减小ProGuard使用的内存。non-public的类经常没有关联其他类。
 *  \-dontskipnonpubliclibraryclasses
    
    不忽略library中non-public的类。
 *  \-dontskipnonpubliclibraryclassmembers
    
    不忽略library中的类的成员变量和方法。默认是忽略的。
 *  \-keepdirectories \[directory\_filter\]
    
    保存输出jar的目录。默认移除。
 *  \-target version
    
    处理类文件的版本号(java版本号)。
 *  \-for ceprocessing
    
    指定处理输入过程，即使输出的jar是最新的。

--------------------

**Keep Options：**

*  \-keep \[,modifier,…\] *class\_specification*
    
    保护指定的类和类的成员
 *  \-keepclassmembers \[,modifier,…\] *class\_specification*
    
    保护类的成员
 *  \-keepclasseswithmembers \[,modifier,…\] *class\_specification*
    
    保护指定的类和类的成员,条件是所有成员是要存在的。
 *  \-keepnames *class\_specification*
    
    保护指定的类和类的成员名称，如果他们没有在shrinker(压缩)阶段被移除
 *  keepclassmembernames *class\_specification*
    
    保护指定的类成员，如果他们没有在shrinker(压缩)阶段被移除
 *  keepclasswithmembernames *class\_specification*
    
    保护指定的类和类成员，在shrinker(压缩)阶段所有指定的类成员都存在。
 *  printseeds \[*filename*\]
    
    列出类和类的成员-keep选项的清单，标准输出到给定的文件。

--------------------

**Shrinking Options**

*  \-dnotshrink
    
    不压缩指定的输入类文件。默认是开启的。
 *  \-printusage
    
    输出没有使用的代码
 *  \-whyareyoukeeping
    
    打印详细信息，为什么给指定的类和类的成员在shrinker（压缩）步骤中保持不被压缩。

--------------------

**Opitmization Options**

*  \-dnotoptimize
    
    指定输入类文件不优化。默认优化
 *  \-optimizations optimization\_filter
    
    指定什么优化什么不优化。
 *  \-optimizationpasses n
    
    指定要执行优化的数量
 *  \-assumenosideeffects class\_specification
    
    指定没有任何副作用的方法。proguard将移除方法，如果这个方法有返回值，但是没有使用。
 *  \-allowaccessmodification
    
    优化时允许访问并修改有修饰符的类和类的成员
 *  \-mergeinterfacesaggressively
    
    合并接口。不管他们是否有实现类。

--------------------

**Obfuscation Options**

*  \-dontobfuscate
    
    不混淆指定的输入文件。
 *  \-printmapping \[filename\]
    
    指定要将已重命名的类和类成员的旧名称映射到新名称的映射。
 *  \-applymapping filename
    
    重用映射增加混淆
 *  \-obfuscationdictionary filename
    
    指定一个text文件，所有的可用单词被用作混淆的字段名和方法名
 *  \-classobfuscationdictionary filename
    
    指定一个text文件，所有的可用单词被用作混淆的类名
 *  \-packageobfuscationdictionary filename
    
    指定一个text文件，所有的可用单词被用作混淆的包名
 *  \-overloadaggressively
    
    指定混淆重载过多
 *  \-useuniqueclassmembernames
    
    混淆后类成员唯一
 *  \-dontusemixedcaseclassnames
    
    混淆时不会产生形形色色的类名
 *  **-keeppackagenames \[package\_filter\]**
    
    指定包不混淆
 *  \-flattenpackagehierarchy \[package\_name\]
    
    重命名所有包，将他移动到指定父类包中
 *  \-repackageclasses \[package\_name\]
    
    重命名所有包，将他移动到指定包中
 *  \-keepattributes \[attribute\_filter\]
    
    指定保护的属性参数
 *  \-keepparameternames
    
    指定保护参数名和方法类型。
 *  \-renamesourcefileattribute \[string\]
    
    设置源文件中给定的字符串常量
 *  \-adaptclassstrings \[class\_filter\]
    
    指定字符串常数，对应应该混淆的类名
 *  \-adaptresourcefilenames \[file\_filter\]
    
    重命名资源文件，根据混淆名来对应。
 *  \-adaptresourcefilecontents \[file\_filter\]
    
    指定要更新其内容的资源文件

--------------------

**Preverification Options**

*  \-dontpreverify
    
    指定不预先验证处理类文件。
 *  \-microedition

## 指定处理Java Micro Edition的目标类文件 ##

**General Options**

*  \-verbose
    
    指定在处理过程中，写出一些信息。
 *  \-dontnote \[class\_filter\]
    
    指定不打印配置中潜在的错误或遗漏的笔记。
 *  \-dontwarn \[class\_filter\]
    
    指定不警告未解决的问题。
 *  \-ignorewarnings
    
    打印警告信息，但继续往下处理。
 *  \-printconfiguration \[filename\]
    
    指定要写出已经解析的配置，包括文件和替换的变量。
 *  \-dump \[filename\]
    
    指定在任何处理后写出类文件的内部结构

--------------------

#### 使用ProGuard的注意要点 ####

当我们使用混淆时，你应该注意这几个问题：

1.ProGuard优化了算法规则，假定处理的代码永远不会抛出NullPointerExceptions，ArrayIndexOutOfBoundsExceptions， or even OutOfMemoryErrors or StackOverflowErrors。

2.如果input jar和library jar在同一个包包含相同的类，混淆输出可能会覆盖在library jar中同名的类。这个最有可能的是library jar在混淆前可能使用”a”,”b”,”c”作为类名等。所以input jar和library jar应该分开。

3.当混淆时，ProGuard写出类名为a.class,b.class等，如果包中包含太多的类，Proguard可能写出”aux.class”。不巧的是，Windows拒绝创建这个文件，创建其他名字。

--------------------

[ProGuard文档][ProGuard]

[image]: http://p1.bqimg.com/567571/bf3e43ef05df8e49.png
[ProGuard]: https://stuff.mit.edu/afs/sipb/project/android/sdk/android-sdk-linux/tools/proguard/docs/index.html#manual/usage.html