Spring Boot中用JSON配置替代Liquibase做数据库迁移的优化诉求

我正在开发一个Spring Boot项目，当前使用Liquibase对接PostgreSQL数据库执行迁移操作，涵盖建表、数据持久化及更新。但因采用SQL脚本，遇到了回滚方面的难题。为解决该问题，我计划用基于JSON配置的自定义方案替换Liquibase，目前已完成以下工作：

• 编写描述数据库结构与数据变更的JSON文件；
• 开发读取JSON配置并应用数据库变更的服务；
• 将该服务集成到Spring Boot应用中。

JSON配置示例（db_migrations.json） #

{
  "migrations": [
    {
      "id": "001",
      "description": "Create table1",
      "up": [
        "CREATE TABLE table1 (id SERIAL PRIMARY KEY, field1 VARCHAR(255) NOT NULL, field2 VARCHAR(255), field3 VARCHAR(255), field4 VARCHAR(255), field5 VARCHAR(255), field6 VARCHAR(255) NOT NULL, field7 JSONB NOT NULL, field8 TIMESTAMP, field9 TIMESTAMP, field10 VARCHAR(255), field11 UUID NOT NULL)"
      ],
      "down": [
        "DROP TABLE table1"
      ]
    }
  ]
}

JsonMigrationService代码 #

@Service
public class JsonMigrationService {

    private final JdbcTemplate jdbcTemplate;
    private final ObjectMapper objectMapper;

    @Autowired
    public JsonMigrationService(JdbcTemplate jdbcTemplate, ObjectMapper objectMapper) {
        this.jdbcTemplate = jdbcTemplate;
        this.objectMapper = objectMapper;
    }

    @PostConstruct
    public void applyMigrations() throws IOException {
        File file = new File("src/main/resources/db_migrations.json");
        JsonNode rootNode = objectMapper.readTree(file);
        JsonNode migrations = rootNode.path("migrations");

        for (JsonNode migration : migrations) {
            String id = migration.path("id").asText();
            String description = migration.path("description").asText();
            JsonNode upCommands = migration.path("up");

            for (JsonNode command : upCommands) {
                jdbcTemplate.execute(command.asText());
            }
        }
    }

    public void rollbackMigration(String migrationId) throws IOException {
        File file = new File("src/main/resources/db_migrations.json");
        JsonNode rootNode = objectMapper.readTree(file);
        JsonNode migrations = rootNode.path("migrations");

        for (JsonNode migration : migrations) {
            if (migration.path("id").asText().equals(migrationId)) {
                JsonNode downCommands = migration.path("down");
                for (JsonNode command : downCommands) {
                    jdbcTemplate.execute(command.asText());
                }
                break;
            }
        }
    }
}

咨询问题 #

1. 如何优化该回滚机制，使其具备健壮性与可靠性？
2. 是否有支持JSON格式数据库迁移的现成库或框架可替代自定义方案？

1. 回滚机制优化方案 #

记录迁移执行状态 #

• 必须创建迁移历史表（比如db_migration_history），核心字段包括：迁移ID、描述、执行时间、状态（成功/失败）。每次执行up操作前先校验该迁移是否已完成，避免重复执行；回滚时仅处理状态为成功的迁移。
• 示例表结构：

  CREATE TABLE db_migration_history (
      id VARCHAR(20) PRIMARY KEY,
      description TEXT NOT NULL,
      executed_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
      status VARCHAR(10) NOT NULL CHECK (status IN ('SUCCESS', 'FAILED'))
  );
  

事务包裹单个迁移 #

• 每个迁移的up/down操作必须纳入事务：若某条SQL执行失败，整个迁移回滚，防止数据库处于不一致状态。可通过@Transactional声明式事务或JdbcTemplate的事务回调实现。
• 示例修改：

  @Transactional
  public void applySingleMigration(JsonNode migration) {
      String id = migration.path("id").asText();
      // 校验是否已执行
      boolean exists = jdbcTemplate.queryForObject(
          "SELECT COUNT(*) FROM db_migration_history WHERE id = ?",
          Integer.class, id) > 0;
      if (exists) return;
  
      // 执行所有up命令
      JsonNode upCommands = migration.path("up");
      for (JsonNode command : upCommands) {
          jdbcTemplate.execute(command.asText());
      }
      // 写入历史记录
      jdbcTemplate.update(
          "INSERT INTO db_migration_history (id, description, status) VALUES (?, ?, ?)",
          id, migration.path("description").asText(), "SUCCESS");
  }
  

严格控制回滚顺序 #

• 回滚必须按迁移执行的逆序进行，禁止随意回滚中间某条迁移（比如先回滚002再回滚001），否则会出现依赖失效问题（如002依赖001创建的表）。
• 优化回滚逻辑：从历史表查询已成功执行的迁移列表，按执行时间倒序遍历，依次执行对应down命令，完成后更新历史表状态或删除记录。

完善错误处理与日志 #

• 为迁移的执行、回滚过程添加详细日志，记录SQL命令、执行结果、错误栈信息，便于排查问题。
• 回滚失败时需抛出明确异常，同时将错误状态写入历史表，避免后续重复尝试回滚同一失败迁移。

资源加载优化 #

• 不要硬编码文件路径src/main/resources/db_migrations.json，改用Spring的ResourceLoader加载资源，适配jar包等不同部署环境：

  @Autowired
  private ResourceLoader resourceLoader;
  
  public void loadMigrations() throws IOException {
      Resource resource = resourceLoader.getResource("classpath:db_migrations.json");
      JsonNode rootNode = objectMapper.readTree(resource.getInputStream());
      // 后续逻辑
  }
  

2. 支持JSON格式的数据库迁移框架 #

Liquibase原生支持JSON/YAML变更集 #

其实无需完全替换Liquibase，它本身支持用JSON/YAML编写变更集，自带成熟的回滚、事务、历史记录管理机制。示例JSON格式变更集：

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "001",
        "author": "your-name",
        "changes": [
          {
            "createTable": {
              "tableName": "table1",
              "columns": [
                { "column": { "name": "id", "type": "SERIAL", "constraints": { "primaryKey": true } } },
                { "column": { "name": "field1", "type": "VARCHAR(255)", "constraints": { "nullable": false } } }
                // 其他字段定义
              ]
            }
          }
        ],
        "rollback": [
          { "dropTable": { "tableName": "table1" } }
        ]
      }
    }
  ]
}

Flyway自定义JSON迁移支持 #

Flyway是主流迁移工具，默认支持SQL脚本，但可通过实现Migration接口自定义JSON迁移类型：编写JsonMigration解析JSON文件中的up/down命令，集成到Flyway生命周期中，既能复用Flyway的成熟机制，又满足JSON配置需求。

MyBatis Migrations（可选） #

虽然默认用SQL脚本，但可通过自定义解析器扩展JSON支持，不过生态成熟度略逊于前两者。

内容的提问来源于stack exchange，提问作者Ali BOUHLEL