鴻蒙代碼配置混淆

1、前言

Java代碼會被編譯成字節碼，字節碼很是容易被反編譯，一旦字節碼被反編譯，源碼也就泄露了。爲了很好的保護源代碼，須要對編譯好後的字節碼文件進行混淆。代碼通過混淆後，包體積會變小，而且源碼都被處理過，進一步保障了應用的安全。本文將首先介紹混淆原理以及混淆命令，而後教你們如何在鴻蒙項目裏面配置混淆。框架

2、ProGuard

ProGuard就是用來混淆代碼的，主要有如下4個功能。
post

壓縮(Shrink)：檢測並移除代碼中無用的類、字段、方法和特性。可使用下面的指令關閉壓縮

# 關閉壓縮
-dontshrink

優化(Optimize)：對字節碼進行優化，移除無用的指令。可使用下面的指令關閉優化

# 關閉優化
-dontoptimize
-optimizationpasses n 表示proguard對代碼進行迭代優化的次數

混淆(Obfuscate)：使用a，b，c，d這樣簡短而無心義的名稱，對類、字段和方法進行重命名。可使用下面的指令關閉混淆

# 關閉混淆
-dontobfuscate

預檢(Preveirfy)：在Java平臺上對處理後的代碼進行預檢，確保加載的字節碼文件是可執行的。
總之，Proguard是一個Java類文件壓縮器、優化器、混淆器、預校驗器。壓縮環節會檢測以及移除沒有用到的類、字段、方法以及屬性。優化環節會分析以及優化方法的字節碼。混淆環節會用無心義的短變量去重命名類、變量、方法。這些步驟讓代碼更精簡，更高效，也更難被逆向（破解）。
那麼有一個問題，ProGuard怎麼知道這個代碼沒有被用到呢？這裏引入一個Entry Point（入口點）概念，Entry Point表示在混淆過程當中不會被處理的類或方法。在壓縮的步驟中，ProGuard會從上述的Entry Point開始遞歸遍歷，搜索哪些類和類的成員在使用，對於沒有被使用的類和類的成員，就會在壓縮段丟棄，在接下來的優化過程當中，那些非Entry Point的類、方法都會被設置爲private、static或final，不使用的參數會被移除，此外，有些方法會被標記爲內聯的，在混淆的步驟中，ProGuard會對非Entry Point的類和方法進行重命名。
通常來講，開啓混淆後，代碼越亂越無規律越好，但有些代碼是不能被混淆的，不然程序運行就會出錯，因此就須要咱們熟悉混淆指令，當開啓混淆的時候，使用混淆指令告訴編譯器某些代碼不能被混淆。

3、混淆指令

命令	含義
-keep	防止類和成員被移除或者被重命名
-keepnames	防止類和成員被重命名
-keepclassmembers	防止成員被移除或者被重命名
-keepclasseswithmembernames	防止擁有該成員的類和成員被重命名
-keepclasseswithmembers	防止擁有該成員的類和成員被移除或者被重命名

三、1 先看以下以下的命令，一個星號表示只是保持該包下的類名，而子包下的類名仍是會被混淆。測試

-keep class com.poetry.jianjia.bean.*

三、2 兩個星號表示把本包和所含子包下的類名都保持。gradle

-keep class com.poetry.jianjia.bean.**

三、3 用以上方法保持類後，雖然類名未混淆，但類裏面的方法和變量命名仍是會變，若是既想保持類名，又想保持裏面的內容不被混淆，就須要加上{*;}

-keep class com.poetry.jianjia.bean.**{*;}

三、4 在此基礎上，還可使用extends、implements等關鍵字來保護特定類不被混淆，以下例子表示實現Serializable接口的類名不被混淆

-keep class * implements java.io.Serializable

三、5 若是想保留內部類不被混淆則須要用$符號，以下例子MainAbilitySlice內部類InnerClass中的全部public內容不被混淆。

-keepclassmembers class com.poetry.jianjia.slice.MainAbilitySlice$InnerClass{
   public *;
}

三、6 若是隻是但願類裏面的特定內容不被混淆，就可使用

<init>; //匹配全部構造方法 <fields>; //匹配全部變量 <methods>; //匹配全部方法

三、7 能夠在<fields>或<methods>前面加上private 、public、native等來進一步指定不被混淆的內容，以下例子，Banner類中全部的共有方法不被混淆。

-keep class com.poetry.jianjia.Banner {
    public <methods>; }

三、8 類中能夠有重載方法，若是但願某個重載方法不被混淆，能夠加上方法參數，以下例子，帶有一個字符串參數的構造方法不被混淆

-keep class com.poetry.jianjia.Banner {
    public <init>(java.lang.String); }

三、9 有時類名能夠被混淆，可是但願該類下的特定方法不被混淆，那就不能用keep了，keep不會混淆類名，而須要用keepclassmembers。以下例子，實現了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();
}

三、10 有些類或者類成員是不能被重命名的， keepclasseswithmembernames會防止類和成員被重命名。以下實例，本地方法不能被重命名。

-keepclasseswithmembernames class * {    
    native <methods>; }

三、11 保持枚舉不被混淆

-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

