带有 MockMvc 的 Hamcrest：检查键是否存在但值可能为空答案

【问题标题】：Hamcrest with MockMvc: check that key exists but value may be null带有 MockMvc 的 Hamcrest：检查键是否存在但值可能为空
【发布时间】：2014-08-14 22:16:15
【问题描述】：

我正在使用 MockMvc 进行一些测试，并且我想验证 JSON 响应的结构。具体来说，我想确保一个属性的键存在，并且该值是某种类型或为空。

{
   "keyToNull": null,  # This may be null, or a String
   "keyToString": "some value"
}

以下对我有用，但我想知道是否有办法将每组两个期望组合成一行，因为我有很多属性要检查：

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
import static org.hamcrest.Matchers.*;

.andExpect(jsonPath("$").value(hasKey("keyToNull")))
.andExpect(jsonPath("$.keyToNull").value(
                  anyOf(any(String.class), nullValue(String.class))))

.andExpect(jsonPath("$").value(hasKey("keyToString")))
.andExpect(jsonPath("$.keyToString").value(
                  anyOf(any(String.class), nullValue(String.class))))

hasKey() 是必要的，因为另一个断言本身会通过，因为 MockMvc 的实现中不存在的键映射为 null：

.andExpect(jsonPath("$.notAKey").value(
                  anyOf(any(String.class), nullValue(String.class)))) // ok

jsonPath().exists() 也不起作用，因为它在内部将值与null 进行比较。

我考虑过像这样制作一个单独的方法：

private static <T> void assertNullableAttr(ResultActions res, String jsonPath, Class<T> type) throws Exception {
    int split = jsonPath.lastIndexOf('.');
    String prefix = jsonPath.substring(0, split), key = jsonPath.substring(split+1);

    res.andExpect(jsonPath(prefix).value(hasKey(key)))
        .andExpect(jsonPath(jsonPath).value(anyOf(any(type), nullValue(type))));
    }

但它迫使我以一种不自然的方式拆分我的代码：

ResultActions res = mockMvc.perform(get("/api"))
    // these attributes must not be null
    .andExpect(jsonPath("$.someInfo").value(hasSize(2)))
        .andExpect(jsonPath("$.someInfo[0].info1").value(any(String.class)))
        .andExpect(jsonPath("$.someInfo[0].info2").value(any(String.class)))
    .andExpect(jsonPath("$.addlInfo").value(hasSize(2)))
        .andExpect(jsonPath("$.addlInfo[0].info1").value(any(String.class)))
        .andExpect(jsonPath("$.addlInfo[0].info2").value(any(String.class)));

// these attributes may be null
assertNullableAttr(res, "$.someInfo[0].info3", String.class);
assertNullableAttr(res, "$.someInfo[0].info4", String.class);

assertNullableAttr(res, "$.addlInfo[0].info3", String.class);
assertNullableAttr(res, "$.addlInfo[0].info4", String.class);

是否有任何聪明的 Hamcrest Matcher 可以应用于每个属性的单个 json 路径？

【问题讨论】：

标签： java hamcrest jsonpath mockmvc

【解决方案1】：

您可以使用以下现有测试类执行此操作：

.andExpect(jsonPath("$..myExpectedNullKey[0]").value(IsNull.nullValue()));

一定要导入 org.hamcrest.core.IsNull

【讨论】：

【解决方案2】：

我在blog:

中找到了这个解决方案

.andExpect(jsonPath( "$.keyToNull").doesNotExist());

它对我有用。

【讨论】：

【解决方案3】：

您可以添加以下静态匹配器工厂：

public static <K> Matcher<Map<? extends K, ?>> hasNullKey(K key) {
    return new IsMapContaining<K,Object>(equalTo(key), anyOf(nullValue(), anyString());
}

然后，您可以像这样使用它：

// will succeed, because keyToNull exists and null
.andExpect(jsonPath("$").value(hasNullKey("keyToNull")))

// will succeed, bacause keyToString exists and not null
.andExpect(jsonPath("$").value(hasNullKey("keyToString")))

// will fail, because notAKey doesn't exists
.andExpect(jsonPath("$").value(hasNullKey("notAKey")))

【讨论】：

【解决方案4】：

这是我的解决方案：

.andExpect(jsonPath("$.object", is(nullValue())));

希望这会有所帮助！

【讨论】：