Android--混淆配置

杨建章

2023-12-01

android studio自带java语言的ProGuard工具，主要用来压缩、优化、混淆，然后配合Gradle构建工具实现混淆。

在app module中统一配置混淆规则
我们可以直接在app module中build.gradle文件配置所有module需要混淆的规则。这样，其他module中就无需开启混淆。
首先在build.gradle 中将混淆的开关打开，即 minifyEnabled 置为 true

buildTypes {
        release {
            minifyEnabled true   //开启混淆
            zipAlignEnabled true  //压缩优化
            shrinkResources true  //移出无用资源
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' //默认的混淆文件以及我们指定的混淆文件
        }
}

如果是model混淆，子模块混淆文件的指定是通过consumerProguardFiles这个属性来指定的，并不是proguardFiles 属性，而且我们无需配置其他的选项，只需要配置consumerProguardFiles属性就可以。该属性表示在打包的时候会自动寻找该module下我们指定的混淆文件对代码进行混淆。配置如下：

buildTypes {
    release {
    //minifyEnabled true //是否开启混淆，其实子模块中这个已经没有作用了，由主模块控制
    consumerProguardFiles 'proguard-rules.pro' //子模块要用这个命令才能生效
}

然后就要去proguard-rules.pro写入我们的混淆的规则（如文件其名），防止重要的类被混淆移除了。

先特别介绍的是与保持相关元素不参与混淆的规则相关的几种命令：
-keep   防止类和成员被移除或者被重命名
-keepnames   防止类和成员被重命名
-keepclassmembers   防止成员被移除或者被重命名
-keepclasseswithmembers   防止拥有该成员的类和成员被移除或者被重命名
-keepclasseswithmembernames   防止拥有该成员的类和成员被重命名

混淆规则：

1、有一些固定的混淆规则不需要更改：
#指定代码的压缩级别
-optimizationpasses 5

#包明不混合大小写
-dontusemixedcaseclassnames

#不去忽略非公共的库类
-dontskipnonpubliclibraryclasses

#优化不优化输入的类文件
-dontoptimize

#预校验
-dontpreverify

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

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

#保护注解
-keepattributes *Annotation*
2、理解通配符
-keep class cn.hadcn.test.**
-keep class cn.hadcn.test.*
很多同学都搞不懂下面两个的区别，一颗星表示只是保持该包下的类名，而子包下的类名还是会被混淆；两颗星表示把本包和所含子包下的类名都保持；用以上方法保持类后，你会发现类名虽然未混淆，但里面的具体方法和变量命名还是变了，这时如果既想保持类名，又想保持里面的内容不被混淆，我们就需要以下方法了：

-keep class cn.hadcn.test.* {*;}
3、保证指定包名下的所有类及子包中所有的类不被混淆
例子1：com.lib.manager 包下面的类不混淆
-keep class com.lib.manager.**{*;}
例子2：v4包下面的所有类不混淆
-keep class android.support.v4.** { *; }
4、保证指定的类不被混淆
例子1：YiBaWiFiActivity 类不被混淆, YiBaWiFiActivity 完整包名：com.yiba.wifi.sdk.lib.activity.YiBaWiFiActivity
-keep class com.yiba.wifi.sdk.lib.activity.YiBaWiFiActivity{*;}
例子2：v4 包下面的 ActivityCompat 类不被混淆
-keep class android.support.v4.app.ActivityCompat{*;}
5、不混淆指定类的子类
-keep class * extends pp.lib.User { *; }
User 类的子类不混淆

6、指定接口不混淆
Callback 是一个接口，完整包名为：com.lib.impl.Callback

-keep interface com.lib.impl.Callback{ * ; }
7、指定接口的实现类不混淆
Callback 是一个接口，完整包名为：com.lib.impl.Callback . 所有的实现类都不会混淆。

-keep class * implements com.lib.impl.Callback { *; }
8、指定类的内部类不混淆
PhoneUtil 的源码如下：

package com.lib.manager;
import android.content.Context;
import android.os.AsyncTask;

/**
* Created by yiba_zyj on 2017/4/5.
*/

public class PhoneUtil {

public final static int APPID = 100 ;

public PhoneUtil( Context context ){

}

class MyTask extends AsyncTask {

@Override
protected Object doInBackground(Object[] params) {
return null;
}
}
}
PhoneUtil 有一个常量、一个构造函数、一个内部类.

混淆规则：

-keep class com.lib.manager.PhoneUtil$* {
* ;
}

9、构造函数不混淆
PhoneUtil 的源码如所示：

package com.lib;

/**
* Created by yiba_zyj on 2017/4/7.
*/

public class PhoneUtil {

public static final String aa = "1222" ;

public void run(){

}

}
混淆规则：PhoneUtil 的无参构造函数不混淆。PhoneUtil 里面没有用到的属性和方法将会被移除。

-keep class com.lib.PhoneUtil {
public <init>();
}
那么有参的构造函数的混淆规则是怎么样的？

混淆规则：PhoneUtil 的参数为 Context 的构造函数不混淆

-keep class com.lib.PhoneUtil {
public <init>( android.content.Context );
}
10、指定类的属性和方法不被混淆
原始类 PhoneUtil 代码如下，完整的包名为：com.lib.manager.PhoneUtil
package com.lib.manager;

import android.content.Context;
import android.util.DisplayMetrics;
import android.view.WindowManager;

/**
* Created by yiba_zyj on 2017/4/5.
*/

public class PhoneUtil {

public static final int AppID = 100 ;

/**
* 获得屏幕高度
* @param context
* @return
*/
public static int getScreenWidth(Context context) {
WindowManager wm = (WindowManager) context
.getSystemService(Context.WINDOW_SERVICE);
DisplayMetrics outMetrics = new DisplayMetrics();
wm.getDefaultDisplay().getMetrics(outMetrics);
return outMetrics.widthPixels;
}

/**
* 获得屏幕宽度
* @param context
* @return
*/
public static int getScreenHeight(Context context) {
WindowManager wm = (WindowManager) context
.getSystemService(Context.WINDOW_SERVICE);
DisplayMetrics outMetrics = new DisplayMetrics();
wm.getDefaultDisplay().getMetrics(outMetrics);
return outMetrics.heightPixels;
}

}
PhoneUtil 类中包含1个常量及2个方法.

类中的变量不被混淆：
-keep class com.lib.manager.PhoneUtil{
public static final int AppID ;
}
混淆后的效果如下：
package com.lib.manager;

public class PhoneUtil {
public static final int AppID = 100;

public PhoneUtil() {
}
}
可以看到混淆后的类中，AppID 常量被保存下来了，getScreenWidth 、 getScreenHeight 这两个方法被移除了。为什么会有方法被移除？因为在混淆时，Android 会默认移除没有使用的的方法和资源，保证apk 合理的被压缩。

保留类中的方法不被混淆
-keep class com.lib.manager.PhoneUtil{
public static int getScreenWidth(android.content.Context);
}
混淆后的方法如下：
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.lib.manager;

import android.content.Context;
import android.util.DisplayMetrics;
import android.view.WindowManager;

public class PhoneUtil {
public PhoneUtil() {
}

public static int getScreenWidth(Context var0) {
WindowManager var1 = (WindowManager)var0.getSystemService("window");
DisplayMetrics var2 = new DisplayMetrics();
var1.getDefaultDisplay().getMetrics(var2);
return var2.widthPixels;
}
}
11、不混淆类中所有的 public 方法
# <methods> 匹配所有的方法

-keep class cn.hadcn.test.One {
public <methods>;
}
表示One类下的所有public方法都不会被混淆

12、不混淆类中所有的 public 字段
-keep class pp.lib.PhoneUtil{
public <fields> ;
}
表示 PhoneUtil 类中所有的 public 属性将保留，其他类型的字段

13、不混淆构造函数

-keep class pp.lib.PhoneUtil{
<init>(***) ;
<init>(*** , *** ) ;
}
不混淆 PhoneUtil 类中所有一个参数和两个参数的的构造函数。

13、不混淆 bean 对象里面的 set 、get 方法
User 对象如下图所示：

package pp.lib;

/**
* Created by ${zhaoyanjun} on 2017/4/10.
*/

public class User {

private String name ;
private String age ;

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public String getAge() {
return age;
}

public void setAge(String age) {
this.age = age;
}
}
混淆规则：不混淆 User 类中所有的 set 和 get 方法，*** 代表通配符

-keep class pp.lib.User{
void set*( *** ) ;
*** get*() ;
}
常见不混淆的类和属性
不混淆四大组件和 Application
因为四大组件和 Application 需要在 AndroidManifest.xml 中注册，不能混淆，否则就会报类找不到异常。

-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
特殊情况：

如果 BroadcastReceiver 是动态注册的，则是可以加入混淆的。

不混淆任何包含native方法的类的类名以及native方法名
-keepclasseswithmembernames class * {
native <methods>;
}
不混淆任何一个View中的setXxx()和getXxx()方法，因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。
-keepclassmembers public class * extends android.view.View {
void set*(***);
*** get*();
}
不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick=”buttonClick”属性，当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了。
-keepclassmembers class * extends android.app.Activity {
public void *(android.view.View);
}
不混淆枚举中的values()和valueOf()方法
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
不混淆Parcelable实现类中的CREATOR字段，毫无疑问，CREATOR字段是绝对不能改变的，包括大小写都不能变，不然整个Parcelable工作机制都会失败。
-keepclassmembers class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator CREATOR;
}
不混淆R文件中的所有静态字段，我们都知道R文件是通过字段来记录每个资源的id的，字段名要是被混淆了，id也就找不着了。
登录后复制
-keepclassmembers class **.R$* {
public static <fields>;
}

