社区编辑申请
注册/登录
新来个技术总监:谁在用isXxx形式定义布尔类型年后不用来了
开发 开发工具
在日常开发中,我们会经常要在类中定义布尔类型的变量,比如在给外部系统提供一个RPC接口的时候,我们一般会定义一个字段表示本次请求是否成功的。

 在日常开发中,我们会经常要在类中定义布尔类型的变量,比如在给外部系统提供一个RPC接口的时候,我们一般会定义一个字段表示本次请求是否成功的。

关于这个”本次请求是否成功”的字段的定义,我见过很多不同的开发者,定义的方式都不同,尤其是在属性的命名上,有人用 success,有人用 isSuccess 表示。

从语义上面来讲,两种命名方式都可以讲的通,并且也都没有歧义。那么还有什么原则可以参考来让我们做选择呢。

根据JavaBeans Specification规定,如果是普通的参数propertyName,要以以下方式定义其setter/getter:

  1. public <PropertyType> get<PropertyName>(); 
  2.  
  3. public void set<PropertyName>(<PropertyType> a); 

但是,布尔类型的变量propertyName则是单独定义的:

  1. public boolean is<PropertyName>(); 
  2.  
  3. public void set<PropertyName>(boolean m); 

success方法的 getter 应该是isSuccess/getSuccess,而isSuccess的getter 应该是isIsSuccess/getIsSuccess。

但是很多人,在使用isSuccess作为属性名的时候,还是会采用isSuccess/getSuccess作为 getter 方法名,尤其是现在的很多 IDE 在默认生成 getter 的时候也是会生成isSuccess。

在一般情况下,其实是没有影响的。但是有一种特殊情况就会有问题,那就是发生序列化的时候可能会导致参数转换异常。

