优雅的处理 Android 代码混淆 Keep 问题

为了源码安全以及缩小 APK 体积,Android 应用发布前是必须要进行混淆打包的。而混淆打包并不是全量打包,特定的类、方法、属性是需要排除在混淆之外的,比如数据模型类,自定义 View 等在混淆时如果不通过规则排除在外可能存在运行时找不到资源的问题。

常规操作

常规操作有以下两种方式:

  • 要保持的代码规则逐条添加到 proguard-rules.pro 混淆规则文件中

    存在问题:随着代码量的不断增大,混淆规则会爆炸式增长。还会经常忘记将资源加入到混淆规则中

  • 要保持的类方法统一的包中,再讲整个包的保持规则加入到 proguard-rules.pro 混淆规则文件中

    存在问题
    1、keep 粒度是 Class ,如果只想 keep某个方法或者某个属性就不行了
    2、会干预代码的目录,不利于工程内部代码隔离

简化操作

针对常规操作的问题,做出对应的处理就得到了简约操作 —— Tag 标记法,要做到不干预代码目录,每个类都能标记,因此使用接口对 Class进行标记,Java 类多继承的特性不会对代码有其他的干扰。

  • 定义空接口,将接口保持规则加入到 proguard-rules.pro 混淆规则文件中,需要保持的类实现接口,使用接口标记身份
// 与项目包名路径对应
-keep public interface com.company.project.KeepClass{public *;}
-keep class * implements com.company.project.KeepClass {
<methods>;
<fields>;
} 

存在问题
1、每个 keep 类都要继承比较麻烦(当然比每个类写 keep 要省事多了...)
2、依然不能只 keep 方法或者属性,不 keep 整个类

优雅操作

同样针对接口标记法中的存在的问题,进一步优化得到了注解标记法。因为注解可以标记类、方法、属性,因此可以将 keep 粒度降到属性方法上。

  • 1、写一个空注解类
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
public @interface ProguardKeep {

}
  • 2、混淆规则中添加如下规则
-keep @com.pandaq.appcore.framework.annotation.ProguardKeep class * {*;}
-keep class * {
    @com.pandaq.appcore.framework.annotation.ProguardKeep <fields>;
}
-keepclassmembers class * {
    @com.pandaq.appcore.framework.annotation.ProguardKeep <methods>;
}
  • 3、在需要 keep 的地方使用注解
// 示例需要,使用时不需要类、方法、属性 全都给加上注解
@ProguardKeep
public class UserInfo {
    @ProguardKeep
    private String account;
    private String userName;
    private String token;

    @ProguardKeep
    public String getAccount() {
        return account;
    }
}

总结

使用注解标记,大大的减少了 keep 规则文件内容,开发时只需要记住在需要保持的地方加上 @ProguardKeep ,这也降低了忘记添加混淆规则的风险。当然这只是针对项目自写代码,三方库三方框架的混淆规则还是需要 copy 进规则文件的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容