知識庫 / JSON RSS 訂閱

Filter expensiveFilter = Filter.filter(Criteria.where("price").gt(20.00));
List<Map<String, Object>> expensive = JsonPath.parse(jsonDataSourceString)
  .read("$['book'][?]", expensiveFilter);
predicateUsageAssertionHelper(expensive);

我們還可以定義自定義的 Predicate 並將其用作 read API 的參數：

Predicate expensivePredicate = new Predicate() {
    public boolean apply(PredicateContext context) {
        String value = context.item(Map.class).get("price").toString();
        return Float.valueOf(value) > 20.00;
    }
};
List<Map<String, Object>> expensive = JsonPath.parse(jsonDataSourceString)
  .read("$['book'][?]", expensivePredicate);
predicateUsageAssertionHelper(expensive);

最後，一個謂詞可以直接應用於 read API，而無需創建任何對象，這種方法稱為內聯謂詞。

List<Map<String, Object>> expensive = JsonPath.parse(jsonDataSourceString)
  .read("$['book'][?(@['price'] > $['price range']['medium'])]");
predicateUsageAssertionHelper(expensive);

所有三個 謂詞 示例均已通過以下斷言輔助方法驗證：

private void predicateUsageAssertionHelper(List<?> predicate) {
    assertThat(predicate.toString(), containsString("Beginning JSON"));
    assertThat(predicate.toString(), containsString("JSON at Work"));
    assertThat(predicate.toString(), not(containsString("Learn JSON in a DAY")));
    assertThat(predicate.toString(), not(containsString("JSON: Questions and Answers")));
}

5. 配置

5.1. 選項

Jayway JsonPath 提供了一些選項來調整默認配置：

• Option.AS_PATH_LIST 返回評估命中點的路徑，而不是它們的實際值。
• Option.DEFAULT_PATH_LEAF_TO_NULL 對於缺失的葉節點返回 null。
• Option.ALWAYS_RETURN_LIST 即使路徑明確時，也返回一個列表。
• Option.SUPPRESS_EXCEPTIONS 確保路徑評估過程中不會傳播異常。
• Option.REQUIRE_PROPERTIES 在評估不明確路徑時，要求路徑中定義的屬性。

以下是如何從頭開始應用 Option 的方法：

Configuration configuration = Configuration.builder().options(Option.<OPTION>).build();

以及如何將其添加到現有的配置中：

Configuration newConfiguration = configuration.addOptions(Option.<OPTION>);

5.2. SPIs

JsonPath 的默認配置，藉助 Option 選項，通常足以滿足大部分任務的需求。然而，對於具有更復雜用例的用户，他們可以根據特定要求修改 JsonPath 的行為——通過三種不同的 SPIs 實現：

• JsonProvider SPI 允許我們更改 JsonPath 解析和處理 JSON 文檔的方式。
• MappingProvider SPI 允許自定義節點值和返回對象類型之間的綁定。
• CacheProvider SPI 調整路徑緩存的方式，這有助於提高性能。

6. 示例使用場景

我們現在對 JsonPath 的功能有了很好的理解。現在，讓我們來看一個示例。

本節將演示如何處理來自 Web 服務的 JSON 數據。

假設我們有一個電影信息服務，它返回以下結構：

[
    {
        "id": 1,
        "title": "Casino Royale",
        "director": "Martin Campbell",
        "starring": 
        [
            "Daniel Craig",
            "Eva Green"
        ],
        "desc": "Twenty-first James Bond movie",
        "release date": 1163466000000,
        "box office": 594275385
    },

    {
        "id": 2,
        "title": "Quantum of Solace",
        "director": "Marc Forster",
        "starring": 
        [
            "Daniel Craig",
            "Olga Kurylenko"
        ],
        "desc": "Twenty-second James Bond movie",
        "release date": 1225242000000,
        "box office": 591692078
    },

    {
        "id": 3,
        "title": "Skyfall",
        "director": "Sam Mendes",
        "starring": 
        [
            "Daniel Craig",
            "Naomie Harris"
        ],
        "desc": "Twenty-third James Bond movie",
        "release date": 1350954000000,
        "box office": 1110526981
    },

    {
        "id": 4,
        "title": "Spectre",
        "director": "Sam Mendes",
        "starring": 
        [
            "Daniel Craig",
            "Lea Seydoux"
        ],
        "desc": "Twenty-fourth James Bond movie",
        "release date": 1445821200000,
        "box office": 879376275
    }
]

其中，發佈日期 字段的值是自紀元（Epoch）以來的毫秒數，票房 是電影在美國影院的美元收入。

我們將處理五個不同的 GET 請求工作場景，假設上述 JSON 層次結構已提取並存儲在一個名為 jsonString 的 String 變量中。

6.1. 通過ID獲取對象數據

