本文详细介绍了如何使用skyscreamer jsonassert库为特定数据类型创建自定义比较器，而非仅针对特定字段。通过扩展`defaultcomparator`并重写`comparevalues`方法，可以实现如布尔值与整数之间的灵活比较，确保在比较失败时提供详细的差异报告，从而提高json断言的精确性和可调试性。
在进行API测试或数据验证时，我们经常需要比较两个JSON字符串是否相等。Skyscreamer的JSONAssert是一个强大的库，它提供了多种比较模式和自定义功能。然而，当我们需要对特定数据类型（而非仅仅是特定字段）进行定制化比较，例如将JSON中的true与1视为相等，或false与0视为相等时，传统的字段级定制可能无法满足需求，甚至可能导致无法获得详细的差异报告。
传统字段定制的局限性
JSONAssert允许通过Customization类对特定字段路径进行自定义比较。例如：
CustomComparator comparator = new CustomComparator( JSONCompareMode.LENIENT, new Customization("field.number", (o1, o2) -> true), // 忽略此字段 new Customization("field.code", (o1, o2) -> true)); // 忽略此字段JSONAssert.assertEquals(expectedJsonAsString, actualJsonAsString, comparator);
这种方式适用于忽略特定字段或对特定字段进行简单的值匹配。但是，如果尝试将其应用于所有字段（使用”*”通配符）并尝试进行数据类型转换，例如布尔值与整数的转换，会遇到两个主要问题：
粒度不足： Customization主要针对字段路径，而不是数据类型本身。缺乏详细差异报告： ValueMatcher的equal方法只返回一个布尔值，表示是否相等。如果返回false，JSONAssert无法提供具体的差异信息（即哪个值与哪个值不匹配），这使得调试变得困难。
为了实现数据类型的定制化比较并保留详细的差异报告，我们需要一种更底层的扩展方式。
扩展DefaultComparator实现数据类型比较
JSONAssert的DefaultComparator是所有比较逻辑的基础。通过扩展它并重写compareValues方法，我们可以介入到值级别的比较过程，从而实现对特定数据类型的定制处理。
compareValues方法提供了以下参数：
Calliper 文档对比神器
文档内容对比神器
28 查看详情 prefix: 当前正在比较的JSON路径前缀，用于生成差异报告。expectedValue: 期望的JSON值。actualValue: 实际的JSON值。result: JSONCompareResult对象，用于记录比较结果和差异。
以下是一个示例，展示如何创建一个自定义比较器，以处理布尔值和整数之间的等价性比较（true与1，false与0）：
import org.json.JSONException;import org.skyscreamer.jsonassert.JSONCompareMode;import org.skyscreamer.jsonassert.JSONCompareResult;import org.skyscreamer.jsonassert.comparator.DefaultComparator;import org.apache.commons.lang3.BooleanUtils; // 假设使用Apache Commons Lang进行布尔值到整数的转换/** * 一个自定义的JSON比较器，用于处理布尔值与整数之间的等价性比较。 * 例如，将true与1、false与0视为相等。 */private static class BooleanNumberCustomComparator extends DefaultComparator { public BooleanNumberCustomComparator(final JSONCompareMode mode) { super(mode); } @Override public void compareValues(String prefix, Object expectedValue, Object actualValue, JSONCompareResult result) throws JSONException { // 场景1: 期望值是数字，实际值是布尔值 if (expectedValue instanceof Number && actualValue instanceof Boolean) { // 将布尔值转换为整数 (true -> 1, false -> 0) 进行比较 if (BooleanUtils.toInteger((boolean)actualValue) != ((Number) expectedValue).intValue()) { // 如果不匹配，则记录失败，并提供详细的期望值和实际值 result.fail(prefix, expectedValue, actualValue); } } // 场景2: 期望值是布尔值，实际值是数字 else if (expectedValue instanceof Boolean && actualValue instanceof Number) { // 将布尔值转换为整数 (true -> 1, false -> 0) 进行比较 if (BooleanUtils.toInteger((boolean)expectedValue) != ((Number) actualValue).intValue()) { // 如果不匹配，则记录失败 result.fail(prefix, expectedValue, actualValue); } } // 对于其他类型或不符合上述条件的比较，回退到默认的比较逻辑 else { super.compareValues(prefix, expectedValue, actualValue, result); } }}
在上述代码中：
我们首先判断expectedValue和actualValue是否分别是Number和Boolean（或反之）。如果是，我们使用BooleanUtils.toInteger（来自Apache Commons Lang库）将布尔值转换为整数（true转为1，false转为0），然后与数字值进行比较。如果转换后的值不相等，我们调用result.fail(prefix, expectedValue, actualValue)来记录失败。这会确保在比较报告中显示详细的路径、期望值和实际值，极大地提高了调试效率。如果当前比较的值不属于我们想要特殊处理的布尔-数字组合，我们调用super.compareValues(prefix, expectedValue, actualValue, result)，将比较任务委托给父类DefaultComparator的默认逻辑。
使用自定义比较器
创建好自定义比较器后，其使用方式与内置比较器一样简单：
import org.skyscreamer.jsonassert.JSONAssert;import org.skyscreamer.jsonassert.JSONCompareMode;public class JsonComparisonExample { public static void main(String[] args) throws JSONException { String expectedJson = "{ "status": 1, "enabled": true }"; String actualJson = "{ "status": 1, "enabled": 1 }"; // 注意这里 enabled 是 1 // 使用自定义比较器进行断言 JSONAssert.assertEquals(expectedJson, actualJson, new BooleanNumberCustomComparator(JSONCompareMode.STRICT)); System.out.println("JSON比较成功！"); // 如果断言通过，则输出 }}
在这个例子中，尽管expectedJson中的enabled是布尔值true，而actualJson中是数字1，但由于BooleanNumberCustomComparator的处理，它们会被视为相等，断言将通过。如果将actualJson中的enabled改为0，断言也会通过。如果改为2，则会失败并报告详细差异。
注意事项与总结
JSONCompareMode： 在实例化自定义比较器时，仍需传入JSONCompareMode，它定义了整体的比较策略（如STRICT、LENIENT、NON_EXTENSIBLE等）。依赖： 如果您使用了BooleanUtils等工具类，请确保项目中包含了相应的依赖（例如org.apache.commons:commons-lang3）。可扩展性： 这种扩展DefaultComparator的方式非常灵活，您可以根据需要处理各种复杂的数据类型转换和比较逻辑，例如日期字符串与时间戳的比较、特定格式字符串的正则匹配等。详细报告： 最重要的优势是能够利用JSONCompareResult的fail方法，在自定义逻辑中精确地报告差异，这对于问题排查至关重要。
通过扩展DefaultComparator并重写compareValues方法，我们能够为JSONAssert提供强大的数据类型级别定制能力，从而应对更复杂的JSON比较场景，同时保留了详细的差异报告功能，极大地提升了测试的准确性和可维护性。
以上就是使用Skyscreamer JSONAssert实现数据类型定制化比较器的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/632440.html
微信扫一扫 
支付宝扫一扫 
