鴻蒙代碼配置混淆原理以及混淆命令
一、前言
Java代碼會被編譯成字節碼，字節碼非常容易被反編譯，一旦字節碼被反編譯，源碼也就泄露了。為了很好的保護源代碼，需要對編譯好后的字節碼文件進行混淆。代碼經過混淆后，包體積會變小，并且源碼都被處理過，進一步保障了應用的安全。本文將首先介紹混淆原理以及混淆命令，然后教大家如何在鴻蒙項目里面配置混淆。
二、ProGuard
ProGuard就是用來混淆代碼的，主要有以下4個功能。
- 壓縮(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、1 先看如下如下的命令，一個星號表示只是保持該包下的類名，而子包下的類名還是會被混淆。
- -keep class com.poetry.jianjia.bean.*
3、2 兩個星號表示把本包和所含子包下的類名都保持。
- -keep class com.poetry.jianjia.bean.**
3、3 用以上方法保持類后，雖然類名未混淆，但類里面的方法和變量命名還是會變，如果既想保持類名，又想保持里面的內容不被混淆，就需要加上{*;}
- -keep class com.poetry.jianjia.bean.**{*;}
3、4 在此基礎上，還可以使用extends、implements等關鍵字來保護特定類不被混淆，如下例子表示實現Serializable接口的類名不被混淆
- -keep class * implements java.io.Serializable
3、5 如果想保留內部類不被混淆則需要用$符號，如下例子MainAbilitySlice內部類InnerClass中的所有public內容不被混淆。
- -keepclassmembers class com.poetry.jianjia.slice.MainAbilitySlice$InnerClass{
- public *;
- }
3、6 如果只是希望類里面的特定內容不被混淆，就可以使用
- <init>; //匹配所有構造方法
- <fields>; //匹配所有變量
- <methods>; //匹配所有方法
3、7 可以在
- -keep class com.poetry.jianjia.Banner {
- public <methods>;
- }
3、8 類中可以有重載方法，如果希望某個重載方法不被混淆，可以加上方法參數，如下例子，帶有一個字符串參數的構造方法不被混淆
- -keep class com.poetry.jianjia.Banner {
- public <init>(java.lang.String);
- }
3、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();
- }
3、10 有些類或者類成員是不能被重命名的，keepclasseswithmembernames會防止類和成員被重命名。如下實例，本地方法不能被重命名。
- -keepclasseswithmembernames class * {
- native <methods>;
- }
3、11 保持枚舉不被混淆
- -keepclassmembers enum * {
- public static **[] values();
- public static ** valueOf(java.lang.String);
- }
3、12 反射用到的類不能被混淆。
3、13 配置文件中的類不能被混淆，配置文件中聲明的Ability默認不會被混淆，在配置文件中聲明的類不需要額外的配置混淆。
3、14 使用gson、fastjson等框架解析服務端數據時，所寫的json對象類不能混淆，否則無法將json解析成對應的對象。
3、15 第三方開源庫會大量的使用注解、反射、泛型，使用第三方開源庫或者引用其他第三方的SDK包時，如果有特別要求，也需要在混淆文件中加入對應的混淆規則。
四、給鴻蒙項目配置混淆
4、1 我們已經熟悉了混淆指令，那如何給鴻蒙項目配置混淆呢?在最新版的編譯器里面創建項目，編譯器會幫我們創建一個proguard-rules.pro文件，proguard-rules.pro文件是什么呢?鴻蒙使用proguard進行混淆，proguard-rules.pro文件就是用來配置混淆規則的，將不能被混淆的代碼配置在proguard-rules.pro文件中。請注意，老版本的編譯器不支持混淆，使用老版本的編譯器創建項目，編譯器不會創建proguard-rules.pro文件。
4、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'
- }
- }
- }
4、3 如果使用最新版編譯器打開老版本編譯器創建的項目，那么項目中不會有proguard-rules.pro文件，同時build.gradle文件中也不會有proguardOpt。這時就需要我們自己手動創建proguard-rules.pro文件，并且在build.gradle文件添加上述代碼。
4、4 綜上，如何給鴻蒙項目配置混淆?只需兩步，第一，將proguardEnabled 設置為true，第二，在proguard-rules.pro文件中使用混淆指令配置混淆規則。
五、給出一個常見的混淆配置
- # 代碼混淆壓縮比，在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.**{*;}
六、總結
本文主要介紹混淆原理以及混淆命令，并且教大家如何在鴻蒙項目里面配置混淆，大家最好熟悉下混淆指令。在實際開發中，經常性的會遇到這種問題，在測試包里面沒有問題，但在正式包里面就出現了問題，這種情況往往是因為在正式包開啟了混淆，但沒有在proguard-rules.pro文件中配置混淆規則。