附一份配置：

# 指定代码的压缩级别 0 - 7(指定代码进行迭代优化的次数，在Android里面默认是5，这条指令也只有在可以优化时起作用。)
-optimizationpasses 5
# 混淆时不会产生形形色色的类名(混淆时不使用大小写混合类名)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的库类(不跳过library中的非public的类)
-dontskipnonpubliclibraryclasses
# 指定不去忽略包可见的库类的成员
-dontskipnonpubliclibraryclassmembers
#不进行优化，建议使用此选项，
-dontoptimize
 # 不进行预校验,Android不需要,可加快混淆速度。
-dontpreverify
# 屏蔽警告
-ignorewarnings
# 指定混淆是采用的算法，后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法，一般不做更改
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 保护代码中的Annotation不被混淆
-keepattributes *Annotation*
# 避免混淆泛型, 这在JSON实体映射时非常重要
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
 #优化时允许访问并修改有修饰符的类和类的成员，这可以提高优化步骤的结果。
# 比如，当内联一个公共的getter方法时，这也可能需要外地公共访问。
# 虽然java二进制规范不需要这个，要不然有的虚拟机处理这些代码会有问题。当有优化和使用-repackageclasses时才适用。
#指示语：不能用这个指令处理库中的代码，因为有的类和类成员没有设计成public ,而在api中可能变成public
-allowaccessmodification
#当有优化和使用-repackageclasses时才适用。
-repackageclasses ''
 # 混淆时记录日志(打印混淆的详细信息)
 # 这句话能够使我们的项目混淆后产生映射文件
 # 包含有类名->混淆后类名的映射关系
