Android Proguard混淆打包经验总结

Posted 2022-11-25 阿蛮家

作为一名android开发，应该了解并尝试给自己的项目进行Proguard混淆打包。项目经过Proguard混淆打包后，会发现apk包体积会变小，也就是混淆可以使得apk瘦身；并且反编译apk的时候会发现， 项目中的源码都被处理过，进一步保障了apk的安全；这就是我所理解的Proguard混淆打包的两个优点。不过，想要真正给自己的项目进行Proguard混淆打包，可不是一件容易的事情，真正尝试去做了，才会发现有好多问题需要去解决，毕竟，混淆打包是针对特定的项目，每个项目需要混淆的代码都是有区别的。不过，所有apk混淆打包，也有一些通用的规则处理，像这些规则，就可以自己记录下来，这样其他项目混淆打包的时候就可以复制粘贴使用混淆代码了。好了，进入正题，如何给自己的项目量身定制一套Proguard混淆代码了？

关于Proguard混淆，给APP瘦身，Google官方也给出了文档给了大致解释，大家有兴趣可以看看，纯英文（够呛），不过怎么在Android Studio配置Proguard混淆，还是可以看懂的：

https://developer.android.com/studio/build/shrink-code.html

我们可以从这些方面对apk瘦身：

1）冗余的代码，比如多余的jar包代码；

2）未使用的静态代码；

3）资源代码的冗余；

4）native code

5）图片资源的优化和压缩

ProGuard混淆打包，解决的问题主要针对第一点，一般项目进行ProGuard混淆打包后，apk的体积会减小200-500KB左右。

一、在Android Studio中配置Proguard混淆

buildTypes 
        release 
            //混淆
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        
    

配置很简单，只需要把minifyEnabled的状态改成true即可，然后，当进行apk打包时，编译工具首先会读取proguar-rules.pro文件。所有混淆规则，即项目的专属混淆配置代码就写在该文件里面。

二、编写ProGuard文件

proguar-rules.pro文件目录位置

1、ProGuard混淆配置文件通用配置

这里形容的通用配置，也就是需要添加一些不需要混淆的代码，比如Android的四大组件的相关代码，自定义View相关代码，项目中引用的第三方jar包相关代码等等；

1）ProGuadr混淆代码属性配置代码

-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontpreverify
-verbose
-dontwarn
-dontskipnonpubliclibraryclassmembers
-ignorewarnings
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*


 -keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,*Annotation*,EnclosingMethod

# 保持 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);



# 泛型与反射
-keepattributes Signature
-keepattributes EnclosingMethod
-keepattributes *Annotation*

以上属性基本配置代码中，配置了ProGuard混淆代码压缩比例等基本属性，配置了本地native方法、泛型与反射、注解、内部类、异常处理等相关代码的混淆配置，保证这些相关的代码不被混淆，基本上所有项目都可以通用。

1）四大组件ProGuard配置代码

-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
-keep public class * extends android.os.IInterface

2)项目中的activity、constants、model、bean等混淆配置

比如我的项目结构如下

针对我的项目配置相关配置代码如下：

-keep class com.example.proguard.model.** *;
-keep class com.example.proguard.activity.** *;
-keep class com.example.proguard.adapter.** *;
-keep class com.example.proguard.constants.***;
-keep class com.example.proguard.base.***;
-keep class com.example.proguard.model.***;
-keep class com.example.proguard.service.***;
-keep class com.example.proguard.weidgt.***;
-keep class com.example.proguard.utils.** *;
-keep class com.example.proguard.network.api** *;

3）第三方jar包混淆配置代码

比如我的项目中涉及到的第三方jar包如下：

compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:23.0.0'
    compile 'com.android.support:design:23.1.1'
    compile 'com.squareup.okhttp3:okhttp:3.2.0'
    compile 'com.squareup.retrofit2:retrofit:2.0.0'
    compile 'com.squareup.retrofit2:converter-gson:2.0.0'
    compile 'com.squareup.retrofit2:adapter-rxjava:2.0.0'
    compile 'com.jakewharton:butterknife:7.0.1'
    compile 'io.reactivex:rxjava:1.1.0'
    compile 'io.reactivex:rxandroid:1.1.0'
    compile 'io.reactivex:rxjava:1.0.10'
    compile 'com.jakewharton.rxbinding:rxbinding:0.4.0'
    compile 'com.jakewharton.rxbinding:rxbinding-appcompat-v7:0.4.0'
    compile 'com.jakewharton.rxbinding:rxbinding-design:0.4.0'
    compile 'com.facebook.fresco:fresco:0.8.1+'
    compile 'com.facebook.fresco:drawee:0.5.0+'
    compile 'com.facebook.fresco:fbcore:0.5.0+'
    compile 'com.facebook.fresco:imagepipeline:0.5.0+'
    compile 'com.google.code.gson:gson:2.7'
    compile 'com.orhanobut:logger:1.8'
    compile 'com.facebook.stetho:stetho:1.3.1'
    compile 'de.greenrobot:greendao:1.3.7'
    //  时间日期选择控件 里面包含nineold动画jar包
    compile 'com.github.flavienlaurent.datetimepicker:library:0.0.2'
    //Android 6.0f权限检查
    compile 'gun0912.ted:tedpermission:1.0.0'

