如何在不重启Spring Boot应用时编程触发Liquibase迁移？

针对你需要分离外键约束迁移、在数据迁移完成后手动触发Liquibase的需求，以下是几种无需重启或重新部署应用的实现方式：

1. 暴露Admin API端点触发迁移 #

在Spring Boot中创建一个受权限保护的API接口，直接调用Liquibase的更新方法来执行未完成的迁移步骤。

实现步骤： #

• 注入Liquibase实例（Spring Boot会自动配置该Bean）
• 编写Controller接口，添加权限控制避免未授权访问
• 在接口方法中调用liquibase.update("")执行迁移

示例代码：

@RestController
@RequestMapping("/admin/liquibase")
@PreAuthorize("hasAuthority('TRIGGER_MIGRATION')") // 自定义权限控制
public class LiquibaseTriggerController {

    private final Liquibase liquibase;

    // 构造注入Liquibase实例
    public LiquibaseTriggerController(Liquibase liquibase) {
        this.liquibase = liquibase;
    }

    @PostMapping("/run")
    public ResponseEntity<String> triggerMigration() {
        try {
            // 执行所有未完成的迁移（包括满足preconditions的外键创建步骤）
            liquibase.update("");
            return ResponseEntity.ok("迁移执行成功");
        } catch (Exception e) {
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                    .body("迁移失败：" + e.getMessage());
        }
    }
}

2. 通过Spring事件机制触发迁移 #

利用Spring的事件发布-监听机制，在数据迁移完成后发布自定义事件，监听事件的Bean自动执行Liquibase迁移。

实现步骤： #

• 定义自定义事件类
• 创建事件监听器，注入Liquibase并在事件触发时执行迁移
• 在数据迁移完成的逻辑中发布事件

自定义事件类：

public class TriggerLiquibaseEvent extends ApplicationEvent {
    public TriggerLiquibaseEvent(Object source) {
        super(source);
    }
}

事件监听器：

@Component
public class LiquibaseMigrationListener {

    private final Liquibase liquibase;
    private static final Logger log = LoggerFactory.getLogger(LiquibaseMigrationListener.class);

    public LiquibaseMigrationListener(Liquibase liquibase) {
        this.liquibase = liquibase;
    }

    @EventListener(TriggerLiquibaseEvent.class)
    public void onMigrationTrigger(TriggerLiquibaseEvent event) {
        try {
            liquibase.update("");
            log.info("Liquibase迁移已执行完成");
        } catch (Exception e) {
            log.error("Liquibase迁移执行失败", e);
        }
    }
}

触发事件（数据迁移完成后）：

@Autowired
private ApplicationEventPublisher eventPublisher;

// 当数据迁移完成、满足preconditions时触发
public void afterDataMigrationCompleted() {
    eventPublisher.publishEvent(new TriggerLiquibaseEvent(this));
}

3. 基于条件的定时检查触发 #

如果需要自动检测数据迁移完成状态，可以添加定时任务，定期检查preconditions是否满足，满足则执行迁移。

示例代码：

@Component
public class LiquibaseScheduledTrigger {

    private final Liquibase liquibase;
    private final JdbcTemplate jdbcTemplate;
    private static final Logger log = LoggerFactory.getLogger(LiquibaseScheduledTrigger.class);
    private boolean migrationTriggered = false; // 标记是否已执行过迁移

    public LiquibaseScheduledTrigger(Liquibase liquibase, JdbcTemplate jdbcTemplate) {
        this.liquibase = liquibase;
        this.jdbcTemplate = jdbcTemplate;
    }

    @Scheduled(fixedRate = 300000) // 每5分钟检查一次
    public void checkAndTriggerMigration() {
        if (migrationTriggered) {
            return; // 已执行过则跳过
        }
        // 检查是否满足外键迁移的preconditions（比如数据迁移完成标记）
        Integer count = jdbcTemplate.queryForObject(
                "SELECT COUNT(*) FROM migration_status WHERE task = 'data_migration' AND status = 'COMPLETED'",
                Integer.class
        );
        if (count != null && count > 0) {
            try {
                liquibase.update("");
                migrationTriggered = true;
                log.info("定时触发Liquibase迁移完成");
            } catch (Exception e) {
                log.error("定时触发迁移失败", e);
            }
        }
    }
}

关键配置补充：外键迁移的Preconditions #

确保你的外键创建changeSet配置了正确的preconditions，初始启动时跳过执行，满足条件后才会被执行：

<changeSet id="add_user_order_fk" author="sumek">
    <preConditions onFail="MARK_RAN">
        <!-- 检查数据迁移是否完成，比如查询迁移状态表 -->
        <sqlCheck expectedResult="1">
            SELECT COUNT(*) FROM migration_status WHERE task = 'user_data_migration' AND status = 'SUCCESS'
        </sqlCheck>
        <!-- 或者检查目标表数据是否存在 -->
        <tableExists tableName="user"/>
        <tableExists tableName="order"/>
    </preConditions>
    <addForeignKeyConstraint 
        baseTableName="order" 
        baseColumnNames="user_id"
        referencedTableName="user" 
        referencedColumnNames="id"
        constraintName="fk_order_user"/>
</changeSet>

注意事项 #

• 权限控制：API方式必须添加严格的权限校验，避免未授权调用
• 并发安全：确保迁移过程不会被多次触发，可添加分布式锁或本地锁
• 日志监控：详细记录迁移过程的日志，便于排查问题
• 幂等性：确保changeSet本身是幂等的，避免重复执行导致异常

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