簡介
作為Android開發者,如果你不想開源你的應用,那么在應用發布前,就需要對代碼進行混淆處理,從而讓我們代碼即使被反編譯,也難以閱讀。混淆概念雖然容易,但很多初學者也只是網上搜一些成型的混淆規則粘貼進自己項目,并沒有對混淆有個深入的理解。本篇文章的目的就是讓一個初學者在看完后,能在不進行任何幫助的情況下,獨立寫出適合自己代碼的混淆規則。
說在前面
這里我們直接用Android Studio
來說明如何進行混淆,Android Studio
自身集成Java語言的ProGuard作為壓縮,優化和混淆工具,配合Gradle構建工具使用很簡單,只需要在工程應用目錄的gradle文件中設置minifyEnabled為true即可。然后我們就可以到proguard-rules.pro
文件中加入我們的混淆規則了。
android {
...
buildTypes {
release {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
以上示例代碼表示對release版本就行混淆處理。下面我們先來簡介下ProGuard的三大作用,并簡要說明下它們常用的命令。
ProGuard作用
壓縮(Shrinking):默認開啟,用以減小應用體積,移除未被使用的類和成員,并且會在優化動作執行之后再次執行(因為優化后可能會再次暴露一些未被使用的類和成員)。
-dontshrink 關閉壓縮
優化(Optimization):默認開啟,在字節碼級別執行優化,讓應用運行的更快。
-dontoptimize 關閉優化
-optimizationpasses n 表示proguard對代碼進行迭代優化的次數,Android一般為5
混淆(Obfuscation):默認開啟,增大反編譯難度,類和類成員會被隨機命名,除非用keep保護。
-dontobfuscate 關閉混淆
混淆后默認會在工程目錄app/build/outputs/mapping/release
下生成一個mapping.txt
文件,這就是混淆規則,我們可以根據這個文件把混淆后的代碼反推回源本的代碼,所以這個文件很重要,注意保護好。原則上,代碼混淆后越亂越無規律越好,但有些地方我們是要避免混淆的,否則程序運行就會出錯,所以就有了下面我們要教大家的,如何讓自己的部分代碼避免混淆從而防止出錯。
基本規則
先看如下兩個比較常用的命令,很多童鞋可能會比較迷惑以下兩者的區別。
-keep class cn.hadcn.test.**
-keep class cn.hadcn.test.*
一顆星表示只是保持該包下的類名,而子包下的類名還是會被混淆;兩顆星表示把本包和所含子包下的類名都保持;用以上方法保持類后,你會發現類名雖然未混淆,但里面的具體方法和變量命名還是變了,這時如果既想保持類名,又想保持里面的內容不被混淆,我們就需要以下方法了
-keep class cn.hadcn.test.* {*;}
在此基礎上,我們也可以使用Java的基本規則來保護特定類不被混淆,比如我們可以用extend
,implement
等這些Java規則。如下例子就避免所有繼承Activity的類被混淆
-keep public class * extends android.app.Activity
如果我們要保留一個類中的內部類不被混淆則需要用$
符號,如下例子表示保持ScriptFragment內部類JavaScriptInterface中的所有public內容不被混淆。
-keepclassmembers class cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {
public *;
}
再者,如果一個類中你不希望保持全部內容不被混淆,而只是希望保護類下的特定內容,就可以使用
<init>; //匹配所有構造器
<fields>; //匹配所有域
<methods>; //匹配所有方法方法
你還可以在<fields>
或<methods>
前面加上private
、public
、native
等來進一步指定不被混淆的內容,如
-keep class cn.hadcn.test.One {
public <methods>;
}
表示One
類下的所有public
方法都不會被混淆,當然你還可以加入參數,比如以下表示用JSONObject作為入參的構造函數不會被混淆
-keep class cn.hadcn.test.One {
public <init>(org.json.JSONObject);
}
有時候你是不是還想著,我不需要保持類名,我只需要把該類下的特定方法保持不被混淆就好,那你就不能用keep方法了,keep方法會保持類名,而需要用keepclassmembers
,如此類名就不會被保持,為了便于對這些規則進行理解,官網給出了以下表格
保留 | 防止被移除或者被重命名 | 防止被重命名 |
---|---|---|
類和類成員 | -keep | -keepnames |
僅類成員 | -keepclassmembers | -keepclassmembernames |
如果擁有某成員,保留類和類成員 | -keepclasseswithmembers | -keepclasseswithmembernames |
移除是指在壓縮(Shrinking)時是否會被刪除。以上內容時混淆規則中需要重點掌握的,了解后,基本所有的混淆規則文件你應該都能看懂了。再配合以下幾點注意事項,開啟你為自己代碼,實現混淆規則之旅吧。
注意事項
1,jni方法不可混淆,因為這個方法需要和native方法保持一致;
-keepclasseswithmembernames class * { # 保持native方法不被混淆
native <methods>;
}
2,反射用到的類不混淆(否則反射可能出現問題);
3,AndroidMainfest中的類不混淆,所以四大組件和Application的子類和Framework層下所有的類默認不會進行混淆。自定義的View默認也不會被混淆;所以像網上貼的很多排除自定義View,或四大組件被混淆的規則在Android Studio中是無需加入的;
4,與服務端交互時,使用GSON、fastjson等框架解析服務端數據時,所寫的JSON對象類不混淆,否則無法將JSON解析成對應的對象;
5,使用第三方開源庫或者引用其他第三方的SDK包時,如果有特別要求,也需要在混淆文件中加入對應的混淆規則;
6,有用到WebView的JS調用也需要保證寫的接口方法不混淆,原因和第一條一樣;
7,Parcelable的子類和Creator靜態成員變量不混淆,否則會產生Android.os.BadParcelableException異常;
-keep class * implements Android.os.Parcelable { # 保持Parcelable不被混淆
public static final Android.os.Parcelable$Creator *;
}
8,使用enum類型時需要注意避免以下兩個方法混淆,因為enum類的特殊性,以下兩個方法會被反射調用,見第二條規則。
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
寫在最后
發布一款應用除了設minifyEnabled
為ture
,你也應該設置zipAlignEnabled
為true
,像Google Play
強制要求開發者上傳的應用必須是經過zipAlign的,zipAlign可以讓安裝包中的資源按4字節對齊,這樣可以減少應用在運行時的內存消耗。
最后的最后
大家平時有沒有過從 PC 和 手機互傳文件時的煩惱,如果無數據線的情況下,還得打開 QQ 活在微信,有時候傳個 APK,微信還會自動給文件增加一個后綴,還得用文件管理工具找到該文件后修改后綴才能進行安裝,總之麻煩到爆,即使有數據線時,傳輸也是相當麻煩。現在給大家安利一款比較好的開源工具:FileTransfer,你可以在 http://fir.im/transfer 下下載。源碼地址:https://github.com/CPPAlien/FileTransfer。
作者簡介
彭濤(@彭濤me) 致力于讓技術變得易懂且有趣
個人博客:http://pengtao.me, GitHub地址:https://github.com/CPPAlien