SpringBoot使用JSONPath實(shí)現(xiàn)高效處理JSON數(shù)據(jù)

更新時(shí)間：2026年01月15日 11:51:52 作者：風(fēng)象南

在日常開發(fā)中,我們經(jīng)常需要處理 JSON 數(shù)據(jù),特別是從復(fù)雜的 JSON 結(jié)構(gòu)中提取特定字段,下面我們就來看看如何使用SpringBoot和JSONPath實(shí)現(xiàn)處理JSON數(shù)據(jù)吧

前言

在日常開發(fā)中，我們經(jīng)常需要處理 JSON 數(shù)據(jù)，特別是從復(fù)雜的 JSON 結(jié)構(gòu)中提取特定字段。傳統(tǒng)的處理方式如 Gson、Jackson 的 API 雖然功能強(qiáng)大，但在處理復(fù)雜路徑提取時(shí)代碼往往顯得冗長且不易維護(hù)。

今天給大家介紹一個(gè)更優(yōu)雅的解決方案 —— JSONPath，它就像 JSON 界的 XPath，讓我們可以用簡潔的路徑表達(dá)式來定位和提取 JSON 數(shù)據(jù)。

什么是 JSONPath

JSONPath 是一種用于從 JSON 文檔中提取特定數(shù)據(jù)的查詢語言。它的語法簡潔直觀，類似于 JavaScript 對(duì)象屬性的訪問方式。

常用 JSONPath 語法

表達(dá)式	說明
$	根節(jié)點(diǎn)
@	當(dāng)前節(jié)點(diǎn)
. 或 []	子節(jié)點(diǎn)操作符
..	遞歸下降（任意深度）
*	通配符，匹配所有成員/元素
[]	下標(biāo)運(yùn)算符
[start:end]	數(shù)組切片
[?()]	過濾表達(dá)式

Spring Boot 集成 JSONPath

1. 添加依賴

在 pom.xml 中添加 JSONPath 依賴：

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

2. 基礎(chǔ)使用示例

首先準(zhǔn)備一個(gè) JSON 示例：

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  }
}

讀取數(shù)據(jù)

import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.PathNotFoundException;

public class JsonPathExample {

    private String json = "..."; // 上述 JSON 字符串

    @Test
    public void testReadJson() {
        // 獲取所有書籍的作者
        List<String> authors = JsonPath.parse(json)
            .read("$.store.book[*].author");

        // 獲取第一本書的價(jià)格
        Double price = JsonPath.parse(json)
            .read("$.store.book[0].price");

        // 獲取所有價(jià)格低于10元的書籍
        List<Map> cheapBooks = JsonPath.parse(json)
            .read("$.store.book[?(@.price < 10)]");

        // 獲取最后一本書
        Map lastBook = JsonPath.parse(json)
            .read("$.store.book[-1]");
    }
}

在 Spring Boot 中的實(shí)際應(yīng)用

import org.springframework.web.bind.annotation.*;
import com.jayway.jsonpath.JsonPath;

@RestController
@RequestMapping("/api")
public class BookController {

    @PostMapping("/extract")
    public ResponseEntity<?> extractData(@RequestBody String jsonString) {
        try {
            // 提取所有書籍標(biāo)題
            List<String> titles = JsonPath.parse(jsonString)
                .read("$.store.book[*].title");

            // 提取價(jià)格區(qū)間內(nèi)的書籍
            List<Map> books = JsonPath.parse(jsonString)
                .read("$.store.book[?(@.price >= 8 && @.price <= 12)]");

            return ResponseEntity.ok(Map.of(
                "titles", titles,
                "filteredBooks", books
            ));
        } catch (PathNotFoundException e) {
            return ResponseEntity.badRequest()
                .body("JSON路徑不存在: " + e.getMessage());
        }
    }

    @GetMapping("/authors")
    public ResponseEntity<?> getAuthors(@RequestParam String jsonData) {
        List<String> authors = JsonPath.parse(jsonData)
            .read("$.store.book[*].author");
        return ResponseEntity.ok(authors);
    }
}

3. 高級(jí)用法

自定義配置

import com.jayway.jsonpath.Configuration;
import com.jayway.jsonpath.Option;

@Configuration
public class JsonPathConfig {

    public Configuration jsonPathConfiguration() {
        return Configuration.builder()
            // 抑制異常，返回 null
            .options(Option.SUPPRESS_EXCEPTIONS)
            // 默認(rèn)值為空集合
            .options(Option.DEFAULT_PATH_LEAF_TO_NULL)
            // 總是返回列表
            .options(Option.ALWAYS_RETURN_LIST)
            // 緩存
            .options(Option.CACHE)
            .build();
    }
}

緩存解析結(jié)果

@Service
public class JsonPathCacheService {

    private final Map<String, Object> cache = new ConcurrentHashMap<>();

    public Object readWithCache(String json, String path) {
        return JsonPath.using(Configuration.defaultConfiguration())
            .parse(json)
            .read(path);
    }

    // 預(yù)編譯路徑，提升性能
    private final JsonPath compiledPath = JsonPath.compile("$.store.book[*]");

