Spring Boot 集成 Liquibase，数据库也能做版本控制！

小咪咪 2023-09-30 20:46 21阅读 0赞

今天给大家介绍另外一款比较不错的数据库变更管理工具：**Liquibase**

本文将带着大家实操一个 SpringBoot 结合 Liquibase 的项目，看看如何新增数据表、修改表字段、初始化数据等功能，顺带使用一下 Liquibase 模版生成器插件。

本项目包含两个小项目，一个是 liquibase 模版生成器插件，项目名叫做 liquibase-changelog-generate，另一个项目是 liquibase 应用，叫做 springboot-liquibase。

## Liquibase 模版生成器插件 ##

创建一个 maven 项目 liquibase-changelog-generate，本项目具备生成 xml 和 yaml 两种格式的 changelog，个人觉得 yaml 格式的 changelog 可读性更高。

1、导入依赖

<dependencies>    <dependency>    <groupId>org.apache.maven</groupId>    <artifactId>maven-plugin-api</artifactId>    <version>3.8.6</version>  </dependency>  <dependency>    <groupId>org.apache.maven.plugin-tools</groupId>    <artifactId>maven-plugin-annotations</artifactId>    <version>3.6.4</version>    <scope>provided</scope>  </dependency>  <dependency>    <groupId>cn.hutool</groupId>    <artifactId>hutool-all</artifactId>    <version>5.8.5</version>  </dependency>
    </dependencies>
    <build>  <plugins>    <plugin>      <groupId>org.apache.maven.plugins</groupId>      <artifactId>maven-plugin-plugin</artifactId>      <version>3.6.4</version>            <configuration>        <goalPrefix>hresh</goalPrefix>        <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>      </configuration>    </plugin>    <plugin>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-maven-plugin</artifactId>      <version>2.6.3</version>    </plugin>        <plugin>      <groupId>org.apache.maven.plugins</groupId>      <artifactId>maven-compiler-plugin</artifactId>      <configuration>        <source>1.8</source>        <target>1.8</target>      </configuration>    </plugin>  </plugins></build>

2、定义一个接口，提前准备好公用代码，主要是判断 changelog id 是否有非法字符，并且生成 changelog name。

public interface LiquibaseChangeLog {
       
      default String getChangeLogFileName(String sourceFolderPath) {
           System.out.println("> Please enter the id of this change:");    Scanner scanner = new Scanner(System.in);    String changeId = scanner.nextLine();    if (StrUtil.isBlank(changeId)) {
             return null;    }
        String changeIdPattern = "^[a-z][a-z0-9_]*$";    Pattern pattern = Pattern.compile(changeIdPattern);    Matcher matcher = pattern.matcher(changeId);    if (!matcher.find()) {
             System.out.println("Change id should match " + changeIdPattern);      return null;    }
        if (isExistedChangeId(changeId, sourceFolderPath)) {
             System.out.println("Duplicate change id :" + changeId);      return null;    }
        Date now = new Date();    String timestamp = DateUtil.format(now, "yyyyMMdd_HHmmss_SSS");    return timestamp + "__" + changeId;  }
      default boolean isExistedChangeId(String changeId, String sourceFolderPath) {
           File file = new File(sourceFolderPath);    File[] files = file.listFiles();    if (null == files) {
             return false;    }
        for (File f : files) {
             if (f.isFile()) {
               if (f.getName().contains(changeId)) {
                 return true;        }      }    }    return false;  }}

3、每个 changelog 文件中的 changeSet 都有一个 author 属性，用来标注是谁创建的 changelog，目前我的做法是执行终端命令来获取 git 的 userName，如果有更好的实现，望不吝赐教。

public class GitUtil {
       
      public static String getGitUserName() {
           try {
             String cmd = "git config user.name";      Process p = Runtime.getRuntime().exec(cmd);      InputStream is = p.getInputStream();      BufferedReader reader = new BufferedReader(new InputStreamReader(is));      String line = reader.readLine();      p.waitFor();      is.close();      reader.close();      p.destroy();      return line;    } catch (IOException | InterruptedException e) {
             e.printStackTrace();    }    return "hresh";  }}

4、生成 xml 格式的 changelog

