第2章 ProGuard基础

课程目录第2章 ProGuard基础

ProGuard基础：工作原理、配置文件结构、开启混淆的步骤

各位同学好，我是你们的Android安全讲师。今天我们来聊聊ProGuard——这个在Android混淆加固领域绕不开的基础工具。

说实话，我刚开始接触ProGuard的时候，觉得它就是个黑盒子。配置一下，跑一下，APK变小了，代码看不懂了，完事。但后来在一次线上事故中，因为混淆导致反射调用失败，App直接崩溃——嗯，从那以后，我才真正沉下心来研究它的工作原理。

这一章，我们就从原理到实践，把ProGuard彻底讲透。

一、ProGuard是什么？

ProGuard是一个Java字节码的优化工具。它主要做四件事：

压缩（Shrink）：检测并移除未使用的类、字段、方法和属性
优化（Optimize）：分析并优化字节码，比如移除无用参数、内联短方法
混淆（Obfuscate）：将类名、方法名、字段名重命名为无意义的短名称
预校验（Preverify）：为Java 6及以上版本添加预校验信息

说白了，ProGuard就是给你的APK做一次「瘦身+加密」的预处理。我个人的习惯是，每次发布正式版之前，都会先跑一遍ProGuard看看效果。

二、ProGuard的工作原理

ProGuard的工作流程其实不复杂。它读取你的输入（jar包、class文件），然后按照你给的规则，一步步处理，最后输出处理后的结果。

核心流程：

读取输入：加载所有待处理的字节码文件
压缩：构建类之间的依赖关系图，标记哪些类、方法、字段是「可达」的，不可达的直接删除
优化：对保留的代码做进一步优化，比如合并重复代码、移除日志
混淆：将保留的类名、方法名替换成a、b、c这样的短名称
输出：生成混淆后的jar或APK

这里有个关键点：ProGuard是基于「入口点」来判断哪些代码需要保留的。你想想看，如果你的代码没有被任何入口引用，那它大概率就是死代码，直接删掉没问题。

下面这张图可以帮你更直观地理解整个流程：

三、配置文件结构

ProGuard的配置文件通常叫proguard-rules.pro，放在项目的app/目录下。它的语法其实很直观，我给大家拆解一下核心部分。

3.1 基本结构

一个典型的ProGuard配置文件包含以下几类规则：

规则类型	作用	示例
`-keep`	保留指定的类和成员，不混淆、不压缩	`-keep class com.example.MyClass`
`-keepclassmembers`	保留指定类的成员（字段、方法）	`-keepclassmembers class * { public *; }`
`-dontwarn`	忽略指定类的警告	`-dontwarn com.example.**`
`-keepattributes`	保留指定的属性，如注解、签名	`-keepattributes Annotation`
`-assumenosideeffects`	假设某些方法没有副作用，可移除	`-assumenosideeffects class android.util.Log { ... }`

小技巧：我个人习惯在配置文件的顶部先写一个「全局保留」规则，把那些肯定不能混淆的类先保住。比如：

-keep class com.google.gson.** { *; }
-keep class com.yourpackage.BuildConfig { *; }

这样后面写规则的时候就不用担心误伤这些基础库了。

3.2 通配符的使用

ProGuard支持几种通配符，用好了能省不少事：

**：匹配任意包名和类名（包括子包）
*：匹配任意类名，但不匹配包名
?：匹配单个字符
*（在方法参数中）：匹配任意类型

举个例子：

// 保留com.example包下所有类
-keep class com.example.** { *; }

// 保留所有实现了Serializable接口的类
-keep class * implements java.io.Serializable { *; }

// 保留所有类的native方法
-keepclasseswithmembernames class * {
    native <methods>;
}

四、开启混淆的步骤

在Android项目中开启ProGuard，其实就三步。我当年第一次配置的时候，就是照着这三步来的，一次成功。

步骤1：修改build.gradle

在app/build.gradle中，找到buildTypes配置，开启minifyEnabled：

