使用Flyway与Spring Boot在H2内存数据库中管理数据库Schema

本教程旨在解决Spring Boot应用与H2内存数据库结合时常见的“表不存在”问题，特别是涉及单元测试场景。文章将详细阐述如何通过集成Flyway数据库迁移工具，规范化地管理数据库Schema，包括目录结构、SQL迁移脚本的编写、Spring Boot配置以及在测试环境中的最佳实践，确保数据库结构在应用启动和测试执行前得到正确初始化。

在使用Spring Boot与H2内存数据库进行开发和测试时，开发者经常会遇到 JdbcSQLSyntaxErrorException: Table "X" not found 的错误。这通常是因为在应用程序尝试执行数据操作（如 INSERT、SELECT）时，所需的数据库表结构尚未被创建。虽然Spring Boot提供了通过JPA实体自动创建Schema的能力，但在某些场景下，尤其是在需要更精细控制或使用纯SQL初始化数据库时，Flyway等数据库迁移工具显得尤为重要。

Flyway简介与Schema管理原理

Flyway是一个开源的数据库迁移工具，它通过版本控制的方式管理数据库Schema的演变。其核心思想是，将数据库的所有Schema变更都定义为一系列带有版本号的SQL脚本。当应用程序启动时，Flyway会自动检测并执行尚未应用于数据库的迁移脚本，从而确保数据库Schema始终处于最新且正确的状态。

对于H2内存数据库，Flyway的优势在于它能够确保每次测试运行或应用启动时，都能从一个已知的、干净的数据库Schema状态开始，极大地简化了测试环境的准备工作。

Flyway基本配置与目录结构

要将Flyway集成到Spring Boot项目中，首先需要确保Flyway的依赖已添加到项目的 pom.xml 或 build.gradle 文件中：

<!-- Maven -->
<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
</dependency>
<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>

接下来，Flyway的迁移脚本需要放置在特定的目录结构中。默认情况下，Flyway会在 src/main/resources/db/migration 目录下查找SQL脚本。

例如，创建一个用于创建 merchant_rating_detail 表的迁移脚本：

1. 在 src/main/resources 目录下创建 db/migration 文件夹。
2. 在该文件夹下创建一个名为 V001__create_merchant_rating_detail_table.sql 的文件。

文件名遵循 V<版本号>__<描述>.sql 的命名约定。版本号可以是数字或数字加下划线，用于Flyway排序和执行迁移。

PHP经典实例(第二版)

PHP经典实例（第2版）能够为您节省宝贵的Web开发时间。有了这些针对真实问题的解决方案放在手边，大多数编程难题都会迎刃而解。《PHP经典实例(第2版)》将PHP的特性与经典实例丛书的独特形式组合到一起，足以帮您成功地构建跨浏览器的Web应用程序。在这个修订版中，您可以更加方便地找到各种编程问题的解决方案，《PHP经典实例(第2版)》中内容涵盖了：表单处理；Session管理；数据库交互；使用We

453

查看详情

创建数据库Schema迁移脚本

在 V001__create_merchant_rating_detail_table.sql 文件中，写入用于创建表的SQL语句。例如：

-- V001__create_merchant_rating_detail_table.sql
CREATE TABLE merchant_rating_detail (
    order_id VARCHAR(255) NOT NULL,
    shop_id VARCHAR(255) NOT NULL,
    user_id VARCHAR(255) NOT NULL,
    rating INT NOT NULL,
    created_datetime TIMESTAMP NOT NULL,
    feedback_ids VARCHAR(255),
    PRIMARY KEY (order_id)
);

Spring Boot集成与H2配置

在 application.properties (或 application.yml) 文件中，配置H2数据库和Flyway。关键是确保Flyway被启用，并且H2的URL配置正确。

# H2 Database Configuration
spring.datasource.url=jdbc:h2:mem:testdb;DATABASE_TO_UPPER=false;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password

# JPA Configuration (Optional, but good practice for H2 dialect)
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
# If using JPA for schema generation, this defers it until after Flyway runs.
# However, if Flyway is used, JPA's schema generation should typically be disabled (e.g., spring.jpa.hibernate.ddl-auto=none).
spring.jpa.defer-datasource-initialization=true