@Mojo(name = "generateModelChangeXml", defaultPhase = LifecyclePhase.PACKAGE)public class LiquibaseChangeLogXml extends AbstractMojo implements LiquibaseChangeLog {
       
      // 配置的是本maven插件的配置，在pom使用configration标签进行配置 property就是名字，  // 在配置里面的标签名字。在调用该插件的时候会看到  @Parameter(property = "sourceFolderPath")  private String sourceFolderPath;
      @Override  public void execute() throws MojoExecutionException, MojoFailureException {
           System.out.println("Create a new empty model changelog in liquibase yaml file.");    String userName = GitUtil.getGitUserName();
        String changeLogFileName = getChangeLogFileName(sourceFolderPath);    if (StrUtil.isNotBlank(changeLogFileName)) {
             generateXmlChangeLog(changeLogFileName, userName);    }  }
      private void generateXmlChangeLog(String changeLogFileName, String userName) {
           String changeLogFileFullName = changeLogFileName + ".xml";    File file = new File(sourceFolderPath, changeLogFileFullName);    String content = "<?xml version=\"1.1\" encoding=\"UTF-8\" standalone=\"no\"?>\n"        + "<databaseChangeLog xmlns=\"http://www.liquibase.org/xml/ns/dbchangelog\"\n"        + "  xmlns:ext=\"http://www.liquibase.org/xml/ns/dbchangelog-ext\"\n"        + "  xmlns:pro=\"http://www.liquibase.org/xml/ns/pro\"\n"        + "  xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n"        + "  xsi:schemaLocation=\"http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd\">\n"        + "  <changeSet author=\" " + userName + "\" id=\"" + changeLogFileName + "\">\n"        + "  </changeSet>\n"        + "</databaseChangeLog>";    try {
             FileWriter fw = new FileWriter(file.getAbsoluteFile());      BufferedWriter bw = new BufferedWriter(fw);      bw.write(content);      bw.close();      fw.close();    } catch (IOException e) {
             e.printStackTrace();    }  }
    }

5、生成 yaml 格式的 changelog

@Mojo(name = "generateModelChangeYaml", defaultPhase = LifecyclePhase.PACKAGE)public class LiquibaseChangeLogYaml extends AbstractMojo implements LiquibaseChangeLog {
       
      // 配置的是本maven插件的配置，在pom使用configration标签进行配置 property就是名字，  // 在配置里面的标签名字。在调用该插件的时候会看到  @Parameter(property = "sourceFolderPath")  private String sourceFolderPath;
      @Override  public void execute() throws MojoExecutionException, MojoFailureException {
           System.out.println("Create a new empty model changelog in liquibase yaml file.");    String userName = GitUtil.getGitUserName();
        String changeLogFileName = getChangeLogFileName(sourceFolderPath);    if (StrUtil.isNotBlank(changeLogFileName)) {
             generateYamlChangeLog(changeLogFileName, userName);    }  }
      private void generateYamlChangeLog(String changeLogFileName, String userName) {
           String changeLogFileFullName = changeLogFileName + ".yml";    File file = new File(sourceFolderPath, changeLogFileFullName);    String content = "databaseChangeLog:\n"        + "  - changeSet:\n"        + "      id: " + changeLogFileName + "\n"        + "      author: " + userName + "\n"        + "      changes:";    try {
             FileWriter fw = new FileWriter(file.getAbsoluteFile());      BufferedWriter bw = new BufferedWriter(fw);      bw.write(content);      bw.close();      fw.close();    } catch (IOException e) {
             e.printStackTrace();    }  }
    }

6、执行 mvn install 命令，然后会在 maven 的 repository 文件中生成对应的 jar 包。

项目整体结构如下图所示：

![455ca1402a9d2f1884bd9b6de2f4f1b7.png][]

liquibase 模版生成器项目结构

因为个人感觉 yaml 文件看起来比较简洁，所以虽然插件提供了两种格式，但后续我选择 yaml 文件。关注公众号：码猿技术专栏，回复关键词:1111 获取阿里内部 Java 性能调优手册！

## Liquibase 项目 ##

本项目只是演示如何通过 Liquibase 新增数据表、修改表字段、初始化数据等功能，并不涉及具体的业务功能，所以代码部分会比较少。

1、引入依赖

<parent>  <groupId>org.springframework.boot</groupId>  <artifactId>spring-boot-starter-parent</artifactId>  <version>2.6.3</version>  <relativePath/></parent>
    <properties>  <java.version>1.8</java.version>  <mysql.version>8.0.19</mysql.version>  <org.projectlombok.version>1.18.20</org.projectlombok.version>  <druid.version>1.1.18</druid.version>  <liquibase.version>4.16.1</liquibase.version></properties>
    <dependencies>    <dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-web</artifactId>  </dependency>
      <dependency>    <groupId>mysql</groupId>    <artifactId>mysql-connector-java</artifactId>    <version>${mysql.version}</version>    <scope>runtime</scope>  </dependency>  <dependency>    <groupId>com.alibaba</groupId>    <artifactId>druid-spring-boot-starter</artifactId>    <version>${druid.version}</version>  </dependency>  <dependency>    <groupId>org.liquibase</groupId>    <artifactId>liquibase-core</artifactId>    <version>4.16.1</version>  </dependency>  <dependency>    <groupId>com.baomidou</groupId>    <artifactId>mybatis-plus-boot-starter</artifactId>    <version>3.5.1</version>  </dependency>  <dependency>    <groupId>com.baomidou</groupId>    <artifactId>mybatis-plus</artifactId>    <version>3.5.1</version>  </dependency>
    </dependencies>
    <build>  <plugins>    <plugin>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-maven-plugin</artifactId>    </plugin>    <plugin>      <groupId>org.liquibase</groupId>      <artifactId>liquibase-maven-plugin</artifactId>      <version>4.16.1</version>      <configuration>                <propertyFile>src/main/resources/application.yml</propertyFile>        <propertyFileWillOverride>true</propertyFileWillOverride>      </configuration>    </plugin>    <plugin>      <groupId>com.msdn.hresh</groupId>      <artifactId>liquibase-changelog-generate</artifactId>      <version>1.0-SNAPSHOT</version>      <configuration>        <sourceFolderPath>src/main/resources/liquibase/changelogs/        </sourceFolderPath>      </configuration>    </plugin>  </plugins></build>

2、application.yml 配置如下：

