嵌入式数据库支持

org.springframework.jdbc.datasource.embedded 包提供了对嵌入式 Java 数据库引擎的支持。对 HSQLH2Derby 的支持是原生提供的。你还可以使用可扩展的 API 来插入新的嵌入式数据库类型和 DataSource 实现。

为什么使用嵌入式数据库?

嵌入式数据库因其轻量级特性,在项目开发阶段非常有用。其优点包括易于配置、启动时间快、可测试性以及在开发过程中快速演进 SQL 的能力。

创建嵌入式数据库

你可以将嵌入式数据库实例作为 bean 公开,如下例所示:

上述配置创建了一个嵌入式 H2 数据库,该数据库通过类路径根目录下的 schema.sqltest-data.sql 资源中的 SQL 进行填充。此外,作为最佳实践,嵌入式数据库被分配了一个唯一生成的名字。嵌入式数据库作为 javax.sql.DataSource 类型的 bean 提供给 Spring 容器,然后可以根据需要注入到数据访问对象中。

有关所有支持选项的更多详细信息,请参阅 EmbeddedDatabaseBuilder 的 Javadoc

选择嵌入式数据库类型

本节介绍如何选择 Spring 支持的三种嵌入式数据库之一。它包括以下主题:

使用 HSQL

Spring 支持 HSQL 1.8.0 及更高版本。如果未明确指定类型,HSQL 是默认的嵌入式数据库。要明确指定 HSQL,请将 embedded-database 标签的 type 属性设置为 HSQL。如果你使用构建器 API,请调用 setType(EmbeddedDatabaseType) 方法,并将 EmbeddedDatabaseType.HSQL 作为参数。

使用 H2

Spring 支持 H2 数据库。要启用 H2,请将 embedded-database 标签的 type 属性设置为 H2。如果你使用构建器 API,请调用 setType(EmbeddedDatabaseType) 方法,并将 EmbeddedDatabaseType.H2 作为参数。

使用 Derby

Spring 支持 Apache Derby 10.5 及更高版本。要启用 Derby,请将 embedded-database 标签的 type 属性设置为 DERBY。如果你使用构建器 API,请调用 setType(EmbeddedDatabaseType) 方法,并将 EmbeddedDatabaseType.DERBY 作为参数。

自定义嵌入式数据库类型

虽然每种支持的类型都带有默认连接设置,但如有必要,可以对其进行自定义。以下示例使用 H2 和自定义驱动程序:

  • Java

  • Kotlin

@Configuration
public class DataSourceConfig {

	@Bean
	public DataSource dataSource() {
		return new EmbeddedDatabaseBuilder()
				.setDatabaseConfigurer(EmbeddedDatabaseConfigurers
						.customizeConfigurer(H2, this::customize))
				.addScript("schema.sql")
				.build();
	}

	private EmbeddedDatabaseConfigurer customize(EmbeddedDatabaseConfigurer defaultConfigurer) {
		return new EmbeddedDatabaseConfigurerDelegate(defaultConfigurer) {
			@Override
			public void configureConnectionProperties(ConnectionProperties properties, String databaseName) {
				super.configureConnectionProperties(properties, databaseName);
				properties.setDriverClass(CustomDriver.class);
			}
		};
	}
}
@Configuration
class DataSourceConfig {

	@Bean
	fun dataSource(): DataSource {
		return EmbeddedDatabaseBuilder()
			.setDatabaseConfigurer(EmbeddedDatabaseConfigurers
				.customizeConfigurer(EmbeddedDatabaseType.H2) { this.customize(it) })
			.addScript("schema.sql")
			.build()
	}

	private fun customize(defaultConfigurer: EmbeddedDatabaseConfigurer): EmbeddedDatabaseConfigurer {
		return object : EmbeddedDatabaseConfigurerDelegate(defaultConfigurer) {
			override fun configureConnectionProperties(
				properties: ConnectionProperties,
				databaseName: String
			) {
				super.configureConnectionProperties(properties, databaseName)
				properties.setDriverClass(CustomDriver::class.java)
			}
		}
	}
}

