目录
前言
为了尽可能减小应用的大小，在发布 build 中启用缩减功能来移除不使用的代码和资源。启用缩减功能后，会受益于两项功能。 一项是混淆处理功能，该功能会缩短应用的类和成员的名称；另一项是优化功能，该功能会采用更积极的策略来进一步减小应用的大小。
使用 Android Gradle 插件 3.4.0 或更高版本构建项目时，该插件不再使用 ProGuard 执行编译时代码优化，而是与 R8 编译器协同工作，处理以下编译时任务：
- 代码缩减（即摇树优化）：从应用及其库依赖项中检测并安全地移除不使用的类、字段、方法和属性（这使其成为了一个对于规避 64k 引用限制 非常有用的工具）。例如，如果您仅使用某个库依赖项的少数几个 API，那么缩减功能可以识别应用不使用的库代码并仅从应用中移除这部分代码。如需了解详情，请转到介绍如何缩减代码的部分。
- 资源缩减：从封装应用中移除不使用的资源，包括应用库依赖项中不使用的资源。此功能可与代码缩减功能结合使用，这样一来，移除不使用的代码后，也可以安全地移除不再引用的所有资源。如需了解详情，请转到介绍如何缩减资源的部分。
- 混淆：缩短类和成员的名称，从而减小 DEX 文件的大小。如需了解详情，请转到介绍如何对代码进行混淆处理的部分。
- 优化：检查并重写代码，以进一步减小应用的 DEX 文件的大小。例如，如果 R8 检测到从未采用过给定 if/else 语句的
else {}分支，则会移除else {}分支的代码。如需了解详情，请转到介绍代码优化的部分。
默认情况下，在构建应用的发布版本时，R8 会自动执行上述编译时任务。不过，您也可以停用某些任务或通过 ProGuard 规则文件自定义 R8 的行为。事实上，R8 支持所有现有 ProGuard 规则文件，因此您在更新 Android Gradle 插件以使用 R8 时，无需更改现有规则。
启用压缩、混淆和优化功能
使用 Android Studio 3.4 或 Android Gradle 插件 3.4.0 及更高版本时，R8 是默认编译器，用于将项目的 Java 字节码转换为在 Android 平台上运行的 DEX 格式。不过，当您使用 Android Studio 创建新项目时，缩减、混淆处理和代码优化功能默认处于停用状态。这是因为，这些编译时优化功能会增加项目的构建时间，而且如果您没有充分自定义要保留的代码，还可能会引入错误。因此，在构建应用的最终版本（也就是在发布应用之前测试的版本）时，最好启用这些编译时任务。如需启用缩减、混淆处理和优化功能，请在项目级 build.gradle 文件中添加以下代码。
android {
buildTypes {
getByName("release") {
// Enables code shrinking, obfuscation, and optimization for only
// your project's release build type.
minifyEnabled = true
// Enables resource shrinking, which is performed by the
// Android Gradle plugin.
shrinkResources = true
// Includes the default ProGuard rules files that are packaged with
// the Android Gradle plugin. To learn more, go to the section about
// R8 configuration files.
proguardFiles(
getDefaultProguardFile("proguard-android-optimize.txt")),
"proguard-rules.pro"
)
}
}
...
}Proguard 混淆规则
混淆的原则如下：
- 反射用到的类不混淆
- JNI方法不混淆
- AndroidMainfest中的类不混淆，四大组件和Application的子类和Framework层下所有的类默认不会进行混淆
- Parcelable的子类和Creator静态成员变量不混淆，否则会产生android.os.BadParcelableException异常
- 使用GSON、fastjson等框架时，所写的JSON对象类不混淆，否则无法将JSON解析成对应的对象
- 使用第三方开源库或者引用其他第三方的SDK包时，需要在混淆文件中加入对应的混淆规则
- 有用到WebView的JS调用时，也需要保证写的接口方法不混淆
Keep命令简介
| 命令 | 作用 |
|---|---|
| -keep | 保持类和类成员，防止被移除或者被重命名 |
| -keepnames | 保持类和类成员，防止被重命名 |
| -keepclassmembers | 保持类成员，防止被移除或者被重命名 |
| -keepclassmembernames | 保持类成员，防止被重命名 |
| -keepclasseswithmembers | 保持拥有该成员的类和成员，防止被移除或者被重命名 |
| -keepclasseswithmembernames | 保持拥有该成员的类和成员，防止被重命名 |
保持元素不参与混淆的规则的命令格式：[保持命令] [类] { [成员] }
相关语法：
- 通配符
*，匹配任意长度字符，但不含包名分隔符(.) - 通配符
**，匹配任意长度字符，并且包含包名分隔符(.) …，匹配任意长度的任意类型参数。比如void test(…)就能匹配任意 void test(String a) 或者是 void test(int a, String b) 这些方法。extends，即可以指定类的基类implement，匹配实现了某接口的类$，内部类 “成员”代表类成员相关的限定条件，它将定位到某些符合该限定条件的类成员。它的内容可以使用：<init>匹配所有构造器<fields>匹配所有域<methods>匹配所有方法
基本指令
- -ignorewarning：是否忽略警告
- -optimizationpasses n：指定代码的压缩级别(在0~7之间，默认为5)
- -dontusemixedcaseclassnames：是否使用大小写混合(windows大小写不敏感，建议加入)
- -dontskipnonpubliclibraryclasses：是否混淆非公共的库的类
- -dontskipnonpubliclibraryclassmembers：是否混淆非公共的库的类的成员
- -dontpreverify：混淆时是否做预校验(Android不需要预校验，去掉可以加快混淆速度)
- -verbose：混淆时是否记录日志(混淆后会生成映射文件)
- -obfuscationdictionary dictionary_path：指定外部模糊字典
- -classobfuscationdictionary dictionary_path：指定class模糊字典
- -packageobfuscationdictionary dictionary_path：指定package模糊字典
- -optimizations !code/simplification/arithmetic,!field/,!class/merging/,!code/allocation/variable：混淆时所采用的算法(谷歌推荐算法)
- -libraryjars libs(*.jar;):添加支持的jar(引入libs下的所有jar包)
- -renamesourcefileattribute SourceFile：将文件来源重命名为“SourceFile”字符串
- -keepattributes Annotation：保持注解不被混淆
- -keep class * extends java.lang.annotation.Annotation {*;}：保持注解不被混淆
- -keep interface * extends java.lang.annotation.Annotation { *; }：保持注解不被混淆
- -keepattributes Signature：保持泛型不被混淆
- -keepattributes EnclosingMethod：保持反射不被混淆
- -keepattributes Exceptions：保持异常不被混淆
- -keepattributes InnerClasses：保持内部类不被混淆
- -keepattributes SourceFile,LineNumberTable：抛出异常时保留代码行号
保留选项
- -keep [,modifier，...] class_specification：指定需要保留的类和类成员（作为公共类库，应该保留所有可公开访问的public方法）
- -keepclassmembers [,modifier，...] class_specification：指定需要保留的类成员:变量或者方法
- -keepclasseswithmembers [,modifier，...] class_specification：指定保留的类和类成员，条件是所指定的类成员都存在（既在压缩阶段没有被删除的成员，效果和keep差不多）
- -keepnames class_specification:指定要保留名称的类和类成员，前提是在压缩阶段未被删除，仅用于模糊处理。[-keep allowshrinking class_specification 的简写]
- -keepclassmembernames class_specification：指定要保留名称的类成员，前提是在压缩阶段未被删除，仅用于模糊处理。[-keepclassmembers allowshrinking class_specification 的简写]
- -keepclasseswithmembernames class_specification：指定要保留名称的类成员，前提是在压缩阶段后所指定的类成员都存在，仅用于模糊处理。[-keepclasseswithmembers allowshrinking class_specification 的简写]
- -printseeds [filename]：指定详尽列出由各种-keep选项匹配的类和类成员。列表打印到标准输出或给定文件。 该列表可用于验证是否真的找到了预期的类成员，特别是如果您使用通配符。
CodeLab:
- 不混淆某个包所有的类
-keep class com.android.example.** { *; } - 不混淆某个类
-keep public class com.android.example.Test { *; } - 不混淆某个类的子类
-keep public class * extends com.android.example.Test { *; } - 不混淆某个接口的实现
-keep class * implements com.android.example.Interface { *; } - 不混淆某个类的构造方法
-keepclassmembers class com.android.example.Test { public <init>(); } - 不混淆某个类的特定的方法
-keepclassmembers class com.android.example.Test { public void test(java.lang.String); } - 不混淆某个类的内部类
-keep class com.android.example.Test$* { *; }
项目通用模板~混肴规则如下：
#基本指令区
-ignorewarning # 是否忽略警告
-optimizationpasses 5 # 指定代码的压缩级别(0~7之间，默认为5)
-dontusemixedcaseclassnames # 是否使用大小写混合(windows大小写不敏感，建议加入)
-dontskipnonpubliclibraryclasses # 是否混淆非公共的库的类
-dontskipnonpubliclibraryclassmembers # 是否混淆非公共的库的类的成员
-dontpreverify # 混淆时是否做预校验(Android不需要预校验，去掉可以加快混淆速度)
-verbose # 混淆时是否记录日志(混淆后会生成映射文件)
#指定外部模糊字典
-obfuscationdictionary dictionary1.txt
#指定class模糊字典
-classobfuscationdictionary dictionary1.txt
#指定package模糊字典
-packageobfuscationdictionary dictionary2.txt
# 混淆时所采用的算法(谷歌推荐算法)
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 添加支持的jar(引入libs下的所有jar包)
-libraryjars libs(*.jar;)
# 将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
# 保持注解不被混淆
-keepattributes *Annotation*
-keep class * extends java.lang.annotation.Annotation {*;}
# 保持泛型不被混淆
-keepattributes Signature
# 保持反射不被混淆
-keepattributes EnclosingMethod
# 保持异常不被混淆
-keepattributes Exceptions
# 保持内部类不被混淆
-keepattributes Exceptions,InnerClasses
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
# 默认保留区#
# 保持基本组件不被混淆
-keep public class * extends android.app.Fragment
-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
# 保持 Google 原生服务需要的类不被混淆
-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
# Support包规则
-dontwarn android.support.**
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**
# 保持 native 方法不被混淆
-keepclasseswithmembernames class * {
native <methods>;
}
# 保留自定义控件(继承自View)不被混淆
-keep public class * extends android.view.View {
public <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
public void set*(***);
*** get*();
}
# 保留指定格式的构造方法不被混淆
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
# 保留在Activity中的方法参数是view的方法(避免布局文件里面onClick被影响)
-keepclassmembers class * extends android.app.Activity {
public void *(android.view.View);
}
# 保持枚举 enum 类不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# 保持R(资源)下的所有类及其方法不能被混淆
-keep class **.R$* { *; }
# 保持 Parcelable 序列化的类不被混淆(注：aidl文件不能去混淆)
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
# 需要序列化和反序列化的类不能被混淆(注：Java反射用到的类也不能被混淆)
-keepnames class * implements java.io.Serializable
# 保持 Serializable 序列化的类成员不被混淆
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient <fields>;
!private <fields>;
!private <methods>;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
# 保持 BaseAdapter 类不被混淆
-keep public class * extends android.widget.BaseAdapter { *; }
# 保持 CusorAdapter 类不被混淆
-keep public class * extends android.widget.CusorAdapter{ *; }
# webView相关，项目中没有使用到webView忽略即可
# 保持Android与JavaScript进行交互的类不被混淆
-keep class **.AndroidJavaScript { *; }
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView,java.lang.String,android.graphics.Bitmap);
public boolean *(android.webkit.WebView,java.lang.String);
}
-keepclassmembers class * extends android.webkit.WebChromeClient {
public void *(android.webkit.WebView,java.lang.String);
}
# 网络请求相关
-keep public class android.net.http.SslError
# 删除代码区 #
# 删除代码中Log相关的代码
-assumenosideeffects class android.util.Log {
public static boolean isLoggable(java.lang.String, int);
public static int v(...);
public static int i(...);
public static int w(...);
public static int d(...);
public static int e(...);
}
# ====================》项目定制化：
#1.实体类
#2.webview与JS交互的类
#3.反射相关的类和方法
#4.第三方依赖
1042
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
