嵌入式数据库支持 (Embedded Database Support) _ Spring Framework6.2.0-SNAPSHOT中文文档(官方文档中文翻译)|Spring 教程 —

此版本仍在开发中，尚未被视为稳定版本。最新的稳定版本请使用 Spring Framework 6.1.13！spring-doc.cn

该软件包支持嵌入式 Java 数据库引擎。提供对 HSQL、H2 和 Derby 的支持本地。您还可以使用可扩展 API 插入新的嵌入式数据库类型和实现。org.springframework.jdbc.datasource.embeddedDataSourcespring-doc.cn

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

嵌入式数据库在项目的开发阶段可能很有用，因为它轻质自然。优点包括易于配置、启动时间短、可测试性，以及在开发过程中快速改进 SQL 的能力。spring-doc.cn

创建嵌入式数据库

您可以将嵌入式数据库实例公开为 Bean，如下例所示：spring-doc.cn

@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 数据库，该数据库填充了 SQL 和类路径根目录中的资源。此外，由于最佳做法是，为 Embedded Database 分配一个唯一生成的 Name。这嵌入式数据库作为 Bean 类型提供给 Spring 容器，然后可以根据需要将其注入到数据访问对象中。schema.sqltest-data.sqljavax.sql.DataSourcespring-doc.cn

有关所有支持选项的更多详细信息，请参阅 EmbeddedDatabaseBuilder 的 javadoc。spring-doc.cn

选择嵌入式数据库类型

本节介绍如何选择 Spring 支持。它包括以下主题：spring-doc.cn

使用 HSQL

Spring 支持 HSQL 1.8.0 及更高版本。HSQL 是默认嵌入式数据库（如果 no type 为显式指定。要显式指定 HSQL，请将标记的属性设置为。如果您使用构建器 API，请使用 .typeembedded-databaseHSQLsetType(EmbeddedDatabaseType)EmbeddedDatabaseType.HSQLspring-doc.cn

使用 H2

Spring 支持 H2 数据库。要启用 H2，请将 tag 的属性设置为。如果您使用构建器 API，请使用 .typeembedded-databaseH2setType(EmbeddedDatabaseType)EmbeddedDatabaseType.H2spring-doc.cn

使用 Derby

Spring 支持 Apache Derby 10.5 及更高版本。要启用 Derby，请将标记的属性设置为 .如果您使用构建器 API，使用 .typeembedded-databaseDERBYsetType(EmbeddedDatabaseType)EmbeddedDatabaseType.DERBYspring-doc.cn

自定义嵌入式数据库类型

虽然每种受支持的类型都带有默认连接设置，但这是可能的以根据需要对其进行自定义。以下示例将 H2 与自定义驱动程序一起使用：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

   @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 中将嵌入式数据库配置为 Bean，如在创建嵌入式数据库中。下面的清单显示了测试模板：ApplicationContextspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

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 配置文件或类负责创建嵌入式数据库，然后重用相应的配置跨同一测试套件（即，在同一个 JVM 中）中的多个测试场景 process） — 例如，针对嵌入式数据库进行集成测试，这些数据库的配置仅在 bean 定义方面有所不同配置文件处于活动状态。@ConfigurationApplicationContextspring-doc.cn

此类错误的根本原因是 Spring 的（使用在 XML 命名空间元素和 for Java 配置内部）将嵌入式数据库的名称设置为（如果未另行指定）。对于的情况， Embedded Database 通常被分配一个等于 Bean 的名称（通常为类似于）。因此，后续尝试创建嵌入式数据库不会导致新数据库。相反，相同的 JDBC 连接 URL 被重用，并且尝试创建新的嵌入式数据库实际上指向现有的从相同配置创建的嵌入式数据库。EmbeddedDatabaseFactory<jdbc:embedded-database>EmbeddedDatabaseBuildertestdb<jdbc:embedded-database>iddataSourcespring-doc.cn

为了解决这个常见问题，Spring Framework 4.2 提供了对生成嵌入式数据库的唯一名称。要启用生成名称的使用，请使用以下选项。spring-doc.cn

EmbeddedDatabaseFactory.setGenerateUniqueDatabaseName()spring-doc.cn
EmbeddedDatabaseBuilder.generateUniqueName()spring-doc.cn
<jdbc:embedded-database generate-name="true" … >spring-doc.cn

扩展嵌入式数据库支持

您可以通过两种方式扩展 Spring JDBC 嵌入式数据库支持：spring-doc.cn

Implement 以支持新的嵌入式数据库类型。EmbeddedDatabaseConfigurerspring-doc.cn
Implement 以支持新的实现，例如连接池，用于管理嵌入式数据库连接。DataSourceFactoryDataSourcespring-doc.cn

我们鼓励您在 GitHub Issues 上为 Spring 社区贡献扩展。spring-doc.cn