嵌入式数据库支持

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

为何使用嵌入式数据库?

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

创建嵌入式数据库

您可以将嵌入式数据库实例作为 bean 暴露,如下例所示

  • Java

  • Kotlin

  • Xml

@Bean
DataSource dataSource() {
	return new EmbeddedDatabaseBuilder()
			.generateUniqueName(true)
			.setType(EmbeddedDatabaseType.H2)
			.addScripts("schema.sql", "test-data.sql")
			.build();
}
@Bean
fun dataSource() = EmbeddedDatabaseBuilder()
	.generateUniqueName(true)
	.setType(EmbeddedDatabaseType.H2)
	.addScripts("schema.sql", "test-data.sql")
	.build()
<jdbc:embedded-database id="dataSource" generate-name="true" type="H2">
	<jdbc:script location="classpath:schema.sql"/>
	<jdbc:script location="classpath:test-data.sql"/>
</jdbc:embedded-database>

上述配置创建了一个嵌入式 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。如果使用 builder API,请调用 setType(EmbeddedDatabaseType) 方法并传入 EmbeddedDatabaseType.HSQL

使用 H2

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

使用 Derby

Spring 支持 Apache Derby 10.5 及以上版本。要启用 Derby,请将 embedded-database 标签的 type 属性设置为 DERBY。如果使用 builder 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 Framework 并按照 创建嵌入式数据库 中所述,将嵌入式数据库配置为 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 定义 profile 方面有所不同。

此类错误的根本原因在于 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 社区贡献扩展。