在用例中，客户端通過向服務器提供電影的精確 id 來請求有關特定電影的詳細信息。此示例演示了服務器如何查找請求的數據，然後再將其返回給客户端。

假設我們需要查找 id 等於 2 的記錄。

第一步是獲取正確的對象數據：

Object dataObject = JsonPath.parse(jsonString).read("$[?(@.id == 2)]");
String dataString = dataObject.toString();

JUnit 的 斷言 (Assert) API 確認了多個字段的存在：

assertThat(dataString, containsString("2"));
assertThat(dataString, containsString("Quantum of Solace"));
assertThat(dataString, containsString("Twenty-second James Bond movie"));

6.2. 獲取包含主演的電影標題

假設我們想要查找一位名為 Eva Green 的女演員主演的電影。 服務器需要返回包含 Eva Green 在 主演 數組中的 標題。

以下測試將演示如何執行此操作並驗證返回的結果：

@Test
public void givenStarring_whenRequestingMovieTitle_thenSucceed() {
    List<Map<String, Object>> dataList = JsonPath.parse(jsonString)
      .read("$[?('Eva Green' in @['starring'])]");
    String title = (String) dataList.get(0).get("title");

    assertEquals("Casino Royale", title);
}

6.3. 總收入計算

本場景利用 JsonPath 函數 length() 來確定電影記錄的數量，從而計算所有電影的總收入。

讓我們來看一下實現和測試：

@Test
public void givenCompleteStructure_whenCalculatingTotalRevenue_thenSucceed() {
    DocumentContext context = JsonPath.parse(jsonString);
    int length = context.read("$.length()");
    long revenue = 0;
    for (int i = 0; i < length; i++) {
        revenue += context.read("$[" + i + "]['box office']", Long.class);
    }

    assertEquals(594275385L + 591692078L + 1110526981L + 879376275L, revenue);
}

6.4. 最高票房電影

本用例演示了使用非默認的 JsonPath 配置選項，即 Option.AS_PATH_LIST，來查找票房最高的電影。

首先，我們需要提取所有電影的票房收入列表，然後將其轉換為數組以便進行排序：

DocumentContext context = JsonPath.parse(jsonString);
List<Object> revenueList = context.read("$[*]['box office']");
Integer[] revenueArray = revenueList.toArray(new Integer[0]);
Arrays.sort(revenueArray);

我們可以輕鬆地從排序後的 revenueArray 中提取 highestRevenue 變量，然後利用它來確定具有最高收入的電影記錄的路徑：

int highestRevenue = revenueArray[revenueArray.length - 1];
Configuration pathConfiguration = 
  Configuration.builder().options(Option.AS_PATH_LIST).build();
List<String> pathList = JsonPath.using(pathConfiguration).parse(jsonString)
  .read("$[?(@['box office'] == " + highestRevenue + ")]");

根據計算出的路徑，我們將確定並返回對應電影的 標題：

Map<String, String> dataRecord = context.read(pathList.get(0));
String title = dataRecord.get("title");

整個過程由 Assert API 驗證：

assertEquals("Skyfall", title);

6.5. 一位導演的最新作品

本示例將説明如何確定一位名為 Sam Mendes 的導演的最新作品。

首先，我們創建一個包含所有由 Sam Mendes 導演執導的電影的列表：

DocumentContext context = JsonPath.parse(jsonString);
List<Map<String, Object>> samMendesMovies = context.read("$[?(@.director == 'Sam Mendes')]");

我們還可以為根節點 director 定義一個 Filter ，並將其用作謂詞：

Filter directorSamMendesFilter = Filter.filter(Criteria.where("director")
    .contains("Sam Mendes"));
List<Map<String, Object>> samMendesMovies = JsonPath.parse(jsonString)
    .read("$[?]", directorSamMendesFilter);

我們隨後使用該列表來提取發佈日期。這些日期將被存儲在一個數組中，然後進行排序：

List<Object> dateList = new ArrayList<>();
for (Map<String, Object> item : samMendesMovies) {
    Object date = item.get("release date");
    dateList.add(date);
}
Long[] dateArray = dateList.toArray(new Long[0]);
Arrays.sort(dateArray);

我們使用 lastestTime 變量（排序數組的最後一個元素）與 director 字段的值結合，以確定所請求電影的 title：

long latestTime = dateArray[dateArray.length - 1];
List<Map<String, Object>> finalDataList = context.read("$[?(@['director'] 
  == 'Sam Mendes' && @['release date'] == " + latestTime + ")]");
String title = (String) finalDataList.get(0).get("title");

以下斷言證明一切都按預期工作：

assertEquals("Spectre", title);

7. 結論

本文介紹了 Jayway JsonPath 的基本功能——一個強大的工具，用於遍歷和解析 JSON 文檔。

儘管 JsonPath 存在一些缺點，例如缺乏用於訪問父節點或兄弟節點的操作符，但在許多場景下仍然非常有用。