-verbose
# ----------------------------- 默认保留 -----------------------------
# 保持哪些类不被混淆
#继承activity,application,service,broadcastReceiver,contentprovider....不进行混淆
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-keep public class * extends android.support.multidex.MultiDexApplication
-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 class android.support.** {*;}## 保留support下的所有类及其内部类

-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
#表示不混淆上面声明的类，最后这两个类我们基本也用不上，是接入Google原生的一些服务时使用的。
#----------------------------------------------------

# 保留继承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**

#表示不混淆任何包含native方法的类的类名以及native方法名，这个和我们刚才验证的结果是一致
-keepclasseswithmembernames class * {
    native <methods>;
}

#这个主要是在layout 中写的onclick方法android:onclick="onClick"，不进行混淆
#表示不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick=”buttonClick”属性，
#当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

#表示不混淆枚举中的values()和valueOf()方法，枚举我用的非常少，这个就不评论了
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#表示不混淆任何一个View中的setXxx()和getXxx()方法，
#因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。
-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);
}
-keepclasseswithmembers class * {
    public <init>(android.content.Context, android.util.AttributeSet);
    public <init>(android.content.Context, android.util.AttributeSet, int);
}

#表示不混淆Parcelable实现类中的CREATOR字段，
#毫无疑问，CREATOR字段是绝对不能改变的，包括大小写都不能变，不然整个Parcelable工作机制都会失败。
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
# 这指定了继承Serizalizable的类的如下成员不被移除混淆
-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();
}
# 保留R下面的资源
-keep class **.R$* {
 *;
}
#不混淆资源类下static的
-keepclassmembers class **.R$* {
    public static <fields>;
}

# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
    void *(**On*Listener);
}

# 保留我们自定义控件（继承自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);
}
-keep class com.example.odm.garbagesorthelper.widget.** { *; }


#
#----------------------------- WebView(项目中没有可以忽略) -----------------------------
#
#webView需要进行特殊处理

#在app中与HTML5的JavaScript的交互进行特殊处理
#我们需要确保这些js要调用的原生方法不能够被混淆，于是我们需要做如下处理：


#
#---------------------------------实体类---------------------------
#--------(实体Model不能混淆，否则找不到对应的属性获取不到值)-----
#
-keep class com.example.odm.garbagesorthelper.model.entity.** { *; }
-dontwarn  com.example.odm.garbagesorthelper.model.entity.**

#对含有反射类的处理
-keep class com.example.odm.garbagesorthelper.utils.** { *; }

#
# ----------------------------- 其他的 -----------------------------
#
# 删除代码中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(...);
}

# 保持测试相关的代码
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**
#
# ----------------------------- 第三方库、框架、SDK -----------------------------
#logger
-dontwarn com.orhanobut.logger.**
-keep class com.orhanobut.logger.**{*;}
-keep interface com.orhanobut.logger.**{*;}

# Gson
-keep class com.google.gson.stream.** { *; }
-keepattributes EnclosingMethod
-dontwarn com.google.gson.**
-keep class com.google.gson.**{*;}
-keep interface com.google.gson.**{*;}
#gson
#如果用到Gson解析包的，直接添加下面这几行就能成功混淆，不然会报错。

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Prevent proguard from stripping interface information from TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer
# Application classes that will be serialized/deserialized over Gso


# OkHttp3
-dontwarn okhttp3.logging.**
-keep class okhttp3.internal.**{*;}
-dontwarn okio.**

# Retrofit
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
#-keepattributes Signature-keepattributes Exceptions

# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions


# RxJava RxAndroid
-dontwarn sun.misc.**
-keepclassmembers class rx.internal.util.unsafe.*ArrayQueue*Field* {
    long producerIndex;
    long consumerIndex;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueProducerNodeRef {
    rx.internal.util.atomic.LinkedQueueNode producerNode;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueConsumerNodeRef {
    rx.internal.util.atomic.LinkedQueueNode consumerNode;
}

#LiveEventBus
-dontwarn com.jeremyliao.liveeventbus.**
-keep class com.jeremyliao.liveeventbus.** { *; }
-keep class androidx.lifecycle.** { *; }
-keep class androidx.arch.core.** { *; }

#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
  **[] $VALUES;
  public *;
}

#utilcodex
-keep class  com.blankj.utilcode.util.** { *; }

#
-keep class site.gemus.** { *; }

#XUI
-keep class com.xuexiang.xui.** { *; }

#讯飞SDK
-libraryjars libs/Msc.jar
-libraryjars src/main/jniLibs/Msc.jar
-keep class com.iflytek.**{*;}
-keepattributes Signature

#RxPermission
-keep class com.tbruyelle.rxpermissions2.** { *; }

#XBanner
-keep class com.stx.xhb.androidx.XBanner.** { *; }

#Bugly SDK
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
-keep class android.support.**{*;}

Android--混淆配置

相关阅读

相关文章

相关问答

相关文档