在 Cucumber 测试中自动将 Cucumber 数据表映射到 Java 对象-阿里云开发者社区

在 Cucumber 测试中自动将 Cucumber 数据表映射到 Java 对象

2024-10-13 10

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 在 Cucumber 测试中自动将 Cucumber 数据表映射到 Java 对象

作为 Java 开发人员，使用 Cucumber 进行行为驱动开发（BDD）是一种很好的方法，可以通过使用通俗易懂的语言编写测试来确保代码满足业务要求。Cucumber 最强大的功能之一是能够在功能文件中使用数据表。但是，手动将这些表映射到 Java 对象可能是重复的，并且容易出错。

为了简化此过程，库 cucumber-datatable-to-bean mapping 旨在自动将 Cucumber 数据表映射到 Java 对象。在本文中，我将向您介绍该库的功能，以及如何轻松地将其集成到 Cucumber 项目中，以节省时间并减少样板代码。

如何使用 cucumber-datatable-to-bean 映射

让我们深入了解如何在项目中使用此库。

第 1 步：将库添加到您的项目中

首先，您需要将 cucumber-datatable-to-bean 映射库添加到您的 Maven 或 Gradle 项目中。

对于 Maven，请将以下依赖项添加到您的 pom.xml：

XML 格式

<dependency>
    <groupId>io.github.deblockt</groupId>
    <artifactId>cucumber-datatable-to-bean-mapping</artifactId>
    <version>1.1.2</version>
</dependency>

对于 Gradle，请将以下内容添加到您的 build.gradle 中：

槽的

implementation 'io.github.deblockt:cucumber-datatable-to-bean-mapping:1.1.2'

第 2 步：定义 Java Bean

创建一个 Java Bean 类，该类表示要从 Cucumber 数据表映射的数据结构。使用 Java 注释来指定表头和 Bean 字段之间的映射。

例如，假设您有一个特征文件，其中包含如下所示的数据表：

小黄瓜

Given the following users exist
  | first name | last name | email                  |
  | John       | Doe       | john.doe@example.com   |
  | Jane       | Smith     | jane.smith@example.com |

您可以为User

爪哇岛

import com.deblock.cucumber.datatable.annotations.DataTableWithHeader;
import com.deblock.cucumber.datatable.annotations.Column;
@DataTableWithHeader
public class User {
    @Column
    private String firstName;
    @Column
    private String lastName;
    @Column
    private String email;
    // Getter / Setter
}
// Or use a record
@DataTableWithHeader
public record User(@Column String firstName, @Column String lastName, @Column String email) {}

步骤 3：注释您的步骤定义

现在，您可以在步骤定义中使用此类。

例如：

爪哇岛

import io.cucumber.java.en.Given;
import java.util.List;
public class UserStepDefinitions {
    @Given("the following users exist")
    public void theFollowingUsersExist(List<User> users) {
        for (User user : users) {
            System.out.println("Creating user: " + user.getFirstName() + " " + user.getLastName());
            // Logic to handle user creation
        }
    }
}

第 4 步：运行 Cucumber 测试

就这样：您现在可以运行 Cucumber 测试，该库会自动将数据表映射到对象列表。步骤定义中的 s 参数将填充特征文件中的数据，并且您可以轻松地迭代用户并执行任何必要的逻辑。UserUser

配置

Column Extra 配置

前面的示例使用默认库配置。但是，您可以在注释中提供更多详细信息，例如设置字段描述、定义字段是否为必填字段或指定列的默认值。@Column

爪哇岛

@DataTableWithHeader
public class User {
    @Column(mandatory = false, description = "The custom first name")
    private String firstName;
    @Column(defaultValue = "Doe")
    private String lastName;
    @Column(value = "overridden email name")
    private String email;
    // Getters and Setters
}

库配置

默认情况下，列名是使用人类可读格式（驼峰式命名法转换为带空格的单词）从字段名生成的。您可以通过向文件添加特定属性来覆盖此行为。cucumber.properties

属性文件

cucumber.datatable.mapper.name-builder-class=com.deblock.cucumber.datatable.mapper.name.UseFieldNameColumnNameBuilder

使用此配置，列名称将直接使用字段名称，而无需将其转换为人类可读的格式。

此外，虽然通常建议使用注释注释所有 Data Table 列，但您可以将库配置为自动将所有类字段用作 Data Table 列。@Column

属性文件

cucumber.datatable.mapper.field-resolver-class=com.deblock.cucumber.datatable.mapper.datatable.fieldresolvers.ImplicitFieldResolver
1.
使用此配置，您可以更简洁地定义 Java bean：
爪哇岛
@DataTableWithHeader
public class User {
    private String firstName;
    private String lastName;
    private String email;
    @Ignore
    private String externalInformation;
    // Getters and Setters
}