我们先来定义一个 JavaBean:

  1. class Model implements Serializable { 
  2.  
  3.  
  4.    private static final long serialVersionUID = 1836697963736227954L; 
  5.  
  6.    private boolean isSuccess; 
  7.  
  8.    public boolean isSuccess() { 
  9.  
  10.        return isSuccess; 
  11.  
  12.    } 
  13.  
  14.    public void setSuccess(boolean success) { 
  15.  
  16.        isSuccess = success; 
  17.  
  18.    } 
  19.  
  20.    public String getHollis(){ 
  21.  
  22.        return "hollischuang"
  23.  
  24.    } 
  25.  

在这个 JavaBean 中,有一个成员变量isSuccess,三个方法,分别是IDE帮我们自动生成的isSuccess和setSuccess,另外一个是作者自己增加的一个符合getter命名规范的方法。

我们分别使用不同的 JSON 序列化工具来对这个类的对象进行序列化和反序列化:

  1. public class BooleanMainTest { 
  2.  
  3.      public static void main(String[] args) throws IOException { 
  4.  
  5.          //定一个Model类型 
  6.  
  7.          Model model = new Model(); 
  8.  
  9.          model.setSuccess(true); 
  10.  
  11.  
  12.  
  13.          //使用fastjson(1.2.16)序列化model成字符串并输出 
  14.  
  15.          System.out.println("Serializable Result With fastjson :" + JSON.toJSONString(model)); 
  16.  
  17.  
  18.  
  19.          //使用Gson(2.8.5)序列化model成字符串并输出 
  20.  
  21.          Gson gson =new Gson(); 
  22.  
  23.          System.out.println("Serializable Result With Gson :" +gson.toJson(model)); 
  24.  
  25.  
  26.  
  27.          //使用jackson(2.9.7)序列化model成字符串并输出 
  28.  
  29.          ObjectMapper om = new ObjectMapper(); 
  30.  
  31.          System.out.println("Serializable Result With jackson :" +om.writeValueAsString(model)); 
  32.  
  33.      } 
  34.  

以上代码输出结果:

  1. Serializable Result With fastjson :{"hollis":"hollischuang","success":true
  2.  
  3. Serializable Result With Gson :{"isSuccess":true
  4.  
  5. Serializable Result With jackson :{"success":true,"hollis":"hollischuang"

在fastjson和jackson的结果中,原来类中的isSuccess字段被序列化成success,并且其中还包含hollis值。而Gson中只有isSuccess字段。

我们可以得出结论:fastjson和jackson在把对象序列化成json字符串的时候,是通过反射遍历出该类中的所有getter方法,得到getHollis和isSuccess,然后根据JavaBeans规则,他会认为这是两个属性hollis和success的值。直接序列化成json:

  1. {“hollis”:”hollischuang”,”success”:true

但是Gson并不是这么做的,他是通过反射遍历该类中的所有属性,并把其值序列化成json:

  1. {“isSuccess”:true

可以看到,由于不同的序列化工具,在进行序列化的时候使用到的策略是不一样的,所以,对于同一个类的同一个对象的序列化结果可能是不同的。那么,如果我们把一个对象使用fastjson进行序列化,再使用Gson反序列化会发生什么呢?

  1. public class BooleanMainTest { 
  2.  
  3.     public static void main(String[] args) throws IOException { 
  4.  
  5.         Model model = new Model(); 
  6.  
  7.         model.setSuccess(true); 
  8.  
  9.         Gson gson =new Gson(); 
  10.  
  11.         System.out.println(gson.fromJson(JSON.toJSONString(model),Model.class)); 
  12.  
  13.     } 
  14.  

以上代码,输出结果:

  1. Model[isSuccess=false

这和我们预期的结果完全相反,原因是因为JSON框架通过扫描所有的getter后发现有一个isSuccess方法,然后根据JavaBeans的规范,解析出变量名为success,把model对象序列化城字符串后内容为{"success":true}。

根据{"success":true}这个json串,Gson框架在通过解析后,通过反射寻找Model类中的success属性,但是Model类中只有isSuccess属性,所以,最终反序列化后的Model类的对象中,isSuccess则会使用默认值false。

但是,一旦以上代码发生在生产环境,这绝对是一个致命的问题。

所以,作为开发者,我们应该想办法尽量避免这种问题的发生。

所以,建议大家使用success而不是 isSuccess 这种形式。这样,该类里面的成员变量时success,getter方法是isSuccess,这是完全符合JavaBeans规范的。无论哪种序列化框架,执行结果都一样。就从源头避免了这个问题。

责任编辑:武晓燕 来源: 51CTO专栏
相关推荐

2022-05-18 23:42:08

网络安全安全分析工具

2022-05-09 15:08:56

存储厂商NFV领域华为

2022-05-20 14:54:33

数据安全数字化转型企业

2022-05-11 14:48:33

腾讯云寿险民生保险

2022-05-16 10:49:28

网络协议数据

2022-05-10 14:11:05

网络安全网络犯罪

2022-05-17 15:51:32

数据中心运维能力基础设施

2022-05-24 19:49:22

2022-05-11 14:05:11

区块链网络安全存储

2022-05-26 10:57:51

机器人人工智能

2022-05-07 09:08:13

路由策略网络规划

2022-05-26 11:37:58

亚马逊云科技C7g实例

2022-05-03 23:21:13

安全意识网络安全网络钓鱼

2022-05-09 11:57:39

云原生实践安全

2022-05-25 10:49:02

云存储云计算

2022-05-20 14:08:13

Web3元宇宙区块链

2022-05-23 09:18:55

RocketMQ存储中间件

2022-05-24 10:27:39

博云容器云运维

2022-05-26 11:50:15

2022-05-23 10:55:19

华为数字化转型架构蓝图

同话题下的热门内容

Python 编程的好搭档—VSCode 详细指南用不同的测试模型来构建测试套件实用!一款开源的 JSON 可视化管理工具吐血推荐17个提升开发效率的“轮子”我常用的五款效率小工具,你用过哪几个?想要控制好权限,这八个注解你必须知道!Vue新一代状态管理插件PiniaGithub Actions 那些事儿,你知道吗?

编辑推荐

终于有人把Elasticsearch原理讲透了!花了一个星期,我终于把RPC框架整明白了!这可能是把ZooKeeper概念讲的最清楚的一篇文章论如何下载一个在线的m3u8文件到本地成为一个mp4!拜托!面试不要再问我Spring Cloud底层原理
我收藏的内容
点赞
收藏

51CTO技术栈公众号