程序员scholar
  • Hutoll
  • JSON
scholar
2024-08-20
目录

JSON 数组 - JSONArray

# JSON 数组 - JSONArray

# 简介

在 JSON 中，JSONArray 代表一个数组，使用中括号包围，每个元素使用逗号隔开。通常用于表示有序的集合或列表。一个典型的 JSONArray 示例如下：

["value1", "value2", "value3"]
1

JSONArray 可以存储任意类型的元素（如字符串、数字、布尔值、对象、数组等），并提供了丰富的 API 来操作这些元素。

# 1. JSONArray 的创建

JSONArray 可以通过 JSONUtil.createArray() 或直接使用 new JSONArray() 创建。创建后可以添加元素，并将其转换为字符串输出。

创建 JSONArray 并添加元素

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;

public class JSONArrayExample {
    public static void main(String[] args) {
        // 方法 1：使用 JSONUtil 创建
        JSONArray array1 = JSONUtil.createArray();

        // 方法 2：直接 new 一个 JSONArray
        JSONArray array2 = new JSONArray();

        // 向数组中添加元素
        array1.add("value1");
        array1.add("value2");
        array1.add("value3");

        // 输出 JSON 数组字符串
        System.out.println("JSONArray 字符串: " + array1.toString()); // 输出: ["value1","value2","value3"]

        // 输出格式化的 JSON 数组字符串
        System.out.println("格式化的 JSONArray 字符串:\n" + array1.toStringPretty());
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

  • JSONUtil.createArray()：创建一个空的 JSONArray 对象。

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

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

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

  • add(Object value)：向 JSONArray 中添加元素。

    • value：要添加的元素，可以是任意类型。
    • 返回值：返回添加元素后的 JSONArray。

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

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

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

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

作用： 在需要组织有序数据集合时，JSONArray 是一种非常直观且易于使用的结构。

实际开发场景： 在 RESTful API 开发中，通常需要返回列表形式的数据，此时可以使用 JSONArray 来组织和输出这些数据。

# 2. 从 Bean 列表解析 JSONArray

JSONArray 可以通过解析一个 Bean 列表来创建，其中每个 Bean 的属性将成为 JSON 数组中每个对象的字段。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;
import cn.hutool.core.collection.CollUtil;
import lombok.Data;
import java.util.ArrayList;
import java.util.List;

public class JSONArrayExample {
    public static void main(String[] args) {
        // 定义 Bean
        KeyBean b1 = new KeyBean();
        b1.setAkey("aValue1");
        b1.setBkey("bValue1");

        KeyBean b2 = new KeyBean();
        b2.setAkey("aValue2");
        b2.setBkey("bValue2");

        // 将 Bean 对象存储到列表中
        ArrayList<KeyBean> list = CollUtil.newArrayList(b1, b2);

        // 将 Bean 列表解析为 JSONArray
        JSONArray jsonArray = JSONUtil.parseArray(list);

        // 输出解析后的 JSONArray 字符串
        System.out.println("JSONArray 字符串:\n" + jsonArray.toStringPretty());

        // 获取 JSONArray 中第一个对象的指定字段
        System.out.println("第一个对象的 akey 字段: " + jsonArray.getJSONObject(0).getStr("akey")); // 输出: aValue1
    }
}

@Data
class KeyBean {
    private String akey;
    private String bkey;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
  • JSONUtil.parseArray(Collection<?> collection)：将一个集合解析为 JSONArray。
    • collection：需要解析的集合（如 List、Set 等）。
    • 返回值：返回解析后的 JSONArray。

作用： 用于将对象列表快速转换为 JSON 数组，方便前端解析和展示。

实际开发场景： 在将数据库查询结果或业务对象集合返回给前端时，通常需要将这些对象转换为 JSON 数组格式。

# 3. 从 JSON 字符串解析 JSONArray

JSONArray 可以通过解析 JSON 字符串来创建。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;

public class JSONArrayExample {
    public static void main(String[] args) {
        String jsonStr = "[\"value1\", \"value2\", \"value3\"]";

        // 解析 JSON 字符串为 JSONArray
        JSONArray jsonArray = JSONUtil.parseArray(jsonStr);

        // 输出解析后的 JSONArray
        System.out.println("解析后的 JSONArray: " + jsonArray.toStringPretty());
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  • JSONUtil.parseArray(String jsonStr)：将 JSON 字符串解析为 JSONArray。
    • jsonStr：待解析的 JSON 字符串。
    • 返回值：返回解析后的 JSONArray。

作用： 用于从 JSON 字符串中提取数组数据，便于进一步操作。

实际开发场景： 在接收到前端传递的 JSON 数据时，通常需要将其解析为 JSONArray 以便处理。

# 4. 将 JSONArray 转换为 Bean 的 List

JSONArray 支持将 JSON 数组转换为指定类型的 JavaBean 列表。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;
import lombok.Data;
import java.util.List;

public class JSONArrayExample {
    public static void main(String[] args) {
        String jsonArr = "[{\"id\":111,\"name\":\"test1\"},{\"id\":112,\"name\":\"test2\"}]";

        // 解析 JSON 数组字符串为 JSONArray
        JSONArray array = JSONUtil.parseArray(jsonArr);

        // 将 JSONArray 转换为 List<User>
        List<User> userList = JSONUtil.toList(array, User.class);

        // 输出 List 中第一个对象的 id
        System.out.println("第一个用户的 id: " + userList.get(0).getId()); // 输出: 111
    }
}

@Data
class User {
    private Integer id;
    private String name;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
  • JSONUtil.toList(JSONArray jsonArray, Class<T> elementType)：将 JSONArray 转换为指定类型的 List。
    • jsonArray：待转换的 JSONArray。
    • elementType：目标元素的类型（如 User.class）。
    • 返回值：返回转换后的 List。

作用： 用于将 JSON 数组映射为 JavaBean 列表，便于在业务逻辑中处理数据。

实际开发场景： 在前后端分离的项目中，接收到的 JSON 数据通常需要映射到业务对象中以便进一步操作。

# 5. 将 JSONArray 转换为 Dict 的 List

Dict 是 Hutool 定义的特殊 Map，提供了以字符串为 key 的 Map 功能，并支持 getXXX 方法获取数据。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;
import cn.hutool.core.lang.Dict;
import java.util.List;

public class JSONArrayExample {
    public static void main(String[] args) {
        String jsonArr = "[{\"id\":111,\"name\":\"test1\"},{\"id\":112,\"name\":\"test2\"}]";

        // 解析 JSON 数组字符串为 JSONArray
        JSONArray array = JSONUtil.parseArray(jsonArr);

        // 将 JSONArray 转换为 List<Dict>
        List<Dict> list = JSONUtil.toList(array, Dict.class);

        // 输出 List 中第一个对象的 id
        System.out.println("第一个对象的 id: " + list.get(0).getInt("id")); // 输出: 111
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
  • JSONUtil.toList(JSONArray jsonArray, Class<T> elementType)：将 JSONArray 转换为指定类型的 List。
    • jsonArray：待转换的 JSONArray。
    • elementType：目标元素的类型（如 Dict.class）。
    • 返回值：返回转换后的 List。

作用： 在需要灵活处理 JSON 数据时，可以将其转换为 Dict 以便根据 key 快速获取值。

实际开发场景： 在处理不确定结构或动态字段的 JSON 数据

时，使用 Dict 提供了更灵活的数据访问方式。

# 6. 将 JSONArray 转换为数组

JSONArray 支持直接转换为指定类型的数组，方便在操作固定类型数据时使用。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;
import lombok.Data;

public class JSONArrayExample {
    public static void main(String[] args) {
        String jsonArr = "[{\"id\":111,\"name\":\"test1\"},{\"id\":112,\"name\":\"test2\"}]";

        // 解析 JSON 数组字符串为 JSONArray
        JSONArray array = JSONUtil.parseArray(jsonArr);

        // 将 JSONArray 转换为 User 数组
        User[] userArray = array.toArray(new User[0]);

        // 输出数组中第一个用户的 id
        System.out.println("第一个用户的 id: " + userArray[0].getId()); // 输出: 111
    }
}

@Data
class User {
    private Integer id;
    private String name;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
  • toArray(T[] array)：将 JSONArray 转换为指定类型的数组。
    • array：目标数组，通常传入 new T[0]。
    • 返回值：返回转换后的数组。

作用： 当需要将 JSON 数据直接转换为固定类型数组时，可以使用该方法简化操作。

实际开发场景： 在需要处理批量数据或固定长度的数据集时，通常会将其转换为数组来进行操作。

# 7. 使用 JSON 路径获取嵌套数据

当 JSON 数据层级较深时，使用传统方式获取值会使代码变得臃肿。Hutool 提供了 getByPath 方法，支持通过路径表达式快速获取值。

import cn.hutool.json.JSONUtil;
import cn.hutool.json.JSONArray;

public class JSONArrayExample {
    public static void main(String[] args) {
        String jsonStr = "[{\"id\": \"1\",\"name\": \"a\"},{\"id\": \"2\",\"name\": \"b\"}]";

        // 解析 JSON 字符串为 JSONArray
        JSONArray jsonArray = JSONUtil.parseArray(jsonStr);

        // 使用路径表达式获取第二个对象的 name 字段
        String name = jsonArray.getByPath("[1].name").toString();
        System.out.println("第二个对象的 name 字段: " + name); // 输出: b
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  • getByPath(String expression)：通过路径表达式获取 JSON 数据中的值。
    • expression：路径表达式，如 [1].name。
    • 返回值：返回获取的值（Object 类型）。

作用： 在处理层级较深或结构复杂的 JSON 数据时，可以简化数据提取过程。

实际开发场景： 在解析复杂嵌套的 JSON 数据时，通过路径表达式可以快速获取目标值，减少代码量。

编辑此页 (opens new window)
上次更新: 2024/12/28, 18:32:08
JSON 对象 - `JSONObject`
加密解密工具 - `SecureUtil`

← 加密解密工具 - `SecureUtil`→

Theme by Vdoing | Copyright © 2019-2025 程序员scholar