同事问我怎么解决使用 fastjson 进行JSON序列时属性部分丢失问题,你能说不会嘛😐

3,127 阅读13分钟

👨‍🎓作者:bug菌
✏️博客:CSDN掘金InfoQ51CTO
🎉简介:CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,掘金 | InfoQ | 51CTO| 腾讯云等社区优质创作者,全网粉丝合计15w+ ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。

🏆本文收录于《Spring Boot从入门到精通》,专门攻坚指数提升,2023 年国内最系统+最强(更新中)。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中…欢迎大家订阅持续学习。

环境说明:Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

1. 前言🔥

        一提到FastJson,就没有不清楚它为何物的,毕竟FastJson出自一位阿里工程师所开源的一款JSON解析器和生成器(反序列化与序列化组件),几乎所有项目都有它的身影,起码我开发过的九点九成项目都有用到它...

        此刻,于是乎很多同学便开始脑补了,作者难道今天就只是为了介绍FastJson组件这种老掉牙的知识点?从而把我们给打发咯?这也太敷衍了吧。否也否也,同学们别心急,bug菌只是抛砖引玉,好戏在后头!其实细心的同学就能发现了, 正如标题所言,如何解决这种序列化时属性会部分丢失问题,今天我要讲的就是带着同学们认识这种问题并如何优雅解决这种bug,

比如如下截图所示:

        像这种带isXxx的属性丢失前缀“is”的bug,如果你们在日常开发过程中遇到,会如何快速并优雅解决呢?

        那么,具体如何实现呢?这将又会是干货满满的一期,全程无尿点不废话只抓重点教,具有非常好的学习效果,拿好小板凳准备就坐!希望学习的过程中大家认真听好好学,学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信,bug菌将第一时间给予解惑,那么废话不多说,直接开整!Fighting!! 

2 . 环境说明🔥

本地的开发环境:

  • 开发工具:IDEA 2021.3
  • JDK版本: JDK 1.8
  • Spring Boot版本:2.3.1 RELEASE
  • Maven版本:3.8.2

3. 复现问题🔥 

        既然把问题给暴露出来了,那么我们肯定是希望能够把它解决了!这也是身为一名合格开发者的基本素养!那么来吧,就让暴风雨来的更猛烈些吧。

如下我定义一个PoJo类,然后把该类的get、set方法、有参无参构造给生成好。示例代码如下:

MessageVo.java

/**
 * 通知消息结构体
 */
public class MessageVo {

    private Integer id;
    private String name;
    private String content;
    private boolean isSolve;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getContent() {
        return content;
    }

    public void setContent(String content) {
        this.content = content;
    }

    public boolean isSolve() {
        return isSolve;
    }

    public void setSolve(boolean isSolve) {
        this.isSolve = isSolve;
    }

    //有参构造
    public MessageVo(Integer id, String name, String content, boolean isSolve) {
        this.id = id;
        this.name = name;
        this.content = content;
        this.isSolve = isSolve;
    }

    //无参构造
    public MessageVo() {
    }

        接着我们直接定义个Test测试类,进行模拟一波,使用FastJson来对此类进行序列化操作,然后将其序列化后字符串进行控制台输出打印,看看会发生一件什么事。

示例代码如下:

    //根据指定name和age组合进行数据查询
    @Test
    public void fastjsonTest() {
        //实例MessageVo对象
        MessageVo messageVo = new MessageVo(1,"张三","缴费记录丢失",true);

        // 使用fastjson序列化对象
        String jsonStr = JSON.toJSONString(messageVo);

        // 输出JSON字符串
        System.out.println(jsonStr);
    }

        同学们可以预言一下,输出的字段名是否会存在问题?可以先用大脑思考一波,我一分钟给你们公布结果!

...

一分钟到了,大家请看,控制台打印内容如下: 

        大家是否会觉得很奇怪啊,怎么打印的json字符串,isSolve字段名会是"solve " 而不是" isSolve "??一脸蒙对吧,其实一开始同事问我我看完她的代码后也表示觉得很假很蒙,不着急,咱们坐下来认真分析一波。

4. 分析问题🔥

        经过一通debug调试,查阅FastJson源码确定问题出现在下面这个方法中:com.alibaba.fastjson.serializer.SerializeConfig 包路径下的createJavaBeanSerializer(Class<?> clazz)方法:如下是源码展示:

