深入理解 Android 混淆规则

在 Android 开发中，混淆（Obfuscation）是一种保护代码安全的重要手段，通常通过 ProGuard 或 R8 工具来实现。本文将详细介绍 Android 混淆规则的基本原理、配置方法以及最佳实践，帮助开发者更好地保护应用代码。

博主博客

https://blog.uso6.com
https://blog.csdn.net/dxk539687357

什么是混淆？

混淆是一种通过对代码进行重命名、删除无用代码等操作，来降低代码可读性和反编译风险的技术。在 Android 开发中，ProGuard 和 R8 是最常用的混淆工具。两者均可通过缩小代码体积、优化性能来提升应用的整体表现，同时保护应用逻辑。

ProGuard 与 R8 的区别

ProGuard：一个独立的代码混淆工具，主要作用是对代码进行优化、缩小和混淆。
R8：Google 开发的替代工具，默认集成在 Android Gradle Plugin 中，相比 ProGuard 提供更高效的混淆和优化。

混淆规则基础

混淆规则文件通常以 proguard-rules.pro 命名，位于项目的 app 模块下。常见的规则包括：

-keep：指定需要保留的类、方法或字段，防止被混淆。
-dontwarn：忽略指定类或包的警告。
-optimizations：启用特定的优化选项。
-dontoptimize：禁用所有优化。

常见的混淆规则示例

# 保留所有公有类和方法
-keep public class * {
    public *;
}

# 忽略特定包的警告
-dontwarn com.example.unusedpackage.**

# 保留带有特定注解的类
-keep @interface com.example.MyAnnotation

# 保留继承特定父类的所有子类
-keep class * extends com.example.BaseClass

# 保留类名和方法名，但不保护方法的内部实现
-keepclassmembers class com.example.MyClass {
    public <methods>;
}

# 如果想保持特定方法名不混淆
-keepclassmembers class com.example.MyClass {
    public void myMethod(...);
}

# 指定代码的压缩级别
-optimizationpasses 5

# 是否使用大小写混合
-dontusemixedcaseclassnames

# 混淆时是否做预校验
-dontpreverify

# 混淆时是否记录日志
-verbose

# 混淆时所采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

# 保持哪些类不被混淆
-keep public class * extends android.app.Activity

# 保持哪些类不被混淆
-keep public class * extends android.app.Application

# 保持哪些类不被混淆
-keep public class * extends android.app.Service

# 保持哪些类不被混淆
-keep public class * extends android.content.BroadcastReceiver

# 保持哪些类不被混淆
-keep public class * extends android.content.ContentProvider

# 保持哪些类不被混淆
-keep public class * extends android.app.backup.BackupAgentHelper

# 保持哪些类不被混淆
-keep public class * extends android.preference.Preference

# 保持哪些类不被混淆
-keep public class com.android.vending.licensing.ILicensingService

# 保持 native 方法不被混淆
-keepclasseswithmembernames class * {
   native <methods>;
}

# 保持自定义控件类不被混淆
-keepclasseswithmembers class * {
   public <init>(android.content.Context, android.util.AttributeSet);
}

# 保持自定义控件类不被混淆
-keepclasseswithmembers class * { 
   public <init>(android.content.Context, android.util.AttributeSet, int); 
}

# 保持自定义控件类不被混淆
-keepclassmembers class * extends android.app.Activity {
   public void *(android.view.View);
}

# 保持枚举 enum 类不被混淆
-keepclassmembers enum * {
   public static **[] values(); 
   public static ** valueOf(java.lang.String);
}

# 保持 Parcelable 不被混淆
-keep class * implements android.os.Parcelable {
   public static final android.os.Parcelable$Creator *;
}

# Explicitly preserve all serialization members. The Serializable interface
# is only a marker interface, so it wouldn't save them.
# 显式保留所有序列化成员。可序列化接口只是一个标记接口，因此不会保存它们。
-keep public class * implements java.io.Serializable {*;}
-keepclassmembers class * implements java.io.Serializable {    
   static final long serialVersionUID;    
   private static final java.io.ObjectStreamField[]   serialPersistentFields;    
   private void writeObject(java.io.ObjectOutputStream);    
   private void readObject(java.io.ObjectInputStream);    
   java.lang.Object writeReplace();   
   java.lang.Object readResolve();
}

-keepclassmembers class * {   
   public <init> (org.json.JSONObject);
}

# com.example 是你的包名
-keep public class com.example.R$*{
   public static final int *;
}

配置混淆规则

在 Android 项目中启用混淆只需以下几步：

确认使用的构建工具版本：确保使用的 Gradle Plugin 支持混淆（通常 R8 默认启用）。
配置 build.gradle 文件：

buildTypes {
    release {
        buildConfigField "boolean", "LOG_DEBUG", "false" // 不显示log 
        zipAlignEnabled true     // Zipalign优化 
        shrinkResources true    // 移除无用的resource文件
        minifyEnabled true // 启用代码混淆
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

编辑 proguard-rules.pro 文件：添加适合项目的混淆规则。

混淆规则的最佳实践

测试和调试：
在开发阶段开启混淆规则进行测试。
使用 mapping.txt 文件排查混淆导致的问题。
保护重要类和方法：
保留必要的反射调用，防止运行时崩溃。
对需要与外部交互的接口、API 保留清晰的命名。
使用默认配置：
Android 提供了默认的优化规则文件（如 proguard-android-optimize.txt）。
在此基础上根据项目需求进行扩展。
定期更新工具：
使用最新版本的 Gradle Plugin 和混淆工具，获取最新的性能优化和安全保护。