    public List<Map> readOptimized(String json) {
        return compiledPath.read(json);
    }
}

與 REST 調(diào)用結(jié)合

@Service
public class ExternalApiService {

    private final RestTemplate restTemplate;

    public List<String> extractFromExternalApi(String url, String jsonPath) {
        String response = restTemplate.getForObject(url, String.class);
        return JsonPath.parse(response).read(jsonPath);
    }
}

過濾表達(dá)式詳解

// 價(jià)格大于10的書籍
$.store.book[?(@.price > 10)]

// category 為 fiction 的書籍
$.store.book[?(@.category == 'fiction')]

// 包含 isbn 字段的書籍
$.store.book[?(@.isbn)]

// 正則匹配
$.store.book[?(@.author =~ /.*Melville.*/)]

// 多條件組合
$.store.book[?(@.price < 10 && @.category == 'fiction')]

除了 Jayway JsonPath，常見的 JSON 處理庫也有各自的 JSONPath 或類似功能實(shí)現(xiàn)。

FastJSON - 內(nèi)置 JSONPath

FastJSON內(nèi)置了 JSONPath 支持，使用起來非常簡潔。

添加依賴

<dependency>
    <groupId>com.alibaba.fastjson2</groupId>
    <artifactId>fastjson2</artifactId>
    <version>2.0.53</version>
</dependency>

使用示例

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONPath;
import com.alibaba.fastjson2.JSONObject;

public class FastJsonPathExample {

    private String json = "..."; // 同上 JSON 示例

    @Test
    public void testFastJsonPath() {
        JSONObject object = JSON.parseObject(json);

        // 獲取所有書籍作者
        List<String> authors = (List<String>) JSONPath.eval(object, "$.store.book[*].author");

        // 獲取第一本書價(jià)格
        Double price = (Double) JSONPath.eval(object, "$.store.book[0].price");

        // 過濾價(jià)格小于10的書籍
        List books = (List) JSONPath.eval(object, "$.store.book[?(@.price < 10)]");

        // size 方法
        Integer size = (Integer) JSONPath.eval(object, "$.store.book.size()");

        // 獲取所有包含 isbn 的書籍
        List booksWithIsbn = (List) JSONPath.eval(object, "$.store.book[?(@.isbn)]");
    }
}

FastJSON JSONPath 多種查詢方式

FastJSON 提供了多種查詢方式，適應(yīng)不同場景：

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONPath;
import com.alibaba.fastjson2.JSONObject;

public class FastJsonPathQueryExample {

    private JSONObject object = JSON.parseObject(json);

    @Test
    public void testDifferentQueryMethods() {

        // ========== 方式一：JSONPath.eval（靜態(tài)方法，最常用）==========
        List authors1 = (List) JSONPath.eval(object, "$.store.book[*].author");


        // ========== 方式二：JSONPath.of + extract（推薦，性能更好）==========
        // 預(yù)編譯路徑表達(dá)式，性能更優(yōu)（適合重復(fù)使用）
        JSONPath path = JSONPath.of("$.store.book[*].author");
        List authors2 = (List) path.extract(object);


        // ========== 方式三：compile + eval（另一種編譯方式）==========
        JSONPath compiledPath = JSONPath.compile("$.store.book[*].author");
        List authors3 = (List) compiledPath.eval(object);


        // ========== 方式四：路徑對(duì)象直接調(diào)用 set（修改操作）==========
        JSONPath pricePath = JSONPath.of("$.store.book[0].price");
        pricePath.set(object, 88.88);


        // ========== 方式五：contains（判斷是否包含路徑）==========
        boolean hasBook = JSONPath.contains(object, "$.store.book");
        boolean hasIsbn = JSONPath.contains(object, "$.store.book[2].isbn");


        // ========== 方式六：size（獲取數(shù)組大?。?=========
        Integer arraySize = (Integer) JSONPath.eval(object, "$.store.book.size()");
        // 或者使用編譯后的路徑
        JSONPath sizePath = JSONPath.of("$.store.book.size()");
        Integer size = (Integer) sizePath.eval(object);
    }
}

FastJSON JSONPath 修改操作

FastJSON 的 JSONPath 不僅可以讀取數(shù)據(jù)，還支持修改數(shù)據(jù)，這是它的一個(gè)強(qiáng)大特性。

import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONPath;
import com.alibaba.fastjson2.JSONObject;

public class FastJsonPathModifyExample {

    @Test
    public void testJsonPathSet() {
        JSONObject object = JSON.parseObject(json);

        // 修改第一本書的價(jià)格
        JSONPath.set(object, "$.store.book[0].price", 99.99);

        // 修改自行車的顏色
        JSONPath.set(object, "$.store.bicycle.color", "blue");

        // 批量修改所有書籍價(jià)格
        JSONPath.set(object, "$.store.book[*].price", 15.88);

        // 修改包含 isbn 的書籍的 category
        JSONPath.set(object, "$.store.book[?(@.isbn)].category", "classic");

        // 添加新字段
        JSONPath.set(object, "$.store.book[0].publisher", "Tech Press");

        // 數(shù)組末尾添加元素（通過路徑獲取數(shù)組后操作）
        JSONArray bookArray = (JSONArray) JSONPath.eval(object, "$.store.book");
        bookArray.add(JSON.parseObject("{\"title\":\"New Book\",\"price\":9.99}"));

        // 刪除字段
        JSONPath.remove(object, "$.store.bicycle");

        System.out.println(JSON.toJSONString(object));
    }
}