server:  port: 8088
    spring:  application:    name: springboot-liquibase  datasource:    type: com.alibaba.druid.pool.DruidDataSource    driver-class-name: com.mysql.cj.jdbc.Driver    url: jdbc:mysql://localhost:3306/mysql_db?serverTimezone=Hongkong&characterEncoding=utf-8&useSSL=false    username: root    password: root  liquibase:    enabled: true    change-log: classpath:liquibase/master.xml    # 记录版本日志表    database-change-log-table: databasechangelog    # 记录版本改变lock表    database-change-log-lock-table: databasechangeloglock
    mybatis:  mapper-locations: classpath:mapper/*Mapper.xml  configuration:    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl    lazy-loading-enabled: true
    changeLogFile: src/main/resources/liquibase/master.xml#输出文件路径配置#outputChangeLogFile: src/main/resources/liquibase/out/out.xml

3、resources 目录下创建 Liquibase 相关文件，主要是 master.xml

<?xml version="1.0" encoding="UTF-8"?><databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd">
        <property name="id" value="int(11)" dbms="mysql"/>  <property name="time" value="timestamp" dbms="mysql"/>
      <includeAll path="liquibase/changelogs"/>
    </databaseChangeLog>

还需要创建 liquibase/changelogs 目录。

4、创建一个启动类，准备启动项目

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

接下来我们就进行测试使用 Liquibase 来进行数据库变更控制。

## 创建表 ##

准备通过 Liquibase 来创建数据表，首先点击下面这个命令：

![db8fddf7a74dba0fa1030adc4e9bcc7a.png][]

然后在控制台输入 create\_table\_admin，回车，我们可以看到对应的文件如下：

![4a2e99c9c796f4ebb45fb91d96aae778.png][]

我们填充上述文件，将建表字段加进去。

databaseChangeLog:  - changeSet:      id: 20221124_161016_997__create_table_admin      author: hresh      changes:        - createTable:            tableName: admin            columns:              - column:                  name: id                  type: ${id}                  autoIncrement: true                  constraints:                    primaryKey: true                    nullable: false              - column:                  name: name                  type: varchar(50)              - column:                  name: password                  type: varchar(100)              - column:                  name: create_time                  type: ${time}

关于 Liquibase yaml SQL 格式推荐去官网查询。

启动项目后，先来查看控制台输出：

![52a0c2a6606349cda4aa0a779e916839.png][]

接着去数据库中看 databasechangelog 表记录

![dd3cb69ff171ec67a0bb2515279e9821.png][]

以及 admin 表结构

![6706c76acbe134bc76d301d5dbb6baed.png][]

## 新增表字段 ##

使用我们的模版生成器插件，输入 add\_column\_address\_in\_admin，回车得到一个模版文件，比如说我们在 admin 表中新增 address 字段。

databaseChangeLog:  - changeSet:      id: 20221124_163754_923__add_column_address_in_admin      author: hresh      changes:        - addColumn:            tableName: admin            columns:              - column:                  name: address                  type: varchar(100)

再次重启项目，这里我就不贴控制台输出日志了，直接去数据库中看 admin 表的变化。

![b66d849b460468c06c872f1620e3c9f3.png][]

## 创建索引 ##

输入 create\_index\_in\_admin，回车得到模版文件，然后填充内容：

databaseChangeLog:  - changeSet:      id: 20221124_164641_992__create_index_in_admin      author: hresh      changes:        - createIndex:            tableName: admin            indexName: idx_name            columns:              - column:                  name: name

查看 admin 表变化：

![995a7530b14ea79e23a879b1ac057ed5.png][]

如果要修改索引，一般都是先删再增，删除索引可以这样写：

databaseChangeLog:  - changeSet:      id: 20221124_164641_992__create_index_in_admin      author: hresh      changes:        - dropIndex:            tableName: admin            indexName: idx_name

## 初始化数据 ##

输入 init\_data\_in\_admin ，修改模版文件

databaseChangeLog:  - changeSet:      id: 20221124_165413_348__init_data_in_admin      author: hresh      changes:        - sql:            dbms: mysql            sql: "insert into admin(name,password) values('hresh','1234')"            stripComments:  true

重启项目后，可以发现数据表中多了一条记录。

关于 Liquibase 还有很多操作没介绍，等大家实际应用时再去发掘了，这里就不一一介绍了。

Liquibase 好用是好用，那么有没有可视化的界面呢？答案当然是有的。

## plugin-生成数据库修改文档 ##

双击 liquibase plugin 面板中的 liquibase:dbDoc 选项，会生成数据库修改文档，默认会生成到 target 目录中，如下图所示

![857ad1423e45012ce1c78e32fed46941.jpeg][]

访问 index.html 会展示如下页面，简直应有尽有

![8a31bd104f7ae3c81baa51524f2c0f38.png][]

关于 liquibase 的更多有意思的命令使用，可以花时间再去挖掘一下，这里就不过多介绍了。

## 问题 ##

**控制台输出 liquibase.changelog Reading resource 读取了很多没必要的文件**

控制台截图如下所示：

![a72178195c9d3388d9396faa443d11e1.png][]

我们查找一个 AbstractChangeLogHistoryService 文件所在位置，发现它是 liquibase-core 包下的文件，如下所示：

![2d19c2e7f2b41e5683456ef76c67d905.png][]

为什么会这样呢？首先来看下我们关于 liquibase 的配置，如下图所示：

![f056ce65918109801366a516deeb5361.png][]

其中 master.xml 文件内容如下：

<?xml version="1.0" encoding="UTF-8"?><databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd">
      <property name="id" value="int(11)" dbms="mysql"/>  <property name="time" value="timestamp" dbms="mysql"/>
      <includeAll path="liquibase/changelog/"/>
    </databaseChangeLog>

[455ca1402a9d2f1884bd9b6de2f4f1b7.png]: https://img-blog.csdnimg.cn/img_convert/455ca1402a9d2f1884bd9b6de2f4f1b7.png
[db8fddf7a74dba0fa1030adc4e9bcc7a.png]: https://img-blog.csdnimg.cn/img_convert/db8fddf7a74dba0fa1030adc4e9bcc7a.png
[4a2e99c9c796f4ebb45fb91d96aae778.png]: https://img-blog.csdnimg.cn/img_convert/4a2e99c9c796f4ebb45fb91d96aae778.png
[52a0c2a6606349cda4aa0a779e916839.png]: https://img-blog.csdnimg.cn/img_convert/52a0c2a6606349cda4aa0a779e916839.png
[dd3cb69ff171ec67a0bb2515279e9821.png]: https://img-blog.csdnimg.cn/img_convert/dd3cb69ff171ec67a0bb2515279e9821.png
[6706c76acbe134bc76d301d5dbb6baed.png]: https://img-blog.csdnimg.cn/img_convert/6706c76acbe134bc76d301d5dbb6baed.png
[b66d849b460468c06c872f1620e3c9f3.png]: https://img-blog.csdnimg.cn/img_convert/b66d849b460468c06c872f1620e3c9f3.png
[995a7530b14ea79e23a879b1ac057ed5.png]: https://img-blog.csdnimg.cn/img_convert/995a7530b14ea79e23a879b1ac057ed5.png
[857ad1423e45012ce1c78e32fed46941.jpeg]: https://img-blog.csdnimg.cn/img_convert/857ad1423e45012ce1c78e32fed46941.jpeg
[8a31bd104f7ae3c81baa51524f2c0f38.png]: https://img-blog.csdnimg.cn/img_convert/8a31bd104f7ae3c81baa51524f2c0f38.png
[a72178195c9d3388d9396faa443d11e1.png]: https://img-blog.csdnimg.cn/img_convert/a72178195c9d3388d9396faa443d11e1.png
[2d19c2e7f2b41e5683456ef76c67d905.png]: https://img-blog.csdnimg.cn/img_convert/2d19c2e7f2b41e5683456ef76c67d905.png
[f056ce65918109801366a516deeb5361.png]: https://img-blog.csdnimg.cn/img_convert/f056ce65918109801366a516deeb5361.png