我需要的ProGuard配置代码如下：

#保持第3方jar包不混淆
-keep class com.alibaba.sdk.android.** *;
-keep class com.squareup.okhttp.** *;
-keep class com.squareup.okhttp3.** *;
-keep class com.squareup.retrofit2.** *;
-keep class com.jakewharton.** *;
-keep class io.reactivex.** *;
-keep class rx.** *;
-keep class com.jakewharton.rxbinding.** *;
-keep class com.facebook.** *;
-keep class com.butterknife.** *;
-keep class com.google.code.gson.** *;
-keep class com.orhanobut.** *;
-dontwarn de.greenrobot.daogenerator.**
-keep class de.greenrobot.** *;
-keep class com.github.flavienlaurent.datetimepicker.** *;
-keep class gun0912.ted.** *;

4）针对support4包的配置

-dontwarn android.support.**
-dontwarn android.support.v4.**
-keep class android.support.v4.**  *; 
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v4.app.Fragment

针对supportv7包的配置一样

5）针对butterknife的配置

#####butterknife#######
-keep class butterknife.**  *; 
-dontwarn butterknife.internal.**
-keep class **$$ViewBinder  *; 
-dontwarn butterknife.**
-keepclasseswithmembernames class * 
    @butterknife.* <fields>;

-keepclasseswithmembernames class * 
    @butterknife.* <methods>;

6）针对gson的配置

-keep class com.google.gson.** *;
#-keep class com.google.***;
-keep class sun.misc.Unsafe  *; 
-keep class com.google.gson.stream.**  *; 
-keep class com.google.gson.examples.android.model.**  *; 
-keep class com.google.** 
    <fields>;
    <methods>;

-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();

-dontwarn com.google.gson.**

7）针对greenDao数据库的配置

-keep class de.greenrobot.dao.** *;
#保持greenDao的方法不被混淆 用来保持生成的表名不被混淆
-keepclassmembers class * extends de.greenrobot.dao.AbstractDao 
 public static java.lang.String TABLENAME;

 -keep class **$Properties

8)针对okhttp的配置

# OkHttp
-dontwarn com.squareup.okhttp.**
-keep class com.squareup.okhttp.** *;
-keep interface com.squareup.okhttp.** *;
-dontwarn okio.**

等等，针对某个jar包的具体混淆配置，大家可以去Google，这里我就列举这些了。

至此，针对你项目的专属ProGuard配置文件就出来了，打个正式包看看apk包有没有瘦身吧。

三、ProGuard混淆打包过程的问题

当你配置好项目的ProGuard文件后，打包过程可能就报错了，这些错误需要我们一一去解决，这里列出几个我在打包过程遇到的几个错误及解决方法：

1）java.lang.UnsupportedOperationException: Unknown ASTNode child: LambdaExpression

解决方法：

http://stackoverflow.com/questions/29316332/retrolambda-lint-crashes-when-using-lambda-expressions-with-retrolambda/30536556#30536556

2）如果配置好ProGuard文件后，并且打包也顺利进行，打包成功了，但是当你运行瘦身后的apk，会发现apk会出现崩溃的情况，如果出现这种情况，说明配置的ProGuard文件还有问题，有些地方的代码混淆配置还需要更改，这时候就需要我们定位到具体报错的代码位置了，去发现并定位混淆配置错误的代码。Android Studio在debug模式下运行的程序，是没有经过ProGuard混淆配置的，所以我们没法通过debug模式定位混淆出错的位置。但是我们该如何定位到代码崩溃的代码位置了，解决的方法就是在debug模式下，我们也让程序跑ProGuard文件，进行debug模式下的混淆打包。

buildTypes 
        release 
            //混淆
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        
        debug
            //混淆
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        
    

这样，在debug模式下，就可以定位到程序崩溃或异常的代码了，进而可以查询到混淆配置错误的代码进行修改调整。

好了，以上就是我在项目中配置ProGuard文件的经验总结，希望大家也能针对自己的项目做一份特制的ProGuard文件，让apk瘦身成功。