数据库初始化 (Database Initialization) _ Spring Boot 3.4.0-SNAPSHOT 中文文档(官方文档中文翻译) —

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

SQL 数据库可以以不同的方式初始化，具体取决于您的堆栈是什么。当然，您也可以手动执行此操作，前提是数据库是一个单独的过程。建议使用单个机制来生成架构。spring-doc.cn

使用 Hibernate 初始化数据库

您可以设置控制 Hibernate 的数据库初始化。支持的值为、、、和。 Spring Boot 根据您是否使用嵌入式数据库为您选择默认值。嵌入式数据库是通过查看类型和 JDBC URL 来识别的。、或嵌入式数据库，而其他数据库则不是。如果标识了嵌入式数据库，但未检测到架构管理器（Flyway 或 Liquibase），则默认为 . 在所有其他情况下，它默认为。spring.jpa.hibernate.ddl-autononevalidateupdatecreatecreate-dropConnectionhsqldbh2derbyddl-autocreate-dropnonespring-doc.cn

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

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

此外，如果 Hibernate 从头开始创建模式（即，如果属性设置为或），则在启动时执行 Classpath 根目录中命名的文件。如果您小心，这对于演示和测试很有用，但可能不是您希望在 production 中的 Classpath 上的内容。它是一个 Hibernate 功能（与 Spring 无关）。import.sqlddl-autocreatecreate-dropspring-doc.cn

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

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

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

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

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

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

默认情况下，在创建任何 JPA bean 之前执行基于脚本的初始化。可用于为 JPA 托管的实体创建架构，并可用于填充它。虽然我们不建议使用多个数据源初始化技术，但如果您希望基于脚本的初始化能够基于 Hibernate 执行的架构创建进行构建，请将 . 这会将数据源初始化推迟到创建和初始化任何 bean 之后。然后，可以用于对 Hibernate 执行的任何模式创建进行添加，并可用于填充它。DataSourceEntityManagerFactoryschema.sqldata.sqlDataSourcespring.jpa.defer-datasource-initializationtrueEntityManagerFactoryschema.sqldata.sqlspring-doc.cn

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

如果您使用的是更高级别的数据库迁移工具，如 Flyway 或 Liquibase，则应单独使用它们来创建和初始化架构。不建议将 basic 和 scripts 与 Flyway 或 Liquibase 一起使用，在未来版本中将删除支持。schema.sqldata.sqlspring-doc.cn

如果您需要使用更高级别的数据库迁移工具初始化测试数据，请参阅有关 Flyway 和 Liquibase 的部分。spring-doc.cn

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

初始化 Spring Batch 数据库

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

Propertiesspring-doc.cn
YAMLspring-doc.cn

spring.batch.jdbc.initialize-schema=always

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

您还可以通过设置为来显式关闭初始化。spring.batch.jdbc.initialize-schemaneverspring-doc.cn

使用更高级别的数据库迁移工具

Spring Boot 支持两个更高级别的迁移工具：Flyway 和 Liquibase。spring-doc.cn

启动时执行 Flyway 数据库迁移

要在启动时自动运行 Flyway 数据库迁移，请将适当的 Flyway 模块添加到您的 Classpath 中。内存中数据库和基于文件的数据库受支持。否则，需要特定于数据库的模块。例如，与 PostgreSQL 和 MySQL 一起使用。有关更多详细信息，请参阅 Flyway 文档。org.flywaydb:flyway-coreorg.flywaydb:flyway-database-postgresqlorg.flywaydb:flyway-mysqlspring-doc.cn

通常，迁移是以下格式的脚本（带有下划线分隔的版本，例如 '1' 或 '2_1'）。默认情况下，它们位于名为的目录中，但您可以通过设置来修改该位置。这是一个或多个 or locations 的逗号分隔列表。例如，以下配置将在默认 Classpath 位置和目录中搜索脚本：V<VERSION>__<NAME>.sql<VERSION>classpath:db/migrationspring.flyway.locationsclasspath:filesystem:/opt/migrationspring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

您还可以添加特殊占位符以使用特定于供应商的脚本。假设以下内容：{vendor}spring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

前面的配置不是使用，而是根据数据库的类型（例如MySQL）设置要使用的目录。支持的数据库列表可在中找到。db/migrationdb/migration/mysqlDatabaseDriverspring-doc.cn

迁移也可以用 Java 编写。 Flyway 将自动配置任何实现 .JavaMigrationspring-doc.cn

FlywayProperties提供了 Flyway 的大部分设置和一小部分附加属性，这些属性可用于禁用迁移或关闭位置检查。如果需要对配置进行更多控制，请考虑注册 Bean。FlywayConfigurationCustomizerspring-doc.cn

Spring Boot 调用来执行数据库迁移。如果您想要更多控制，请提供实现 .Flyway.migrate()@BeanFlywayMigrationStrategyspring-doc.cn

Flyway 支持 SQL 和 Java 回调。要使用基于 SQL 的回调，请将回调脚本放在目录中。要使用基于 Java 的回调，请创建一个或多个实现 . 任何此类 bean 都会自动注册到。可以使用或 implementation 对它们进行排序。也可以检测到实现已弃用接口的 Bean，但是它们不能与 Bean 一起使用。classpath:db/migrationCallbackFlyway@OrderOrderedFlywayCallbackCallbackspring-doc.cn

