鴻蒙代碼配置混淆原理以及混淆命令
51CTO和華為官方合作共建的鴻蒙技術(shù)社區(qū)
一、前言
Java代碼會(huì)被編譯成字節(jié)碼,字節(jié)碼非常容易被反編譯,一旦字節(jié)碼被反編譯,源碼也就泄露了。為了很好的保護(hù)源代碼,需要對(duì)編譯好后的字節(jié)碼文件進(jìn)行混淆。代碼經(jīng)過混淆后,包體積會(huì)變小,并且源碼都被處理過,進(jìn)一步保障了應(yīng)用的安全。本文將首先介紹混淆原理以及混淆命令,然后教大家如何在鴻蒙項(xiàng)目里面配置混淆。
二、ProGuard
ProGuard就是用來混淆代碼的,主要有以下4個(gè)功能。
- 壓縮(Shrink):檢測(cè)并移除代碼中無用的類、字段、方法和特性??梢允褂孟旅娴闹噶铌P(guān)閉壓縮
- # 關(guān)閉壓縮
- -dontshrink
- 優(yōu)化(Optimize):對(duì)字節(jié)碼進(jìn)行優(yōu)化,移除無用的指令??梢允褂孟旅娴闹噶铌P(guān)閉優(yōu)化
- # 關(guān)閉優(yōu)化
- -dontoptimize
- -optimizationpasses n 表示proguard對(duì)代碼進(jìn)行迭代優(yōu)化的次數(shù)
- 混淆(Obfuscate):使用a,b,c,d這樣簡(jiǎn)短而無意義的名稱,對(duì)類、字段和方法進(jìn)行重命名。可以使用下面的指令關(guān)閉混淆
- # 關(guān)閉混淆
- -dontobfuscate
- 預(yù)檢(Preveirfy):在Java平臺(tái)上對(duì)處理后的代碼進(jìn)行預(yù)檢,確保加載的字節(jié)碼文件是可執(zhí)行的。
- 總之,Proguard是一個(gè)Java類文件壓縮器、優(yōu)化器、混淆器、預(yù)校驗(yàn)器。壓縮環(huán)節(jié)會(huì)檢測(cè)以及移除沒有用到的類、字段、方法以及屬性。優(yōu)化環(huán)節(jié)會(huì)分析以及優(yōu)化方法的字節(jié)碼?;煜h(huán)節(jié)會(huì)用無意義的短變量去重命名類、變量、方法。這些步驟讓代碼更精簡(jiǎn),更高效,也更難被逆向(破解)。
- 那么有一個(gè)問題,ProGuard怎么知道這個(gè)代碼沒有被用到呢?這里引入一個(gè)Entry Point(入口點(diǎn))概念,Entry Point表示在混淆過程中不會(huì)被處理的類或方法。在壓縮的步驟中,ProGuard會(huì)從上述的Entry Point開始遞歸遍歷,搜索哪些類和類的成員在使用,對(duì)于沒有被使用的類和類的成員,就會(huì)在壓縮段丟棄,在接下來的優(yōu)化過程中,那些非Entry Point的類、方法都會(huì)被設(shè)置為private、static或final,不使用的參數(shù)會(huì)被移除,此外,有些方法會(huì)被標(biāo)記為內(nèi)聯(lián)的,在混淆的步驟中,ProGuard會(huì)對(duì)非Entry Point的類和方法進(jìn)行重命名。
- 一般來說,開啟混淆后,代碼越亂越無規(guī)律越好,但有些代碼是不能被混淆的,否則程序運(yùn)行就會(huì)出錯(cuò),所以就需要我們熟悉混淆指令,當(dāng)開啟混淆的時(shí)候,使用混淆指令告訴編譯器某些代碼不能被混淆。
三、混淆指令
3、1 先看如下如下的命令,一個(gè)星號(hào)表示只是保持該包下的類名,而子包下的類名還是會(huì)被混淆。
- -keep class com.poetry.jianjia.bean.*
3、2 兩個(gè)星號(hào)表示把本包和所含子包下的類名都保持。
- -keep class com.poetry.jianjia.bean.**
3、3 用以上方法保持類后,雖然類名未混淆,但類里面的方法和變量命名還是會(huì)變,如果既想保持類名,又想保持里面的內(nèi)容不被混淆,就需要加上{*;}
- -keep class com.poetry.jianjia.bean.**{*;}
3、4 在此基礎(chǔ)上,還可以使用extends、implements等關(guān)鍵字來保護(hù)特定類不被混淆,如下例子表示實(shí)現(xiàn)Serializable接口的類名不被混淆
- -keep class * implements java.io.Serializable
3、5 如果想保留內(nèi)部類不被混淆則需要用$符號(hào),如下例子MainAbilitySlice內(nèi)部類InnerClass中的所有public內(nèi)容不被混淆。
- -keepclassmembers class com.poetry.jianjia.slice.MainAbilitySlice$InnerClass{
- public *;
- }
3、6 如果只是希望類里面的特定內(nèi)容不被混淆,就可以使用
- <init>; //匹配所有構(gòu)造方法
- <fields>; //匹配所有變量
- <methods>; //匹配所有方法
3、7 可以在
- -keep class com.poetry.jianjia.Banner {
- public <methods>;
- }
3、8 類中可以有重載方法,如果希望某個(gè)重載方法不被混淆,可以加上方法參數(shù),如下例子,帶有一個(gè)字符串參數(shù)的構(gòu)造方法不被混淆
- -keep class com.poetry.jianjia.Banner {
- public <init>(java.lang.String);
- }
3、9 有時(shí)類名可以被混淆,但是希望該類下的特定方法不被混淆,那就不能用keep了,keep不會(huì)混淆類名,而需要用keepclassmembers。如下例子,實(shí)現(xiàn)了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會(huì)防止類和成員被重命名。如下實(shí)例,本地方法不能被重命名。
- -keepclasseswithmembernames class * {
- native <methods>;
- }
3、11 保持枚舉不被混淆
- -keepclassmembers enum * {
- public static **[] values();
- public static ** valueOf(java.lang.String);
- }
3、12 反射用到的類不能被混淆。
3、13 配置文件中的類不能被混淆,配置文件中聲明的Ability默認(rèn)不會(huì)被混淆,在配置文件中聲明的類不需要額外的配置混淆。
3、14 使用gson、fastjson等框架解析服務(wù)端數(shù)據(jù)時(shí),所寫的json對(duì)象類不能混淆,否則無法將json解析成對(duì)應(yīng)的對(duì)象。
3、15 第三方開源庫會(huì)大量的使用注解、反射、泛型,使用第三方開源庫或者引用其他第三方的SDK包時(shí),如果有特別要求,也需要在混淆文件中加入對(duì)應(yīng)的混淆規(guī)則。
四、給鴻蒙項(xiàng)目配置混淆
4、1 我們已經(jīng)熟悉了混淆指令,那如何給鴻蒙項(xiàng)目配置混淆呢?在最新版的編譯器里面創(chuàng)建項(xiàng)目,編譯器會(huì)幫我們創(chuàng)建一個(gè)proguard-rules.pro文件,proguard-rules.pro文件是什么呢?鴻蒙使用proguard進(jìn)行混淆,proguard-rules.pro文件就是用來配置混淆規(guī)則的,將不能被混淆的代碼配置在proguard-rules.pro文件中。請(qǐng)注意,老版本的編譯器不支持混淆,使用老版本的編譯器創(chuàng)建項(xiàng)目,編譯器不會(huì)創(chuàng)建proguard-rules.pro文件。
4、2 編譯器除了幫我們創(chuàng)建proguard-rules.pro文件外,還在build.gradle文件中添加了新代碼,打開build.gradle文件
編譯器在buildTypes閉包里面添加release閉包,release表示正式包。release閉包下面又有一個(gè)proguardOpt閉包,proguardOpt就是用來配置混淆的。proguardEnabled表示是否開啟混淆,true表示開始混淆,false表示不開啟混淆。rulesFiles則表示配置混淆的規(guī)則文件。
可以看出,默認(rèn)情況下,是不開啟混淆的,出于保護(hù)源碼的原因,當(dāng)我們打正式包的時(shí)候,是需要開啟混淆的。其實(shí),我們也可以給測(cè)試包配置混淆,如下代碼。我們手動(dòng)添加了一個(gè)debug閉包,debug表示測(cè)試包,不要在測(cè)試包里面開啟混淆,當(dāng)你在測(cè)試包開啟混淆,斷點(diǎn)調(diào)試的時(shí)候?qū)⒖床坏阶兞康闹怠?/p>
- buildTypes {
- // release表示正式包
- release {
- // 配置混淆
- proguardOpt {
- // 正式包開啟混淆
- proguardEnabled true
- // 混淆規(guī)則配置在proguard-rules.pro文件中
- rulesFiles 'proguard-rules.pro'
- }
- }
- // debug表示測(cè)試包
- debug {
- // 配置混淆
- proguardOpt {
- // 測(cè)試包不開啟混淆
- proguardEnabled false
- // 混淆規(guī)則配置在proguard-rules.pro文件中
- rulesFiles 'proguard-rules.pro'
- }
- }
- }
4、3 如果使用最新版編譯器打開老版本編譯器創(chuàng)建的項(xiàng)目,那么項(xiàng)目中不會(huì)有proguard-rules.pro文件,同時(shí)build.gradle文件中也不會(huì)有proguardOpt。這時(shí)就需要我們自己手動(dòng)創(chuàng)建proguard-rules.pro文件,并且在build.gradle文件添加上述代碼。
4、4 綜上,如何給鴻蒙項(xiàng)目配置混淆?只需兩步,第一,將proguardEnabled 設(shè)置為true,第二,在proguard-rules.pro文件中使用混淆指令配置混淆規(guī)則。
五、給出一個(gè)常見的混淆配置
- # 代碼混淆壓縮比,在0~7之間
- -optimizationpasses 5
- # 混合時(shí)不使用大小寫混合,混合后的類名為小寫
- -dontusemixedcaseclassnames
- # 指定不去忽略非公共庫的類
- -dontskipnonpubliclibraryclasses
- # 不做預(yù)校驗(yàn),preverify是proguard的四個(gè)步驟之一,去掉這一步能夠加快混淆速度。
- -dontpreverify
- -verbose
- # 避免混淆泛型
- -keepattributes Signature
- #google推薦算法
- -optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
- # 保留注解、內(nèi)部類、泛型、匿名類
- -keepattributes *Annotation*,InnerClasses,Signature,EnclosingMethod
- # 重命名拋出異常時(shí)的文件名稱
- -renamesourcefileattribute SourceFile
- # 拋出異常時(shí)保留代碼行號(hào)
- -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這個(gè)包下面的類實(shí)現(xiàn)了Serialized接口,
- # 實(shí)現(xiàn)了Serialized接口的類不能被混淆,請(qǐng)把com.poetry.jianjia.bean這個(gè)包名替換成你自己的包名
- -keep class com.poetry.jianjia.bean.**{*;}
六、總結(jié)
本文主要介紹混淆原理以及混淆命令,并且教大家如何在鴻蒙項(xiàng)目里面配置混淆,大家最好熟悉下混淆指令。在實(shí)際開發(fā)中,經(jīng)常性的會(huì)遇到這種問題,在測(cè)試包里面沒有問題,但在正式包里面就出現(xiàn)了問題,這種情況往往是因?yàn)樵谡桨_啟了混淆,但沒有在proguard-rules.pro文件中配置混淆規(guī)則。
51CTO和華為官方合作共建的鴻蒙技術(shù)社區(qū)