使用 jsonassert 比较 json 结果的核心在于调用 jsonassert.assertequals() 方法,将期望的 json 字符串、实际的 json 字符串以及一个布尔类型的 strictmode 参数传入。当 strictmode 设为 false 时,它只检查实际 json 中存在的键值对是否与期望一致,忽略多余字段;设为 true 时,则要求两者完全匹配,任何差异都会抛出异常。

如何验证 API 返回的 JSON 结构是否包含预期字段
在测试 REST API 响应时,通常不需要校验所有细节,只需确认关键字段存在且值正确。此时应使用宽松模式(strictMode = false),这样即使后端增加了新字段或调整了顺序,只要核心数据不变,测试就不会失败。

import org.json.JSONObject;
import static net.javacrumbs.jsonunit.assertj.JsonAssertions.assertThatJson;
import static net.javacrumbs.jsonunit.core.listener.Strictness.IGNORE_EXTRA_KEYS;
public class ApiTest {
public void testUserResponse() {
String expected = "{\"name\":\"Alice\", \"age\":30}";
String actual = "{\"name\":\"Alice\", \"age\":30, \"id\":101}";
// 使用宽松模式,忽略额外字段 "id"
assertThatJson(actual).isEqualTo(expected);
}
}
上述代码展示了如何使用 JsonUnit 的 AssertJ 风格断言。通过 assertThatJson(actual) 获取断言对象,再调用 isEqualTo(expected) 进行比较。这种写法比传统的 JSONAssert 更直观,且默认行为即为忽略额外键,符合大多数 API 测试场景。
如何精确比对嵌套 JSON 对象的深层属性
当需要验证复杂嵌套结构中的特定值时,可以使用路径表达式定位到具体节点。这种方式允许开发者在不关心其他无关字段的情况下,精准检查某个深层属性的值是否正确,特别适用于大型 JSON 响应的局部验证。

import static net.javacrumbs.jsonunit.assertj.JsonAssertions.assertThatJson;
public class NestedTest {
public void testNestedAddress() {
String actual = "{\"user\":{\"profile\":{\"city\":\"Beijing\"}}}";
// 使用路径表达式精确检查嵌套值
assertThatJson(actual).node("user.profile.city").isEqualTo("Beijing");
}
}
在上面的示例中,node("user.profile.city") 明确指定了要检查的路径。如果该路径下的值不等于 "Beijing",测试将立即失败并指出具体位置。这种方法避免了将整个大 JSON 对象作为字符串进行全量比较,提高了测试的针对性和可读性。
当实际 JSON 缺少必需字段时会发生什么
如果实际 JSON 中缺失了期望 JSON 中定义的必需字段,无论使用严格模式还是宽松模式,测试都会失败。在宽松模式下,虽然会忽略实际 JSON 中多出的字段,但不会容忍缺失字段;在严格模式下,不仅会报错缺失字段,还会报错多出字段。因此,确保实际响应包含所有期望字段是测试通过的前提。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











