继 Android 缩减、混淆处理和优化应用研究(一) 后,这里主要介绍缩减代码
一、缩减代码
如果将 minifyEnabled
属性设为 true
,系统会默认启用 R8 代码缩减功能。
代码缩减是指移除 R8 确定在运行时不需要的代码的过程。此过程可以大大减小应用的大小,例如,当应用包含许多库依赖项,但只使用它们的一小部分功能时。
为了缩减应用的代码,R8 首先会根据组合的配置文件集确定应用代码的入口点( Android 平台可用来打开应用的 Activity 或服务的所有类)。
R8 会从入口点开始,检查应用的代码来构建一张图表,列出应用在运行时可能会访问的所有方法、成员变量和其他类。系统会将与该图表没有关联的代码视为执行不到的代码,并可能会从应用中移除。
图 1 显示了一个具有运行时库依赖项的应用。R8 通过检查应用的代码,确定可以从 MainActivity.class
入口点执行到的 foo()
、faz()
和 bar()
方法。不过,应用从未在运行时使用过 OkayApi.class
类或其 baz()
方法,因此 R8 会在缩减应用时移除该代码。
R8 通过项目的 R8 配置文件中的 -keep
保留规则,指定 R8 在缩减应用时不应舍弃的类。Android Gradle 插件和 AAPT2 会自动生成大多数应用项目(如应用的 Activity、视图和服务)所需的保留规则。
如果需要使用其他保留规则来自定义此默认行为,请查看自定义要保留的代码。
二、自定义要保留的代码
在大多数情况下,如要让 R8 仅移除不使用的代码,使用默认的 ProGuard 规则文件 (proguard-android- optimize.txt
) 就已足够。不过,在某些情况下,R8 很难做出正确判断,因而可能会移除应用实际上需要的代码。下面列举了几个示例,说明它在什么情况下可能会错误地移除代码:
- 当应用通过 Java 原生接口 (JNI) 调用方法时
- 当您的应用在运行时查询代码时(如使用反射)
通过测试应用应该可以发现因错误移除代码而导致的错误,也可以通过生成已移除代码的报告检查移除了哪些代码。
如需修复错误并强制 R8 保留某些代码,请在 ProGuard 规则文件中添加 -keep
代码行。
例如:
-keep public class MyClass
也可以为要保留的代码添加 @Keep
注解。在类上添加 @Keep
可按原样保留整个类。在方法或字段上添加该注释,将使该方法/字段(及其名称)以及类名称保持不变。
注意:
只有在使用 AndroidX 注解库, 即:androidx.annotation, 且您添加 Android Gradle 插件随附的 ProGuard 规则文件时,此注解才可用。
在使用 -keep
选项时,还有许多注意事项;如需详细了解如何自定义规则文件,请参阅 ProGuard 手册。
常用指令:
关闭压缩 -dontshrink 关闭混淆 -dontobfuscate 保持指定包下的类名,不包括子包下的类名 -keep class com.xy.myapp* 保持指定包下的类名,包括子包下的类名 -keep class com.xy.myapp** 保持指定包下的类名以及类里面的内容 -keep class com.xy.myapp.* {*;} 保持所有继承于指定类的类 -keep public class * extends android.app.Activity 如果我们要保留一个类中的内部类不被混淆则需要用$符号,如下例子表示保持MyClass内部类JavaScriptInterface中的所有public内容。 -keepclassmembers class com.xy.myapp.MyClass$JavaScriptInterface { public *; } 保持指定类的所有方法 -keep class com.xy.myapp.MyClass { public <methods>; } 保持指定类的所有字段 -keep class com.xy.myapp.MyClass { public <fields>; } 保持指定类的所有构造器 -keep class com.xy.myapp.MyClass { public <init>; } 保持用指定参数作为形参的方法 -keep class com.xy.myapp.MyClass { public <methods>(java.lang.String); } 类文件除了定义类,字段,方法外,还为它们附加了一些属性,例如注解,异常,行号等,优化操作会删除不必要的属性,使用-keepattributes可以保留指定的属性 -keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod 使指定的类不输出警告信息 -dontwarn com.squareup.okhttp.**
示例:
############################################# # # 基本指令区域(没什么别的需求不需要动) # ############################################# # 代码混淆压缩比,在0~7之间,默认为5,一般不做修改 -optimizationpasses 5 # 混合时不使用大小写混合,混合后的类名为小写 -dontusemixedcaseclassnames # 指定不去忽略非公共库的类 -dontskipnonpubliclibraryclasses # 这句话能够使我们的项目混淆后产生映射文件 # 包含有类名->混淆后类名的映射关系 -verbose # 指定不去忽略非公共库的类成员 -dontskipnonpubliclibraryclassmembers # 不做预校验,preverify是proguard的四个步骤之一,Android不需要preverify,去掉这一步能够加快混淆速度。 -dontpreverify # 保留Annotation不混淆 -keepattributes *Annotation*,InnerClasses # 避免混淆泛型 -keepattributes Signature # 抛出异常时保留代码行号 -keepattributes SourceFile,LineNumberTable # 指定混淆是采用的算法,后面的参数是一个过滤器 # 这个过滤器是谷歌推荐的算法,一般不做更改 -optimizations !code/simplification/cast,!field/*,!class/merging/* ############################################# # # Android开发中一些需要保留的公共部分(没什么别的需求不需要动) # ############################################# # 保留我们使用的四大组件,自定义的Application等等这些类不被混淆 # 因为这些子类都有可能被外部调用 -keep public class * extends android.app.Activity -keep public class * extends android.app.Appliction -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 * extends android.view.View -keep public class com.android.vending.licensing.ILicensingService # 保留support下的所有类及其内部类 -keep class android.support.** {*;} # 保留继承的 -keep public class * extends android.support.v4.** -keep public class * extends android.support.v7.** -keep public class * extends android.support.annotation.** # 保留R下面的资源 -keep class **.R$* {*;} # 保留本地native方法不被混淆 -keepclasseswithmembernames class * { native <methods>; } # 保留在Activity中的方法参数是view的方法, # 这样以来我们在layout中写的onClick就不会被影响 -keepclassmembers class * extends android.app.Activity{ public void *(android.view.View); } # 保留枚举类不被混淆 -keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); } # 保留我们自定义控件(继承自View)不被混淆 -keep public class * extends android.view.View{ *** get*(); void set*(***); public <init>(android.content.Context); public <init>(android.content.Context, android.util.AttributeSet); public <init>(android.content.Context, android.util.AttributeSet, int); } # 保留Parcelable序列化类不被混淆 -keep class * implements android.os.Parcelable { public static final android.os.Parcelable$Creator *; } # 保留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(); } # 对于带有回调函数的onXXEvent、**On*Listener的,不能被混淆 -keepclassmembers class * { void *(**On*Event); void *(**On*Listener); } # webView处理,项目中没有使用到webView忽略即可 #-keepclassmembers class fqcn.of.javascript.interface.for.webview { # public *; #} #-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.webViewClient { # public void *(android.webkit.webView, jav.lang.String); #} # 移除Log类打印各个等级日志的代码,打正式包的时候可以做为禁log使用,这里可以作为禁止log打印的功能使用 # 记得proguard-android.txt中一定不要加-dontoptimize才起作用 # 另外的一种实现方案是通过BuildConfig.DEBUG的变量来控制 #-assumenosideeffects class android.util.Log { # public static int v(...); # public static int i(...); # public static int w(...); # public static int d(...); # public static int e(...); #}
其他的混淆点:
- AndroidManifest.xml引用的四大组件。
- 反射用到的类。
- WebView中JavaScript调用的java接口方法不被混淆。
- Layout文件引用的自定义View。
- 不要混淆第三方库。
- Gson使用到的实体类。因为Gson会反射获取与json同名的字段。