在 Spring Boot 中将 Liquibase 替换为基于 JSON 的数据库迁移配置

Question

我正在开发一个 Spring Boot 项目，目前我们正在使用 Liquibase 将数据库迁移到 PostgreSQL 数据库。我们的项目涉及创建表、保存数据和执行更新。然而，我们面临着回滚的挑战，因为我们使用的是 SQL 脚本。

为了解决这个问题，我正在考虑用使用 JSON 配置进行数据库迁移的自定义解决方案替换 Liquibase。这是我到目前为止所做的。

1. 创建了一个描述数据库架构和数据更改的 JSON 文件。
2. 创建了一个读取 JSON 配置并将更改应用到数据库的服务。
3. 将该服务集成到我们的 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;
            }
        }
    }
}

如何改进回滚机制，保证其健壮可靠？

是否有任何现有的库或框架支持基于 JSON 的数据库迁移，我应该考虑而不是构建自定义解决方案？

如有任何意见或建议，我们将不胜感激。谢谢！

Answer 1

Liquibase 已经支持 JSON、SQL、XML 和 YAML。以下文档可帮助您开始使用 JSON：https://docs.liquibase.com/start/get-started/liquibase-json.html

如果您专门寻找回滚，这里有一个使用 JSON 的示例：https://docs.liquibase.com/commands/rollback/rollback.html#json_example_custom_generic

您绝对可以创建自己的解决方案，但我建议不要创建已经与活跃社区建立开源替代方案的定制工具。