初始化 DataSource

org.springframework.jdbc.datasource.init 包提供了对现有 DataSource 进行初始化的支持。嵌入式数据库支持为应用程序创建和初始化 DataSource 提供了一种选项。但是，您有时可能需要初始化运行在某个服务器上的实例。

使用 Spring XML 初始化数据库

如果您想初始化数据库，并且可以提供 DataSource bean 的引用，您可以使用 spring-jdbc 命名空间中的 initialize-database 标签：

<jdbc:initialize-database data-source="dataSource">
	<jdbc:script location="classpath:com/foo/sql/db-schema.sql"/>
	<jdbc:script location="classpath:com/foo/sql/db-test-data.sql"/>
</jdbc:initialize-database>

前面的例子针对数据库运行了两个指定的脚本。第一个脚本创建模式，第二个脚本用测试数据集填充表。脚本位置也可以是带有通配符的模式，采用 Spring 中资源常用的 Ant 样式（例如，classpath*:/com/foo/*/sql/-data.sql）。如果使用模式，脚本将按照其 URL 或文件名的词法顺序运行。

数据库初始化器的默认行为是无条件地运行提供的脚本。这可能并非总是您想要的，例如，如果您针对一个已经包含测试数据的数据库运行脚本。通过遵循先创建表然后插入数据的常见模式（如前所示），可以减少意外删除数据的可能性。如果表已经存在，则第一步会失败。

然而，为了更好地控制现有数据的创建和删除，XML 命名空间提供了一些额外的选项。第一个是用于打开和关闭初始化的标志。您可以根据环境设置此标志（例如，从系统属性或环境 bean 中获取布尔值）。以下示例从系统属性中获取一个值：

<jdbc:initialize-database data-source="dataSource"
	enabled="#{systemProperties.INITIALIZE_DATABASE}"> [id="CO1-1"]1
	<jdbc:script location="..."/>
</jdbc:initialize-database>
<1>  从名为 `INITIALIZE_DATABASE` 的系统属性中获取 `enabled` 的值。

控制现有数据处理的第二个选项是对故障更宽容。为此，您可以控制初始化器忽略它从脚本运行的 SQL 中的某些错误的能力，如以下示例所示：

<jdbc:initialize-database data-source="dataSource" ignore-failures="DROPS">
	<jdbc:script location="..."/>
</jdbc:initialize-database>

在前面的示例中，我们表示我们期望有时脚本会针对空数据库运行，并且脚本中存在一些 DROP 语句，因此这些语句会失败。因此，失败的 SQL DROP 语句将被忽略，但其他失败将导致异常。如果您的 SQL 方言不支持 DROP …​ IF EXISTS（或类似语句），但您希望在重新创建所有测试数据之前无条件地删除它们，这将非常有用。在这种情况下，第一个脚本通常是一组 DROP 语句，后面跟着一组 CREATE 语句。

ignore-failures 选项可以设置为 NONE（默认）、DROPS（忽略失败的删除）或 ALL（忽略所有失败）。

每个语句应该用 ; 分隔，如果脚本中根本没有 ; 字符，则用换行符分隔。您可以全局控制，也可以逐个脚本控制，如以下示例所示：

<jdbc:initialize-database data-source="dataSource" separator="@@"> [id="CO2-1"]1
	<jdbc:script location="classpath:com/myapp/sql/db-schema.sql" separator=";"/> [id="CO2-2"]2
	<jdbc:script location="classpath:com/myapp/sql/db-test-data-1.sql"/>
	<jdbc:script location="classpath:com/myapp/sql/db-test-data-2.sql"/>
</jdbc:initialize-database>
<1>  将分隔符脚本设置为 `@@`。
<1>  将 `db-schema.sql` 的分隔符设置为 `;`。

在此示例中，两个 test-data 脚本使用 @@ 作为语句分隔符，只有 db-schema.sql 使用 ;。此配置指定默认分隔符是 @@，并为 db-schema 脚本覆盖了该默认值。

如果您需要比 XML 命名空间提供的更多控制，可以直接使用 DataSourceInitializer 并将其定义为应用程序中的组件。

依赖于数据库的其他组件的初始化

一大类应用程序（那些在 Spring 上下文启动后才使用数据库的应用程序）可以使用数据库初始化器，而无需进一步的复杂性。如果您的应用程序不属于此类，您可能需要阅读本节的其余部分。

数据库初始化器依赖于 DataSource 实例，并在其初始化回调中运行提供的脚本（类似于 XML bean 定义中的 init-method、组件中的 @PostConstruct 方法或实现 InitializingBean 的组件中的 afterPropertiesSet() 方法）。如果其他 bean 依赖于相同的 DataSource 并在初始化回调中使用 DataSource，则可能会出现问题，因为数据尚未初始化。一个常见的例子是缓存，它在应用程序启动时急切地初始化并从数据库加载数据。

为了解决这个问题，您有两个选择：将您的缓存初始化策略更改到稍后的阶段，或者确保数据库初始化器首先被初始化。

如果应用程序在您的控制之下，更改缓存初始化策略可能很容易，否则则不然。实现此目的的一些建议包括：

  • 使缓存在使用时惰性初始化，这可以提高应用程序启动时间。

  • 让您的缓存或初始化缓存的独立组件实现 Lifecycle 或 SmartLifecycle。当应用程序上下文启动时，您可以通过设置其 autoStartup 标志来自动启动 SmartLifecycle，并且您可以通过在封闭上下文上调用 ConfigurableApplicationContext.start() 来手动启动 Lifecycle。

  • 使用 Spring ApplicationEvent 或类似的自定义观察者机制来触发缓存初始化。ContextRefreshedEvent 始终在上下文准备好使用时（所有 bean 都已初始化后）发布，因此它通常是一个有用的钩子（这就是 SmartLifecycle 默认的工作方式）。

确保数据库初始化器首先被初始化也很容易。实现此目的的一些建议包括：

  • 依赖 Spring BeanFactory 的默认行为，即 bean 按照注册顺序初始化。您可以通过采用常见的做法轻松实现这一点：在 XML 配置中使用一组 <import/> 元素来排序您的应用程序模块，并确保数据库和数据库初始化首先列出。

  • 将 DataSource 和使用它的业务组件分开，并通过将它们放在单独的 ApplicationContext 实例中来控制它们的启动顺序（例如，父上下文包含 DataSource，子上下文包含业务组件）。这种结构在 Spring Web 应用程序中很常见，但可以更普遍地应用。