此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
嵌入式数据库支持
创建嵌入式数据库
您可以将嵌入式数据库实例公开为 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.sql
和test-data.sql
类路径根目录中的资源。此外,作为
最佳做法是为嵌入式数据库分配一个唯一生成的名称。这
嵌入式数据库作为类型javax.sql.DataSource
然后可以根据需要将其注入到数据访问对象中。
请参阅javadoc 的EmbeddedDatabaseBuilder
有关所有支持选项的更多详细信息。
选择嵌入式数据库类型
本节介绍如何选择 Spring 的三个嵌入式数据库之一 支持。它包括以下主题:
使用 HSQL
Spring 支持 HSQL 1.8.0 及更高版本。如果没有类型
显式指定。要显式指定 HSQL,请将type
属性的embedded-database
标签设置为HSQL
.如果您使用构建器 API,请调用setType(EmbeddedDatabaseType)
方法EmbeddedDatabaseType.HSQL
.
自定义嵌入式数据库类型
虽然每种受支持的类型都带有默认连接设置,但这是可能的 如有必要,可以自定义它们。以下示例将 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 中将嵌入式数据库配置为 beanApplicationContext
如所述
在创建嵌入式数据库中。
以下列表显示了测试模板:
-
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 中)
process) — 例如,针对嵌入式数据库的集成测试,其ApplicationContext
配置仅与哪个 Bean 定义不同
配置文件处于活动状态。
此类错误的根本原因是 Spring 的EmbeddedDatabaseFactory
(用过
在内部由<jdbc:embedded-database>
XML 命名空间元素和EmbeddedDatabaseBuilder
对于 Java 配置)将嵌入式数据库的名称设置为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 社区贡献扩展。