将H2应用在测试环境中

将H2应用在测试环境中

上篇文章中介绍了 H2 的一些特性。H2 因其提供了内存数据库的模式,经常应用在测试当中,快速验证某些SQL 操作的结果。本文将 H2 应用于测试中的原因,并使用一个简单的实例说明 H2 在测试中的使用。

对 H2 提供的全文索引感兴趣可参考:《H2 提供全文索引功能》

1, 为什么将 H2 适合应用在测环境中?

代码中的测试需要满足 FIRST 原则:

Fast 快的

Independent 独立的

Repeatable 可重复的

Self-validating 自验证的

Timely 及时的

传统的数据库安装、启动使用都需要一个很长的过长,无法满足测试环境对快速验证的需求。而

  1. H2 提供了 In-Memory Mode,能将数据在内存中进行操作,速度会记更加快,能够让测试快读验证;
  2. 另外由于 H2 安装、启动都非常方便能够使测试在本地、集成测试环境能够快速搭建测试环境并进行验证;
  3. In-Memory Mode 的 H2 每次启动程序都能够得到一致的数据上下文,方便构建测试数据环境;
  4. H2 对数据类型、SQL 支持的较为完成,合适的环境更加丰富;

2, Spring Boot 项目测试中使用 H2

这里项目环境是使用 Gralde 构建的 Spring Boot 项目。源码: github.com/tengbai/h2-f

  1. 在 build.gradle 中引入 H2
testImplementation 'com.h2database:h2'
  1. 编写一个测试并补齐其依赖上下文
@SpringBootTest
class CarRepositoryTest {

    @Autowired
    private CarRepository carRepository;

    @Test
    void should_got_3L_order_when_count_given_a_new_order_and_initialized_2_cars_in_sql() {
        carRepository.save(new Car("Mazda"));

        long countAfterSavedNew = carRepository.count();

        then(countAfterSavedNew).isEqualTo(3L);
    }
}
  1. 补齐测试相关的依赖
@NoArgsConstructor
@Data
@Entity
@Table(name = "cars")
public class Car {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private long id;

    private String name;

    public Car(String name) {
        this.name = name;
    }
}
@Repository
public interface CarRepository extends JpaRepository<Car, Long> {
}
  1. 配置 build.gradle 中对 H2 的依赖
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'com.h2database:h2'
    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}
  1. 表结构 schema.sql
create table cars
(
    id   bigint generated always as identity not null,
    name varchar(20),
    primary key (id)
);
  1. 初始化 data.sql
insert into cars values (1, 'benz'),(2, 'benz');
  1. 设置测试环境的配置,test/resources/application.properties
spring.datasource.schema=schema.sql
spring.datasource.data=data.sql

spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update

spring.jooq.sql-dialect=org.hibernate.dialect.H2Dialect

其中:

spring.datasource.schema 指定数据库表结构

spring.datasource.data 指定数据库初始化数据

运行测试后,能够看到在 H2 中新增了一条新的数据,测试启动和运行速度非常快。

扩展

借助 flyway 等数据库版本版本管里管理功能,更加更加方便的在本地测试中进行数据库操作的相关测试。

编辑于 2020-05-22