使用低版本Jackson 2的类级@JsonInclude包含策略的bug

本文出处:http://blog.csdn.net/chaijunkun/article/details/45110623,转载请注明。由于本人不定期会整理相关博文,会对相应内容作出完善。因此强烈建议在原始出处查看此文。


Jackson是Java语言中非常好用的对象与JSON相互转换的工具。然而本人的一次使用过程中发现了其老版本在某些情况下没有按照我们既定的序列化策略来生成JSON。本文将以使用过程中的例子来说明这一问题并给出相应的解决方法。

首先例子中要实现的功能是将对象转换为JSON时(序列化过程),如果对象的某个属性值为null,则该属性不参与序列化,生成的JSON结果也不会包含该属性。

如果你使用过Jackson,尤其是Jackson 2,就知道这样一个功能可以通过设置ObjectMapper对象的SerializationInclusion策略来实现:

[java] view plain copy
  1. ObjectMappermapper=newObjectMapper();
  2. mapper.setSerializationInclusion(Include.NON_NULL);

然而巧合的是,将要被序列化的对象其中有一个字段需要使用特别的序列化方式,先来看一下这个类的定义:

    /**
  1. *动物bean
  2. *@authorchaijunkun
  3. *@since2015年4月18日
  4. */
  5. //此类级注解暂时不启用,待文中提到时再启用
  6. //@JsonInclude(Include.NON_NULL)
  7. publicclassAnimal{
  8. /**名称*/
  9. privateStringname;
  10. /**性别*/
  11. @JsonSerialize(using=BooleanSerializer.class)
  12. privateBooleansex;
  13. //gettersandsetters
  14. }