使用嵌入式数据库测试数据访问逻辑

嵌入式数据库提供了一种轻量级的方式来测试数据访问代码。下一个示例是使用嵌入式数据库的数据访问集成测试模板。当嵌入式数据库不需要在测试类之间重用时,使用这样的模板对于一次性测试可能很有用。但是,如果你希望创建在测试套件中共享的嵌入式数据库,请考虑使用 Spring TestContext 框架,并按照 创建嵌入式数据库 中所述,将嵌入式数据库配置为 Spring ApplicationContext 中的 bean。以下列表显示了测试模板:

  • Java

  • Kotlin

public class DataAccessIntegrationTestTemplate {

	private EmbeddedDatabase db;

	@BeforeEach
	public void setUp() {
		// creates an HSQL in-memory database populated from default scripts
		// classpath:schema.sql and classpath:data.sql
		db = new EmbeddedDatabaseBuilder()
				.generateUniqueName(true)
				.addDefaultScripts()
				.build();
	}

	@Test
	public void testDataAccess() {
		JdbcTemplate template = new JdbcTemplate(db);
		template.query( /* ... */ );
	}

	@AfterEach
	public void tearDown() {
		db.shutdown();
	}

}
class DataAccessIntegrationTestTemplate {

	private lateinit var db: EmbeddedDatabase

	@BeforeEach
	fun setUp() {
		// creates an HSQL in-memory database populated from default scripts
		// classpath:schema.sql and classpath:data.sql
		db = EmbeddedDatabaseBuilder()
				.generateUniqueName(true)
				.addDefaultScripts()
				.build()
	}

	@Test
	fun testDataAccess() {
		val template = JdbcTemplate(db)
		template.query( /* ... */)
	}

	@AfterEach
	fun tearDown() {
		db.shutdown()
	}
}

为嵌入式数据库生成唯一名称

如果测试套件无意中尝试重新创建同一数据库的额外实例,开发团队经常会遇到嵌入式数据库错误。如果 XML 配置文件或 @Configuration 类负责创建嵌入式数据库,并且相应的配置随后在同一测试套件(即同一 JVM 进程)中的多个测试场景中重复使用,这种情况很容易发生——例如,针对嵌入式数据库的集成测试,其 ApplicationContext 配置仅在哪些 bean 定义配置文件处于活动状态方面有所不同。

此类错误的根本原因是 Spring 的 EmbeddedDatabaseFactory(内部由 <jdbc:embedded-database> XML 命名空间元素和用于 Java 配置的 EmbeddedDatabaseBuilder 使用)在未另行指定的情况下将嵌入式数据库的名称设置为 testdb。对于 <jdbc:embedded-database> 的情况,嵌入式数据库通常被分配一个等于 bean 的 id 的名称(通常是 dataSource 之类的)。因此,后续创建嵌入式数据库的尝试不会导致创建新数据库。相反,相同的 JDBC 连接 URL 被重复使用,并且创建新嵌入式数据库的尝试实际上指向从同一配置创建的现有嵌入式数据库。

为了解决这个常见问题,Spring Framework 4.2 提供了为嵌入式数据库生成唯一名称的支持。要启用生成名称的使用,请使用以下选项之一。

  • EmbeddedDatabaseFactory.setGenerateUniqueDatabaseName()

  • EmbeddedDatabaseBuilder.generateUniqueName()

  • <jdbc:embedded-database generate-name="true" …​ >

扩展嵌入式数据库支持

你可以通过两种方式扩展 Spring JDBC 嵌入式数据库支持:

  • 实现 EmbeddedDatabaseConfigurer 以支持新的嵌入式数据库类型。

  • 实现 DataSourceFactory 以支持新的 DataSource 实现,例如连接池来管理嵌入式数据库连接。

我们鼓励你向 GitHub Issues 上的 Spring 社区贡献扩展。