设置Json序列化时字段的顺序

这篇具有很好参考价值的文章主要介绍了设置Json序列化时字段的顺序。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1. 背景

在部分使用场景(如元数据驱动,后台接口仅返回序列化后的json字符串,前端需要根据每个字段在前端呈现),需要手动设置字段的长度。通常情况下,框架是有默认的顺序,如 jackson 默认使用字段声明的顺序, fastjson 默认是使用字典序。在这种业务场景下,就需要我们可以手动指定序列化后字段的顺序。

这里分别使用 jackson 和 fastjson 两种框架。

2. 使用 jackson

使用注解 @JsonPropertyOrder 声明具体的字段顺序。如 @JsonPropertyOrder({"city", "age", "name"}) 。具体参考实例程序。

pom依赖:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.14.3</version>
</dependency>

Java 验证程序:

package com.ysx.utils.json.jackson;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.Getter;
import lombok.Setter;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

/**
 * @author youngbear
 * @email youngbear@aliyun.com
 * @date 2023-10-15 22:15
 * @blog <a href="https://blog.csdn.net/next_second">...</a>
 * @github <a href="https://github.com/YoungBear">...</a>
 * @description
 */
@DisplayName("使用jackson设置序列化时字段的顺序")
public class JsonFieldOrderTest {
    @Test
    @DisplayName("默认顺序:字段声明的顺序")
    public void defaultOrderTest() throws JsonProcessingException {
        Student1 student = new Student1();
        student.setName("John");
        student.setAge(25);
        student.setCity("Beijing");
        ObjectMapper objectMapper = new ObjectMapper();
        String json = objectMapper.writeValueAsString(student);
        // {"name":"John","age":25,"city":"Beijing"}
        Assertions.assertEquals("{\"name\":\"John\",\"age\":25,\"city\":\"Beijing\"}", json);
    }

    @Test
    @DisplayName("使用@JsonPropertyOrder指定顺序")
    public void userJsonPropertyOrderTest() throws JsonProcessingException {
        Student2 student = new Student2();
        student.setName("John");
        student.setAge(25);
        student.setCity("Beijing");
        ObjectMapper objectMapper = new ObjectMapper();
        String json = objectMapper.writeValueAsString(student);
        // {"city":"Beijing","age":25,"name":"John"}
        Assertions.assertEquals("{\"city\":\"Beijing\",\"age\":25,\"name\":\"John\"}", json);
    }

    @Getter
    @Setter
    public static class Student1 {
        private String name;
        private Integer age;
        private String city;
    }

    @Getter
    @Setter
    @JsonPropertyOrder({"city", "age", "name"})
    public static class Student2 {
        private String name;
        private Integer age;
        private String city;
    }
}

3. 使用 fastjson

有两种方法,

  • 使用 @JsonField 的 ordinal 指定顺序,数越小优先级越高,默认为0。
  • 使用@JSONType的orders属性指定字段顺序

详细参考实例程序:

pom依赖:

<!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>2.0.41</version>
</dependency>

程序:文章来源地址https://www.toymoban.com/news/detail-725119.html

package com.ysx.utils.json.fastjson;

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.annotation.JSONField;
import com.alibaba.fastjson2.annotation.JSONType;
import lombok.Getter;
import lombok.Setter;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;


/**
 * @author youngbear
 * @email youngbear@aliyun.com
 * @date 2023-10-15 21:28
 * @blog <a href="https://blog.csdn.net/next_second">...</a>
 * @github <a href="https://github.com/YoungBear">...</a>
 * @description
 */
@DisplayName("使用fastjson设置序列化时字段的顺序")
public class JsonFieldOrderTest {

    @Test
    @DisplayName("默认顺序:字典序")
    public void defaultOrderTest() {
        Student1 student = new Student1();
        student.setName("John");
        student.setAge(25);
        student.setCity("Beijing");
        String json = JSON.toJSONString(student);
        // {"age":25,"city":"Beijing","name":"John"}
        Assertions.assertEquals("{\"age\":25,\"city\":\"Beijing\",\"name\":\"John\"}", json);
    }

    @Test
    @DisplayName("使用@JsonField的ordinal指定顺序,数越小优先级越高,默认为0")
    public void userJsonFieldOrdinalTest() {
        Student2 student = new Student2();
        student.setName("John");
        student.setAge(25);
        student.setCity("Beijing");
        String json = JSON.toJSONString(student);
        // {"name":"John","age":25,"city":"Beijing"}
        Assertions.assertEquals("{\"name\":\"John\",\"age\":25,\"city\":\"Beijing\"}", json);
    }

