如何验证JSON中是否存在JSON路径

Question

在给定的json文档中，如何验证是否存在json路径？

我使用的是jayway jsonpath，代码如下

JsonPath.read(jsonDocument, jsonPath)

上述代码可能会引发以下异常

通用域名格式。乱穿马路。jsonpath。PathNotFoundException:路径：$['a.b.c']没有结果

为了缓解这种情况，我打算在尝试使用JsonPath读取该路径之前验证该路径是否存在。阅读

作为参考，我看了以下两个文档，但没有真正得到我想要的。

1. http://www.baeldung.com/guide-to-jayway-jsonpath
2. https://github.com/json-path/JsonPath

Answer 1

如果您有一个检查多个路径的用例，您还可以使用配置创建一个JsonPath对象或ReadContext。

    // Suppress errors thrown by JsonPath and instead return null if a path does not exist in a JSON blob.
    Configuration suppressExceptionConfiguration = Configuration
            .defaultConfiguration()
            .addOptions(Option.SUPPRESS_EXCEPTIONS);
    ReadContext jsonData = JsonPath.using(suppressExceptionConfiguration).parse(jsonString);

    for (int i = 0; i < listOfPaths.size(); i++) {
        String pathData = jsonData.read(listOfPaths.get(i));
        if (pathData != null) {
            // do something
        }

Answer 2

虽然您确实可以捕获异常，但就像注释中提到的那样，可能有一种更优雅的方法来检查路径是否存在，而无需在代码中到处写尝试捕获块。

可以在jayway-jsonpath中使用以下配置选项：

com.jayway.jsonpath.Option.SUPPRESS_EXCEPTIONS

此选项处于活动状态时，不会引发异常。如果使用read方法，只要没有找到路径，它就会简单地返回null。

下面是一个JUnit 5和AssertJ的示例，展示了如何使用此配置选项，避免仅用于检查json路径是否存在的try/catch块：

@ParameterizedTest
@ArgumentsSource(CustomerProvider.class)
void replaceStructuredPhone(JsonPathReplacementArgument jsonPathReplacementArgument) {
    DocumentContext dc = jsonPathReplacementHelper.replaceStructuredPhone(
            JsonPath.parse(jsonPathReplacementArgument.getCustomerJson(),
                    Configuration.defaultConfiguration().addOptions(Option.SUPPRESS_EXCEPTIONS)),
            "$.cps[5].contactPhoneNumber", jsonPathReplacementArgument.getUnStructuredPhoneNumberType());
    UnStructuredPhoneNumberType unstructRes = dc.read("$.cps[5].contactPhoneNumber.unStructuredPhoneNumber");
    assertThat(unstructRes).isNotNull();
    // this path does not exist, since it should have been deleted.
    Object structRes = dc.read("$.cps[5].contactPhoneNumber.structuredPhoneNumber");
    assertThat(structRes).isNull();
}