Android开发之ProGuard技术

本文主要参考了《App研发录》一书,有需求的朋友可以查阅此书了解更多内容。

ProGuard简介

ProGuard一共包括以下4个功能,其中每个功能都是可选的,我们可以通过配置脚本来决定执行其中的哪几个功能,ProGuard的执行流程如下图。

  • 压缩(Shrink):侦测并移除代码中无用的类、字段、方法和属性。
  • 优化(Optimize):对字节码进行优化,移除无用的指令。
  • 混淆(Obfuscate):使用a、b、c、d这样简短而无意义的名称,对类、字段和方法进行重命名。
  • 预检(Preveirfy):在Java平台上对处理后的代码进行预检。

在这里插入图片描述

ProGuard的混淆规则

以下是混淆最基本的配置信息,任何app都需要使用,可以作为模板使用

1.基本指令

  # 代码混淆压缩比,在07之间,默认为5,一般不需要改
    -optimizationpasses 5

 # 混淆时不使用大小写混合,混淆后的类名为小写,Windows操作系统必须加这一条,因为Windows系统对大小写不敏感
   -dontusemixedcaseclassnames

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

# 指定不去忽略非公共的库的类的成员
-dontskipnonpubliclibraryclassmembers

# 不做预校验,preverify是proguard的4个步骤之一
# Android不需要preverify,去掉这一步可加快混淆速度
-dontpreverify

# 有了verbose这句话,混淆后就会生成映射文件
# 包含有类名->混淆后类名的映射关系
# 然后使用printmapping指定映射文件的名称
-verbose
-printmapping proguardMapping.txt

# 指定混淆时采用的算法,后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法,一般不改变
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

# 保护代码中的Annotation不被混淆,这在JSON实体映射时非常重要,比如fastJson
-keepattributes *Annotation*

# 避免混淆泛型,这在JSON实体映射时非常重要,比如fastJson
-keepattributes Signature

//抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable

2.需要保留的东西

以下只是一些例子,可以根据各自的需求,添加所需的内容。

# 保留所有的本地native方法不被混淆

-keepclasseswithmembernames class * {
    
    
    native <methods>;
}

# 保留了继承自Activity、Application这些类的子类
# 因为这些子类,都有可能被外部调用
# 比如说,第一行就保证了所有Activity的子类不要被混淆

-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 * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
 
# 保留在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;
    private void writeObject(java.io.ObjectOutputStream);
    private void readObject(java.io.ObjectInputStream);
    java.lang.Object writeReplace();
    java.lang.Object readResolve();
}

# 对于R(资源)下的所有类及其方法,都不能被混淆
//$表示的是内嵌类,内嵌类经常会被混淆,结果在调用的时候为空就会导致崩溃,最好的解决方法是把这个内嵌类拿出来,单独成为一个类。如果一定要内置,那么这个类就必须在混淆时进行保留。
-keep class **.R$* {
    
    
    *;
}

# 对于带有回调函数onXXEvent的,不能被混淆

-keepclassmembers class * {
    
    
    void *(**On*Event);
}

# 保留实体类和成员不被混淆

-keep public class com.youndheart.entity.** {
    
    

    public void set*(***);
    public *** get*();
    public *** is*();
}

3.对WebView的处理

# 对WebView的处理

-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, java.lang.String)

}

#在app中与HTML5的JavaScript的交互进行特殊处理
#我们需要确保这些js要调用的原生方法不能够被混淆,于是我们需要做如下处理:
-keepclassmembers class com.ljd.example.JSInterface {
    
    
    <methods>;
}

4.针对第三方Jar包的解决方案

  • 针对android-support-v4.jar的解决方案
-libraryjars libs/android-support-v4.jar

-dontwarn android.support.v4.**

-keep class android.support.v4.**  {
    
     *; }

-keep interface android.support.v4.app.** {
    
     *; }

-keep public class * extends android.support.v4.**

-keep public class * extends android.app.Fragment
  • 其他的第三方jar包的解决方案
    一般而言,第三方jar包都是经过progiard混淆过的,通常会在sdk说明文档中有相关的说明,我们所需要做的就是避免这些SDK的类和方法在我们的app中被混淆。

相关参考链接:https://www.jianshu.com/p/b5b2a5dfaaf4
https://blog.csdn.net/pang9998/article/details/83505980

猜你喜欢

转载自blog.csdn.net/qq_36828822/article/details/105897367