    @Test
    @DisplayName("使用@JSONType的orders属性指定字段顺序")
    public void userJsonPropertyOrderTest() {
        Student3 student = new Student3();
        student.setName("John");
        student.setAge(25);
        student.setCity("Beijing");
        String json = JSON.toJSONString(student);
        // {"name":"John","age":25,"city":"Beijing"}
        Assertions.assertEquals("{\"name\":\"John\",\"age\":25,\"city\":\"Beijing\"}", json);
    }

    @Getter
    @Setter
    public static class Student1 {
        private String name;
        private Integer age;
        private String city;
    }

    @Getter
    @Setter
    public static class Student2 {
        @JSONField(ordinal = 1)
        private String name;
        @JSONField(ordinal = 2)
        private Integer age;
        @JSONField(ordinal = 3)
        private String city;
    }

    @Getter
    @Setter
    @JSONType(orders = {"name", "age", "city"})
    public static class Student3 {
        private String name;
        private Integer age;
        private String city;
    }
}

源代码github地址

到了这里,关于设置Json序列化时字段的顺序的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • nlohmann::json 超简单序列化反序列化

    2024年01月20日
    浏览(40)
  • iOS处理json,序列化和反序列化

    Mantle 是一个开源的 Objective-C 框架,用于在 iOS 和 macOS 应用程序中实现模型层的序列化和反序列化。它提供了一种简单而强大的方式来将 JSON数据格式转换为自定义的数据模型对象,以及将数据模型对象转换为字典或 JSON 格式。 Mantle具有如下特点 自动映射 Mantle自动将 JSON 数据

    2024年02月11日
    浏览(63)
  • c#示例-json序列化和json树

    由于指针和引用类型的存在,在运行中的程序中,数据不一定是整块的。 可能东一块西一块散落在内存的各个地方。 序列,是指连续且有序的一个整体。序列化就是把数据变为连续有序整体的过程。 经过这样处理后的数据就可以方便的进行传输和储存了。 json是一种文本数

    2024年02月16日
    浏览(80)
  • rust学习-json的序列化和反序列化

    由于 serde 库默认使用 JSON 格式进行序列化和反序列化 因此程序将使用 JSON 格式对数据进行序列化和反序列化 JSON:广泛使用的 JavaScript 对象符号,用于许多 HTTP API Postcard:no_std 和嵌入式系统友好的紧凑二进制格式。 CBOR:用于小消息大小且无需版本协商的简洁二进制对象表示

    2024年02月12日
    浏览(40)
  • 【网络编程】协议定制+Json序列化与反序列化

    需要云服务器等云产品来学习Linux的同学可以移步/--腾讯云--/--阿里云--/--华为云--/官网,轻量型云服务器低至112元/年,新用户首次下单享超低折扣。   目录 一、序列化与反序列化的概念 二、自定义协议设计一个网络计算器 2.1TCP协议,如何保证接收方收到了完整的报文呢?

    2024年02月06日
    浏览(56)
  • 使用nlohmann json库进行序列化与反序列化

    nlohmann源码仓库:https://github.com/nlohmann/json 使用方式:将其nlohmann文件夹加入,包含其头文件json.hpp即可 demo

    2024年02月10日
    浏览(40)
  • 【网络】协议的定制与Json序列化和反序列化

    我们程序员写的一个个解决我们实际问题, 满足我们日常需求的网络程序, 都是在应用层 建立链接和断开链接 基于TCP协议,我们需要知道写代码时对应的接口大概在TCP通讯的过程中属于什么样的时间点角色,在TCP协议时详谈。三次握手,四次挥手 listen状态:准备好了,可以进

    2024年02月09日
    浏览(41)
  • JSON序列化与反序列化NULL值丢失问题

    做项目一般都会有一些特殊的需求,例如保留json中的null值,但是fastjson都会把null值得属性给过滤掉 json序列化保留null值 json反序列化保留null值 使用hutool的Json工具时

    2024年02月15日
    浏览(70)
  • delphi JSON序列化(四)

    涉及的重要类 REST.Json,REST.JsonReflect,REST.Json.Interceptors, REST.Json.Types单元中。 一、TJson类 最简单的一个类,提供了JSON - OBJECT和OBJECT - JSON几个方法,方法有TJsonOptions参数,如:     class function ObjectToJsonObject(AObject: TObject; AOptions: TJsonOptions = CDefaultOptions): TJSONObject; TJsonOptions主要

    2024年02月03日
    浏览(35)
  • delphi JSON序列化(五)

    关于TJSONConverters的使用 结果: {\\\"value\\\":\\\"haha\\\",\\\"createTime\\\":\\\"2024-01-10T17:15:33.588Z\\\"} 注:REST. XXX单元的序列化类感觉不好用, 想把TObjectListTPerson序列化没有好的切处点。

    2024年02月03日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包