了解ProGuard-Android代码混淆

古城微笑少年丶 2022-06-01 05:55 271阅读 0赞

ProGuard

最近小师傅让我学习了解一下Android中的代码混淆，混淆是啥啊？？我这个嘴啊立马就问出来了 小师傅解释说：我们apk其实可以看作一个压缩包，你改一个后缀名解压缩之后里面的资源文件，配置以及源代码都可以完全呈现，混淆之后会把一些类和方法的名字改变，就很难追踪了，就是不想自己的代码被破解，增加别人反编译的难度，android中的混淆规则写在proguard-rules.pro中，有一些特定的命令规则，我听的云里雾里的，特定规则是什么？混淆又是怎么做的？不敢问了不敢问了，自己查资料吧。所以自己上guardsquare的官网去看了看（也算是一遍翻译一边总结）。

目标收获：了解ProGuard是什么，有自己的理解能够给别人讲清楚，以及和AndroidStudio的联系，以及能熟悉一遍相关语法吧。

一.ProGuard简介

guardsquare官网有这样一句话—

A complete Android application

The standard build processes of the Android SDK (with Ant, Gradle, Android Studio and Eclipse) already integrate ProGuard with all the proper settings.

一个完整的Android应用程序

Android SDK的标准构建过程（包括Ant，Gradle，Android Studio和Eclipse）已经将ProGuard与所有正确的设置集成在一起。

注意：已经将ProGuard与所有正确的设置集成在一起。

那就有这样的疑问：ProGuard是什么？为什么要用这个东西，他有什么作用？什么算正确的设置？

一个一个问题解决

*  ProGuard是什么
    
    ProGuard是一个java字节码的开源优化器，他拥有四个部分，Java类文件收缩器，优化器，混淆器和预校验器。通过这四个步骤，它可以删除无用的类、字段、方法和属性。可以删除没用的注释，最大限度地优化字节码文件。它还可以使用简短的无意义的名称来重命名已经存在的类、字段、方法和属性。常常用于Android开发用于混淆最终的项目，增加项目被反编译的难度。

原来不仅仅可以混淆代码防止反编译，它还可以优化我们的代码 所以这四个步骤肯定各自有各自的的作用

*  ProGuard的作用  
    最终目标：ProGuard减少了Android应用程序的下载和启动时间，并提高了它们在移动设备上的性能。  
    
    
    1.  Java类文件收缩器(shrink)：这一步进行的压缩步骤，从入口点开始递归的确定使用哪些类和类成员，其他的没有被用到的类和类成员就被丢弃
    2.  优化器(optimize)：进行的优化步骤，ProGuard会进一步优化代码，这一步属于在字节码级别的性能优化，可以将不是入口点的类和方法变成私有的静态的或最终的（在可能的情况下为类添加static和final修饰符，在可能的情况下为方法添加private, static和final修饰符）未使用的参数可以移除，并且可以内联一些方法（在可能的情况下使get/set方法成为内联的）
    3.  混淆器(obfuscate) : 在混淆步骤中，ProGuard会重命名不是入口点的类和类成员，比如使用a，b，c，d这样简短而无意义的名称，对类、字段和方法进行重命名。在这整个过程中，保持入口点确保他们仍然可以通过他们原来的名字被访问。
    4.  预校验器( preverify)：在Java平台上对处理后的代码进行预检，确保加载的class文件是可执行的。这个步骤是不必知道入口点的唯一步骤

![这里写图片描述][SouthEast]

图：来自官网的工作流程图

上面四个步骤中三个都提到了入口点（Entry Point），那么什么是入口点呢？

入口点是在ProGuard过程中不会被处理的类或方法。在压缩的步骤中，ProGuard会从入口点开始递归遍历，搜索哪些类和类的成员在使用。对于没有被使用的类和类的成员，就会在压缩阶段丢弃。在优化阶段，那些非EntryPoint的类、方法都会被设置为private、static或final，不使用的参数会被移除。在混淆的阶段，ProGuard会对非EntryPoint的类和方法进行重命名。 为了能够确定哪些代码必须被保留以及哪些代码可以被丢弃或模糊处理，就必须指定一个或多个代码入口点 。（ProGuard文件中我们写的保持的那些我感觉就是写的入口点）

