|
此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.7! |
嵌入式数据库支持
使用 Spring XML 创建嵌入式数据库
如果要在 Spring 中将嵌入式数据库实例作为 Bean 公开ApplicationContext,您可以使用embedded-database标记中spring-jdbcNamespace:
<jdbc:embedded-database id="dataSource" generate-name="true">
<jdbc:script location="classpath:schema.sql"/>
<jdbc:script location="classpath:test-data.sql"/>
</jdbc:embedded-database>
前面的配置创建了一个嵌入式 HSQL 数据库,该数据库填充了 SQL
这schema.sql和test-data.sqlresources 的 classpath 根目录中。此外,由于
最佳做法是,为 Embedded Database 分配一个唯一生成的 Name。这
嵌入式数据库作为 Spring 容器的 bean 类型为javax.sql.DataSource然后,可以根据需要将其注入到 Data Access 对象中。
以编程方式创建嵌入式数据库
这EmbeddedDatabaseBuilderclass 提供了一个 Fluent API,用于构造嵌入式
数据库。当您需要在
独立环境或独立集成测试中,如以下示例所示:
-
Java
-
Kotlin
EmbeddedDatabase db = new EmbeddedDatabaseBuilder()
.generateUniqueName(true)
.setType(H2)
.setScriptEncoding("UTF-8")
.ignoreFailedDrops(true)
.addScript("schema.sql")
.addScripts("user_data.sql", "country_data.sql")
.build();
// perform actions against the db (EmbeddedDatabase extends javax.sql.DataSource)
db.shutdown()
val db = EmbeddedDatabaseBuilder()
.generateUniqueName(true)
.setType(H2)
.setScriptEncoding("UTF-8")
.ignoreFailedDrops(true)
.addScript("schema.sql")
.addScripts("user_data.sql", "country_data.sql")
.build()
// perform actions against the db (EmbeddedDatabase extends javax.sql.DataSource)
db.shutdown()
请参阅javadoc 的EmbeddedDatabaseBuilder了解有关所有支持选项的更多详细信息。
您还可以使用EmbeddedDatabaseBuilder使用 Java 创建嵌入式数据库
配置,如下例所示:
-
Java
-
Kotlin
@Configuration
public class DataSourceConfig {
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder()
.generateUniqueName(true)
.setType(H2)
.setScriptEncoding("UTF-8")
.ignoreFailedDrops(true)
.addScript("schema.sql")
.addScripts("user_data.sql", "country_data.sql")
.build();
}
}
@Configuration
class DataSourceConfig {
@Bean
fun dataSource(): DataSource {
return EmbeddedDatabaseBuilder()
.generateUniqueName(true)
.setType(H2)
.setScriptEncoding("UTF-8")
.ignoreFailedDrops(true)
.addScript("schema.sql")
.addScripts("user_data.sql", "country_data.sql")
.build()
}
}
选择嵌入式数据库类型
本节介绍如何选择 Spring 支持。它包括以下主题:
使用 HSQL
Spring 支持 HSQL 1.8.0 及更高版本。HSQL 是默认嵌入式数据库(如果 no type 为
显式指定。要显式指定 HSQL,请将type属性的embedded-database标签设置为HSQL.如果您使用构建器 API,请调用setType(EmbeddedDatabaseType)method 替换为EmbeddedDatabaseType.HSQL.
使用嵌入式数据库测试数据访问逻辑
嵌入式数据库提供了一种测试数据访问代码的轻量级方法。下一个示例是
使用嵌入式数据库的数据访问集成测试模板。使用此类模板
当嵌入式数据库不需要在测试中重复使用时,对于一次性作可能很有用
类。但是,如果您希望创建在测试套件中共享的嵌入式数据库,
考虑使用 Spring TestContext 框架和
在 Spring 中将嵌入式数据库配置为 beanApplicationContext如前所述
在使用 Spring XML 创建嵌入式数据库和以编程方式创建嵌入式数据库中。以下清单
显示测试模板:
-
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 配置文件或@Configurationclass 负责
创建嵌入式数据库,然后重用相应的配置
跨同一测试套件(即,在同一个 JVM 中)中的多个测试场景
进程)— 例如,针对嵌入式数据库进行集成测试,这些数据库ApplicationContext配置仅在 bean 定义方面有所不同
配置文件处于活动状态。
此类错误的根本原因是 Spring 的EmbeddedDatabaseFactory(已使用
在内部由<jdbc:embedded-database>XML 命名空间元素和EmbeddedDatabaseBuilder对于 Java 配置)将嵌入式数据库的名称设置为testdb如果没有特别说明。对于<jdbc:embedded-database>这
Embedded Database 通常被分配一个等于 Bean 的id(通常,
类似dataSource).因此,后续尝试创建嵌入式数据库
不会导致新数据库。相反,相同的 JDBC 连接 URL 被重用,
并且尝试创建新的嵌入式数据库实际上指向现有的
从相同配置创建的嵌入式数据库。
为了解决这个常见问题,Spring Framework 4.2 提供了对生成 嵌入式数据库的唯一名称。要启用生成名称的使用,请使用 以下选项。
-
EmbeddedDatabaseFactory.setGenerateUniqueDatabaseName() -
EmbeddedDatabaseBuilder.generateUniqueName() -
<jdbc:embedded-database generate-name="true" … >
扩展嵌入式数据库支持
您可以通过两种方式扩展 Spring JDBC 嵌入式数据库支持:
-
实现
EmbeddedDatabaseConfigurer以支持新的 Embedded 数据库类型。 -
实现
DataSourceFactory以支持新的DataSource实现,例如 连接池,用于管理嵌入式数据库连接。
我们鼓励您在 GitHub Issues 上为 Spring 社区贡献扩展。