默认情况下，Flyway 会在您的上下文中自动连接（）并将其用于迁移。如果您想使用不同的，您可以创建一个并将其标记为。如果您这样做并且需要两个数据源，请记住创建另一个数据源并将其标记为 . 或者，您可以通过在外部属性中设置来使用 Flyway 的原生。设置 or 足以使 Flyway 使用自己的 . 如果尚未设置这三个属性中的任何一个，则将使用其等效属性的值。@PrimaryDataSourceDataSource@Bean@FlywayDataSource@PrimaryDataSourcespring.flyway.[url,user,password]spring.flyway.urlspring.flyway.userDataSourcespring.datasourcespring-doc.cn

您还可以使用 Flyway 为特定场景提供数据。例如，您可以放置特定于测试的迁移，并且它们仅在应用程序启动进行测试时运行。此外，您还可以使用特定于配置文件的配置进行自定义，以便仅在特定配置文件处于活动状态时运行某些迁移。例如，在中，您可以指定以下设置：src/test/resourcesspring.flyway.locationsapplication-dev.propertiesspring-doc.cn

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

通过该设置，仅当配置文件处于活动状态时，才会运行迁移。dev/db/migrationdevspring-doc.cn

启动时执行 Liquibase 数据库迁移

要在启动时自动运行 Liquibase 数据库迁移，请将添加到你的 Classpath 中。org.liquibase:liquibase-corespring-doc.cn

将 the 添加到 classpath 时，默认情况下，数据库迁移将在应用程序启动期间和测试运行之前运行。可以使用 property 自定义此行为，在和配置中设置不同的值。不能使用两种不同的方法来初始化数据库（例如，Liquibase 用于应用程序启动，JPA 用于测试运行）。org.liquibase:liquibase-corespring.liquibase.enabledmaintestspring-doc.cn

默认情况下，主更改日志是从中读取的，但您可以通过设置来更改位置。除了 YAML，Liquibase 还支持 JSON、XML 和 SQL 更改日志格式。db/changelog/db.changelog-master.yamlspring.liquibase.change-logspring-doc.cn

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

有关可用设置（如上下文、默认架构等）的详细信息，请参阅。LiquibasePropertiesspring-doc.cn

如果要在使用实例之前对其进行自定义，也可以使用 Bean。Customizer<Liquibase>Liquibasespring-doc.cn

使用 Flyway 进行仅测试迁移

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

使用 Liquibase 进行仅测试迁移

如果要创建填充测试数据库的 Liquibase 迁移，则必须创建一个测试更改日志，其中还包括生产更改日志。spring-doc.cn

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

Propertiesspring-doc.cn
YAMLspring-doc.cn

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

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

这会将 Liquibase 配置为在配置文件中运行时使用不同的更改日志。testspring-doc.cn

现在在中创建 changelog 文件：src/test/resources/db/changelog/db.changelog-test.yamlspring-doc.cn

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

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

最后要做的是配置 Spring Boot 以在运行测试时激活配置文件。为此，您可以将 annotation 添加到带 Comments 的测试类中。test@ActiveProfiles("test")@SpringBootTestspring-doc.cn

依赖于初始化的数据库

数据库初始化是在应用程序启动时作为应用程序上下文刷新的一部分执行的。为了允许在启动期间访问已初始化的数据库，将自动检测充当数据库初始值设定项的 bean 和需要初始化该数据库的 bean。其初始化依赖于已初始化数据库的 Bean 被配置为依赖于初始化它的 Bean。如果在启动期间，应用程序尝试访问数据库，但尚未初始化数据库，则可以配置对 bean 的其他检测，这些 bean 初始化数据库并要求已初始化数据库。spring-doc.cn

检测数据库初始值设定项

Spring Boot 将自动检测初始化 SQL 数据库的以下类型的 bean：spring-doc.cn

DataSourceScriptDatabaseInitializerspring-doc.cn
EntityManagerFactoryspring-doc.cn
Flywayspring-doc.cn
FlywayMigrationInitializerspring-doc.cn
R2dbcScriptDatabaseInitializerspring-doc.cn
SpringLiquibasespring-doc.cn

如果你将第三方Starters用于数据库初始化库，它可能会提供一个检测器，以便也自动检测其他类型的 bean。要检测其他 bean，请在中注册的实现。DatabaseInitializerDetectorMETA-INF/spring.factoriesspring-doc.cn

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

Spring Boot 将自动检测依赖于数据库初始化的以下类型的 bean：spring-doc.cn

AbstractEntityManagerFactoryBean（除非设置为spring.jpa.defer-datasource-initializationtrue)spring-doc.cn
DSLContext（jOOQ）spring-doc.cn
EntityManagerFactory（除非设置为spring.jpa.defer-datasource-initializationtrue)spring-doc.cn
JdbcClientspring-doc.cn
JdbcOperationsspring-doc.cn
NamedParameterJdbcOperationsspring-doc.cn

如果您使用的是第三方入门数据访问库，则它可能会提供一个检测器，以便也会自动检测其他类型的 bean。要检测其他 bean，请在中注册的实现。或者，用 .DependsOnDatabaseInitializationDetectorMETA-INF/spring.factories@Bean@DependsOnDatabaseInitializationspring-doc.cn