一个Getter引发的血案

本文转载自微信公众号「你呀不牛」,作者不牛。转载本文请联系你呀不牛公众号。

创新互联"三网合一"的企业建站思路。企业可建设拥有电脑版、微信版、手机版的企业网站。实现跨屏营销,产品发布一步更新,电脑网络+移动网络一网打尽,满足企业的营销需求!创新互联具备承接各种类型的成都网站设计、成都网站制作项目的能力。经过十多年的努力的开拓,为不同行业的企事业单位提供了优质的服务,并获得了客户的一致好评。

1需求

最近做一了个需求,调用其他服务的REST接口,感觉很简单,于是迅速就搞起来了

构造Request类

 
 
 
 
  1. public class User { 
  2.     private String name; 
  3.     private Integer age; 
  4.  
  5.     public User(String name, Integer age) { 
  6.         this.name = name; 
  7.         this.age = age; 
  8.     } 

啪,我上来就一new

 
 
 
 
  1. service.sendRequest(new User("niu", 18)); 

打完,收工,又是努力工作(摸鱼)的一天。

2定位

但是,某天晚上8点,测试人员突然给我打电话,说调用失败,同时本身又缺少打印,没有办法具体哪出问题了。

我是不会认为这么简单的代码自己会出错的,不可能!!

经过网络抓包后发现,收到的参数都是null,但是我这边明明调用构造器传入参数了

难道出现灵异事件了?

经过分析,整体数据流为:

能出现问题的地方只能是序列化JSON地方,于是本地测试验证了这一结论:

 
 
 
 
  1. public static void main(String[] args) throws IOException { 
  2.     ObjectMapper objectMapper = new ObjectMapper(); 
  3.     String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  4.     System.out.println(request); 

虽然是出问题了,但是序列化并没有转为属性为null的对象,而是直接抛出异常

 
 
 
 
  1. Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class online.jvm.bean.User and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS) 
  2.  at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77) 

