Java利用JSONPath操作JSON数据的方法详解

拾荒的小海螺 2025-04-01 11:01:31编程技术

501

随着互联网技术的飞速发展，数据交换和处理的需求日益增加。JSON(JavaScript Object Notation)作为一种轻量级的数据交换格式，因其易读性和高效性，被广泛应用于各种应用场景中。为了方便地操作 JSON 数据，许多编程语言提供了相应的库和工具。在 Java 中，JSONPath 是一种强大的工具，可以用来查询、修改和操作 JSON 数据。本文将详细介绍如何在 Java 中使用 JSONPath 操作 JSON 数据，并通过具体的示例代码展示其具体用法。无论你是初学者还是有一定经验的开发者，本文都能帮助你快速上手并掌握 JSONPath 的核心功能。

1、简述

JSONPath 是一种强大的工具，用于查询和操作 JSON 数据。类似于 SQL 的语法，它为处理复杂的 JSON 数据结构提供了简单且高效的解决方案。

本文将介绍 JSONPath 的基本语法，并通过详细的 Java 示例展示其实际应用。

2、什么是 JSONPath？

JSONPath 是一种用于 JSON 文档的路径表达式语言，类似于 XPath（用于 XML）。它允许我们：

提取 JSON 中的值
过滤和操作数据
遍历嵌套结构

基本语法规则：

JSONPath 表达式	功能说明
`$`	根对象
`.` 或 `[]`	访问子元素
`*`	通配符，匹配所有元素
`..`	递归搜索
`?()`	过滤表达式
`@`	当前元素

在使用 JSONPath 之前，需要添加其依赖。以下是 JSONPath 的 Maven 依赖：

<dependency>
    <groupId>com.jayway.jsonpath</groupId>
    <artifactId>json-path</artifactId>
    <version>2.8.0</version>
</dependency>

3、Java 示例

在 Java 中，我们可以使用开源库 Jayway JSONPath 来实现 JSONPath 的功能。以下示例 JSON 数据：

{
  "store": {
    "book": [
      { "category": "fiction", "author": "John", "price": 10.99 },
      { "category": "science", "author": "Jane", "price": 12.99 },
      { "category": "fiction", "author": "George", "price": 8.99 }
    ],
    "bicycle": {
      "color": "red",
      "price": 99.99
    }
  }
}

3.1 基本查询

从 JSON 中获取所有书籍的类别。

import com.jayway.jsonpath.JsonPath;
import java.util.List;

public class JSONPathDemo {
    public static void main(String[] args) {
        String json = """
        {
          "store": {
            "book": [
              { "category": "fiction", "author": "John", "price": 10.99 },
              { "category": "science", "author": "Jane", "price": 12.99 },
              { "category": "fiction", "author": "George", "price": 8.99 }
            ]
          }
        }
        """;

        List<String> categories = JsonPath.read(json, "$.store.book[*].category");
        System.out.println("📚书籍类别: " + categories);
    }
}

输出：

书籍类别: [fiction, science, fiction]

3.2 过滤查询

获取价格大于 10 的书籍。

List<Map<String, Object>> expensiveBooks = JsonPath.read(json, "$.store.book[?(@.price > 10)]");
System.out.println("💰价格大于 10 的书籍: " + expensiveBooks);

输出：

价格大于 10 的书籍: [{category=fiction, author=John, price=10.99}, {category=science, author=Jane, price=12.99}]

3.3 递归搜索

获取所有价格字段。

List<Double> prices = JsonPath.read(json, "$.store..price");
System.out.println("💵所有价格: " + prices);

输出：

所有价格: [10.99, 12.99, 8.99, 99.99]

3.4 嵌套查询

获取自行车的颜色。

String color = JsonPath.read(json, "$.store.bicycle.color");
System.out.println("🚲自行车颜色: " + color);

输出：

自行车颜色: red

3.5 结合 POJO 使用

将查询结果映射到 Java 对象中。

import com.fasterxml.jackson.databind.ObjectMapper;

class Book {
    private String category;
    private String author;
    private double price;

    // Getters and Setters
}

List<Book> books = JsonPath.parse(json).read("$.store.book[*]", new TypeRef<List<Book>>() {});
books.forEach(book -> System.out.println("📖书籍: " + book.getCategory() + " by " + book.getAuthor()));

4、高级用法

4.1 动态路径

根据用户输入动态生成 JSONPath 表达式。

String category = "fiction";
String jsonPath = String.format("$.store.book[?(@.category == '%s')]", category);
List<Map<String, Object>> result = JsonPath.read(json, jsonPath);
System.out.println("🔍查询结果: " + result);

4.2 自定义函数

通过扩展 JSONPath 的功能，实现复杂逻辑。

Configuration conf = Configuration.builder()
        .options(Option.DEFAULT_PATH_LEAF_TO_NULL)
        .functions(new CustomFunctions())
        .build();
DocumentContext context = JsonPath.using(conf).parse(json);