 public final ObjectSerializer createJavaBeanSerializer(Class<?> clazz) {

        String className = clazz.getName();
        long hashCode64 = TypeUtils.fnv1a_64(className);
	    if (Arrays.binarySearch(denyClasses, hashCode64) >= 0) {
	        throw new JSONException("not support class : " + className);
        }

        //关键在buildBeanInfo()身上
	    SerializeBeanInfo beanInfo = TypeUtils.buildBeanInfo(clazz, null, propertyNamingStrategy, fieldBased);
	    if (beanInfo.fields.length == 0 && Iterable.class.isAssignableFrom(clazz)) {
	        return MiscCodec.instance;
	    }

	    return createJavaBeanSerializer(beanInfo);
}

        而 buildBeanInfo() 下的关键是 com.alibaba.fastjson.util.TypeUtils 包中的computeGetters()方法,给大家看下源码,你们就会明白了:

    public static List<FieldInfo> computeGetters(Class<?> clazz, //
                                                 JSONType jsonType, //
                                                 Map<String, String> aliasMap, //
                                                 Map<String, Field> fieldCacheMap, //
                                                 boolean sorted, //
                                                 PropertyNamingStrategy propertyNamingStrategy ) {
        // 省略部分代码
        if (methodName.startsWith("is")) {
            if (methodName.length() < 3) {
                continue;
            }
            if (returnType != Boolean.TYPE
                    && returnType != Boolean.class) {
                continue;
            }
            char c2 = methodName.charAt(2);
            String propertyName;
            Field field = null;
            if (Character.isUpperCase(c2)) {
                if (compatibleWithJavaBean) {
                    propertyName = decapitalize(methodName.substring(2));
                } else {
                    propertyName = Character.toLowerCase(methodName.charAt(2)) + methodName.substring(3);
                }
                // 这里 isActive 的属性名被计算出 active
                propertyName = getPropertyNameByCompatibleFieldName(fieldCacheMap, methodName, propertyName, 2);
            }

            // 省略其他

            JSONField fieldAnnotation = null;
            if (field != null) {
                fieldAnnotation = TypeUtils.getAnnotation(field, JSONField.class);
                if (fieldAnnotation != null) {
                    if (!fieldAnnotation.serialize()) {
                        continue;
                    }
                    ordinal = fieldAnnotation.ordinal();
                    serialzeFeatures = SerializerFeature.of(fieldAnnotation.serialzeFeatures());
                    parserFeatures = Feature.of(fieldAnnotation.parseFeatures());
                    if (fieldAnnotation.name().length() != 0) {
                        //关键: 使用 JSONField 注解设置的 name 替代属性名
                        propertyName = fieldAnnotation.name();
                        if (aliasMap != null) {
                            propertyName = aliasMap.get(propertyName);
                            if (propertyName == null) {
                                continue;
                            }
                        }
                    }
                    if (fieldAnnotation.label().length() != 0) {
                        label = fieldAnnotation.label();
                    }
                }
            }


            // 省略部分代码

            FieldInfo fieldInfo = new FieldInfo(propertyName, method, field, clazz, null, ordinal, serialzeFeatures, parserFeatures,
                    annotation, fieldAnnotation, label);
            fieldInfoMap.put(propertyName, fieldInfo);
        }
    }

    Field[] fields = clazz.getFields();
    computeFields(clazz, aliasMap, propertyNamingStrategy, fieldInfoMap, fields);
        return
    getFieldInfos(clazz, sorted, fieldInfoMap);
}

        上段逻辑并不复杂,判断以 'is'开头时,会从'is'后截取作为PropertyName。虽然源码中没有注释解释为何要这么做,但作者理解为这与setter/getter构造原理相似,都是通过规范去反射实现功能。其实Spring框架中依赖注入也有类似的原理。

        这下分析出了问题源头出自其就是JSON序列化时虽然能通过反射反推字段名,但序列化时中源码逻辑的确是由于规范问题,从而造成转为 JSON 字符串时和实际属性名有所偏差。

5. 解决问题🔥

        既然知道问题源头在何方了,那接下展示吧!如何解决它,要求又快又优雅。 

5.1 解决方案1

        既然由于使用FastJSON序列化所导致的部分字段丢失,那么它就考虑了该种情况如何兼容,@JSONField注解 就是一个不错的解决方案。