*  ProGuard正确的设置

关于设置AndroidStudio以及具备了ProGuard的所有步骤，但是我们要针对制定一些关于自己APP的ProGuard规则，写在proguard-rules.pro 中。比如对以上四个步骤 哪一个执行哪一个不执行的配置，再比如我们要去保留入口点不被混淆。网上有很多关于ProGuard的正确设置模版 那针对一个APP，我们应该从哪些方面去Add project specific ProGuard rules ？？？

那就是第二个大部分 如何写proguard-rules文件

二.编写ProGuard文件

注意：以下内容可能不全是ProGuard的语法，只针对于Android应用开发

四个步骤都可以去配置,先熟悉一遍语法（可以的话可以看英文，后面是我乱七八糟翻译的，可能有出入）

shrink压缩阶段：

\-dontshrink

Specifies not to shrink the input class files. By default, shrinking is applied; all classes and class members are removed, except for the ones listed by the various -keep options, and the ones on which they depend, directly or indirectly. A shrinking step is also applied after each optimization step, since some optimizations may open the possibility to remove more classes and class members.（指定不压缩输入文件，默认情况下，是会执行压缩步骤的。除了-keep相关配置指定的类，所有其它没有被引用到的类都会被删除，在每一次优化步骤执行完之后，也会进行一次压缩操作，因为在优化的时候可能会删除更多的类和类成员）

\-printusage \[filename\]

Specifies to list dead code of the input class files. The list is printed to the standard output or to the given file. For example, you can list the unused code of an application. Only applicable when shrinking.（指定这个文件里是打印那些被删除的类文件，这个列表可能打印到标准输出流或者一个文件中例如你可以指定哪些代码是不使用的，仅仅适用于shrink阶段）

\-whyareyoukeeping class\_specification

Specifies to print details on why the given classes and class members are being kept in the shrinking step. This can be useful if you are wondering why some given element is present in the output. In general, there can be many different reasons. This option prints the shortest chain of methods to a specified seed or entry point, for each specified class and class member. In the current implementation, the shortest chain that is printed out may sometimes contain circular deductions – these do not reflect the actual shrinking process. If the -verbose option if specified, the traces include full field and method signatures. Only applicable when shrinking.（简单来说就是给一个说法为啥这个类特殊被保护了呢？仅适用于压缩阶段）

optimize 优化阶段：

\-dontoptimize

Specifies not to optimize the input class files. By default, optimization is enabled; all methods are optimized at a bytecode level.（指定不优化输入文件，默认情况下优化选项是开启的，并且所有的优化都是在字节码层进行的。）

\-optimizations

Specifies the optimizations to be enabled and disabled, at a more fine-grained level. Only applicable when optimizing. This is an expert option. （专家选项，慎用，就是优化的更加精细的意思吧）

\-optimizationpasses n

Specifies the number of optimization passes to be performed. By default, a single pass is performed. Multiple passes may result in further improvements. If no improvements are found after an optimization pass, the optimization is ended. Only applicable when optimizing.（指定执行几次优化，默认情况下，只执行一次优化。执行多次优化可以提高优化的效果，如果执行过一次优化之后没有效果，就会停止优化，剩下的设置次数不再执行。这个选项只在optimizate阶段有效）

\-assumenosideeffects class\_specification

Specifies methods that don’t have any side effects (other than maybe returning a value). In the optimization step, ProGuard will then remove calls to such methods, if it can determine that the return values aren’t used. ProGuard will analyze your program code to find such methods automatically. It will not analyze library code, for which this option can therefore be useful. For example, you could specify the method System.currentTimeMillis(), so that any idle calls to it will be removed. With some care, you can also use the option to remove logging code. Note that ProGuard applies the option to the entire hierarchy of the specified methods. Only applicable when optimizing. In general, making assumptions can be dangerous; you can easily break the processed code. Only use this option if you know what you’re doing! (指定一些方法是没有任何意义的方法，可能他会有返回值，在优化阶段，如果他的返回值没有被用到ProGuard将会把这个方法删除，proguard会自动的分析你的代码，但不会分析处理类库中的代码。反正谨慎使用)

