Spring Boot 如何用 Flyway 管理 H2 和 Docker 中的 PostgreSQL?
不需要让 H2 与 PostgreSQL 直接连接。运行应用时连接 PostgreSQL,测试时连接 H2,让 Flyway 对当前环境使用的数据库执行迁移。两个数据库各自保存数据和迁移记录,Flyway 不会自动同步它们的业务数据。
1. 按环境组织配置
可以先采用以下目录结构:
src/
├── main/
│ └── resources/
│ ├── application.yml
│ ├── application-pg.yml
│ └── db/
│ └── migration/
│ └── V1__create_project_item.sql
└── test/
├── java/
└── resources/
└── application-test.yml
pg 和 test 是示例 profile 名称。Spring Boot 支持通过 profile 加载对应的配置文件,可以用启动参数 --spring.profiles.active=pg 激活。Spring Boot Profiles 文档
项目需要包含以下依赖:
- JDBC 数据访问支持,例如
spring-boot-starter-jdbc。如果已经使用spring-boot-starter-data-jpa,通常无需重复添加。 - PostgreSQL JDBC 驱动
org.postgresql:postgresql,Maven scope 使用runtime。 - H2
com.h2database:h2,仅供测试时使用testscope。 - 与项目 Spring Boot 版本匹配的 Flyway 依赖及自动配置支持。
原问题没有给出版本,因此无法提供适用于所有版本的完整依赖清单。所引用的 Spring Boot 文档使用 spring-boot-starter-flyway,并要求 PostgreSQL 额外引入 org.flywaydb:flyway-database-postgresql。使用其他版本时,请查看对应版本的文档,不要直接混用依赖版本。Spring Boot Flyway 配置说明
2. 分别配置 PostgreSQL 和 H2
公共配置 src/main/resources/application.yml:
spring:
flyway:
enabled: true
locations: classpath:db/migration
sql:
init:
mode: never
这里由 Flyway 负责初始化,避免再通过 schema.sql、data.sql 重复建表。如果使用 JPA,还可以设置 spring.jpa.hibernate.ddl-auto=validate,让 Hibernate 检查映射,建表和结构变更仍交给 Flyway。数据库初始化说明
PostgreSQL 配置 src/main/resources/application-pg.yml:
spring:
datasource:
url: ${DB_URL}
username: ${DB_USER}
password: ${DB_PASSWORD}
driver-class-name: org.postgresql.Driver
在 IntelliJ 的运行配置中设置这些环境变量。假设 Docker 将 PostgreSQL 端口映射到了宿主机的 5432,数据库名为 portfolio,URL 可以写成:
jdbc:postgresql://localhost:5432/portfolio
数据库名、映射端口和凭据必须与你的容器配置一致。如果 Java 应用也在 Docker 中运行,通常应使用同一 Docker 网络中的数据库服务名和容器端口;此时 localhost 指向应用容器自身。
H2 配置 src/test/resources/application-test.yml:
spring:
datasource:
url: "jdbc:h2:mem:portfolio_test;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;DEFAULT_NULL_ORDERING=HIGH;DB_CLOSE_DELAY=-1"
username: sa
password: ""
driver-class-name: org.h2.Driver
MODE=PostgreSQL 可以减少部分 SQL 差异,但它只覆盖 PostgreSQL 行为的一部分,H2 仍不能完全替代 PostgreSQL。H2 兼容模式文档
DB_CLOSE_DELAY=-1 让内存数据库在最后一个连接关闭后保留到 JVM 退出。同一 JVM 内连接同名内存数据库可能共享状态,因此这项配置不能保证每个测试方法都使用全新的数据库。H2 内存数据库说明
3. 用 Flyway 创建数据库结构
下面的迁移文件仅供演示,并非原项目已有的表结构。将它保存为 V1__create_project_item.sql:
CREATE TABLE project_item (
id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
name VARCHAR(200) NOT NULL
);
Flyway 的版本化迁移文件使用 V<版本>__<说明>.sql 格式,版本与说明之间有两个下划线。自动配置正常启用时,Spring Boot 启动后会调用 Flyway 执行迁移。Flyway 迁移约定
新建的 H2 内存数据库会从头执行迁移;保留数据的 PostgreSQL 会根据自己的迁移历史执行尚未应用的版本。后续新增字段时,应新增迁移文件,例如 V2__add_description.sql,不要随意修改已经应用到持久化环境的版本化脚本。
共用迁移文件的前提是其中的 SQL 能在两个数据库中执行。如果项目使用 PostgreSQL 特有的数据类型、扩展、函数或索引,H2 测试通过也不足以证明迁移在 PostgreSQL 上正确。这类集成测试应连接独立的 PostgreSQL 测试数据库,也可以使用 Testcontainers 创建临时实例,避免连接实际业务数据库。
确实需要不同 SQL 时,可以通过 spring.flyway.locations 为两个 profile 指定不同的迁移目录,但需要自行维护两套结构的一致性。
4. 在 IntelliJ 中运行应用和测试
运行应用前,先启动 PostgreSQL 容器,确认数据库已创建且端口可访问,再在 Spring Boot 运行配置中设置:
Program arguments:
--spring.profiles.active=pg
同时设置 DB_URL、DB_USER 和 DB_PASSWORD。IntelliJ 的数据库工具窗口只是连接和查看数据库的客户端,应用实际使用哪个连接由 Spring Boot 配置决定。
测试类可以显式激活 test profile。以下示例假设项目使用 JUnit 5,且测试类位于 Spring Boot 应用可以扫描到的包中:
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.test.context.ActiveProfiles;
import static org.junit.jupiter.api.Assertions.assertNotNull;
@SpringBootTest
@ActiveProfiles("test")
class DatabaseMigrationTest {
@Autowired
private JdbcTemplate jdbcTemplate;
@Test
void migratedTableIsQueryable() {
Long count = jdbcTemplate.queryForObject(
"SELECT COUNT(*) FROM project_item", Long.class);
assertNotNull(count);
}
}
这个检查只能确认示例表可查询,业务查询、约束和 PostgreSQL 特有行为仍需相应测试。仅创建 application-test.yml 不会自动激活 test profile;按上述配置运行测试时,无需启动 PostgreSQL 容器。
5. 配置 .gitignore
下面的规则可作为起点,请根据实际使用的构建工具和本地目录调整:
# Build output
/target/
/build/
/.gradle/
# Local IDE files
/.idea/
*.iml
# Local credentials
.env
.env.*
!.env.example
# Optional local database files
*.mv.db
*.trace.db
# Example PostgreSQL bind-mount directory
/docker-data/
/docker-data/ 仅适用于实际使用该目录保存容器数据的情况;Docker named volume 不位于项目工作目录中。内存模式的 H2 不会生成 .mv.db 文件。
Flyway 迁移脚本、构建配置,以及只包含占位符的 application*.yml 应提交到 Git。真实密码放在环境变量或被忽略的本地配置中。Spring Boot 不会仅因为项目存在 .env 就自动读取它,需要通过运行配置或其他明确的加载方式提供变量。
.gitignore 只影响 Git 对文件的跟踪,不负责启动数据库或切换 profile,也不会移除已经提交过的文件或凭据。
备注:内容仅供参考。