我们只需要在【isSolve】字段上加上该注解,并指定 key名为【isSolve】即可,代码演示如下:

    @JSONField( name="isSolve") //指定json串中key的名称
    private boolean isSolve;

再次启动测试类。

        查验监控台,我们可以看到,序列化后的json字段与序列化前的字段名一致了,这也是靠@JSONField注解进行别名化的作用。至于@JSONField注解的使用与教程,我会放到文末给大家简单介绍下。

5.2 解决方案2

       由于set get方法是idea自动生成,它会自动将is过滤掉,所以这里我们需要手动定义下带isXss的字段get set方法。如下是isSolve字段手写的get set方法:

    public boolean getIsSolve() {
        return isSolve;
    }

    public void setIsSolve(boolean isSolve) {
        this.isSolve = isSolve;
    }

再次启动test测试类,我们拭目以待。

         看测试类的输出内容,很明显,字段名输出也跟原字段名一致。

5.3 拓展:@JSONField注解

5.3.1 定义

        通过阅读@JSONField注解源码,@Target中的值为 {ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER},说明它可以作用于字段和方法上。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
public @interface JSONField {

   //...
}

5.3.2 作用

        使用 @JSONField 注解可以有作用呢?这里我来给大家简单总结下:

  • 指定field 所对应的key名:例如:@JSONField(name = "user_id")
  • 对于时间字段,可指定其格式:例如: @JSONField(format = "yyyy-MM-dd HH:mm:ss")
  • 不序列化某些字段:@JSONField(serialize = false)
  • 指定顺序:@JSONField(ordinal = 1)
  • 当然,以上注解中的属性,可以同时使用:@JSONField(name = "name", format = "yyyy-MM-dd HH:mm ")

        至于具体的实例演示,这里我后期单独抽一期进行内容的讲解吧,这里就暂不详细解读了。

5.4 小结

        针对使用@JSONField注解可以解决对象isXxx字段丢失问题,但是侵入性太强了,如果有其他人也用到这个类,且用的其他JSON序列化工具不同,就很有可能造成兼容问题了。所以对于这种常见低级问题,在《阿里巴巴 Java 开发手册》中就有明确提到在POJO 类中布尔类型的变量,都不要加 'is',否则部分框架解析会引起序列化错误,如果你有认真阅读过,日常开发中这些常见性问题就能避免了,提高自己的开发效率,这才是王道。

... ...

  ok,以上就是我这期的全部内容啦,如果还想学习更多,你可以看看如下的往期热文推荐哦,每天积累一个奇淫小知识,日积月累下去,你一定能成为令人敬仰的大佬。

「赠人玫瑰,手留余香」,咱们下期拜拜~~

热文推荐

  为了便于同学快速定位文章学习,熬夜几天终于整理出了【基础篇】【进阶篇】专栏的文章及有效地址,同学们敬请吩咐bug菌吧。

  目前基础篇已完结【130】 篇+,进阶篇已完结【80】篇+,两专栏都在持续更新中;生命不息,更新不止,加油卷起来吧,同学们。部分文章总结如下:

🌟Spring Boot【基础篇】

导读:SpringBoot 学习指南(附思维导图)

Spring Boot入门(01):Spring Boot的奋斗成长史

Spring Boot入门(02):快速开发环境搭建和项目启动

Spring Boot入门(03): yaml、properties配置文件介绍及使用

Spring Boot入门(04):多环境切换,实例演示

Spring Boot入门(05):starter基础入门

Spring Boot入门(06):Spring Boot常用注解大全

Spring Boot入门(07):整合 MySQL 和 Druid数据源(两万字教学)

Spring Boot入门(08):整合Mybatis访问MySQL实现增删改查

Spring Boot入门(09):使用MyBatis的XML配置方式访问MySQL实现增删改查

Spring Boot入门(10): mybatis之xml映射文件>、<=等特殊符号写法

Spring Boot入门(11):Spring Boot 整合 JPA

Spring Boot入门(12):整合Mybatis-Plus mybatis-plus实现接口增删改查

Spring Boot入门(13): Mybatis-Plus之条件构造器使用手册

Spring Boot入门(14): mybatis-plus之如何自定义sql

Spring Boot入门(15):Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码

