Android代码混淆干货

作者: appzy | 来源:发表于2017-09-20 17:38 被阅读278次
    • 混淆代码能有效防止被反编译,防止自己的劳动成果被别人窃取;
    • ProGuard是一个开源的Java代码混淆器。它可以混淆Android项目里面的java代码,对的,你没看错,仅仅是java代码。它是无法混淆Native代码,资源文件drawable、xml等。

    ProGuard作用

    • 压缩: 移除无效的类、属性、方法等
    • 优化: 优化字节码,并删除未使用的结构
    • 混淆: 将类名、属性名、方法名混淆为难以读懂的字母,比如a,b,c

    混淆注意事项

    1.不能被混淆

    • 在AndroidManifest中配置的类,比如四大组件
    • JNI调用的方法
    • 反射用到的类
    • WebView中JavaScript调用的方法
    • Layout文件引用到的自定义View
    • 一些引入的第三方库(一般都会有混淆说明的)

    这里推荐两个开源项目,里面收集了一些第三方库的混淆规则

    混淆之后常遇到的问题,类名会变成a,b,c这种,通过包名+类名自然就会找不到该类了,自然就会出现ClassNotFoundException异常。
    这里推荐一篇文章:

    2.Log处理

    我们都知道,使用Log的时候,需要用到TAG,然而TAG我们一般都会写成:

    private static final String TAG = MainActivity.class.getSimpleName()
    

    这时候MainActivity如何被混淆的话,log输出信息就会变成V/a:xxxxxxx,所以为了让log输出信息维持原状,可以将TAG处理成固定的字符串:

    private static final String TAG = "MainActivity"
    

    关于Log处理,推荐一篇文章:https://www.zybuluo.com/shark0017/note/163330

    3. Crash信息处理

    代码混淆的时候记得加上在混淆文件里面记得加上这句:

    # keep住源文件以及行号 
    -keepattributes SourceFile,LineNumberTable
    

    这里推荐bugly的一篇文章:http://dev.qq.com/topic/5901b310a1643ba670813363

    ProGuard使用

    保留

    • -keep {Modifier} {class_specification} 保护指定的类文件和类的成员
    • -keepclassmembers {modifier} {class_specification} 保护指定类的成员,如果此类受到保护他们会保护的更好
    • -keepclasseswithmembers {class_specification} 保护指定的类和类的成员,但条件是所有指定的类和类成员是要存在。
    • -keepnames {class_specification} 保护指定的类和类的成员的名称(如果他们不会压缩步骤中删除)
    • -keepclassmembernames {class_specification} 保护指定的类的成员的名称(如果他们不会压缩步骤中删除)
    • -keepclasseswithmembernames {class_specification} 保护指定的类和类的成员的名称,如果所有指定的类成员出席(在压缩步骤之后)
    • -printseeds {filename} 列出类和类的成员-keep选项的清单,标准输出到给定的文件

    压缩

    • -dontshrink 不压缩输入的类文件
    • -printusage {filename}
    • -whyareyoukeeping {class_specification

    优化

    • -dontoptimize 不优化输入的类文件
    • -assumenosideeffects {class_specification} 优化时假设指定的方法,没有任何副作用
    • -allowaccessmodification 优化时允许访问并修改有修饰符的类和类的成员

    混淆

    • -dontobfuscate 不混淆输入的类文件
    • -obfuscationdictionary {filename} 使用给定文件中的关键字作为要混淆方法的名称
    • -overloadaggressively 混淆时应用侵入式重载
    • -useuniqueclassmembernames 确定统一的混淆类的成员名称来增加混淆
    • -flattenpackagehierarchy {package_name} 重新包装所有重命名的包并放在给定的单一包中
    • -repackageclass {package_name} 重新包装所有重命名的类文件中放在给定的单一包中
    • -dontusemixedcaseclassnames 混淆时不会产生形形色色的类名
    • -keepattributes {attribute_name,…} 保护给定的可选属性,例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.
    • -renamesourcefileattribute {string} 设置源文件中给定的字符串常量
    通配符 规则
    匹配单个字符
    * 匹配类名中的任何部分,但不包含额外的包名
    ** 匹配类名中的任何部分,并且可以包含额外的包名
    % 匹配任何基础类型的类型名
    * 匹配任意类型名 ,包含基础类型/非基础类型
    ... 匹配任意数量、任意类型的参数
    <init> 匹配任何构造器
    <ifield> 匹配任何字段名
    <imethod> 匹配任何方法
    *(当用在类内部时) 匹配任何字段和方法
    $ 指内部类

    Android Studio中使用方法

    按照上面的语法规则编写proguard-rules.pro后,需要在build.gradle中配置,需要混淆的时候,设置minifyEnabled为true即可

    buildTypes {
        debug {
            minifyEnabled false //关闭混淆
        }
        release {
            signingConfig signingConfigs.release
            minifyEnabled true //开启混淆
            proguardFiles 'proguard-rules.pro'
        }
    }
    

    ProGuard的输出文件说明

    混淆后,会在/build/proguard/目录下输出下面的文件

    • dump.txt 描述apk文件中所有类文件间的内部结构。
    • mapping.txt 列出了原始的类,方法,和字段名与混淆后代码之间的映射。
    • seeds.txt 列出了未被混淆的类和成员
    • usage.txt 列出了从apk中删除的代码
    • 当我们需要处理crash log的时候,就可以通过mapping.txt的映射关系找到对应的类,方法,字段等。方法如下:
    sdk\tools\proguard\bin 目录下有个retrace工具可以将混淆后的报错堆栈解码成正常的类名
    window下为retrace.bat,linux和mac为retrace.sh,
    

    使用方法如下:

    • 将crash log保存为yourfilename.txt
    • 拿到版本发布时生成的mapping.txt
    • 执行命令retrace.bat -verbose mapping.txt yourfilename.txt

    所以我们每次打包版本都需要保存最新的mapping.txt文件。如果要使用到第三方的crash统计平台,比如bugly,还需要我们上传APP版本对应的mapping.txt.每次都要保存最新的mapping文件,那不就很麻烦?放心,gradle会帮到你,只需要在bulid.gradle加入下面的一句。每次我们编译的时候,都会自动帮你保存mapping文件到本地的。

    android {
    applicationVariants.all { variant ->
            variant.outputs.each { output ->
                if (variant.getBuildType().isMinifyEnabled()) {
                    variant.assemble.doLast{
                            copy {
                                from variant.mappingFile
                                into "${projectDir}/mappings"
                                rename { String fileName ->
                                    "mapping-${variant.name}.txt"
                                }
                            }
                    }
                }
            }
            ......
        }
    }
    

    最后奉上近期项目中常用的混淆代码

    #下面是常见的proguard.cfg配置项
    #指定代码的压缩级别
    -optimizationpasses 5
    #包名不混合大小写
    -dontusemixedcaseclassnames
    #不去忽略非公共的库类
    -dontskipnonpubliclibraryclasses
    # 指定不去忽略非公共的库的类的成员
    -dontskipnonpubliclibraryclassmembers
    #优化  不优化输入的类文件
    -dontoptimize
    #预校验
    -dontpreverify
    #混淆时是否记录日志
    -verbose
    # 混淆时所采用的算法
    -optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
    #保护注解
    -keepattributes *Annotation*
    #忽略警告
    -ignorewarning
    #包明不混合大小写
    -dontusemixedcaseclassnames
    ##记录生成的日志数据,gradle build时在本项目根目录输出##
    #apk 包内所有 class 的内部结构
    -dump class_files.txt
    #未混淆的类和成员-printseeds seeds.txt
    #列出从 apk 中删除的代码
    -printusage unused.txt
    #混淆前后的映射-printmapping mapping.txt
    #========================gson & protobuf================================
    -dontwarn com.google.**
    -keep class com.google.gson.jsms.annotations.Until {*;}
    #如果用到Gson解析包的,直接添加下面这几行就能成功混淆,不然会报错
    #gson
    #-libraryjars libs/gson-2.2.4.jar
    -keepattributes Signature
    # Gson specific classes
    -keep class sun.misc.Unsafe { *; }
    # Application classes that will be serialized/deserialized over Gson
    -keep class com.google.gson.examples.android.model.** { *; }
    # -------------系统类不需要混淆 --------------------------
    -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.preference.Preference
    -keep public class * extends android.support.**
    #如果有引用v4包可以添加下面这行
    -keep public class * extends android.support.v4.app.Fragment
    # 保留R下面的资源
    -keep class **.R$* {*;}
    #保持 native 方法不被混淆
    -keepclasseswithmembernames class * {
      native <methods>;
    }
    #保持自定义控件类不被混淆
    -keepclasseswithmembers class * {
      public <init>(android.content.Context, android.util.AttributeSet);
    }
    -keepclassmembers class * {
          public void *ButtonClicked(android.view.View);
    }
    #保持自定义控件类不被混淆
    -keepclassmembers class * extends android.app.Activity {
      public void *(android.view.View);
    }
    ##########JS接口类不混淆,否则执行不了
    -dontwarn com.android.JsInterface.**
    -keep class com.android.JsInterface.** {*; }
    -dontwarn org.apache.**
    -keep class org.apache.**{ *; }
    # Glide 保护
    -keep public class * implements com.bumptech.glide.module.GlideModule
    -keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
    **[] $VALUES;
    public *;
    }
    #不混淆资源类
    -keepclassmembers class **.R$* {
          public static <fields>;
    }
    # 泛型与反射
    -keepattributes Signature
    -keepattributes EnclosingMethod
    -keepattributes *Annotation*
    
    ######混淆保护自己项目的部分代码以及引用的第三方jar包library########
    #如果引用了v4或者v7包
    -dontwarn android.support.**
    #做v7包的混淆配置
    -dontwarn android.support.**
    -dontwarn android.support.v7.**
    -keep class android.support.v7.** { *; }
    -keep public class * extends android.support.v7.**
    -keep public class * extends android.support.v7.app.Fragment
    -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
    #Gson
    -keepattributes Signature
    -keepattributes *Annotation*
    -keep class sun.misc.Unsafe { *; }
    -keep class com.google.gson.stream.** { *; }
    # Application classes that will be serialized/deserialized over Gson
    -keep class com.sunloto.shandong.bean.** { *; }
    # Jackson
    -dontwarn org.codehaus.jackson.**
    -dontwarn com.fasterxml.jackson.databind.**
    -keep class org.codehaus.jackson.** { *;}
    -keep class com.fasterxml.jackson.** { *; }
    
    #客户端代码中的JavaBean(实体类)的类名与其字段名称全部变成了a、b、c、d等等字符串,这与服务端返回的json字符串中的不一致,导致解析失败。所以,解决的办法是:在进行混淆编译进行打包apk的时候,过滤掉存放所有JavaBean(实体类)的包不进行混淆编译
    -keep class com.android.model.** {*;}
    
    #保持第3方jar包不混淆
    -keep class io.reactivex.** {*;}
    -keep class com.hjhrq1991.library.** {*;}
    -dontwarn com.hjhrq1991.library.**
    -keep class com.github.** {*;}
    -keep class com.mcxiaoke.volley.** {*;}
    -keep class com.tencent.stat.** {*;}
    #universalimageloader图片加载框架不混淆
    -keep class com.nostra13.universalimageloader.** { *; }
    -dontwarn com.nostra13.universalimageloader.**
    -keep class cz.msebera.** {*;}
    -dontwarn cz.msebera.**
    -keep class com.jngis.**{*;}
    -dontwarn com.jngis.**
    -keep class com.map.**{*;}
    -dontwarn com.map.**
    -keep class org.kymjs.kjframe.**{*;}
    -dontwarn org.kymjs.kjframe.**
    -keep class org.json.**{*;}
    -keep class com.google.gson.**{*;}
    -keep class com.loopj.android.http.**{*;}
    -dontwarn com.loopj.android.http.**
    -keep class com.google.zxing.**{*;}
    ################xutils##################
    #-libraryjars libs/xUtils-2.6.14.jar
    -keep class com.lidroid.xutils.** { *; }
    -keep public class * extends com.lidroid.xutils.**
    -keepattributes Signature
    -keepattributes *Annotation*
    -keep public interface com.lidroid.xutils.** {*;}
    -dontwarn com.lidroid.xutils.**
    -keepclasseswithmembers class com.jph.android.entity.** {
        <fields>;
        <methods>;
    }
    #极光推送
    -dontoptimize
    -dontpreverify
    -dontwarn cn.jpush.**
    -keep class cn.jpush.** { *; }
    # 高德相关依赖
    # 集合包:3D地图3.3.2 导航1.8.0 定位2.5.0
    -dontwarn com.amap.api.**
    -dontwarn com.autonavi.**
    -keep class com.amap.api.**{*;}
    -keep class com.autonavi.**{*;}
    # 地图服务
    -dontwarn com.amap.api.services.**
    -keep class com.map.api.services.** {*;}
    # 3D地图
    -dontwarn com.amap.api.mapcore.**
    -dontwarn com.amap.api.maps.**
    -dontwarn com.autonavi.amap.mapcore.**
    -keep class com.amap.api.mapcore.**{*;}
    -keep class com.amap.api.maps.**{*;}
    -keep class com.autonavi.amap.mapcore.**{*;}
    # 定位
    -dontwarn com.amap.api.location.**
    -dontwarn com.aps.**
    -keep class com.amap.api.location.**{*;}
    -keep class com.aps.**{*;}
    # 导航
    -dontwarn com.amap.api.navi.**
    -dontwarn com.autonavi.**
    -keep class com.amap.api.navi.** {*;}
    -keep class com.autonavi.** {*;}
    
    #保持 Serializable 不被混淆
    -keepnames class * implements java.io.Serializable
    #保持 Serializable 不被混淆并且enum 类也不被混淆
    -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();
    }
    #避免混淆泛型 如果混淆报错建议关掉
    -keepattributes Signature
    #移除Log类打印各个等级日志的代码,打正式包的时候可以做为禁log使用,这里可以作为禁止log打印的功能使用,另外的一种实现方案是通过BuildConfig.DEBUG的变量来控制
    -assumenosideeffects class android.util.Log {
        public static *** v(...);
        public static *** i(...);
       public static *** d(...);
        public static *** w(...);
        public static *** e(...);
    }
    # 讯飞语音
    -dontwarn com.iflytek.**
    -keep class com.iflytek.** {*;}
    # 对于带有回调函数的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);
    }
    #其他
    # 源文件和行号的信息不混淆
    -keepattributes SourceFile,LineNumberTable
    
    # 保留枚举类不被混淆
    -keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
    }
    # 抛出异常时保留代码行号
    -keepattributes SourceFile,LineNumberTable
    # 不做预校验,preverify是proguard的四个步骤之一,Android不需要preverify,去掉这一步能够加快混淆速度。
    -dontpreverify
    -dontwarn  com.iflytek.sunflower.**
    -keep class  com.iflytek.sunflower.** { *; }
    # 保留Parcelable序列化类不被混淆
    -keep class * implements android.os.Parcelable {
    public static final android.os.Parcelable$Creator *;
    }
    #-dontwarn javax.annotation.**
    #-dontwarn javax.inject.**
    # OkHttp3
    -dontwarn com.squareup.okhttp.**
    -keep class com.squareup.okhttp.** { *;}
    -dontwarn okio.**
    
    #友盟分享
     -dontusemixedcaseclassnames
        -dontshrink
        -dontoptimize
        -dontwarn com.google.android.maps.**
        -dontwarn android.webkit.WebView
        -dontwarn com.umeng.**
        -dontwarn com.tencent.weibo.sdk.**
        -dontwarn com.facebook.**
        -keep public class javax.**
        -keep public class android.webkit.**
        -dontwarn android.support.v4.**
        -keep enum com.facebook.**
        -keepattributes Exceptions,InnerClasses,Signature
        -keepattributes *Annotation*
        -keepattributes SourceFile,LineNumberTable
        -keep public interface com.facebook.**
        -keep public interface com.tencent.**
        -keep public interface com.umeng.socialize.**
        -keep public interface com.umeng.socialize.sensor.**
        -keep public interface com.umeng.scrshot.**
        -keep class com.android.dingtalk.share.ddsharemodule.** { *; }
        -keep public class com.umeng.socialize.* {*;}
        -keep class com.facebook.**
        -keep class com.facebook.** { *; }
        -keep class com.umeng.scrshot.**
        -keep public class com.tencent.** {*;}
        -keep class com.umeng.socialize.sensor.**
        -keep class com.umeng.socialize.handler.**
        -keep class com.umeng.socialize.handler.*
        -keep class com.umeng.weixin.handler.**
        -keep class com.umeng.weixin.handler.*
        -keep class com.umeng.qq.handler.**
        -keep class com.umeng.qq.handler.*
        -keep class UMMoreHandler{*;}
        -keep class com.tencent.mm.sdk.modelmsg.WXMediaMessage {*;}
        -keep class com.tencent.mm.sdk.modelmsg.** implements   com.tencent.mm.sdk.modelmsg.WXMediaMessage$IMediaObject {*;}
        -keep class im.yixin.sdk.api.YXMessage {*;}
        -keep class im.yixin.sdk.api.** implements im.yixin.sdk.api.YXMessage$YXMessageData{*;}
        -keep class com.tencent.mm.sdk.** {
         *;
        }
        -keep class com.tencent.mm.opensdk.** {
       *;
        }
        -dontwarn twitter4j.**
        -keep class twitter4j.** { *; }
        -keep class com.tencent.** {*;}
        -dontwarn com.tencent.**
        -keep public class com.umeng.com.umeng.soexample.R$*{
        public static final int *;
        }
        -keep public class com.linkedin.android.mobilesdk.R$*{
        public static final int *;
            }
        -keepclassmembers enum * {
        public static **[] values();
        public static ** valueOf(java.lang.String);
        }
        -keep class com.tencent.open.TDialog$*
        -keep class com.tencent.open.TDialog$* {*;}
        -keep class com.tencent.open.PKDialog
        -keep class com.tencent.open.PKDialog {*;}
        -keep class com.tencent.open.PKDialog$*
        -keep class com.tencent.open.PKDialog$* {*;}
        -keep class com.sina.** {*;}
        -dontwarn com.sina.**
        -keep class  com.alipay.share.sdk.** {
           *;
        }
        -keepnames class * implements android.os.Parcelable {
        public static final ** CREATOR;
        }
        -keep class com.linkedin.** { *; }
        -keepattributes Signature
    

    原文: Android代码混淆干货
    作者: appzy

    相关文章

      网友评论

      本文标题:Android代码混淆干货

      本文链接:https://www.haomeiwen.com/subject/ykiosxtx.html