三、12 反射用到的類不能被混淆。
三、13 配置文件中的類不能被混淆，配置文件中聲明的Ability默認不會被混淆，在配置文件中聲明的類不須要額外的配置混淆。
三、14 使用gson、fastjson等框架解析服務端數據時，所寫的json對象類不能混淆，不然沒法將json解析成對應的對象。
三、15 第三方開源庫會大量的使用註解、反射、泛型，使用第三方開源庫或者引用其餘第三方的SDK包時，若是有特別要求，也須要在混淆文件中加入對應的混淆規則。

4、給鴻蒙項目配置混淆

四、1 咱們已經熟悉了混淆指令，那如何給鴻蒙項目配置混淆呢？在最新版的編譯器裏面建立項目，編譯器會幫咱們建立一個proguard-rules.pro文件，proguard-rules.pro文件是什麼呢？鴻蒙使用proguard進行混淆，proguard-rules.pro文件就是用來配置混淆規則的，將不能被混淆的代碼配置在proguard-rules.pro文件中。請注意，老版本的編譯器不支持混淆，使用老版本的編譯器建立項目，編譯器不會建立proguard-rules.pro文件。

四、2 編譯器除了幫咱們建立proguard-rules.pro文件外，還在build.gradle文件中添加了新代碼，打開build.gradle文件

編譯器在buildTypes閉包裏面添加release閉包，release表示正式包。release閉包下面又有一個proguardOpt閉包，proguardOpt就是用來配置混淆的。proguardEnabled表示是否開啓混淆，true表示開始混淆，false表示不開啓混淆。rulesFiles則表示配置混淆的規則文件。
能夠看出，默認狀況下，是不開啓混淆的，出於保護源碼的緣由，當咱們打正式包的時候，是須要開啓混淆的。其實，咱們也能夠給測試包配置混淆，以下代碼。咱們手動添加了一個debug閉包，debug表示測試包，不要在測試包裏面開啓混淆，當你在測試包開啓混淆，斷點調試的時候將看不到變量的值。

buildTypes {
        // release表示正式包
        release {
            // 配置混淆
            proguardOpt {
                // 正式包開啓混淆
                proguardEnabled true
                // 混淆規則配置在proguard-rules.pro文件中
                rulesFiles 'proguard-rules.pro'
            }
        }
        // debug表示測試包
        debug {
            // 配置混淆
            proguardOpt {
                // 測試包不開啓混淆
                proguardEnabled false
                // 混淆規則配置在proguard-rules.pro文件中
                rulesFiles 'proguard-rules.pro'
            }
        }
    }

四、3 若是使用最新版編譯器打開老版本編譯器建立的項目，那麼項目中不會有proguard-rules.pro文件，同時build.gradle文件中也不會有proguardOpt。這時就須要咱們本身手動建立proguard-rules.pro文件，而且在build.gradle文件添加上述代碼。
四、4 綜上，如何給鴻蒙項目配置混淆？只需兩步，第一，將proguardEnabled 設置爲true，第二，在proguard-rules.pro文件中使用混淆指令配置混淆規則。

5、給出一個常見的混淆配置

# 代碼混淆壓縮比，在0~7之間
-optimizationpasses 5
# 混合時不使用大小寫混合，混合後的類名爲小寫
-dontusemixedcaseclassnames
# 指定不去忽略非公共庫的類
-dontskipnonpubliclibraryclasses
# 不作預校驗，preverify是proguard的四個步驟之一，去掉這一步可以加快混淆速度。
-dontpreverify
-verbose
# 避免混淆泛型
-keepattributes Signature
#google推薦算法
-optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
# 保留註解、內部類、泛型、匿名類
-keepattributes *Annotation*,InnerClasses,Signature,EnclosingMethod
# 重命名拋出異常時的文件名稱
-renamesourcefileattribute SourceFile
# 拋出異常時保留代碼行號
-keepattributes SourceFile,LineNumberTable
-dontwarn javax.annotation.**

# 保留本地native方法不被混淆
-keepclasseswithmembernames class * {
    native <methods>; } # 保留枚舉類不被混淆 -keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); } -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(); } # OkHttp3 -dontwarn okhttp3.logging.** -keep class okhttp3.internal.**{*;} -dontwarn okio.** # gson -keep class sun.misc.Unsafe { *; } -keep class com.google.gson.stream.** { *; } # 在個人示例代碼中，com.poetry.jianjia.bean這個包下面的類實現了Serialized接口， # 實現了Serialized接口的類不能被混淆，請把com.poetry.jianjia.bean這個包名替換成你本身的包名 -keep class com.poetry.jianjia.bean.**{*;}

6、總結

本文主要介紹混淆原理以及混淆命令，而且教你們如何在鴻蒙項目裏面配置混淆，你們最好熟悉下混淆指令。在實際開發中，常常性的會遇到這種問題，在測試包裏面沒有問題，但在正式包裏面就出現了問題，這種狀況每每是由於在正式包開啓了混淆，但沒有在proguard-rules.pro文件中配置混淆規則。

做者：裴雲飛1
想了解更多內容，請訪問51CTO和華爲合做共建的鴻蒙社區：https://harmonyos.51cto.com