FEST-Assert 技术文档

1. 安装指南

1.1 依赖引入

要使用 FEST-Assert 库，首先需要在项目的构建文件中添加相应的依赖。以下是 Maven 和 Gradle 的依赖配置示例：

Maven

<dependency>
    <groupId>org.easytesting</groupId>
    <artifactId>fest-assert</artifactId>
    <version>2.0M10</version>
    <scope>test</scope>
</dependency>

Gradle

testImplementation 'org.easytesting:fest-assert:2.0M10'

1.2 下载 JAR 文件

如果不想通过构建工具引入依赖，可以直接从 Maven Central Repository 下载 FEST-Assert 的 JAR 文件，并将其添加到项目的 lib 目录中。

2. 项目的使用说明

2.1 基本用法

FEST-Assert 提供了一个流畅的接口来编写断言。以下是一个简单的示例：

int removed = employees.removeFired();
assertThat(removed).isZero();

List<Employee> newEmployees = employees.hired(TODAY);
assertThat(newEmployees).hasSize(6)
                        .contains(frodo, sam);

assertThat(yoda).isInstanceOf(Jedi.class)
                .isEqualTo(foundJedi)
                .isNotEqualTo(foundSith);

2.2 流畅接口

FEST-Assert 的流畅接口使得断言代码非常易读。只需在实际值后输入 assertThat，然后通过点号调用相应的断言方法。IDE 会自动提示可用的断言方法，减少了混淆 "expected" 和 "actual" 值的错误。

2.3 模块化支持

FEST-Assert 提供了多个模块，以支持不同类型的断言：

• Joda Time 断言：用于 Joda Time 库的断言。
• Guava 断言：用于 Google Guava 库的断言。
• Android 断言：专门为 Android 平台设计的断言。

3. 项目 API 使用文档

3.1 常用断言方法

以下是一些常用的断言方法及其用法：

3.1.1 assertThat

assertThat 是所有断言的入口方法，用于指定要断言的实际值。

assertThat(actualValue);

3.1.2 isZero

断言实际值为零。

assertThat(removed).isZero();

3.1.3 hasSize

断言集合的大小。

assertThat(newEmployees).hasSize(6);

3.1.4 contains

断言集合包含指定的元素。

assertThat(newEmployees).contains(frodo, sam);

3.1.5 isInstanceOf

断言对象的类型。

assertThat(yoda).isInstanceOf(Jedi.class);

3.1.6 isEqualTo

断言对象相等。

assertThat(yoda).isEqualTo(foundJedi);

3.1.7 isNotEqualTo

断言对象不相等。

assertThat(yoda).isNotEqualTo(foundSith);

3.2 自定义断言

FEST-Assert 支持自定义断言。可以通过继承 GenericAssert 类来创建自定义断言类。

public class EmployeeAssert extends GenericAssert<EmployeeAssert, Employee> {
    public EmployeeAssert(Employee actual) {
        super(EmployeeAssert.class, actual);
    }

    public EmployeeAssert isActive() {
        isNotNull();
        if (!actual.isActive()) {
            failWithMessage("Expected employee to be active but was not.");
        }
        return this;
    }
}

4. 项目安装方式

4.1 通过 Maven 安装

在项目的 pom.xml 文件中添加 FEST-Assert 的依赖，如上文所述。

4.2 通过 Gradle 安装

在 build.gradle 文件中添加 FEST-Assert 的依赖，如上文所述。

4.3 手动安装

从 Maven Central 下载 FEST-Assert 的 JAR 文件，并将其添加到项目的 lib 目录中。

通过以上步骤，您可以顺利安装并使用 FEST-Assert 库，享受其流畅的断言接口和丰富的功能。