Spring Boot入门(16):Spring Boot整合Swagger-UI实现在线API文档

Spring Boot入门(17):Spring Boot整合Knife4j,美化强化丑陋的Swagger

Spring Boot入门(18):Spring Boot静态资源映射

Spring Boot入门(19):Spring Boot 整合 Thymeleaf 模板引擎,开发Web页面

Spring Boot入门(20):实现多数据源配置,开箱即用

Spring Boot入门(21):整合Log4j2以及配置详解

Spring Boot入门(22):整合LogBack 实现日志文件本地保存

Spring Boot入门(23):Spring Boot基于AOP拦截日志

Spring Boot入门(24):Spring Boot事务

Spring Boot入门(25):过滤器、拦截器、监听器对比及使用场景

Spring Boot入门(26):实现邮件发送简单邮件、附件邮件、嵌入资源(图片)邮件、模板邮件等

Spring Boot入门(27):war包部

Spring Boot入门(28):jar包部署

Spring Boot入门(29):如何实现热部署

Spring Boot入门(30):Windows安装Redis客户端?你玩过么

... ...

若想学习更多,这边请👉👉👉《滚雪球学Spring Boot》👈👈👈

🌟Spring Boot【进阶篇】

Spring Boot进阶(01):Spring Boot 集成 Redis,实现缓存自由

Spring Boot进阶(02):使用Validation进行参数校验

Spring Boot进阶(03):如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04):如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05):Spring Boot 整合RabbitMq,实现消息队列服务

Spring Boot进阶(06):Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07):集成EasyPoi,实现Excel/Word的导入导出

Spring Boot进阶(08):集成EasyPoi,实现Excel/Word携带图片导出

Spring Boot进阶(09):集成EasyPoi,实现Excel文件多sheet导入导出

Spring Boot进阶(10):集成EasyPoi,实现Excel模板导出成PDF文件

Spring Boot进阶(11):Spring Boot 如何实现纯文本转成.csv格式文件?

Spring Boot进阶(12):Spring Boot 如何获取Excel sheet页的数量?

Spring Boot进阶(13):Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值?

Spring Boot进阶(14):Spring Boot 如何手动连接库并获取指定表结构?一文教会你

Spring Boot进阶(15):根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16):Spring Boot 如何通过Redis实现手机号验证码功能?

Spring Boot进阶(17):Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18):SpringBoot如何使用@Scheduled创建定时任务?

Spring Boot进阶(19):Spring Boot 整合ElasticSearch

Spring Boot进阶(20):配置Jetty容器

Spring Boot进阶(21):配置Undertow容器

Spring Boot进阶(22):Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23):实现文件上传

Spring Boot进阶(24):如何快速实现多文件上传?

Spring Boot进阶(25):文件上传的单元测试怎么写?

Spring Boot进阶(26):Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27):Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28):Jar包Linux后台启动部署及滚动日志查看,日志输出至实体文件保存

Spring Boot进阶(29):如何正确使用@PathVariable,@RequestParam、@RequestBody等注解?不会我教你,结合Postman演示

Spring Boot进阶(30):@RestController和@Controller 注解使用区别,实战演示

... ...

  若想学习更多,这边请👉👉👉《SpringBoot 进阶实战》 👈👈👈

  若想系统完整的从0到1的学习,可以参考这篇专栏总结《2023最新首发,全网最全 Spring Boot 学习宝典(附思维导图)》本专栏致力打造最硬核 Spring Boot 进阶系列学习内容,🚀均为全网独家首发,打造精品专栏,专栏持续更新中。欢迎大家订阅持续学习。

  在入门及进阶之途,我必助你一臂之力,系统性学习,从入门到精通,带你不走弯路,直奔终点;投资自己,永远性价比最高,都这么说了,你还不赶紧来学??

本文涉及所有源代码,均已上传至GitHub开源,供同学们一对一参考。

同时,原创开源不易,欢迎给个star🌟,想体验下被🌟的感jio,非常感谢❗

📣关于我


我是bug菌,CSDN | 掘金 | infoQ | 51CTO 等社区博客专家,历届博客之星Top30,掘金年度人气作者Top40,51CTO年度博主Top12,华为云 | 阿里云| 腾讯云等社区优质创作者,全网粉丝合计15w+ ;硬核微信公众号「猿圈奇妙屋」,欢迎你的加入!免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。