Fixture Factory 使用与技术文档

1. 安装指南

将 Fixture Factory 作为项目依赖项添加，如同 Maven 依赖关系一样：

<dependency>
    <groupId>br.com.six2six</groupId>
    <artifactId>fixture-factory</artifactId>
    <version>3.1.0</version>
</dependency>

2. 项目的使用说明

模板规则编写

可以通过定义模板规则来创建测试数据。以下是如何为 Client 类和 Address 类编写模板的示例：

Fixture.of(Client.class).addTemplate("valid", new Rule() {{
    add("id", random(Long.class, range(1L, 200L)));
    add("name", random("Anderson Parra", "Arthur Hirata"));
    add("nickname", random("nerd", "geek"));
    add("email", "${nickname}@gmail.com");
    add("birthday", instant("18 years ago"));
    add("address", one(Address.class, "valid"));
}});

Fixture.of(Address.class).addTemplate("valid", new Rule() {{
    add("id", random(Long.class, range(1L, 100L)));
    add("street", random("Paulista Avenue", "Ibirapuera Avenue"));
    add("city", "São Paulo");
    add("state", "${city}");
    add("country", "Brazil");
    add("zipCode", random("06608000", "17720000"));
}});

模板继承

你也可以基于一个已存在的模板创建一个新的模板，并覆盖其中的某些属性定义：

Fixture.of(Address.class).addTemplate("augustaStreet").inherits("valid", new Rule() {{
    add("street", "Augusta Street");
}});

测试代码中的使用

以下是如何在测试代码中使用定义好的模板来生成对象：

• 生成一个符合 "valid" 标签的对象：

Client client = Fixture.from(Client.class).gimme("valid");

• 生成多个符合 "valid" 标签的对象：

List<Client> clients = Fixture.from(Client.class).gimme(5, "valid");

• 生成多个对象，每个对象符合不同的标签：

List<Client> clients = Fixture.from(Client.class).gimme(2, "valid", "invalid");

3. 项目API使用文档

模板管理

模板可以在 TemplateLoader 接口内编写：

public class ClientTemplateLoader implements TemplateLoader {
    @Override
    public void load() {
        Fixture.of(Client.class).addTemplate("valid", new Rule() {{
            add("id", random(Long.class, range(1L, 200L)));
            // 其他属性规则...
        }});
        // 其他模板...
    }
}

使用 FixtureFactoryLoader 加载模板：

FixtureFactoryLoader.loadTemplates("br.com.six2six.template");

自定义处理器

实现 Processor 接口，在对象生成后执行自定义逻辑：

public class MyCustomProcessor implements Processor {
    public void execute(Object object) {
        // 对生成的对象执行操作
    }
}

并在生成对象时使用它：

Fixture.from(SomeClass.class).uses(new MyCustomProcessor()).gimme("someTemplate");

关系（一对一和一对多）

可以为包含关系的类定义模板，如 Order 类和 Item 类：

Fixture.of(Order.class).addTemplate("valid", new Rule() {{
    add("id", random(Long.class, range(1L, 200L)));
    add("items", has(3).of(Item.class, "valid"));
    add("payment", one(Payment.class, "valid"));
}});

日期和时间

提供了一些处理日期和时间的函数：

Fixture.of(Any.class).addTemplate("valid", new Rule() {{
    add("dueDate", beforeDate("2011-04-15", new SimpleDateFormat("yyyy-MM-dd")));
    // 其他日期规则...
}});

姓名生成

可以生成随机的姓名：

Fixture.of(Any.class).addTemplate("valid", new Rule() {{
    add("firstName", firstName());
    add("lastName", lastName());
}});

唯一随机值

对于需要每次生成唯一值的属性，可以使用 uniqueRandom 函数：

Fixture.of(Any.class).addTemplate("valid", new Rule() {{
    add("country", "Brazil");
    add("state", uniqueRandom("São Paulo", "Rio de Janeiro", "Minas Gerais", "Bahia"));
}});

CNPJ 生成

生成巴西的公司注册号（CNPJ）：

Fixture.of(User.class).addTemplate("valid", new Rule() {{
    add("cnpj", cnpj());
    add("cnpj", cnpj(true)); // 格式化的 CNPJ
}});

更多使用示例可以在项目的测试代码中找到。

4. 项目安装方式

请按照“安装指南”部分所述，将 Fixture Factory 添加为项目依赖项。如果你使用的是 Maven，只需将提供的依赖项添加到你的 pom.xml 文件中。如果你使用的是其他构建工具，请按照该工具的指南来添加依赖项。