初始化 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}"> (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="@@"> (1)
<jdbc:script location="classpath:com/myapp/sql/db-schema.sql" separator=";"/> (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 | 将分隔符脚本设置为@@ 。 |
2 | 将db-schema.sql 的分隔符设置为; 。 |
在此示例中,两个test-data
脚本使用@@
作为语句分隔符,只有db-schema.sql
使用;
。此配置指定默认分隔符为@@
,并为db-schema
脚本覆盖该默认值。
如果需要比 XML 命名空间提供的更多控制,则可以直接使用DataSourceInitializer
并将其定义为应用程序中的组件。
依赖于数据库的其他组件的初始化
一大类应用程序(那些在 Spring 上下文启动后才使用数据库的应用程序)可以使用数据库初始化程序而不会出现进一步的复杂情况。如果您的应用程序不是其中之一,您可能需要阅读本节的其余部分。
数据库初始化程序依赖于DataSource
实例并在其初始化回调中运行提供的脚本(类似于 XML bean 定义中的init-method
、组件中的@PostConstruct
方法或实现InitializingBean
的组件中的afterPropertiesSet()
方法)。如果其他 bean 依赖于相同的 数据源并在初始化回调中使用数据源,则可能会出现问题,因为数据尚未初始化。一个常见的例子是缓存,它会急切地初始化并在应用程序启动时从数据库加载数据。
要解决此问题,您有两个选项:将缓存初始化策略更改为后期阶段或确保数据库初始化程序首先初始化。
如果应用程序在您的控制范围内并且没有其他方式,更改缓存初始化策略可能很容易。有关如何实现此操作的一些建议包括
-
使缓存在第一次使用时延迟初始化,这可以提高应用程序启动时间。
-
让您的缓存或初始化缓存的单独组件实现
Lifecycle
或SmartLifecycle
。当应用程序上下文启动时,您可以通过设置其autoStartup
标志来自动启动SmartLifecycle
,并且您可以通过在封闭上下文中调用ConfigurableApplicationContext.start()
手动启动Lifecycle
。 -
使用 Spring
ApplicationEvent
或类似的自定义观察器机制来触发缓存初始化。ContextRefreshedEvent
在上下文准备好使用时(所有 bean 初始化后)始终由上下文发布,因此它通常是一个有用的挂钩(这就是SmartLifecycle
默认工作方式)。
确保数据库初始化程序首先初始化也很容易。有关如何实现此操作的一些建议包括
-
依靠 Spring
BeanFactory
的默认行为,即 bean 按注册顺序初始化。您可以通过采用 XML 配置中的一组<import/>
元素的通用做法来轻松安排这一点,并确保数据库和数据库初始化首先列出。 -
分离
DataSource
和使用它的业务组件,并通过将它们放在单独的ApplicationContext
实例中来控制它们的启动顺序(例如,父上下文包含DataSource
,子上下文包含业务组件)。此结构在 Spring Web 应用程序中很常见,但可以更广泛地应用。