# Flyway Configuration
spring.flyway.enabled=true # 确保Flyway已启用
# spring.flyway.locations=classpath:db/migration # 默认值，如果路径不同则需要配置

配置说明：

• spring.datasource.url=jdbc:h2:mem:testdb;DATABASE_TO_UPPER=false;DB_CLOSE_ON_EXIT=FALSE:
  • jdbc:h2:mem:testdb: 指定使用H2内存数据库，数据库名为 testdb。
  • DATABASE_TO_UPPER=false: 这是一个非常重要的H2参数，它指示H2不要将所有标识符（如表名、列名）自动转换为大写。如果你的SQL脚本中使用了小写或混合大小写的表名/列名，而Java代码中也按此引用，设置此参数可以避免 Table "X" not found 或 Column "Y" not found 的错误，因为H2默认会将未加引号的标识符转换为大写。
  • DB_CLOSE_ON_EXIT=FALSE: 防止JVM退出时H2数据库实例立即关闭，这在某些集成测试场景中可能有用。
• spring.flyway.enabled=true: 这是解决原问题中“表不存在”的关键。 如果此属性被设置为 false，Flyway将不会执行任何迁移，导致数据库Schema未被创建。

在单元测试中的应用

Flyway在单元测试中尤其有用，它确保每个测试都能在一个干净且具有正确Schema的数据库实例上运行。

通常，在测试环境中，你可以利用Spring Boot的配置文件优先级，为测试专门配置Flyway。例如，在 src/test/resources/application.properties 中：

# src/test/resources/application.properties
spring.datasource.url=jdbc:h2:mem:testdb;DATABASE_TO_UPPER=false;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password

spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.defer-datasource-initialization=true

spring.flyway.enabled=true
# 可以在测试中添加额外的迁移路径，用于测试特定的数据
# spring.flyway.locations=classpath:db/migration,classpath:db/testdata

对于更复杂的测试场景，你可能需要创建额外的Flyway迁移脚本来插入测试数据。例如：

• V001__create_tables.sql: 创建所有必要的表结构。
• V002__insert_initial_data.sql: 插入一些基础数据，供所有测试使用。
• 对于特定测试，可以使用 @Sql 注解来执行额外的SQL脚本，或者在测试方法中手动插入数据。

注意事项

1. Flyway启用状态： 务必确认 spring.flyway.enabled 未被设置为 false，除非你有意禁用Flyway。
2. H2的 DATABASE_TO_UPPER=false： 如果你的SQL脚本和Java代码中使用了小写或混合大小写的表名/列名，此参数对于H2至关重要，以避免大小写不匹配导致的“表/列不存在”错误。
3. JPA与Flyway的协同： 如果同时使用JPA的 spring.jpa.hibernate.ddl-auto 属性进行Schema管理，应将其设置为 none，并让Flyway全权负责Schema迁移，避免冲突。spring.jpa.defer-datasource-initialization=true 在Flyway场景下通常意味着JPA的初始化会在数据源准备好（即Flyway运行完毕）之后进行，但这并不意味着JPA会创建Schema。
4. 迁移脚本的幂等性： 尽管Flyway会跟踪已应用的迁移，但在编写SQL脚本时，考虑其幂等性仍然是一个好习惯，即重复执行不会产生副作用。
5. 测试数据管理： 对于单元测试，可以考虑使用Flyway来插入通用测试数据，或者结合Spring的 @Sql 注解在测试方法或类级别加载特定测试数据。

总结

通过正确配置和使用Flyway，Spring Boot应用可以有效地管理H2内存数据库的Schema，从而避免常见的“表不存在”错误。这不仅为应用程序提供了一个稳定可靠的数据库初始化机制，也极大地简化了单元测试的设置和维护工作，确保每次测试都在一个一致且预期的数据库环境中运行。理解并实践Flyway的迁移流程，是构建健壮Spring Boot应用的关键一环。

以上就是使用Flyway与Spring Boot在H2内存数据库中管理数据库Schema的详细内容，更多请关注php中文网其它相关文章！