FastJSON JSONPath 其他操作

// 獲取集合大小
Integer size = (Integer) JSONPath.eval(object, "$.store.book.size()");

// 獲取集合第一個(gè)
Object first = JSONPath.eval(object, "$.store.book.first()");

// 獲取集合最后一個(gè)
Object last = JSONPath.eval(object, "$.store.book.last()");

// 獲取屬性所有值
Collection values = (Collection) JSONPath.eval(object, "$.store.book.values()");

Jackson - JsonPointer / Jackson JsonPath

Jackson 原生支持 JsonPointer (RFC 6901)，但不是完整的 JSONPath 實(shí)現(xiàn)。若要使用 JSONPath 功能，可以通過以下兩種方式：

方式一：使用 JsonPointer（原生支持）

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

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.core.JsonPointer;

public class JacksonJsonPointerExample {

    private String json = "...";
    private ObjectMapper mapper = new ObjectMapper();

    @Test
    public void testJsonPointer() throws Exception {
        JsonNode root = mapper.readTree(json);

        // 使用 JsonPointer 定位節(jié)點(diǎn)
        JsonPointer ptr = JsonPointer.compile("/store/book/0/author");
        JsonNode authorNode = root.at(ptr);
        String author = authorNode.asText();

        // 鏈?zhǔn)綄懛?
        String title = root.at("/store/book/1/title").asText();
        Double price = root.at("/store/bicycle/price").asDouble();
    }
}

JsonPointer 限制：

語法較簡單，不支持通配符、過濾表達(dá)式
無法一次獲取多個(gè)值
不支持?jǐn)?shù)組切片

方式二：使用 Jackson-JsonPath（第三方擴(kuò)展）

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

import com.jayway.jsonpath.Configuration;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.spi.json.JacksonJsonNodeJsonProvider;
import com.jayway.jsonpath.spi.mapper.JacksonMappingProvider;

public class JacksonJsonPathExample {

    // 配置使用 Jackson
    private Configuration configuration = Configuration.builder()
        .jsonProvider(new JacksonJsonNodeJsonProvider())
        .mappingProvider(new JacksonMappingProvider())
        .build();

    @Test
    public void testJacksonJsonPath() {
        List<String> authors = JsonPath.using(configuration)
            .parse(json)
            .read("$.store.book[*].author");
    }
}

Gson - 無原生 JSONPath

Gson 本身不提供 JSONPath 支持，這是 Gson 的一個(gè)局限。建議搭配 Jayway JsonPath 使用。

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.11.0</version>
</dependency>

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

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.jayway.jsonpath.JsonPath;

public class GsonJsonPathExample {

    private Gson gson = new Gson();
    private String json = "...";

    @Test
    public void testGsonWithJsonPath() {
        // 使用 JsonPath 提取數(shù)據(jù)
        List<String> authors = JsonPath.parse(json)
            .read("$.store.book[*].author");

        // 將結(jié)果轉(zhuǎn)回 Gson 對(duì)象
        JsonElement element = gson.toJsonTree(authors);
    }
}

三種方案對(duì)比

特性	FastJSON	Jackson + JsonPointer	Jayway JsonPath
JSONPath 支持	原生支持	僅 JsonPointer	完整支持
過濾表達(dá)式	支持	不支持	支持
通配符	支持	不支持	支持
性能	優(yōu)秀	優(yōu)秀	良好
生態(tài)穩(wěn)定性	曾有安全漏洞	最穩(wěn)定	社區(qū)活躍
Spring Boot 集成	需手動(dòng)配置	默認(rèn)集成	需添加依賴

選型建議

已有 FastJSON 項(xiàng)目：直接使用 FastJSON 的 JSONPath
使用 Jackson 的項(xiàng)目：簡單場景用 JsonPointer，復(fù)雜場景引入 Jayway JsonPath
使用 Gson 的項(xiàng)目：建議搭配 Jayway JsonPath 使用
新項(xiàng)目：推薦 Jackson + Jayway JsonPath 組合

總結(jié)

JSONPath 是處理 JSON 數(shù)據(jù)的利器，通過簡潔的路徑表達(dá)式實(shí)現(xiàn)復(fù)雜字段提取、條件過濾和動(dòng)態(tài)查詢。在 Spring Boot 中集成 JSONPath 可大幅簡化代碼、提升可讀性，是處理復(fù)雜 JSON 結(jié)構(gòu)和第三方 API 數(shù)據(jù)的一種可選技術(shù)方案。

以上就是SpringBoot使用JSONPath實(shí)現(xiàn)高效處理JSON數(shù)據(jù)的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot處理JSON數(shù)據(jù)的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: