初始化 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 依赖于相同的数据库源并在初始化回调中使用数据库源,可能会出现问题,因为数据尚未初始化。一个常见的例子是,缓存会急切地初始化并在应用程序启动时从数据库加载数据。

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

如果应用程序在您的控制之下,并且没有其他情况,更改您的缓存初始化策略可能很容易。以下是一些关于如何实现此策略的建议:

  • 让缓存延迟到第一次使用时才初始化,这可以提高应用程序启动时间。

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

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

确保数据库初始化器首先被初始化也很容易。以下是一些关于如何实现此策略的建议:

  • 依赖 Spring BeanFactory 的默认行为,即 bean 按注册顺序初始化。您可以通过在 XML 配置中采用一组 <import/> 元素来轻松实现这一点,这些元素对您的应用程序模块进行排序,并确保数据库和数据库初始化排在首位。

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