Hamcrest

Hamcrest 是一个用于创建可读性强的断言库的 Java 库。它允许您编写表达式，使测试代码的意图更清晰。

安装

您可以将依赖项添加到项目的 Maven POM 文件中：

<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest-library</artifactId>
    <version>2.2</version>
    <scope>test</scope>
</dependency>

如果您使用 Gradle，可以将依赖项添加到 build.gradle 文件中：

testImplementation 'org.hamcrest:hamcrest-library:2.2'

使用

Hamcrest 提供了一组 Matcher 类，它们可以用于创建断言表达式。这些表达式是可读性强的，因为它们使用了自然语言的风格，它们用于描述结构和性质，而不只是描述值。

以下是一些常见的 Matcher：

• equalTo()：检查值是否等于指定值
• not()：检查值是否不等于指定值
• containsString()：检查字符串中是否存在指定子字符串
• startsWith()：检查字符串是否以指定前缀开头
• endsWith()：检查字符串是否以指定后缀结尾
• greaterThan()：检查值是否大于指定值
• lessThan()：检查值是否小于指定值
• hasSize()：检查集合是否具有指定的大小

以下是使用 Hamcrest 创建的断言表达式的示例：

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.*;

@Test
public void test() {
    String value = "Hello, World!";
    List<Integer> list = Arrays.asList(1, 2, 3);

    assertThat(value, equalTo("Hello, World!"));
    assertThat(value, not(equalTo("Hello")));
    assertThat(value, containsString("World"));
    assertThat(value, startsWith("Hello"));
    assertThat(value, endsWith("!"));
    assertThat(list, hasSize(3));
}

自定义 Matcher

您可以通过实现 Matcher 接口或 Matcher 类来创建自定义 Matcher。Matcher 类提供了一个方法来描述匹配过程的结果，而 Matcher 接口仅返回一个布尔值。

以下是一个自定义 Matcher 的示例：

class IsDivisibleBy extends TypeSafeMatcher<Integer> {
    private final Integer number;

    public IsDivisibleBy(Integer number) {
        this.number = number;
    }

    @Override
    public void describeTo(Description description) {
        description.appendText("is divisible by ")
                   .appendValue(number);
    }

    @Override
    protected boolean matchesSafely(Integer value) {
        return value % number == 0;
    }
}

@Test
public void test() {
    assertThat(10, new IsDivisibleBy(5));
}

结论

Hamcrest 提供了一种更清晰和可读性更强的方式来编写断言表达式。如果您正在编写单元测试，并且希望使代码更易于阅读和维护，请尝试使用 Hamcrest。