POJO 类中布尔类型为啥不让用 isXxx 命名
源码面前,了无秘密
《阿里开发规范泰山版》(2020.04.22)-->编程规约-->(一) 命名风格-->第8条规定:
【强制】POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。
对于这样一条【强制】级别的规定,虽然规范中做了简单的说明,但依然显得很不起眼,以至于我虽然规范背的很熟,依然踩到了这个坑。
0 起因
最近写了一个钉钉告警工具类,对于这种需求明确,开发文档清晰的任务,写代码信手拈来,很快就写完了。
但是自测的时候却发现@所有人这个接口始终过不了单元测试,经过一番追踪,终于找到原因,于是有了本文。
1 问题重现
本身发钉钉消息就是一个post请求的事,而且钉钉有阿里背书,调用不通那自然是我这个开发者的问题喽。
下面是钉钉的接口说明,参数isAtAll
表示是否@所有人
根据这个json串,我编写了如下的POJO类与之对应,并使用fastjson进行json序列化
问题就出在private boolean isAtAll;
这个字段上,有没有发现阿里的这个参数违背了开篇提到的开发规范?使用fastjson序列化之后,该属性实际转化为了:
这个坑爹货,把前面的is给吃了!导致无法@所有人
2 追根溯源
为什么序列化之后把is吃了呢?带着这个问题我追踪了一下fastjson的源码,发现在序列化的时候,其使用的是属性的getter方法名,而isAtAll
字段自动生成的getter、setter为:
对应的fastjson中对方法名的处理在com.alibaba.fastjson.util.TypeUtils.computeGetters
中,源码摘录如下:
也就是说,对于is开头的方法,fastjson先把第3个字符截取出来,如果该字符是大写,就转换为小写,并且拼装剩余的方法名组成属性名。
例如:isAtAll
方法拼装出来的属性名就是atAll
,最终结果就是把我们的is
给吃了!
3 解决办法
既然问题根源已经找到了,那我们只需要对症下药就可以了,这里针对不同应用场景,课代表给大家总结三种解决办法:
对于有修改权限的代码,要严格遵守开发规范,POJO类中的布尔类型属性不要用
is
开头命名,如果有,改掉对于第三方接口,参数里有类似
isX
这样的参数,可以在对应属性字段上使用fastjson的@JSONField(name = "anotherName")
来定制属性名可以手动修改getter和setter方法名
4 引申
SpringBoot集成了jackson,默认使用jackson来进行json序列化,经过测试,jackson也存在吃掉is
的情况,原理与fastjson类似,就不做过多解释了,开发过程中遵守文中提及的解决办法即可
参考
fastjson源码
《阿里开发规范泰山版》(2020.0422)
版权声明: 本文为 InfoQ 作者【Java课代表】的原创文章。
原文链接:【http://xie.infoq.cn/article/1c4c3e6363e90660693fa6c6b】。文章转载请联系作者。
评论