\-allowaccessmodification

Specifies that the access modifiers of classes and class members may be broadened during processing. This can improve the results of the optimization step. For instance, when inlining a public getter, it may be necessary to make the accessed field public too. Although Java’s binary compatibility specifications formally do not require this (cfr. The Java Language Specification, Third Edition, Section 13.4.6), some virtual machines would have problems with the processed code otherwise. Only applicable when optimizing (and when obfuscating with the -repackageclasses option).Counter-indication:\* you probably shouldn’t use this option when processing code that is to be used as a library, since classes and class members that weren’t designed to be public in the API may become public.( 指定在处理期间可以扩大类和类成员的访问修饰符。这可以改善优化步骤的结果,但是如果你的代码是一个组件库代码的时候，就不要使用这个选项，他可能会将一些私有的部分变为public的)

\-mergeinterfacesaggressively

Specifies that interfaces may be merged, even if their implementing classes don’t implement all interface methods. This can reduce the size of the output by reducing the total number of classes. Note that Java’s binary compatibility specifications allow such constructs (cfr. The Java Language Specification, Third Edition, Section 13.5.3), even if they are not allowed in the Java language (cfr. The Java Language Specification, Third Edition, Section 8.1.4). Only applicable when optimizing.Counter-indication: setting this option can reduce the performance of the processed code on some JVMs, since advanced just-in-time compilation tends to favor more interfaces with fewer implementing classes. Worse, some JVMs may not be able to handle the resulting code. Notably: Sun’s JRE 1.3 may throw an InternalErrorwhen encountering more than 256 Miranda methods (interface methods without implementations) in a class.( 指定一些接口可以被合并即使他的实现类没有实现全部的接口，这可以通过减少类的总数来减少输出文件体积的大小)

obfuscate 混淆阶段

\-dontobfuscate

Specifies not to obfuscate the input class files. By default, obfuscation is applied; classes and class members receive new short random names, except for the ones listed by the various -keep options. Internal attributes that are useful for debugging, such as source files names, variable names, and line numbers are removed.(指定不要混淆输入的类文件。默认情况下，应用混淆。类和类成员会收到新的短随机名称，除了各种-keep选项列出的名称外。对调试有用的内部属性，例如源文件名称，变量名称和行号被删除。)

\-printmapping \[filename\]

Specifies to print the mapping from old names to new names for classes and class members that have been renamed. The mapping is printed to the standard output or to the given file. For example, it is required for subsequent incremental obfuscation, or if you ever want to make sense again of obfuscated stack traces. Only applicable when obfuscating.(指定输出旧名称到已被重命名的类和类成员名称的映射，后续想知道混淆的路径是可以参考的，只在混淆时适用)

\-applymapping filename

Specifies to reuse the given name mapping that was printed out in a previous obfuscation run of ProGuard. Classes and class members that are listed in the mapping file receive the names specified along with them. Classes and class members that are not mentioned receive new names. The mapping may refer to input classes as well as library classes. This option can be useful for incremental obfuscation, i.e. processing add-ons or small patches to an existing piece of code. If the structure of the code changes fundamentally, ProGuard may print out warnings that applying a mapping is causing conflicts. You may be able to reduce this risk by specifying the option -useuniqueclassmembernames in both obfuscation runs. Only a single mapping file is allowed. Only applicable when obfuscating.(指定重用一个已经写好了的map文件作为新旧元素名的映射。元素名已经存在在mapping文件中的元素，按照映射表重命名；没有存在到mapping文件的元素，重新赋一个新的名字，只在混淆时适用)

。。。

还是附上一个链接 相当于语法指南（希望原作者不要介意啊 ）更详细的可以去里面查阅 因为官网是英文的 可能不太好看

初步的了解就看到这里了

等之后再继续完善这部分的内容

[SouthEast]: /images/20220601/d791871954c946e983c0065953516411.png