数据库初始化

SQL 数据库可以根据你的堆栈以不同的方式初始化。当然，你也可以手动执行此操作，前提是数据库是一个单独的进程。建议使用单一

使用 Hibernate 初始化数据库

您可以设置 spring.jpa.hibernate.ddl-auto 来控制 Hibernate 的数据库初始化。支持的值包括 none、validate、update、create 和 create-drop。Spring Boot 会根据您是否使用嵌入式数据库为您选择一个默认值。通过查看 Connection 类型和 JDBC URL 来识别嵌入式数据库。hsqldb、h2 或 derby 是嵌入式数据库，而其他则不是。如果识别出嵌入式数据库且未检测到模式管理器（Flyway 或 Liquibase），则 ddl-auto 的默认值为 create-drop。在所有其他情况下，其默认值为 none。

在从内存数据库切换到“真实”数据库时，请小心不要对新平台中表和数据的存在做出假设。您必须显式设置 ddl-auto 或使用其他机制来初始化数据库。

您可以通过启用 org.hibernate.SQL 记录器来输出模式创建。如果您启用调试模式，则会自动为您完成此操作。

此外，如果 Hibernate 从头开始创建模式（即，如果 ddl-auto 属性设置为 create 或 create-drop），则在类路径的根目录中名为 import.sql 的文件将在启动时执行。如果您小心，这对于演示和测试很有用，但可能不是您希望在生产中放在类路径中的内容。这是一项 Hibernate 功能（与 Spring 无关）。

使用基本 SQL 脚本初始化数据库

Spring Boot 可以自动创建 JDBC DataSource 或 R2DBC ConnectionFactory 的模式（DDL 脚本）并初始化其数据（DML 脚本）。

默认情况下，它从 optional:classpath*:schema.sql 加载模式脚本，从 optional:classpath*:data.sql 加载数据脚本。可以使用 spring.sql.init.schema-locations 和 spring.sql.init.data-locations 分别自定义这些模式和数据脚本的位置。optional: 前缀表示即使文件不存在，应用程序也会启动。要让应用程序在文件不存在时无法启动，请删除 optional: 前缀。

此外，Spring Boot 会处理 optional:classpath*:schema-${platform}.sql 和 optional:classpath*:data-${platform}.sql 文件（如果存在），其中 ${platform} 是 spring.sql.init.platform 的值。这允许您在必要时切换到特定于数据库的脚本。例如，您可以选择将其设置为数据库的供应商名称（hsqldb、h2、oracle、mysql、postgresql 等）。

默认情况下，只有在使用嵌入式内存数据库时才执行 SQL 数据库初始化。要始终初始化 SQL 数据库，无论其类型如何，请将 spring.sql.init.mode 设置为 always。同样，要禁用初始化，请将 spring.sql.init.mode 设置为 never。默认情况下，Spring Boot 会启用其基于脚本的数据库初始化器的快速失败功能。这意味着，如果脚本导致异常，应用程序将无法启动。您可以通过设置 spring.sql.init.continue-on-error 来调整该行为。

默认情况下，在创建任何 JPA EntityManagerFactory bean 之前执行基于脚本的 DataSource 初始化。schema.sql 可用于创建 JPA 管理实体的架构，data.sql 可用于填充该架构。虽然我们不建议使用多种数据源初始化技术，但如果你希望基于脚本的 DataSource 初始化能够建立在 Hibernate 执行的架构创建之上，请将 spring.jpa.defer-datasource-initialization 设置为 true。这将推迟数据源初始化，直到创建并初始化任何 EntityManagerFactory bean 之后。然后，schema.sql 可用于对 Hibernate 执行的任何架构创建进行添加，data.sql 可用于填充该架构。

初始化脚本支持 -- 用于单行注释，支持 /* */ 用于块注释。不支持其他注释格式。

如果你正在使用高级数据库迁移工具（如 Flyway 或 Liquibase），你应该单独使用它们来创建和初始化架构。不建议将基本的 schema.sql 和 data.sql 脚本与 Flyway 或 Liquibase 一起使用，并且将在将来的版本中移除此支持。

如果你需要使用高级数据库迁移工具初始化测试数据，请参阅有关 Flyway 和 Liquibase 的部分。

初始化 Spring Batch 数据库

如果你使用 Spring Batch，它会预先打包适用于大多数流行数据库平台的 SQL 初始化脚本。Spring Boot 可以检测你的数据库类型并在启动时执行这些脚本。如果你使用嵌入式数据库，则默认情况下会发生这种情况。你还可以针对任何数据库类型启用它，如下例所示

属性
YAML

spring.batch.jdbc.initialize-schema=always

spring:
  batch:
    jdbc:
      initialize-schema: "always"

