简化测试断言与反射绕过封装的实用指南

### 简化测试断言与反射绕过封装的实用指南 #### 1. 测试断言的重要性 在测试用例开发中，拥有强大的断言方法工具包至关重要，主要体现在两个方面：提高生产力和增强清晰度。当编写测试用例时，我们的重点通常是测试用例的逻辑，而断言只是辅助手段。例如，要断言一个变量大于某个特定数字，我们可能会本能地写出 `assertTrue(x > 42)`。当条件为真时，这种断言方式没问题，但当条件失败时，只会得到一个 `junit.framework.AssertionFailedError: null` 消息，这显然不够清晰。另一种方法是在断言中包含消息，如 `assertTrue("X should be greater than 42, but it is " + x, x > 42)`，虽然清晰度有所提高，但会降低生产力，因为需要创建一个包含变量名、操作符和当前值的长字符串，这既繁琐又容易出错。更好的方法是使用专门用于比较的断言方法，如 `assertGreaterThan(x, 42)`。 JUnit 自带的 `org.junit.Assert` 类提供了一些基本的断言方法，但在某些特定情况下，如比较集合或 JavaBean 的属性时，这些方法就显得不足了。幸运的是，许多第三方库提供了补充性的断言方法，下面将分析其中几个。 #### 2. 第三方断言库分析 ##### 2.1 JUnit - addons 断言包 JUnit - addons 在 `junitx.framework` 包中提供了一系列 `XXXAssert` 类，如 `ListAssert` 和 `FileAssert`，每个类都提供了用于断言特定对象的静态方法。虽然其中一些断言功能现在在 JUnit 4.x 中也有，但仍有一些功能缺失。例如，JUnit 的 `Assert` 类提供了 `assertTrue()`、`assertFalse()` 和 `assertEquals()` 方法，但没有 `assertNotEquals()` 方法，而 JUnit - addons 的 `Assert` 类提供了该方法。 - **ComparableAssert 类**：用于断言实现了 `java.lang.Comparable` 接口的对象（数字是这类对象的子集）。例如，要断言变量 `x` 大于 42，可以这样写： ```java ComparableAssert.assertGreater(42, x); ``` 如果断言失败，会得到如下消息： ``` junit.framework.AssertionFailedError: expected greater than:<42> but was:<23> ``` - **ListAssertions 类**：提供了验证列表的方法，主要有 `assertEquals(List, List)` 和 `assertContains(List, Object)`。下面定义几个列表用于测试： ```java import java.util.Arrays; import java.util.List; public class ListTest { public static void main(String[] args) { List<Integer> LIST1 = Arrays.asList(4, 8, 15, 16, 23, 42); List<Integer> LIST2 = Arrays.asList(108); List<Integer> LIST3 = Arrays.asList(4, 8, 15, 16, 42, 23); List<Integer> LIST4 = Arrays.asList(4, 8, 15, 16, 108, 23); } } ``` 如果使用 JUnit 的 `assertEquals()` 方法比较 `LIST1` 和 `LIST4`，会得到如下消息： ``` java.lang.AssertionError: expected:<[4, 8, 15, 16, 23, 42]> but was:<[4, 8, 15, 16, 108, 23]> ``` 虽然消息包含了列表的内容，但很难看出它们不相等的原因。而使用 JUnit - addons 的 `ListAssert.assertEquals()` 方法，结果如下： ``` junit.framework.AssertionFailedError: expecting <42> in <4, 8, 15, 16, 108, 23> ``` 这个消息更好一些，但它只表明缺少一个元素，没有指出列表不同的位置。而且，该方法无法检测出 `LIST1` 和 `LIST3` 的不同，因为它认为元素顺序不重要，这在 Javadoc 中有说明：“Asserts that two lists are equal (the order is not relevant)”。如果列表大小不同，如 `LIST1` 和 `LIST2`，消息会更让人困惑： ``` junit.framework.AssertionFailedError: expecting <4> in <108> ``` 不过，`ListAssert` 提供的 `assertContains()` 方法很有用。例如，调用 `ListAssert.assertContains(LIST1, 666)` 会得到： ``` junit.framework.AssertionFailedError: expecting <666> in <4, 8, 15, 16, 23, 42> ``` 此外，JUnit - addons 还提供了其他断言类，如 `FileAssert`（用于比较文本甚至二进制文件的内容）、`NamingAssert`（用于 JNDI 相关的断言）、`StringAssert`（包含用于 String 自身方法的断言方法，如 `assertStartsWith()`）和 `ObjectAssert`（包含如 `assertInstanceOf()` 等方法），这些类简单直接，提供的功能很实用。 ##### 2.2 Unitils 的 ReflectionAssert Unitils 只有一个提供扩展断言的类：`org.unitils.reflectionassert.ReflectionAssert`。这个类非常强大，它可以使用反射比较多种类型的对象，从简单的 JavaBean 到集合和 Hibernate 代理。具体来说，它使用反射比较每个字段的值，并提供了强化或放宽比较的选项，如只比较非空字段或忽略日期。 `ReflectionAssert` 包含几十个方法，使用起来并不简单。有些方法名称相似，如 `assertLenEquals()` 和 `assertLenientEquals()`，前者已被弃用并调用后者；许多方法接受一个 `ReflectionComparatorMode` 数组作为参数，这是一个定义比较行为的枚举，且该数组是可变参数，意味着方法在不传递该参数时也能工作。 下面从该类的主要方法 `assertReflectionEquals()` 开始介绍。该方法的完整签名是 `assertReflectionEquals(Object expected, Object actual, ReflectionComparatorMode... modes)`，由于 `modes` 参数是可变参数，所以是可选的。如果不传递比较模式，它会对所有字段进行严格比较。例如，有两个 `User` 对象，`user1` 的 `username` 字段为 `null`，调用 `assertReflectionEquals(user1, user2)` 会得到如下结果： ``` junit.framework.AssertionFailedError: Found following differences: username => null => "ElDuderino" --- Difference details --- => User<id=0, username=null, firstName="Jeffrey", lastName="Lebowsky", telephones=[]> => User<id=0, username="ElDuderino", firstName="Jeffrey", lastName="Lebowsky", telephones=[]> username => null username => "ElDuderino" ``` 不仅能找到差异，还会打印出简要和详细的错误信息。如果想忽略空字段，需要传递 `ReflectionComparatorMode.IGNORE_DETAILS` 模式作为参数，如 `assertReflectionEquals(user1, user2, IGNORE_DETAILS)`。需要注意的是，这里的顺序很重要，只有当预期参数中的字段值为 `null` 时，才会忽略该字段。例如，调用 `assertReflectionEquals(user2, user1, IGNORE_DETAILS)` 会失败，而 `assertReflectionEquals(user1, user2, IGNORE_DETAILS)` 会通过。 另外两个比较模式是 `LENIENT_DATES`（在比较中忽略 `java.util.Date` 类型的字段）和 `LENIENT_ORDER`（仅在比较集合时有用）。由于宽松比较很常见，`ReflectionAssert` 的大多数 `assertReflectionXXX()` 方法都有一个对应的 `assertLenientXXX()` 方法，会自动包含 `IGNORE_DETAILS` 和 `LENIENT_ORDER`，如 `assertLenientEquals(Object expect, Object actual)`。这种设计的目的是，在很多情况下，被测试的功能不会填充对象的每个字段，如果要比较所有字段会增加很多工作量，这在数据库访问测试中特别有用。 这些方法也可用于比较集合。例如，使用前面定义的列表，调用 `assertReflectionEquals(LIST1, LIST4)` 会得到： ``` junit.framework.AssertionFailedError: Found following differences: [4] => 23 => 108 [5] => 42 => 23 --- Difference details --- => [4, 8, 15, 16, 23, 42] => [4, 8, 15, 16, 108, 23] [4] => 23 [4] => 108 [5] => 42 [5] => 23 ``` 这个消息乍一看可能有些晦涩，但其实很直接，它表明索引 4 和 5 处的元素不同。如果元素顺序不重要，可以传递 `LENIENT_ORDER` 作为参数或调用 `assertLenientEquals()` 方法，此时消息会稍有不同： ``` junit.framework.AssertionFailedError: Found following differences: [5,4] => 42 => 108 --- Difference details --- => [4, 8, 15, 16, 23, 42] => [4, 8, 15, 16, 108, 23] [5,4] => 42 [5,4] => 108 ``` 这表明两个列表只有一个元素不同，但位置不同。总体而言，`ReflectionAssert` 是一个强大的类，一旦克服了学习曲线，它将成为日常断言的宝贵工具。 ##### 2.3 FEST Fluent Assertions Module FEST Fluent Assertions Module（也称为 FEST - Assert）为多种类型的对象提供了自定义断言，如集合、字符串、异常、文件、BigDecimal 甚至 BufferedImage。它不仅支持多种对象类型，而且断言的语法不同，类似于 Hamcrest 语法，但更自然，因为断言方法可以链式调用。 断言的入口点是 `org.fest.assertions.Assertions` 类的 `assertThat(actual)` 方法，该方法有十几种重载形式，每种形式的 `actual` 参数类型不同，并返回适合该类型的断言类。以 `x > 42` 为例，假设 `x` 是 `int` 类型，断言可以这样写： ```java import org.fest.assertions.Assertions; public class FestAssertExample { publi ```