17370845950

新闻动态

Spring Boot集成外部库：Liquibase多Changelog迁移策略

本文探讨了在Spring Boot主应用中集成外部库时，如何有效管理并执行来自不同模块（主应用与外部库）的Liquibase数据库迁移脚本。核心解决方案是通过在主应用中定义多个SpringLiquibase Bean，分别配置各自的changelog文件，从而实现主项目和外部库的数据库初始化和升级。

1. 问题背景与挑战

在一个典型的Spring Boot应用开发场景中，我们可能需要引入一个作为JAR包存在的外部公共库。这个外部库为了提供其功能，通常需要一套默认的数据库表结构。为了管理这些表结构的创建和升级，外部库内部也可能集成了Liquibase，并提供了自己的changelog.xml文件（例如library.xml）。与此同时，主应用本身也使用Liquibase来管理自己的数据库迁移（例如main.xml）。

当主应用引入这个外部库时，面临的挑战是如何让Spring Boot的Liquibase机制同时识别并执行来自主应用和外部库的两个独立的changelog.xml文件，并且通常它们都作用于同一个数据库。简单地在主应用的application.properties中配置spring.liquibase.change-log=main.xml，将无法自动执行library.xml。

2. 核心解决方案：定义多个SpringLiquibase Bean

Spring Boot的Liquibase自动配置默认只会创建一个SpringLiquibase Bean来处理spring.liquibase.change-log指定的一个或一组changelog。要同时处理来自不同源的changelog，最有效的方法是在主应用中手动定义多个SpringLiquibase Bean，每个Bean负责一个特定的changelog。

下面将介绍两种实现方式：一种是简易直接的配置方式，另一种是更贴合Spring Boot自动配置机制的高级方式。

3. 方法一：简易配置法

这种方法通过直接创建并配置SpringLiquibase Bean来指定数据源和changelog文件。它适用于对配置灵活性要求不高，或希望快速实现多changelog执行的场景。

import liquibase.integration.spring.SpringLiquibase;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import javax.sql.DataSource;

@Configuration // 确保这个配置类被Spring扫描到
public class MultipleLiquibaseConfiguration {

    /**
     * 为外部库配置Liquibase迁移
     *
     * @param dataSource 数据库数据源
     * @return 配置好的SpringLiquibase实例
     */
    @Bean
    public SpringLiquibase liquibaseLib(DataSource dataSource) {
        SpringLiquibase liquibase = new SpringLiquibase();
        liquibase.setDataSource(dataSource);
        // 指定外部库的changelog文件路径
        liquibase.setChangeLog("classpath:library.xml");
        // 可以设置其他Liquibase属性，如默认schema等
        // liquibase.setDefaultSchema("public");
        return liquibase;
    }

    /**
     * 为主应用配置Liquibase迁移
     *
     * @param dataSource 数据库数据源
     * @return 配置好的SpringLiquibase实例
     */
    @Bean
    // 如果外部库的迁移必须在主应用之前执行，可以使用@DependsOn
    // @DependsOn("liquibaseLib")
    public SpringLiquibase liquibaseMain(DataSource dataSource) {
        SpringLiquibase liquibase = new SpringLiquibase();
        liquibase.setDataSource(dataSource);
        // 指定主应用的changelog文件路径
        liquibase.setChangeLog("classpath:main.xml");
        return liquibase;
    }
}

说明：

@Configuration：标记这是一个Spring配置类。
@Bean：声明Spring容器会管理这两个SpringLiquibase实例。
DataSource dataSource：通过方法参数，Spring会自动注入默认的数据源。
setChangeLog("classpath:...")：指定changelog文件的路径。classpath:表示文件位于应用的类路径下。
@DependsOn("liquibaseLib")：如果主应用的迁移依赖于外部库的迁移（例如，主应用表依赖于外部库创建的表），可以使用此注解确保liquibaseLib Bean先被初始化和执行。

4. 方法二：利用@ConfigurationProperties的高级配置

这种方法更加灵活和符合Spring Boot的习惯，它允许我们将不同Liquibase实例的配置（如changelog路径、默认schema等）通过application.properties或application.yml进行管理。它通过自定义属性前缀来绑定到不同的LiquibaseProperties对象，然后使用Spring Boot提供的LiquibaseConfiguration工具类来构建SpringLiquibase实例。

4.1 application.properties配置

在主应用的application.properties中，为每个Liquibase实例定义独立的配置前缀。

# 主应用的Liquibase配置
spring.liquibase.change-log=classpath:/main.xml
spring.liquibase.default-schema=public
# ... 其他spring.liquibase.* 属性

# 外部库的Liquibase配置，使用自定义前缀 'lib.liquibase'
lib.liquibase.change-log=classpath:/library.xml
lib.liquibase.default-schema=public
# ... 其他lib.liquibase.* 属性

4.2 Spring Boot主应用配置类

在主应用的某个配置类（例如主启动类或单独的配置类）中，定义多个SpringLiquibase Bean。

package com.example.app; // 替换为你的应用包名

import javax.sql.DataSource;
import liquibase.integration.spring.SpringLiquibase;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration.LiquibaseConfiguration;
import org.springframework.boot.autoconfigure.liquibase.LiquibaseDataSource;
import org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.DependsOn;

