boot-admin整合Liquibase实现数据库版本管理

青旅半醒 2024-03-24 21:05 15阅读 0赞

**Liquibase 和 Flyway 是两款成熟的、优秀的、开源/商业版的数据库版本管理工具，鉴于 Flyway 的社区版本对 Oracle 数据库支持存在限制，所以 boot-admin 选择整合 Liquibase 提供数据库版本管理能力支持。**  
Liquibase 开源版使用 Apache 2.0 协议。

## Liquibase的适用情形？ ##

*  在你的项目进行版本升级的时候，大概率情况下数据库也需要同步升级，Liquibase 会自动扫描数据库迁移文件（changeSet），将迁移文件的版本号与历史记录表（changelog ）中的版本号进行对比，略过已执行的的迁移文件，顺序执行未执行的新版本迁移文件，最终实现数据库与代码版本相匹配；
 *  当多人协作开发项目的时候，系统源代码可使用 git 保持同步，那么数据库的同步就可交由 liquibase 来保证；
 *  使用 liquibase 可以方便地比较两个数据库的差异；
 *  使用 liquibase 还支持数据库版本回滚。

## Liquibase的优点有哪些？ ##

1.  配置文件支持SQL、XML、JSON 或者 YAML；
2.  可兼容14种主流数据库如 oracle，mysql 等，支持平滑迁移；
3.  版本控制按序执行；
4.  可以用上下文控制sql在何时何地如何执行；
5.  具备在应用中具有if / then逻辑的能力；
6.  支持 schema 的变更；
7.  根据配置文件自动生成sql语句用于预览；
8.  可重复执行迁移；
9.  可插件拓展；
10. 可回滚；
11. 支持schema方式的多租户(multi-tenant)；
12. 能够在多种数据库类型上具有相同的更改描述；
13. 生成的数据库历史记录文档；
14. 能够轻松指定更复杂的多语句更改。

## 整合要点 ##

boot-admin 是一款采用前后端分离模式、基于 SpringCloud 微服务架构的SaaS后台管理框架。系统内置基础管理、权限管理、运行管理、定义管理、代码生成器和办公管理6个功能模块，集成分布式事务 Seata、工作流引擎 Flowable、业务规则引擎 Drools、后台作业调度框架 Quartz 等，技术栈包括 Mybatis-plus、Redis、Nacos、Seata、Flowable、Drools、Quartz、SpringCloud、Springboot Admin Gateway、Liquibase、jwt、Openfeign、I18n等。

> [项目源码仓库github][github]  
> [项目源码仓库gitee][gitee]

### 引入Maven依赖 ###

<dependency>
        <groupId>org.liquibase</groupId>
        <artifactId>liquibase-core</artifactId>
    </dependency>

### 添加配置 ###

spring:
      liquibase:
        enabled: true
        change-log: classpath:liquibase/master.xml

### 创建master.xml ###

在 resources 下创建文件夹 liquibase ,创建文件 master.xml

在 liquibase 文件夹下创建 changelogs 和 sql 两个文件夹，如下图所示：

![221c271e7af7882656f8537bca50b220.png][]

### 编写数据库变更单元 changeSet ###

在 resources\\liquibase\\changelogs 下创建 changeSet 文件,推荐每月一个 xml 文件，文件名格式：【changelog-年度+月份.xml】，如：changelog-202304.xml  
常用操作举例：

#### 创建表 ####

#### 添加表字段 ####

#### 删除表字段 ####

#### 修改表字段说明 ####

#### 修改表字段类型 ####

#### 创建视图 ####

<changeSet author="admin (generated)" id="00001-1" dbms="oracle">
            <createView fullDefinition="true" remarks="表和视图" viewName="V_TABLES_MASTER">
                CREATE OR REPLACE FORCE VIEW V_TABLES_MASTER (TABLE_SCHEMA, TABLENAME, TABLETYPE, COMMENTS, TENANT_ID_) AS
                select SYS_CONTEXT('USERENV','CURRENT_SCHEMA') TABLE_SCHEMA,
                t.tname tableName,
                tabtype tabletype,
                f.comments comments,
                'DEMO' TENANT_ID_
                from tab t
                inner join user_tab_comments f
                on t.tname = f.table_name
                where tname != 'DATABASECHANGELOG'
                and tname != 'DATABASECHANGELOGLOCK'
                and tname != 'UNDO_LOG'
            </createView>
        </changeSet>
        <changeSet author="37514 (generated)" id="00000-2" dbms="mysql">
            <createView fullDefinition="true" remarks="表和视图" viewName="V_TABLES_MASTER">
                CREATE OR REPLACE VIEW V_TABLES_MASTER  AS
                SELECT
                TABLE_SCHEMA,
                TABLE_NAME AS TABLENAME,
                case when table_type='BASE TABLE' then 'TABLE' ELSE table_type END AS TABLETYPE,
                TABLE_COMMENT AS COMMENTS,
                'DEMO' TENANT_ID_
                FROM
                information_schema.`TABLES`
                WHERE table_name != 'databasechangeloglock' AND TABLE_NAME != 'databasechangelog' AND TABLE_NAME != 'undo_log'
            </createView>
        </changeSet>

#### 兼容 Oracle 和 Mysql 配置 ####

#### 执行 SQL 文件 ####

需将对应 sql 文件放在指定文件夹中。

## Liquibase changeSet常用命令清单 ##