通过查询异常资料,解决掉这种异常需要在增加Jackson的序列化配置FAIL_ON_EMPTY_BEANS,FAIL_ON_EMPTY_BEANS这个配置表示如果某个bean序列化为空时不会异常失败

 
 
 
 
  1. public static void main(String[] args) throws IOException { 
  2.     ObjectMapper objectMapper = new ObjectMapper(); 
  3.     objectMapper.configure(FAIL_ON_EMPTY_BEANS, false); 
  4.     String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  5.     System.out.println(request); 

这种就不会报错,而是返回序列化成空串,也就导致接受方为属性都为null

通过看自研RPC框架看到是有该FAIL_ON_EMPTY_BEANS的配置

3解决

再来分析一下原因,Jackson序列化时需要调用bean的getter方法

1、写上getter后再看下结果:

 
 
 
 
  1. public class User { 
  2.     private String name; 
  3.     private Integer age; 
  4.  
  5.     public User(String name, Integer age) { 
  6.         this.name = name; 
  7.         this.age = age; 
  8.     } 
  9.  
  10.     public String getName() { 
  11.         return name; 
  12.     } 
  13.  
  14.     public Integer getAge() { 
  15.         return age; 
  16.     } 
  17.  
  18.     public static void main(String[] args) throws IOException { 
  19.         ObjectMapper objectMapper = new ObjectMapper(); 
  20.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  21.         System.out.println(request); 
  22.         // 输出正常 : {"name":"niu","age":18} 
  23.     } 

2、或者把属性访问权限改为public

 
 
 
 
  1. public class User { 
  2.     public String name; 
  3.     public Integer age; 
  4.  
  5.     public User(String name, Integer age) { 
  6.         this.name = name; 
  7.         this.age = age; 
  8.     } 
  9.  
  10.     public static void main(String[] args) throws IOException { 
  11.         ObjectMapper objectMapper = new ObjectMapper(); 
  12.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  13.         System.out.println(request); 
  14.         // 输出正常 : {"name":"niu","age":18} 
  15.     } 

但是如果要求不能暴露bean的属性即使是getter也不行呢?

3、注解 @JsonProperty

这是就需要使用Jackson提供的注解 @JsonProperty

 
 
 
 
  1. public class User { 
  2.     @JsonProperty("userName") 
  3.     private String name; 
  4.     @JsonProperty 
  5.     private Integer age; 
  6.  
  7.     public User(String name, Integer age) { 
  8.         this.name = name; 
  9.         this.age = age; 
  10.     } 
  11.  
  12.     public static void main(String[] args) throws IOException { 
  13.         ObjectMapper objectMapper = new ObjectMapper(); 
  14.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  15.         System.out.println(request); 
  16.         //   {"userName":"niu","age":18} 
  17.     } 

来看下注解@JsonProperty的源码注释

 
 
 
 
  1. Marker annotation that can be used to define a non-static method as a "setter" or "getter" for a logical property (depending on its signature), or non-static object field to be used (serialized, deserialized) as a logical property. 

大体意思是注解如果用在属性上相当于为该属性定义getter和setter。

那如果既有getter又有@JsonProperty注解,以哪个为准呢?

 
 
 
 
  1. public class User { 
  2.     @JsonProperty("userName") 
  3.     private String name; 
  4.     @JsonProperty 
  5.     private Integer age; 
  6.  
  7.     public User(String name, Integer age) { 
  8.         this.name = name; 
  9.         this.age = age; 
  10.     } 
  11.  
  12.     public String getName() { 
  13.         return name; 
  14.     } 
  15.  
  16.     public static void main(String[] args) throws IOException { 
  17.         ObjectMapper objectMapper = new ObjectMapper(); 
  18.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  19.         System.out.println(request); 
  20.         // {"age":18,"userName":"niu"} 
  21.     } 

如果getter一个没有的属性,效果如何呢?

 
 
 
 
  1. public class User { 
  2.     @JsonProperty("userName") 
  3.     private String name; 
  4.     @JsonProperty 
  5.     private Integer age; 
  6.  
  7.     public User(String name, Integer age) { 
  8.         this.name = name; 
  9.         this.age = age; 
  10.     } 
  11.  
  12.     public String getName2() { 
  13.         return name; 
  14.     } 
  15.  
  16.     public static void main(String[] args) throws IOException { 
  17.         ObjectMapper objectMapper = new ObjectMapper(); 
  18.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  19.         System.out.println(request); 
  20.         // {"age":18,"name2":"niu","userName":"niu"} 
  21.     } 

这说明如果有@JsonProperty注解,先以注解为准

然后利用反射找到对象类的所有get方法,接下来去get,然后小写化,作为json的每个key值,而get方法的返回值作为value。接下来再反射field,添加到json中。

4、特殊情况

还有一种比较特殊的情况, getter方法由lombok生成,且属性的次首字母是大写:

 
 
 
 
  1. @Getter 
  2. public class User { 
  3.     @JsonProperty 
  4.     private String nAme; 
  5.     @JsonProperty 
  6.     private Integer age; 
  7.  
  8.     public User(String name, Integer age) { 
  9.         this.nAme = name; 
  10.         this.age = age; 
  11.     } 
  12.  
  13.     public static void main(String[] args) throws IOException { 
  14.         ObjectMapper objectMapper = new ObjectMapper(); 
  15.         String request = objectMapper.writeValueAsString(new User("niu", 18)); 
  16.         System.out.println(request); 
  17.         // {"nAme":"niu","age":18,"name":"niu"} 
  18.     } 

这是因为lombok生成的getter会把属性的第一个字母变成大写,

序列化时会把get后与小写字母中间的大写变成小写,也就是会把NA变成小写

所以序列化结果会有name(getter获取)和nAme(注解获取)两个属性

 
 
 
 
  1. public String getNAme() { 
  2.     return this.nAme; 

如果我们自己用idea快捷键生成getter,

此时之后序列化nAme

 
 
 
 
  1. public String getnAme() { 
  2.     return nAme; 

4小结

许多bug都是在自以为没有问题的地方产生,看似简单,更需要小心,同时也需要多注意序列化原理,整体感觉序列化还是用Gson更省心,完全不用关心Getter和Setter方法,会完全按照属性名来序列化。

本文的涉及的bug过程和解决方式希望对你也有所帮助,再见。

标题名称:一个Getter引发的血案
文章转载:http://www.shufengxianlan.com/qtweb/news26/135726.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联