你还可以通过将 spring.batch.jdbc.initialize-schema 设置为 never 来显式关闭初始化。

使用高级数据库迁移工具

Spring Boot 支持两种高级迁移工具：Flyway 和 Liquibase。

在启动时执行 Flyway 数据库迁移

若要在启动时自动运行 Flyway 数据库迁移，请将 org.flywaydb:flyway-core 添加到你的类路径。

通常，迁移是 V<VERSION>__<NAME>.sql 形式的脚本（其中 <VERSION> 是下划线分隔的版本，例如“1”或“2_1”）。默认情况下，它们位于名为 classpath:db/migration 的目录中，但你可以通过设置 spring.flyway.locations 来修改该位置。这是一个由一个或多个 classpath: 或 filesystem: 位置组成的逗号分隔列表。例如，以下配置将在默认类路径位置和 /opt/migration 目录中搜索脚本

属性
YAML

spring.flyway.locations=classpath:db/migration,filesystem:/opt/migration

spring:
  flyway:
    locations: "classpath:db/migration,filesystem:/opt/migration"

你还可以添加一个特殊的 {vendor} 占位符来使用特定于供应商的脚本。假设以下内容

属性
YAML

spring.flyway.locations=classpath:db/migration/{vendor}

spring:
  flyway:
    locations: "classpath:db/migration/{vendor}"

前面的配置没有使用 db/migration，而是根据数据库的类型（例如 MySQL 的 db/migration/mysql）设置要使用的目录。受支持的数据库列表可在 DatabaseDriver 中获得。

迁移也可以用 Java 编写。Flyway 将使用任何实现 JavaMigration 的 bean 自动配置。

FlywayProperties 提供了 Flyway 的大部分设置以及一小部分其他属性，这些属性可用于禁用迁移或关闭位置检查。如果你需要对配置进行更多控制，请考虑注册一个 FlywayConfigurationCustomizer bean。

Spring Boot 调用 Flyway.migrate() 来执行数据库迁移。如果你希望获得更多控制，请提供一个实现 FlywayMigrationStrategy 的 @Bean。

Flyway 支持 SQL 和 Java 回调。若要使用基于 SQL 的回调，请将回调脚本放在 classpath:db/migration 目录中。若要使用基于 Java 的回调，请创建一个或多个实现 Callback 的 bean。任何此类 bean 都将自动向 Flyway 注册。它们可以通过使用 @Order 或实现 Ordered 来排序。实现已弃用的 FlywayCallback 接口的 bean 也可以被检测到，但是它们不能与 Callback bean 一起使用。

默认情况下，Flyway 会自动装配上下文中（@Primary）的 DataSource，并将其用于迁移。如果你想使用不同的 DataSource，你可以创建一个并将其 @Bean 标记为 @FlywayDataSource。如果你这样做并且想要两个数据源，请记住再创建一个并将其标记为 @Primary。或者，你可以通过在外部属性中设置 spring.flyway.[url,user,password] 来使用 Flyway 的原生 DataSource。设置 spring.flyway.url 或 spring.flyway.user 中的任何一个都足以使 Flyway 使用自己的 DataSource。如果三个属性中的任何一个尚未设置，则将使用其等效的 spring.datasource 属性的值。

你还可以使用 Flyway 为特定场景提供数据。例如，你可以将特定于测试的迁移放在 src/test/resources 中，并且它们仅在你启动应用程序进行测试时才运行。此外，你可以使用特定于配置文件的配置来定制 spring.flyway.locations，以便仅在特定配置文件处于活动状态时才运行某些迁移。例如，在 application-dev.properties 中，你可以指定以下设置

属性
YAML

spring.flyway.locations=classpath:/db/migration,classpath:/dev/db/migration

spring:
  flyway:
    locations: "classpath:/db/migration,classpath:/dev/db/migration"

通过这种设置，dev/db/migration 中的迁移仅在 dev 配置文件处于活动状态时运行。

在启动时执行 Liquibase 数据库迁移

要自动在启动时运行 Liquibase 数据库迁移，请将 org.liquibase:liquibase-core 添加到你的类路径中。

当你将 org.liquibase:liquibase-core 添加到你的类路径中时，数据库迁移在应用程序启动期间和测试运行之前默认运行。可以通过使用 spring.liquibase.enabled 属性来定制此行为，在 main 和 test 配置中设置不同的值。不可能使用两种不同的方式来初始化数据库（例如，应用程序启动时使用 Liquibase，测试运行时使用 JPA）。

默认情况下，主变更日志从 db/changelog/db.changelog-master.yaml 中读取，但你可以通过设置 spring.liquibase.change-log 来更改位置。除了 YAML 之外，Liquibase 还支持 JSON、XML 和 SQL 变更日志格式。