### add ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>addAutoIncrement</td> 
   <td>将一个已存在的列转换为自增</td> 
  </tr> 
  <tr> 
   <td>addColunm</td> 
   <td>增加列</td> 
  </tr> 
  <tr> 
   <td>addDefaultValue</td> 
   <td>对已存在的列增加默认值</td> 
  </tr> 
  <tr> 
   <td>addForeignKeyConstraint</td> 
   <td>对已存在的列增加外键约束</td> 
  </tr> 
  <tr> 
   <td>addLookupTable</td> 
   <td>创建外键关联的表</td> 
  </tr> 
  <tr> 
   <td>addNotNullConstraint</td> 
   <td>对已存在的列增加非空约束</td> 
  </tr> 
  <tr> 
   <td>addPrimaryKey</td> 
   <td>对已存在的列增加主键约束</td> 
  </tr> 
  <tr> 
   <td>ddUniqueConstraint</td> 
   <td>对已存在的列增加主键约束</td> 
  </tr> 
 </tbody> 
</table>

### create ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>createIndex</td> 
   <td>创建索引</td> 
  </tr> 
  <tr> 
   <td>createProcedure</td> 
   <td>创建存储过程</td> 
  </tr> 
  <tr> 
   <td>createSequence</td> 
   <td>创建序列</td> 
  </tr> 
  <tr> 
   <td>createTable</td> 
   <td>创建表</td> 
  </tr> 
  <tr> 
   <td>createView</td> 
   <td>创建视图</td> 
  </tr> 
 </tbody> 
</table>

### drop ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>dropAllForeignKeyConstraints</td> 
   <td>删除全部的外键约束</td> 
  </tr> 
  <tr> 
   <td>dropColumn</td> 
   <td>删除列</td> 
  </tr> 
  <tr> 
   <td>dropDefaultValue</td> 
   <td>删除默认值设置</td> 
  </tr> 
  <tr> 
   <td>dropForeignKeyConstraint</td> 
   <td>删除某一列的外键约束</td> 
  </tr> 
  <tr> 
   <td>dropNotNullConstraint</td> 
   <td>删除非空约束</td> 
  </tr> 
  <tr> 
   <td>dropIndex</td> 
   <td>删除索引</td> 
  </tr> 
  <tr> 
   <td>dropSequence</td> 
   <td>删除约束</td> 
  </tr> 
  <tr> 
   <td>dropProcedure</td> 
   <td>删除存储过程</td> 
  </tr> 
  <tr> 
   <td>dropPrimaryKey</td> 
   <td>删除主键</td> 
  </tr> 
  <tr> 
   <td>dropTable</td> 
   <td>删除表</td> 
  </tr> 
  <tr> 
   <td>dropUniqueConstraint</td> 
   <td>删除唯一性约束</td> 
  </tr> 
  <tr> 
   <td>dropView</td> 
   <td>删除视图</td> 
  </tr> 
 </tbody> 
</table>

### rename ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>renameColumn</td> 
   <td>重命名列</td> 
  </tr> 
  <tr> 
   <td>renameSequence</td> 
   <td>重命名序列</td> 
  </tr> 
  <tr> 
   <td>renameTable</td> 
   <td>重命名表</td> 
  </tr> 
  <tr> 
   <td>renameView</td> 
   <td>重命名视图</td> 
  </tr> 
 </tbody> 
</table>

### sql ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sql</td> 
   <td>原生SQL</td> 
  </tr> 
  <tr> 
   <td>sqlFile</td> 
   <td>引入 SQL 文件</td> 
  </tr> 
 </tbody> 
</table>

### other ###

<table> 
 <thead> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
   <th>标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>alterSequence</td> 
   <td>修改序列</td> 
   <td>customChange</td> 
   <td>自定义change类型，需要自己实现liquibase.change.custom.CustomSqlChange、liquibase.change.custom.CustomTaskChange接口</td> 
  </tr> 
  <tr> 
   <td>delete</td> 
   <td>删除数据</td> 
   <td>empty</td> 
   <td>空操作</td> 
  </tr> 
  <tr> 
   <td>executeCommand</td> 
   <td>执行系统命令，如 mysqldump</td> 
   <td>insert</td> 
   <td>插入数据</td> 
  </tr> 
  <tr> 
   <td>loadData</td> 
   <td>加载 csv 文件到已存在的表中</td> 
   <td>loadUpdateData</td> 
   <td>加载 csv 文件到已存在的表中，但是会判断是否存在，存在更新，否则新增</td> 
  </tr> 
  <tr> 
   <td>mergeColumns</td> 
   <td>将两列值合并在一起，存入新列中</td> 
   <td>modifyDataType</td> 
   <td>修改列数据类型</td> 
  </tr> 
  <tr> 
   <td>output</td> 
   <td>记录一条消息并继续执行</td> 
   <td>setColumnRemarks</td> 
   <td>列上添加备注</td> 
  </tr> 
  <tr> 
   <td>setTableRemarks</td> 
   <td>表上添加备注</td> 
   <td>stop</td> 
   <td>通过消息停止 Liquibase</td> 
  </tr> 
  <tr> 
   <td>tagDatabase</td> 
   <td>将标签应用于数据库以供将来回滚</td> 
   <td>update</td> 
   <td>更新数据</td> 
  </tr> 
 </tbody> 
</table>

[github]: https://github.com/soft1314/boot-admin
[gitee]: https://gitee.com/soft1314/boot-admin-vue
[221c271e7af7882656f8537bca50b220.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/6f0b01e74cef4a0aa9c67e931c920eaa.png