JSONPath表达式的匹配器以查找字段顺序

Question

我有一个API，它返回一个将在UI中显示的JSON对象。对象中字段的顺序很重要，因为UI希望按该顺序显示字段。我想编写一个单元测试来确保对象中字段的顺序是正确的。我的API响应如下所示:

{
    "data": {
        "field1": "value1",
        "field2": "value2"
     }
}

使用spring boot的< code>MockMvc库，我想编写一个这样的表达式来验证字段是否按顺序返回:

.andExpect(jsonPath("$.data"), is("field1=value1, field2=value2")

显然，上述方法不起作用，但我不确定我应该使用哪种类型的Matcher来尝试并验证字段是否正确。

Answer 1

我找不到比较字段顺序的Hamcrest匹配器，但编写自己的很容易。请注意，JSON路径表达式的结果将为您提供一个LinkedHashMap，因此您所需要的只是一个Matcher，它接受一个LinkedHashMap并将其与给定对象进行比较，按条目的顺序逐个条目。将映射转换为条目的List并使用List的equals方法可以解决问题，因为List会按顺序比较项目。

这是匹配器的样子:

private class OrderedMapMatcher extends BaseMatcher<Map<String, String>> {

    private LinkedHashMap<String, String> expected;

    public OrderedMapMatcher(LinkedHashMap<String, String> expected) {
        this.expected = expected;
    }

    @Override
    public boolean matches(Object o) {
        if (!(o instanceof LinkedHashMap)) {
            return false;
        }
        LinkedHashMap actual = (LinkedHashMap) o;
        List<Map.Entry<String, String>> expectedList = new ArrayList<>(expected.entrySet());
        List actualList = new ArrayList(actual.entrySet());
        return expectedList.equals(actualList);
    }

    @Override
    public void describeTo(Description description) {
        description.appendText(expected.toString());
    }
}

断言是这样的：

LinkedHashMap<String, String> expectedData = new LinkedHashMap<>();
expectedData.put("field1", "value1");
expectedData.put("field2", "value2");

// mockMvc ResultActions code would be here
.andExpect(jsonPath("$.data", new OrderedMapMatcher(expectedData)));