android {
    buildTypes {
        release {
            minifyEnabled true  // 开启混淆
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'),
                    'proguard-rules.pro'
        }
        debug {
            minifyEnabled false  // debug模式通常不开
        }
    }
}

这里要注意，getDefaultProguardFile('proguard-android-optimize.txt')是Android SDK自带的默认规则，它会帮你处理一些通用的混淆问题。而proguard-rules.pro是你自己写的自定义规则。

步骤2：编写自定义规则

在proguard-rules.pro中，你需要根据项目情况添加规则。我建议至少包含以下几类：

保留所有Activity、Service、Receiver等组件：因为它们在AndroidManifest中声明了
保留所有View的子类：因为布局文件中会引用
保留所有枚举：枚举混淆后容易出问题
保留所有注解：很多框架依赖注解
保留第三方库的入口：比如Gson、Retrofit等

// 保留四大组件
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider

// 保留View子类
-keep public class * extends android.view.View {
    public <init>(android.content.Context);
    public <init>(android.content.Context, android.util.AttributeSet);
}

// 保留枚举
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

// 保留注解
-keepattributes *Annotation*

// 保留Gson用到的类
-keep class com.google.gson.** { *; }
-keepattributes Signature

注意：我曾经遇到过一个坑——混淆后某个第三方SDK的反射调用失败了，导致整个功能不可用。排查了半天，发现是忘了加-keep规则。所以，如果你用了任何依赖反射的库（比如Gson、EventBus、Retrofit），一定要仔细阅读它们的混淆文档，把对应的规则加进去。

步骤3：构建并验证

配置完成后，执行./gradlew assembleRelease构建正式版APK。构建完成后，建议做两件事：

检查mapping文件：混淆后的映射文件在build/outputs/mapping/release/mapping.txt，里面记录了原始名称和混淆后名称的对应关系。这个文件要妥善保存，否则线上出问题你连堆栈都看不懂。
测试功能：安装混淆后的APK，跑一遍核心功能。我个人的习惯是写一个自动化测试脚本，专门用来验证混淆后的App是否正常。

五、常见问题与避坑指南

问题1：混淆后App崩溃，提示ClassNotFoundException

这通常是因为某个类被混淆了，但其他地方通过反射调用了它。解决方案：找到那个类，加上-keep规则。

问题2：混淆后布局文件中的View找不到

如果你在布局文件中使用了自定义View，记得保留它的构造方法。规则如下：

-keepclassmembers class * extends android.view.View {
    public <init>(android.content.Context);
    public <init>(android.content.Context, android.util.AttributeSet);
}

问题3：混淆后日志输出异常

如果你用了-assumenosideeffects移除了Log，但发现某些地方日志还在，那可能是规则写错了。检查一下通配符是否匹配到了所有Log调用。

我的经验：刚开始做混淆的时候，别追求「极致混淆」。先把所有能保留的都保留，然后逐步收紧规则。每收紧一次，就做一次完整的功能测试。这样即使出了问题，也能快速定位到是哪条规则导致的。

六、总结

ProGuard是Android混淆的基石。它的工作原理说白了就是「保留该保留的，干掉该干掉的」。配置文件的结构也不复杂，核心就是-keep、-dontwarn、-keepattributes这几条。开启混淆的步骤更是简单——改build.gradle、写规则、构建验证。

但简单归简单，实际项目中踩坑的案例比比皆是。我建议你从一个小项目开始练手，把ProGuard的每一条规则都试一遍，看看加了和没加有什么区别。这样你才能真正理解它。

好了，这一章就到这里。下一章我们会深入DexGuard，看看它比ProGuard多了哪些「黑科技」。

公众号:蓝海资料掘金营，微信deep3321

📚 课程目录

ProGuard基础：工作原理、配置文件结构、开启混淆的步骤

一、ProGuard是什么？

二、ProGuard的工作原理

三、配置文件结构

3.1 基本结构

3.2 通配符的使用

四、开启混淆的步骤

步骤1：修改build.gradle

步骤2：编写自定义规则

步骤3：构建并验证

五、常见问题与避坑指南

六、总结