1. 概述
在为使用JSON的软件编写自动化测试时，我们经常需要将JSON数据与一些预期值进行比较。
在某些情况下，我们可以将实际和预期的JSON视为字符串并执行字符串比较，但这有很多限制。
在本教程中，我们将了解如何使用ModelAssert编写JSON值之间的断言和比较。我们将看到如何对JSON文档中的各个值构造断言以及如何比较文档。我们还将介绍如何处理无法预测其确切值的字段，例如日期或GUID。
2. 入门
ModelAssert是一个数据断言库，其语法类似于AssertJ，功能可以与JSONAssert相媲美。它基于Jackson进行JSON解析，并使用JSON指针表达式来描述文档中字段的路径。
让我们从为这个JSON编写一些简单的断言开始：
{
"name": "Tuyucheng",
"isOnline": true,
"topics": [
"Java",
"Spring",
"Kotlin",
"Scala",
"Linux"
]
}
2.1 依赖
首先，让我们将ModelAssert添加到我们的pom.xml中：
<dependency>
<groupId>uk.org.webcompere</groupId>
<artifactId>model-assert</artifactId>
<version>1.0.0</version>
<scope>test</scope>
</dependency>
2.2 断言JSON对象中的字段
假设示例JSON已作为字符串返回给我们，我们要检查name字段是否等于Tuyucheng：
assertJson(jsonString)
.at("/name").isText("Tuyucheng");
assertJson方法将从各种来源读取JSON，包括String、File、Path和Jackson的JsonNode。返回的对象是一个断言，我们可以在此基础上使用流式的DSL(领域特定语言)来添加条件。
at方法描述了文档中我们希望进行字段断言的位置。然后，isText指定我们期望一个值为Tuyucheng的文本节点。
我们可以通过使用稍长的JSON指针表达式来断言topics数组中的路径：
assertJson(jsonString)
.at("/topics/1").isText("Spring");
虽然我们可以一个一个地编写字段断言，但我们也可以将它们组合成一个断言：
assertJson(jsonString)
.at("/name").isText("Tuyucheng")
.at("/topics/1").isText("Spring");
2.3 为什么字符串比较不起作用
通常我们希望将整个JSON文档与另一个文档进行比较。字符串比较虽然在某些情况下是可能的，但经常会被不相关的JSON格式问题所困扰：
String expected = loadFile(EXPECTED_JSON_PATH);
assertThat(jsonString)
.isEqualTo(expected);
像这样的失败消息很常见：
org.opentest4j.AssertionFailedError:
expected: "{
"name": "Tuyucheng",
"isOnline": true,
"topics": [ "Java", "Spring", "Kotlin", "Scala", "Linux" ]
}"
but was : "{"name": "Tuyucheng","isOnline": true,"topics": [ "Java", "Spring", "Kotlin", "Scala", "Linux" ]}"
2.4 语义比较树
要进行整个文档比较，我们可以使用isEqualTo：
assertJson(jsonString)
.isEqualTo(EXPECTED_JSON_PATH);
在这种情况下，实际JSON的字符串由assertJson加载，而预期的JSON文档(由Path描述的文件)在isEqualTo中加载。比较是根据数据进行的。
2.5 不同的格式
ModelAssert还支持可以被Jackson转换为JsonNode的Java对象，以及yaml格式。
Map<String, String> map = new HashMap<>();
map.put("name", "baeldung");
assertJson(map)
.isEqualToYaml("name: baeldung");
对于yaml处理，isEqualToYaml方法用于指示字符串或文件的格式。如果源是yaml，这需要assertYaml：
assertYaml("name: baeldung")
.isEqualTo(map);
3. 字段断言
到目前为止，我们已经看到了一些基本的断言。让我们看看更多的DSL。
3.1 在任何节点上断言
ModelAssert的DSL允许针对树中的任何节点添加几乎所有可能的条件。这是因为JSON树可能包含任何级别的任何类型的节点。
让我们看一下我们可以添加到示例JSON的根节点的一些断言：
assertJson(jsonString)
.isNotNull()
.isNotNumber()
.isObject()
.containsKey("name");
由于断言对象在其接口上提供了这些方法，因此我们的IDE会提示我们在按下“.”时可以添加的各种断言。
在这个例子中，我们添加了很多不必要的条件，因为最后一个条件已经暗示了一个非空对象。
大多数情况下，我们使用来自根节点的JSON指针表达式来对树下层的节点执行断言：
assertJson(jsonString)
.at("/topics").hasSize(5);
此断言使用hasSize来检查topics字段中的数组是否有五个元素。hasSize方法对对象、数组和字符串进行操作。对象的大小是它的键数，字符串的大小是它的字符数，数组的大小是它的元素数。
我们需要对字段做出的大多数断言取决于字段的确切类型。当我们尝试在特定类型上编写断言时，我们可以使用方法number、array、text、booleanNode和object移动到更具体的断言子集中。这是可选的，但可以更具表现力：
assertJson(jsonString)
.at("/isOnline").booleanNode().isTrue();
当我们按下“.”在我们的IDE中键入booleanNode之后，我们只会看到布尔节点的自动完成选项。
3.2 文本节点
当我们断言文本节点时，我们可以使用isText来使用精确值进行比较。或者，我们可以使用textContains来断言子字符串：
assertJson(jsonString)
.at("/name").textContains("ael");
我们还可以通过matches使用正则表达式：
assertJson(jsonString)
.at("/name").matches("[A-Z].+");
此示例断言name以大写字母开头。
3.3 数字节点
对于数字节点，DSL提供了一些有用的数字比较：
assertJson("{count: 12}")
.at("/count").isBetween(1, 25);
我们还可以指定我们期望的Java数字类型：
assertJson("{height: 6.3}")
.at("/height").isGreaterThanDouble(6.0);
isEqualTo方法是为整个树匹配保留的，因此为了比较数值相等性，我们使用isNumberEqualTo：
assertJson("{height: 6.3}")
.at("/height").isNumberEqualTo(6.3);
3.4 数组节点
我们可以使用isArrayContaining测试数组的内容：
assertJson(jsonString)
.at("/topics").isArrayContaining("Scala", "Spring");
这将测试给定值是否存在并允许实际数组包含其他元素。如果我们希望断言更精确的匹配，我们可以使用isArrayContainingExactlyInAnyOrder：
assertJson(jsonString)
.at("/topics")
.isArrayContainingExactlyInAnyOrder("Scala", "Spring", "Java", "Linux", "Kotlin");
我们也可以使这需要确切的顺序：
assertJson(ACTUAL_JSON)
.at("/topics")
.isArrayContainingExactly("Java", "Spring", "Kotlin", "Scala", "Linux");
这是断言包含原始值的数组内容的好方法。如果数组包含对象，我们可能希望使用isEqualTo来代替。
4. 全树匹配
虽然我们可以构建具有多个特定于字段的条件的断言来检查JSON文档中的内容，但我们经常需要将整个文档与另一个文档进行比较。
isEqualTo方法(或isNotEqualTo)用于比较整个树。这可以与at结合使用，在进行比较之前移动到实际的子树：
assertJson(jsonString)
.at("/topics")
.isEqualTo("[ \"Java\", \"Spring\", \"Kotlin\", \"Scala\", \"Linux\" ]");
当JSON包含以下数据时，整个树比较可能会遇到问题：
- 相同，但顺序不同
- 由一些无法预测的值组成
where方法用于自定义下一个isEqualTo操作来绕过这些。
4.1 添加键顺序约束
让我们看两个看起来一样的JSON文档：
String actualJson = "{a:{d:3, c:2, b:1}}";
String expectedJson = "{a:{b:1, c:2, d:3}}";
我们应该注意，这不是严格的JSON格式。ModelAssert允许我们对JSON使用JavaScript表示法，以及通常引用字段名称的连线格式。
这两个文档在“a”下具有完全相同的键，但它们的顺序不同。这些断言将失败，因为ModelAssert默认为严格的键顺序(strict key order)。
我们可以通过添加where配置来放宽键顺序规则：
assertJson(actualJson)
.where().keysInAnyOrder()
.isEqualTo(expectedJson);
这允许树中的任何对象具有与预期文档不同的键顺序并且仍然匹配。
我们可以将此规则本地化到特定路径：
assertJson(actualJson)
.where()
.at("/a").keysInAnyOrder()
.isEqualTo(expectedJson);
这将keysInAnyOrder限制为根对象中的“a”字段。
自定义比较规则的能力使我们能够处理无法完全控制或预测生成的确切文档的许多场景。
4.2 放宽数组约束
如果我们的数组的值顺序可以改变，那么我们可以放宽整个比较的数组排序约束：
String actualJson = "{a:[1, 2, 3, 4, 5]}";
String expectedJson = "{a:[5, 4, 3, 2, 1]}";
assertJson(actualJson)
.where().arrayInAnyOrder()
.isEqualTo(expectedJson);
或者我们可以将该约束限制为一条路径，就像我们对keysInAnyOrder所做的那样。
4.3 忽略路径
也许我们的实际文档包含一些无趣或不可预测的字段。我们可以添加一个规则来忽略该路径：
String actualJson = "{user:{name: \"Tuyucheng\", url:\"http://www.baeldung.com\"}}";
String expectedJson = "{user:{name: \"Tuyucheng\"}}";
assertJson(actualJson)
.where()
.at("/user/url").isIgnored()
.isEqualTo(expectedJson);
我们应该注意，我们表达的路径始终是实际中的JSON指针。
实际中的额外字段“url”现在被忽略。
4.4 忽略任何GUID
到目前为止，我们只添加了使用at的规则，以便在文档中的特定位置自定义比较。
path语法允许我们使用通配符来描述我们的规则适用于何处。当我们在比较的where添加at或path条件时，我们还可以提供上面的任何字段断言来代替与预期文档的并排比较。
假设我们有一个id字段出现在文档中的多个位置，并且是一个我们无法预测的GUID。
我们可以使用路径规则忽略此字段：
String actualJson = "{user:{credentials:[" +
"{id:\"a7dc2567-3340-4a3b-b1ab-9ce1778f265d\",role:\"Admin\"}," +
"{id:\"09da84ba-19c2-4674-974f-fd5afff3a0e5\",role:\"Sales\"}]}}";
String expectedJson = "{user:{credentials:" +
"[{id:\"???\",role:\"Admin\"}," +
"{id:\"???\",role:\"Sales\"}]}}";
assertJson(actualJson)
.where()
.path("user","credentials", ANY, "id").isIgnored()
.isEqualTo(expectedJson);
在这里，我们的期望值可以是id字段的任何值，因为我们只是忽略了JSON指针以“/user/credentials”开头然后具有单个节点(数组索引)并以“/id”结尾的任何字段。
4.5 匹配任何GUID
忽略我们无法预测的字段是一种选择。相反，最好按类型匹配这些节点，也许还可以通过它们必须满足的其他条件来匹配。让我们切换到强制这些GUID匹配GUID的模式，并允许id节点出现在树的任何叶节点上：
assertJson(actualJson)
.where()
.path(ANY_SUBTREE, "id").matches(GUID_PATTERN)
.isEqualTo(expectedJson);
ANY_SUBTREE通配符匹配路径表达式部分之间的任意数量的节点。GUID_PATTERN来自ModelAssertPatterns类，其中包含一些常用的正则表达式来匹配数字和日期戳等内容。
4.6 自定义isEqualTo
where与path或at表达式的组合允许我们覆盖树中任何位置的比较。我们要么为对象或数组匹配添加内置规则，要么指定特定的替代断言以用于比较中的单个或类路径。
如果我们有一个通用的配置，在各种比较中重复使用，我们可以将它提取到一个方法中：
private static <T> WhereDsl<T> idsAreGuids(WhereDsl<T> where) {
return where.path(ANY_SUBTREE, "id").matches(GUID_PATTERN);
}
然后，我们可以使用configureBy将该配置添加到特定断言中：
assertJson(actualJson)
.where()
.configuredBy(where -> idsAreGuids(where))
.isEqualTo(expectedJson);
5. 与其他库的兼容性
ModelAssert是为互操作性而构建的。到目前为止，我们已经看到了AssertJ风格的断言。这些可以有多个条件，并且在第一个条件不满足时它们将失败。
但是，有时我们需要生成一个匹配器对象以用于其他类型的测试。
5.1 Hamcrest
Hamcrest是许多工具支持的主要断言依赖库。我们可以使用ModelAssert的DSL来生成一个Hamcrest匹配器：
Matcher<String> matcher = json()
.at("/name").hasValue("Tuyucheng");
json方法用于描述一个匹配器，该匹配器将接收其中包含JSON数据的字符串。我们还可以使用jsonFile来生成一个期望断言File内容的Matcher。ModelAssert中的JsonAssertions类包含多个像这样的构建器方法来开始构建Hamcrest匹配器。
用于表达比较的DSL与assertJson相同，但在使用匹配器之前不会执行比较。
因此，我们可以将ModelAssert与Hamcrest的MatcherAssert一起使用：
MatcherAssert.assertThat(jsonString, json()
.at("/name").hasValue("Tuyucheng")
.at("/topics/1").isText("Spring"));
5.2 与Spring Mock MVC一起使用
在Spring Mock MVC中使用响应体验证时，我们可以使用Spring内置的jsonPath断言。然而，Spring也允许我们使用Hamcrest匹配器来断言作为响应内容返回的字符串。这意味着我们可以使用ModelAssert执行复杂的内容断言。
5.3 与Mockito一起使用
Mockito已经可以与Hamcrest互操作。但是，ModelAssert也提供了一个原生的ArgumentMatcher。这既可以用来设置stub的行为，也可以用来验证对它们的调用：
public interface DataService {
boolean isUserLoggedIn(String userDetails);
}
@Mock
private DataService mockDataService;
@Test
void givenUserIsOnline_thenIsLoggedIn() {
given(mockDataService.isUserLoggedIn(argThat(json()
.at("/isOnline").isTrue()
.toArgumentMatcher())))
.willReturn(true);
assertThat(mockDataService.isUserLoggedIn(jsonString))
.isTrue();
verify(mockDataService)
.isUserLoggedIn(argThat(json()
.at("/name").isText("Tuyucheng")
.toArgumentMatcher()));
}
在此示例中，Mockito argThat用于mock和verify的设置。在其中，我们使用Hamcrest风格构建器作为匹配器-json。然后我们为其添加条件，最后使用toArgumentMatcher转换为Mockito的ArgumentMatcher。
6. 总结
在本文中，我们研究了在测试中比较JSON语义的必要性。
我们看到了如何使用ModelAssert在JSON文档中的单个节点以及整个树上构建断言。然后我们看到了如何自定义树比较以允许不可预测或不相关的差异。
最后，我们看到了如何将ModelAssert与Hamcrest和其他库一起使用。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
