JSON 对象 - JSONObject

简介

JSONObject 代表了一个 JSON 格式中的键值对象。该对象使用大括号包围，每个键值对使用逗号隔开，键与值之间使用冒号分隔。例如：

{
  "key1": "value1",
  "key2": "value2"
}

其中，键部分可以省略双引号，而值为字符串时不能省略双引号。如果值为数字或布尔值，则无需加上双引号。

1. JSONObject 的创建

JSONUtil.createObj() 是一个快捷创建 JSONObject 的工具方法，也可以直接使用 new JSONObject() 创建。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONObject;

public class JSONObjectExample {
    public static void main(String[] args) {
        // 使用 JSONUtil.createObj() 创建 JSONObject
        JSONObject json1 = JSONUtil.createObj()
            .put("a", "value1")
            .put("b", "value2")
            .put("c", "value3");

        System.out.println("使用 JSONUtil 创建的 JSONObject: " + json1);

        // 使用 new 方式创建 JSONObject
        JSONObject json2 = new JSONObject();
        json2.put("a", "value1");
        json2.put("b", "value2");
        json2.put("c", "value3");

        System.out.println("使用 new 方式创建的 JSONObject: " + json2);
    }
}

• JSONUtil.createObj()：快捷创建 JSONObject 的工具方法。

  • 返回值：返回一个新的空 JSONObject。

• new JSONObject()：手动创建一个新的 JSONObject 实例。

作用： 用于在代码中快速创建 JSON 对象，可以根据需要动态添加键值对。

实际开发场景： 在处理接口返回数据或构建请求参数时，常需要创建 JSON 对象来组织数据。

2. JSONObject 的转换

JSONObject 可以通过解析 JSON 字符串或者 JavaBean 来创建。也可以将 JSONObject 转换为字符串，支持一行输出和格式化输出。

JSON 字符串与 JSONObject 的相互转换

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONObject;

public class JSONObjectExample {
    public static void main(String[] args) {
        String jsonStr = "{\"b\":\"value2\",\"c\":\"value3\",\"a\":\"value1\"}";

        // 方法一：使用 JSONUtil 转换
        JSONObject jsonObject1 = JSONUtil.parseObj(jsonStr);

        // 方法二：使用 new JSONObject() 转换
        JSONObject jsonObject2 = new JSONObject(jsonStr);

        System.out.println("使用 JSONUtil 转换的 JSONObject: " + jsonObject1);
        System.out.println("使用 new 方式转换的 JSONObject: " + jsonObject2);

        // 将 JSONObject 转换为 JSON 字符串
        String jsonString = jsonObject1.toString();
        System.out.println("JSON 字符串（一行输出）: " + jsonString);

        // 格式化输出 JSON 字符串
        String prettyJsonString = jsonObject1.toStringPretty();
        System.out.println("格式化输出的 JSON 字符串:\n" + prettyJsonString);
    }
}

• JSONUtil.parseObj(String jsonStr)：将 JSON 字符串解析为 JSONObject。

  • jsonStr：待解析的 JSON 字符串。
  • 返回值：返回解析后的 JSONObject 对象。

• new JSONObject(String jsonStr)：使用构造方法直接将 JSON 字符串解析为 JSONObject。

  • jsonStr：待解析的 JSON 字符串。
  • 返回值：返回解析后的 JSONObject 对象。

• toString()：将 JSONObject 转换为 JSON 字符串，一行输出。

  • 返回值：返回 JSON 字符串。

• toStringPretty()：将 JSONObject 转换为格式化的 JSON 字符串，带缩进输出。

  • 返回值：返回格式化后的 JSON 字符串。

作用： 用于 JSON 字符串与 JSONObject 之间的转换，方便处理和显示数据。

实际开发场景： 在接收接口请求、处理 JSON 数据时，通常需要将字符串转换为 JSONObject 以便提取数据。格式化输出有助于调试和日志输出。

3. JavaBean 与 JSONObject 的转换

JSONObject 可以通过解析 JavaBean 来创建，支持转换为有序输出并自定义日期格式。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONObject;
import lombok.Data;
import java.util.Date;
import java.util.List;
import cn.hutool.core.collection.CollectionUtil;

public class JSONObjectExample {
    public static void main(String[] args) {
        // 创建 JavaBean 实例
        UserA userA = new UserA();
        userA.setName("nameTest");
        userA.setDate(new Date());
        userA.setSqs(CollectionUtil.newArrayList(new Seq(null), new Seq("seq2")));

        // 默认解析为 JSONObject（不跳过空值）
        JSONObject jsonObject = JSONUtil.parseObj(userA, false);
        System.out.println("默认解析为的 JSONObject:\n" + jsonObject.toStringPretty());

        // 保持字段顺序解析
        JSONObject orderedJsonObject = JSONUtil.parseObj(userA, false, true);
        System.out.println("保持字段顺序解析的 JSONObject:\n" + orderedJsonObject.toStringPretty());

        // 设置日期格式
        orderedJsonObject.setDateFormat("yyyy-MM-dd HH:mm:ss");
        System.out.println("自定义日期格式的 JSONObject:\n" + orderedJsonObject.toStringPretty());
    }
}

@Data
class UserA {
    private String name;
    private String a;
    private Date date;
    private List<Seq> sqs;
}

@Data
class Seq {
    private String seq;

    public Seq(String seq) {
        this.seq = seq;
    }
}

• JSONUtil.parseObj(Object bean, boolean ignoreNullValue)：将 JavaBean 转换为 JSONObject，可以选择是否跳过空值。

  • bean：需要转换的 JavaBean。
  • ignoreNullValue：是否跳过空值（true 跳过，false 不跳过）。
  • 返回值：返回转换后的 JSONObject。

• JSONUtil.parseObj(Object bean, boolean ignoreNullValue, boolean order)：将 JavaBean 转换为有序的 JSONObject，可以选择是否跳过空值和保持字段顺序。

  • bean：需要转换的 JavaBean。
  • ignoreNullValue：是否跳过空值。
  • order：是否保持字段顺序（true 保持）。
  • 返回值：返回转换后的有序 JSONObject。

• setDateFormat(String dateFormat)：设置 JSONObject 输出的日期格式。

  • dateFormat：日期格式字符串（如 "yyyy-MM-dd HH:mm:ss"）。
  • 返回值：返回设置后的 JSONObject。

作用： 用于将 JavaBean 转换为 JSON 对象，便于将业务数据序列化为 JSON 输出或存储。

实际开发场景： 在处理 RESTful API 返回数据时，通常需要将业务对象转换为 JSON 格式，同时保持字段顺序和自定义日期格式。

4. 常见的 JSON 操作方法

• getStr(String key)：获取指定键的字符串值。
• getInt(String key)：获取指定键的整型值。
• getDate(String key)：获取指定键的日期值。