如何开启/关闭代码混淆:
# 在对应模块的build.gradle中的buildTypes下的release下添加:
#proguard-rules.pro就是我们需要添加混淆规则的文件
minifyEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
关闭混淆的话,需要把 minifyEnabled 改为false,并且把 shrinkResources true移除。
混淆常用配置的作用:
-verbose 他的作用是混淆时记录日志,通常会在 build/outputs/mapping/release下生成如下6个相关文件:
他们的作用分别是:
1. mapping.txt :这是一个文本文件,其中包含混淆前后的类和成员名称之间的映射关系。每一行记录了一个映射,通常包括混淆前的名称和混淆后的名称,例如:
com.example.MyClass -> a.a.a:
void myMethod() -> a()
2. usage.txt :这个文件包含了ProGuard分析过程中的类和成员的使用信息。它记录了哪些类和成员被引用了,以及它们是如何被引用的。这个文件对于优化混淆配置非常有用,可以帮助开发者去除未使用的代码。
3. seeds.txt :这个文件包含了ProGuard保留的类和成员的列表。在混淆过程中,有些类和成员可能需要被保留不被混淆,以确保应用的功能正常运行。这个文件列出了这些需要保留的类和成员。
4. missing_rules.txt :文件的存在是为了提醒开发者在混淆配置中添加适当的保留规则,以确保这些类或成员不会被错误地混淆或删除。开发者可以根据这个文件中列出的警告信息,手动更新混淆配置,以解决潜在的问题并确保应用的正常运行。
5. resources.txt : 的存在主要是为了帮助 ProGuard 在混淆处理时保留对资源文件的引用,避免意外删除或混淆这些资源文件,从而导致应用在运行时出现问题。
6. configuration.txt :as自动生成的,对通用混淆配置的建议。我们可以参考。
我们可以指定文件生成的路径,防止clean后日志丢失:
#混淆时记录日志
-verbose
-printmapping proguardLog/mapping.txt
-printseeds proguardLog/seeds.txt
-printusage proguardLog/usage.txt
-dontwarn 用于告诉ProGuard在混淆过程中不要发出警告。这个指令通常用于防止ProGuard在处理某些类或方法时产生不必要的警告信息。防止无效警告、简化输出信息。
-dontwarn org.bouncycastle.jsse.BCSSLParameters
-dontwarn org.bouncycastle.jsse.BCSSLSocket
-dontwarn org.bouncycastle.jsse.provider.BouncyCastleJsseProvider
-dontwarn org.conscrypt.Conscrypt$Version
-dontwarn org.conscrypt.Conscrypt
-dontwarn org.conscrypt.ConscryptHostnameVerifier
-dontwarn org.openjsse.javax.net.ssl.SSLParameters
-dontwarn org.openjsse.javax.net.ssl.SSLSocket
-dontwarn org.openjsse.net.ssl.OpenJSSE
-dontnote 可以帮助你在混淆过程中过滤掉某些类型的笔记信息,使输出日志更加清晰和易于理解。
其实混淆规则大部分用默认的就好,即configuration.txt 中和missing_rules.txt 中建议的配置就好,算是通用配置。其他像第三方依赖、room数据库这些我们其实都可以不用配混淆规则,因为一般做的好的第三方依赖都会在自己的库中带上混淆。我们没有必要再粘贴一遍了。这样可以保持我们的混淆文件始终干净整洁。
然后像我们需要额外配置规则的一般是涉及到序列化\反序列化的类,即bean、各种实体类等(为了方便,我们应将项目中用到的所有bean归类到一个或几个公用的文件夹中)。比如:
# 保留bean下的类都不被混淆
-keep class com.xxx.xxx.beans.** { *; }
还有就是如果项目中用到了EventBus的话,需要为Subscribe加上混淆规则。因为EventBus的Subscribe对方法有要求,即必须是public修饰符修饰的,不然会报错。所以,我们应在混淆文件中加上:
# 保留 EventBus 的订阅方法,非常必要
-keepclassmembers class * {
@org.greenrobot.eventbus.Subscribe <methods>;
}
proguard-rules.pro文件完整配置如下:(基本有这个配置就差不多了,其他根据项目中实际遇到的问题再加。)
# 固定写法(通用配置),configuration.txt
-optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
-optimizationpasses 5
-allowaccessmodification
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-verbose
# Preserve some attributes that may be required for reflection.
-keepattributes AnnotationDefault,
EnclosingMethod,
InnerClasses,
RuntimeVisibleAnnotations,
RuntimeVisibleParameterAnnotations,
RuntimeVisibleTypeAnnotations,
Signature
-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
-keep public class com.google.android.vending.licensing.ILicensingService
-dontnote com.android.vending.licensing.ILicensingService
-dontnote com.google.vending.licensing.ILicensingService
-dontnote com.google.android.vending.licensing.ILicensingService
# For native methods, see http://proguard.sourceforge.net/manual/examples.html#native
-keepclasseswithmembernames,includedescriptorclasses class * {
native <methods>;
}
# Keep setters in Views so that animations can still work.
-keepclassmembers public class * extends android.view.View {
void set*(***);
*** get*();
}
# We want to keep methods in Activity that could be used in the XML attribute onClick.
-keepclassmembers class * extends android.app.Activity {
public void *(android.view.View);
}
# For enumeration classes, see http://proguard.sourceforge.net/manual/examples.html#enumerations
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
-keepclassmembers class * implements android.os.Parcelable {
public static final ** CREATOR;
}
# Preserve annotated Javascript interface methods.
-keepclassmembers class * {
@android.webkit.JavascriptInterface <methods>;
}
# The support libraries contains references to newer platform versions.
# Don't warn about those in case this app is linking against an older
# platform version. We know about them, and they are safe.
-dontnote android.support.**
-dontnote androidx.**
-dontwarn android.support.**
-dontwarn androidx.**
# This class is deprecated, but remains for backward compatibility.
-dontwarn android.util.FloatMath
# Understand the @Keep support annotation.
-keep class android.support.annotation.Keep
-keep class androidx.annotation.Keep
-keep @android.support.annotation.Keep class * {*;}
-keep @androidx.annotation.Keep class * {*;}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <methods>;
}
-keepclasseswithmembers class * {
@androidx.annotation.Keep <methods>;
}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <fields>;
}
-keepclasseswithmembers class * {
@androidx.annotation.Keep <fields>;
}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <init>(...);
}
-keepclasseswithmembers class * {
@androidx.annotation.Keep <init>(...);
}
# These classes are duplicated between android.jar and org.apache.http.legacy.jar.
-dontnote org.apache.http.**
-dontnote android.net.http.**
# These classes are duplicated between android.jar and core-lambda-stubs.jar.
-dontnote java.lang.invoke.**
# 添加missing_rules.txt中的配置
-dontwarn org.bouncycastle.jsse.BCSSLParameters
-dontwarn org.bouncycastle.jsse.BCSSLSocket
-dontwarn org.bouncycastle.jsse.provider.BouncyCastleJsseProvider
-dontwarn org.conscrypt.Conscrypt$Version
-dontwarn org.conscrypt.Conscrypt
-dontwarn org.conscrypt.ConscryptHostnameVerifier
-dontwarn org.openjsse.javax.net.ssl.SSLParameters
-dontwarn org.openjsse.javax.net.ssl.SSLSocket
-dontwarn org.openjsse.net.ssl.OpenJSSE
#==下面才是跟应用相关的混淆配置=================================================================================================
#混淆时记录日志
-printmapping proguardLog/mapping.txt
-printseeds proguardLog/seeds.txt
-printusage proguardLog/usage.txt
# 保留bean下的类都不被混淆
-keep class com.***.*.beans.** { *; }
# 保留 EventBus 的订阅方法,非常必要
-keepclassmembers class * {
@org.greenrobot.eventbus.Subscribe <methods>;
}