在Jackson中,对于Boolean类型的sex属性,序列化结果为{"sex":true}或者{"sex":false}。但我希望当sex为true时,序列化结果为1,否则为0,即{"sex":1}或者{"sex":0}。这就需要自定义一个Boolean类型的序列化器来解决:

    *自定义布尔序列化器
  1. classBooleanSerializerextendsJsonSerializer<Boolean>{
  2. @Override
  3. voidserialize(Booleanvalue,JsonGeneratorjgen,SerializerProviderprovider)throwsIOException,JsonProcessingException{
  4. if(Boolean.FALSE.equals(value)){
  5. jgen.writeNumber(0);
  6. }else{
  7. 1);
  8. }
  9. }
  10. 为了验证可用性,编写了如下的单元测试:

    classJacksonTest{
  1. privatestaticfinalLoggerlogger=LoggerFactory.getLogger(JacksonTest.class);
  2. @Test
  3. voiddoTest()throwsIOException{
  4. ObjectMappermapper= mapper.setSerializationInclusion(Include.NON_NULL);
  5. StringWritersw=null;
  6. Stringjson=null;
  7. try{
  8. Animalanimal=newAnimal();
  9. //代码块:1,设置name和sex属性
  10. {
  11. animal.setName("dog");
  12. animal.setSex(true);
  13. //代码块:2,只设置name属性
  14. {
  15. animal.setName("dog");
  16. //代码块:3,什么也不设置
  17. {}
  18. sw=newStringWriter();
  19. JsonGeneratorgenerator=mapper.getFactory().createGenerator(sw);
  20. generator.writeObject(animal);
  21. json=sw.toString();
  22. generator.close();
  23. finally{
  24. IOUtils.closeQuietly(sw);
  25. logger.info(json);
  26. 首先把代码块2和3都屏蔽掉,保留代码块1,运行结果为:

    [plain]
      {"name":"dog","sex":1}
    结果看起来挺正常的。现在单独启用代码块2、代码块3,分别得到的结果为:

    1. {"sex":null}

    问题出现了,之前不是设置了默认的序列化策略,空属性不参与序列化吗?为何sex字段还是输出null了?原因在于我们对sex字段使用了@JsonSerializer注解。经过查看源码发现,该注解除了using参数外,还有一个include参数,该参数可以不设置,但是隐含的默认值为Inclusion.ALWAYS,也就是说该属性总是参与序列化。那么有没有办法屏蔽掉它呢?可以通过显式设置注解中include参数为Inclusion.NON_NULL来实现,不过在Jackson 2中已经不推荐这种使用方法,而是推荐在属性上增加@JsonInclude(Include.NON_NULL)注解来实现。

    @JsonInclude(Include.NON_NULL)注解固然好用,但是每一个属性上都标注上这样一个注解很累,有没有更好的实践呢?当然有,它支持类级注解,只要将它写在类定义上即可实现所有属性为null时都不参与序列化。OK,问题来了,类级注解到底好不好用呢?还是那个单元测试,只启用代码块2,来看下运行结果:

    坑爹啦!居然没起作用!空的sex字段仍然输出了。来看下我使用的Jackson 2版本

    [html]
      <dependency>
    1. groupId>com.fasterxml.jackson.core</>
    2. artifactId>jackson-databindversion>2.1.0>
    是一个相对老的版本,在http://mvnrepository.com/上看到有版本更新,目前的最新版本是2.5.2,遂更新了下试试,果然问题解决了,单独运行代码块2后的输出结果:

      {"name":"dog"}

    后来经过反复测试,能够支持@JsonInclude注解类级使用的最低版本为2.3.0-rc1,当然如果不考虑候选版本的话,正式版的最低要求为2.3.0。所以,赶快升级你的Jackson 2依赖吧!

    版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

    相关推荐


    文章浏览阅读2.4k次。最近要优化cesium里的热力图效果,浏览了网络上的各种方法,发现大多是贴在影像上的。这么做好是好,但是会被自生添加的模型或者其他数据给遮盖。其次是网上的方法大多数是截取成一个矩形。不能自定义的截取自己所需要的。经过尝试,决定修改下cesium heatmap,让他达到我们需要的要求。首先先下载 cesium heatmap包。其中我们可以看到也是通过叠加entity达到添加canvas的方法绘制到地图上。我们先把这一段代码注释} else {} };
    文章浏览阅读1.2w次,点赞3次,收藏19次。在 Python中读取 json文件也可以使用 sort ()函数,在这里我介绍一个简单的示例程序: (4)如果我们想将字符串转换为列表形式,只需要添加一个变量来存储需要转换的字符串即可。在上面的代码中,我们创建了一个名为` read`的对象,然后在文件的开头使用`./`关键字来命名该对象,并在文件中定义了一个名为` json`的变量,并在其中定义了一个名为` json`的字段。比如,我们可以使用 read方法读取 json文件中的内容,然后使用 send方法将其发送到 json文件中。_python怎么读取json文件
    文章浏览阅读1.4k次。首字母缩略词 API 代表应用程序编程接口,它是一种设备,例如用于使用编程代码发送和检索数据的服务器。最常见的是,该技术用于从源检索数据并将其显示给软件应用程序及其用户。当您访问网页时,API 的工作方式与浏览器相同,信息请求会发送到服务器,如何在 Windows PC 中手动创建系统还原点服务器会做出响应。唯一的区别是服务器响应的数据类型,对于 API,数据是 JSON 类型。JSON 代表 JavaScript Object Notation,它是大多数软件语言中 API 的标准数据表示法。_api是什么 python
    文章浏览阅读802次,点赞10次,收藏10次。解决一个JSON反序列化问题-空字符串变为空集合_cannot coerce empty string ("") to element of `java.util.arraylist
    文章浏览阅读882次。Unity Json和Xml的序列化和反序列化_unity json反序列化存储换行
    文章浏览阅读796次。reader.readAsText(data.file)中data.file的数据格式为。使用FileReader对象读取文件内容,最后将文件内容进行处理使用。_a-upload 同时支持文件和文件夹
    文章浏览阅读775次,点赞19次,收藏10次。fastjson是由国内的阿里推出的一种json处理器,由java语言编写,无依赖,不需要引用额外的jar包,能直接运行在jdk环境中,它的解析速度是非常之快的,目前超过了所有json库。提示:以下是引用fastjson的方法,数据未涉及到私密信息。_解析器用fastjson还是jackson
    文章浏览阅读940次。【Qt之JSON文件】QJsonDocument、QJsonObject、QJsonArray等类介绍及使用_使用什么方法检查qjsondocument是否为空
    文章浏览阅读957次,点赞34次,收藏22次。主要内容原生 ajax重点重点JSON熟悉章节目标掌握原生 ajax掌握jQuery ajax掌握JSON第一节 ajax1. 什么是ajaxAJAX 全称为,表示异步的Java脚本和Xml文件,是一种异步刷新技术。2. 为什么要使用ajaxServlet进行网页的变更往往是通过请求转发或者是重定向来完成,这样的操作更新的是整个网页,如果我们只需要更新网页的局部内容,就需要使用到AJAX来处理了。因为只是更新局部内容,因此,Servlet。
    文章浏览阅读1.4k次,点赞45次,收藏13次。主要介绍了JsonFormat与@DateTimeFormat注解实例解析,文中通过示例代码介绍的非常详细,对大家的学习 或者工作具有一定的参考学习价值,需要的朋友可以参考下 这篇文章主要介绍了从数据库获取时间传到前端进行展示的时候,我们有时候可能无法得到一个满意的时间格式的时间日期,在数据库中显 示的是正确的时间格式,获取出来却变成了时间戳,@JsonFormat注解很好的解决了这个问题,我们通过使用 @JsonFormat可以很好的解决:后台到前台时间格式保持一致的问题,
    文章浏览阅读1k次。JsonDeserialize:json反序列化注解,作用于setter()方法,将json数据反序列化为java对象。可以理解为用在处理接收的数据上。_jsondeserialize
    文章浏览阅读2.7k次。labelme标注的json文件是在数据标注时产生,不能直接应用于模型训练。各大目标检测训练平台或项目框架均有自己的数据格式要求,通常为voc、coco或yolo格式。由于yolov8项目比较火热,故此本博文详细介绍将json格式标注转化为yolo格式的过程及其代码。_labelme json 转 yolo
    文章浏览阅读790次,点赞26次,收藏6次。GROUP_CONCAT_UNORDERED(): 与GROUP_CONCAT类似,但不保证结果的顺序。COUNT_DISTINCT_AND_ORDERED(): 计算指定列的不同值的数量,并保持结果的顺序。COUNT_ALL_DISTINCT(): 计算指定列的所有不同值的数量(包括NULL)。AVG_RANGE(): 计算指定列的最大值和最小值之间的差异的平均值。JSON_OBJECT(): 将结果集中的行转换为JSON对象。COUNT_DISTINCT(): 计算指定列的不同值的数量。_mysql json 聚合
    文章浏览阅读1.2k次。ajax同步与异步,json-serve的安装与使用,node.js的下载_json-serve 与node版本
    文章浏览阅读1.7k次。`.net core`提供了Json处理模块,在命名空间`System.Text.Json`中,下面通过顶级语句,对C#的Json功能进行讲解。_c# json
    文章浏览阅读2.8k次。主要介绍了python对于json文件的读写操作内容_python读取json文件
    文章浏览阅读770次。然而,有时候在处理包含中文字符的Json数据时会出现乱码的情况。本文将介绍一种解决Json中文乱码问题的常见方法,并提供相应的源代码和描述。而某些情况下,中文字符可能会被错误地编码或解码,导致乱码的出现。通过适当地控制编码和解码过程,我们可以有效地处理包含中文字符的Json数据,避免乱码的发生。通过控制编码和解码过程,我们可以确保Json数据中的中文字符能够正确地传输和解析。为了解决这个问题,我们可以使用C#的System.Text.Encoding类提供的方法进行编码和解码的控制。_c# json 中文编码
    文章浏览阅读997次。【代码】【工具】XML和JSON互相转换。_xml 转json
    文章浏览阅读1.1k次。json path 提取数据_jsonpath数组取值
    文章浏览阅读3w次,点赞35次,收藏36次。本文主要介绍了pandas read_json时ValueError: Expected object or value的解决方案,希望能对学习python的同学们有所帮助。文章目录1. 问题描述2. 解决方案_valueerror: expected object or value