专栏首页我要变牛一个Getter引发的血案

一个Getter引发的血案

1需求

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

构造Request类

public class User {
    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
}

啪,我上来就一new

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

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

2定位

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

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

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

难道出现灵异事件了?

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

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

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

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

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)
 at com.fasterxml.jackson.databind.exc.InvalidDefinitionException.from(InvalidDefinitionException.java:77)

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

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

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

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

3解决

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

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

public class User {
    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public Integer getAge() {
        return age;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        // 输出正常 : {"name":"niu","age":18}
    }
}

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

public class User {
    public String name;
    public Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        // 输出正常 : {"name":"niu","age":18}
    }
}

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

3、注解 @JsonProperty

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

public class User {
    @JsonProperty("userName")
    private String name;
    @JsonProperty
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        //   {"userName":"niu","age":18}
    }
}

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

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注解,以哪个为准呢?

public class User {
    @JsonProperty("userName")
    private String name;
    @JsonProperty
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        // {"age":18,"userName":"niu"}
    }
}

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

public class User {
    @JsonProperty("userName")
    private String name;
    @JsonProperty
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName2() {
        return name;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        // {"age":18,"name2":"niu","userName":"niu"}
    }
}

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

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

4、特殊情况

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

@Getter
public class User {
    @JsonProperty
    private String nAme;
    @JsonProperty
    private Integer age;

    public User(String name, Integer age) {
        this.nAme = name;
        this.age = age;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper objectMapper = new ObjectMapper();
        String request = objectMapper.writeValueAsString(new User("niu", 18));
        System.out.println(request);
        // {"nAme":"niu","age":18,"name":"niu"}
    }
}

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

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

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

public String getNAme() {
    return this.nAme;
}

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

此时之后序列化nAme

public String getnAme() {
    return nAme;
}

4小结

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

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

本文分享自微信公众号 - 你呀不牛(notNiu),作者:不牛

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2021-07-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 一个 Array.concat 引发的血案

    在之前的 提升 Node.js 服务稳定性,需要关注哪些指标?这篇文章中,我们介绍了服务端稳定性需要关注的一些指标,其中有一个非常重要的指标 Libuv lat...

    JowayYoung
  • jQuery.unique引发一个血案

    项目开发过程中,PM说系统只要在一个特定的浏览器中运行就好,但是在其他的浏览器中不能出现逻辑的错误,所以在开发过程中,前端和后台选择是Chrome浏览器,没有仔...

    八哥
  • 一个MySQL索引引发的血案

    本人在做测试服务的过程中,开发了一个功能,就是从两个库的两张表从查出来一个账号的login_id和user_id,功能非常简单,就是执行sql语句,处理返回结果...

    FunTester
  • 一个空格引发的血案

    系统运维从来就是一个精细化的工作,除了规则与规范的约束之外,运维人员的严谨、谨慎也必不可少,有时候一个简单的错误就会导致一场灾难,小到一个字符,一个空格。 本文...

    数据和云
  • 一个基因引发的血案

    大家好,我是老米,学习生信一个月,这是我的第二篇Markdown。不知道多少人还记得我的第一个作品:原来一个星期真的可以零基础入门TCGA数据挖掘,甚至mark...

    生信技能树
  • [前端]一个空格引发的血案

    是用flex布局,中间是grow等于1,内容是铺满整个container的 但是却出现了这种情况

    Tuzei
  • 一个域名引发的血案……

    6月29日凌晨,无数球迷正放下小龙虾、握紧啤酒杯,屏气凝神观看三狮军团英格兰鏖战欧洲红魔比利时。

    腾讯游戏云
  • 一个Sqrt函数引发的血案

    好吧,我承认我标题党了,不过既然你来了,就认真看下去吧,保证你有收获。 我们平时经常会有一些数据运算的操作,需要调用sqrt,exp,abs等函数,那么时候你...

    范蠡
  • 由一个stack OOM引发的血案

    内存溢出(OOM)了?是啊,明明白白写着“java.lang.OutOfMemoryError”。然而,有没有注意到错误信息里都有关于stack字样?对,这是由...

    望天
  • 一个 Sqrt 函数引发的血案

    我们平时经常会有一些数据运算的操作,需要调用sqrt,exp,abs等函数,那么时候你有没有想过:这个些函数系统是如何实现的?就拿最常用的sqrt函数来说吧,系...

    范蠡
  • MySQL由一个双引号引发的血案

    最近经常碰到开发误删除误更新数据,这不,他们又给我找了个麻烦,我们来看下整个过程。

    Bug开发工程师
  • 一个编译参数引发的血案

    提示:公众号展示代码会自动折行,建议横屏阅读 问题描述 前几天进行测试,发现一个神奇的现象:不加任何优化的版本与加了-O2参数的版本测试结果不一致! 主要代...

    腾讯数据库技术
  • 一个数据精度引发的血案

    最近在做 X 项目的时候用到了弹性搜索引擎 ES(Elasticsearch),在检索遇到了一个诡异的问题,当存储(长)整型数据超过某个值(具体就是百万),就会...

    陈林峰
  • 一个无线网卡引发的血案

            经常听说一个馒头引发血案,今天我要说的是一个无线网卡的故事......

    木子-Lee
  • 一个中文冒号引发的“血案”

    美好的七夕刚刚过了一半,突然收到了同事的 询问,我们线上运行的脚步转换工具突然不能用了,紧急求助。

    flowerdrop
  • 一桩VIM引发的血案

    在使用vim的时候,如果打开的小文件,没啥问题,如果打开的超大类型的文件,那么就会引发巨大的风险,轻则内存使用爆炸,重则引发操作系统oom。

    SRE运维实践
  • 一条SQL引发的“血案”:

    导读:笔者早年间从事了多年开发工作,后因个人兴趣转做数据库。在长期的工作实践中,看到了数据库工作(特别是SQL优化)面临的种种问题。本文通过几个案例探讨一下SQ...

    朱小五
  • 实战|一个表白墙引发的“血案”

    这是一个风和日丽的下午,想着从网上找一套表白网的源码自己进行修改然后讨女友欢心。当我正在GitHub进行搜索翻阅时,一个表白墙的源码映入眼中。我好奇的点开演示网...

    雪痕@
  • MySQL 中一个双引号的错位引发的血案

    最近经常碰到开发误删除误更新数据,这不,他们又给我找了个麻烦,我们来看下整个过程。

    芋道源码

扫码关注云+社区

领取腾讯云代金券