proguard如何会导致json解析失效?

1. 楔子

json数据的解析是这个星球上99%的Android程序猿都会遇到的问题,而其中的大部分,都会使用Gson,故事就是从这里发生……

2. 一开始

通常json数据是从服务端取的,典型的一段json字符串如下:

  { "name": "老张","age": 18}

一般程序猿们会在本地写一个实体类与之对应,比如数据类Person:

public class Person { 
    private String name;
    private int age;
    //……省略中间get/set
    @Override
    public String toString() {
        return "Person{name='" + name + "', age=" + age + '}';
    }
}

然后就可以愉快地使用Gson来进行解析啦,像这样:

Person someone = new Gson().fromJson(jsonString, Person.class);
Log.d("TAG", "someone: " + someone.toString());

一切顺利,程序猿们得到输出:

Person{ name='老张',age=18}

然后他们就愉快地下班去玩耍了。

3. 后来,他们开启了proguard

意外就是从这里开始的,开启了proguard之后,debug运行的程序一切如常,但是proguard之后输入的apk包,在安装之后的输出变成了这样:

Person{ name='null',age=0}

——解析出错了。
(算了,我编不下去了,从现在开始使用第一人称……)

4. 问题所在

经过反复排查,发现问题就是由proguard引起的。
我们知道,proguard的过程会执行压缩、混淆、去除无用代码等操作。而其中的混淆、去除无用代码的过程,对于使用了反射技术的代码来说,都是有可能受到影响的。
不幸的是:Gson.fromJson()就是基于反射来实现的。

通过反编译apk包,发现我们写的Person类,在没有被保护的情况下,会被proguard成类似这个样子的:


反编译代码1

可以看到,类名、字段名都改成了a/b这样的名字。
这样在使用Gson的时候,它尝试去序列化的字段就会变成了a/b,而不是之前的name/age了。
——那还反射个毛啊!

5. 解决

知道问题了,自然也就很好解决了。
方案是在proguard规则中,把Person类给保护起来

5.1 proguard文件编辑

proguard-rules.pro文件中添加规则(也可能是其他文件,具体见gradle文件中的定义),把数据类保护起来即可。
具体来说,可以直接保护当前类:

-keep class com.xxx.beans.Person {*;}

也可以保护整个包:

-keep class com.xxx.beans.* {*;}

还可以给Person添加一个对Serializable的实现,然后保护所有的Serializable

-keep class * implements java.io.Serializable {*; }

5.2 @Keep注解

另外,项目如果引用了注解支持库,那么给Person类加上@Keep的注解也可以防止它被混淆。

@Keep
public class Person {/*省略*/}

OK,加上保护之后,重新打包。
反编译这时的apk,可以看到,字段Person类没有再被混淆了:


反编译代码2

然后安装、运行,果然一切正常了。

Person{ name='老张',age=18}

完美。

6. 一些链接

反编译工具:https://github.com/google/android-classyshark
压缩代码和资源:https://developer.android.com/studio/build/shrink-code.html
proguard相关问题排查:https://stuff.mit.edu/afs/sipb/project/android/sdk/android-sdk-linux/tools/proguard/docs/index.html#manual/troubleshooting.html
关于作者:https://github.com/barryhappy

另外,希望这篇文章能对你有所帮助。
最近开始整了一个微信公众号,用以分享一些 Android 相关以及不相关的干货,既然都看到这里了,何不长按/扫码关注一下?
不只Android

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

推荐阅读更多精彩内容