默认情况下，Liquibase 自动连接上下文中（@Primary）的 DataSource 并将其用于迁移。如果你需要使用不同的 DataSource，你可以创建一个并将其 @Bean 标记为 @LiquibaseDataSource。如果你这样做并且想要两个数据源，请记住再创建一个并将其标记为 @Primary。或者，你可以通过在外部属性中设置 spring.liquibase.[driver-class-name,url,user,password] 来使用 Liquibase 的本机 DataSource。设置 spring.liquibase.url 或 spring.liquibase.user 足以使 Liquibase 使用它自己的 DataSource。如果三个属性中的任何一个尚未设置，则将使用其等效的 spring.datasource 属性的值。

请参阅 LiquibaseProperties 了解有关可用设置的详细信息，例如上下文、默认架构等。

将 Flyway 用于仅测试迁移

如果你想创建填充测试数据库的 Flyway 迁移，请将它们放在 src/test/resources/db/migration 中。例如，名为 src/test/resources/db/migration/V9999__test-data.sql 的文件将在你的生产迁移之后执行，并且仅在你运行测试时执行。你可以使用此文件来创建所需的测试数据。此文件不会打包到你的 uber jar 或容器中。

将 Liquibase 用于仅测试迁移

如果你想创建填充测试数据库的 Liquibase 迁移，则必须创建一个测试变更日志，其中还包括生产变更日志。

首先，您需要配置 Liquibase，以便在运行测试时使用不同的变更日志。一种方法是创建一个 Spring Boot test 配置文件，并将 Liquibase 属性放入其中。为此，创建一个名为 src/test/resources/application-test.properties 的文件，并将以下属性放入其中

属性
YAML

spring.liquibase.change-log=classpath:/db/changelog/db.changelog-test.yaml

spring:
  liquibase:
    change-log: "classpath:/db/changelog/db.changelog-test.yaml"

这将配置 Liquibase，以便在 test 配置文件中运行时使用不同的变更日志。

现在在 src/test/resources/db/changelog/db.changelog-test.yaml 中创建变更日志文件

databaseChangeLog:
  - include:
      file: classpath:/db/changelog/db.changelog-master.yaml
  - changeSet:
      runOrder: "last"
      id: "test"
      changes:
        # Insert your changes here

此变更日志将在运行测试时使用，并且不会打包到您的 uber jar 或容器中。它包括生产变更日志，然后声明一个新的变更集，其 runOrder: last 设置指定它在所有生产变更集运行之后运行。您现在可以使用例如插入变更集来插入数据或 sql 变更集来直接执行 SQL。

最后要做的事情是配置 Spring Boot，以便在运行测试时激活 test 配置文件。为此，您可以将 @ActiveProfiles("test") 注释添加到您的 @SpringBootTest 注释的测试类中。

依赖于已初始化的数据库

数据库初始化在应用程序启动时作为应用程序上下文刷新的一部分执行。为了允许在启动期间访问已初始化的数据库，将自动检测充当数据库初始化程序的 bean 和要求数据库已初始化的 bean。初始化依赖于数据库已初始化的 bean 被配置为依赖于初始化它的 bean。如果在启动期间，您的应用程序尝试访问数据库并且尚未初始化，您可以配置对初始化数据库并要求数据库已初始化的 bean 的其他检测。

检测数据库初始化程序

Spring Boot 将自动检测以下类型的 bean，这些 bean 初始化 SQL 数据库

DataSourceScriptDatabaseInitializer
EntityManagerFactory
Flyway
FlywayMigrationInitializer
R2dbcScriptDatabaseInitializer
SpringLiquibase

如果您正在为数据库初始化库使用第三方启动器，它可能会提供一个检测器，以便其他类型的 bean 也能自动检测到。要检测到其他 bean，请在 META-INF/spring.factories 中注册 DatabaseInitializerDetector 的实现。

检测依赖于数据库初始化的 bean

Spring Boot 将自动检测以下类型的 bean，这些 bean 依赖于数据库初始化

AbstractEntityManagerFactoryBean（除非 spring.jpa.defer-datasource-initialization 设置为 true）
DSLContext (jOOQ)
EntityManagerFactory（除非 spring.jpa.defer-datasource-initialization 设置为 true）
JdbcClient
JdbcOperations
NamedParameterJdbcOperations

如果您使用第三方启动器数据访问库，它可能会提供一个检测器，以便自动检测其他类型的 bean。要检测其他 bean，请在 META-INF/spring.factories 中注册 DependsOnDatabaseInitializationDetector 的实现。或者，使用 @DependsOnDatabaseInitialization 注释 bean 的类或其 @Bean 方法。