@SpringBootApplication
@EnableConfigurationProperties(LiquibaseProperties.class) // 启用LiquibaseProperties的绑定
public class DemoApplication {

  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }

  /**
   * 为主应用配置Liquibase迁移
   * 使用 'spring.liquibase' 前缀的属性
   */
  @Bean("liquibaseMain") // 可以指定Bean名称
  // 如果外部库的迁移必须在主应用之前执行，可以使用@DependsOn
  // @DependsOn("liquibaseLib")
  @ConfigurationProperties("spring.liquibase") // 绑定以 "spring.liquibase" 为前缀的属性
  public SpringLiquibase liquibase(
      ObjectProvider dataSource,
      @LiquibaseDataSource ObjectProvider liquibaseDataSource,
      LiquibaseProperties properties) {
    return createSpringLiquibase(dataSource, liquibaseDataSource, properties);
  }

  /**
   * 为外部库配置Liquibase迁移
   * 使用 'lib.liquibase' 前缀的属性
   */
  @Bean("liquibaseLib") // 可以指定Bean名称
  @ConfigurationProperties("lib.liquibase") // 绑定以 "lib.liquibase" 为前缀的属性
  public SpringLiquibase liquibaseLib(
      ObjectProvider dataSource,
      @LiquibaseDataSource ObjectProvider liquibaseDataSource,
      LiquibaseProperties properties) {
    return createSpringLiquibase(dataSource, liquibaseDataSource, properties);
  }

  /**
   * 辅助方法：使用LiquibaseConfiguration工具类创建SpringLiquibase实例
   *
   * @param dataSource 通用数据源
   * @param liquibaseDataSource 专用于Liquibase的数据源 (如果不同)
   * @param properties 绑定的Liquibase属性
   * @return SpringLiquibase实例
   */
  private SpringLiquibase createSpringLiquibase(
      ObjectProvider dataSource,
      ObjectProvider liquibaseDataSource,
      LiquibaseProperties properties) {
    // LiquibaseConfiguration 是Spring Boot内部用于创建SpringLiquibase的工具类
    // 注意：不要将LiquibaseConfiguration本身注册为Bean，而是作为工厂使用
    LiquibaseConfiguration helper = new LiquibaseConfiguration(properties);
    return helper.liquibase(dataSource, liquibaseDataSource);
  }
}

说明：

@EnableConfigurationProperties(LiquibaseProperties.class)：确保LiquibaseProperties可以被Spring容器管理并绑定配置。
@ConfigurationProperties("spring.liquibase") 和 @ConfigurationProperties("lib.liquibase")：这两个注解分别将application.properties中以spring.liquibase和lib.liquibase为前缀的属性绑定到对应的LiquibaseProperties对象上。Spring Boot会自动为每个带有@ConfigurationProperties注解的方法参数创建一个独立的LiquibaseProperties实例。
ObjectProvider 和 @LiquibaseDataSource ObjectProvider：这是Spring Boot处理数据源的推荐方式，@LiquibaseDataSource用于在存在多个数据源时指定Liquibase使用的数据源。在大多数单数据源场景下，它们会指向同一个数据源。
LiquibaseConfiguration：这是Spring Boot内部用于创建SpringLiquibase实例的辅助类。它封装了从LiquibaseProperties到SpringLiquibase的转换逻辑，推荐使用它来保证与Spring Boot自动配置行为的一致性。
@DependsOn("liquibaseLib")：同样，如果存在执行顺序依赖，可以使用此注解。

5. 注意事项

Changelog文件路径： 确保classpath:后指定的changelog文件在相应的JAR包或主应用的src/main/resources目录下存在。
执行顺序： 默认情况下，Spring会并行初始化所有@Bean。如果外部库的数据库结构必须在主应用结构之前创建，请务必使用@DependsOn注解来强制执行顺序。
数据源： 上述示例假设主应用和外部库都使用同一个数据源。如果它们需要连接到不同的数据库，你需要配置并注入不同的DataSource Bean。
外部库的application.properties： 外部库（JAR）中如果包含spring.liquibase.change-log等属性，这些属性在被主应用作为依赖引入时，通常会被主应用的配置覆盖或忽略。因此，外部库本身不应期望通过自己的application.properties来触发Liquibase迁移，而应由主应用统一管理。外部库只需提供changelog.xml文件即可。
避免重复执行： Liquibase会通过DATABASECHANGELOG表跟踪已执行的迁移。即使定义了多个SpringLiquibase Bean，只要它们指向同一个数据库和changelog文件，Liquibase也会避免重复执行已应用的迁移。
错误处理： 确保在开发和测试环境中充分测试迁移过程，以捕获任何可能的数据冲突或迁移失败。

6. 总结

在Spring Boot项目中集成外部库并管理其Liquibase迁移是一个常见的需求。通过在主应用中定义多个SpringLiquibase Bean，我们可以灵活地控制不同模块的数据库迁移过程。无论是采用简易的直接配置方式，还是利用@ConfigurationProperties进行高级管理，核心思想都是为每个需要独立执行的changelog创建一个SpringLiquibase实例。选择哪种方法取决于项目的复杂性、对配置灵活性的要求以及团队的偏好。正确配置后，即可确保主应用和外部库的数据库结构都能得到妥善的初始化和更新。

17370845950

1. 问题背景与挑战

2. 核心解决方案：定义多个SpringLiquibase Bean

3. 方法一：简易配置法

4. 方法二：利用@ConfigurationProperties的高级配置

4.1 application.properties配置

4.2 Spring Boot主应用配置类

5. 注意事项

6. 总结

关于我们

服务项目

广告推广

案例欣赏