01 引言
Liquibase是一个数据库变更的版本控制工具。
项目中通过Liquibase解析用户编写的Liquibase的配置文件，生成sql语句，并执行和记录（执行是根据记录确定sql语句是否曾经执行过，和配置文件里的预判断语句确定sql是否执行）。
02 SpringBoot 集成Liquibase
step1：添加依赖
首先需要在项目引入Liquibase依赖：
<dependency> <groupId>org.liquibase</groupId> <artifactId>liquibase-core</artifactId> <version>3.6.3</version> </dependency>
step2：添加配置文件
/** * Liquibase配置类 * * @author : YangLinWei * @createTime: 2022/4/28 4:48 下午 * @version: 1.0.0 */ @Slf4j @Configuration public class LiquibaseConfig { /*** 指定liquibase的版本 **/ @Value("${dc.version:main}") private String contexts; /*** 是否开启liquibase **/ @Value("${dc.liquibase.enable:true}") private Boolean enable; /*** liquibase用到的两张表 **/ private static final String DATABASE_CHANGE_LOG_TABLE = "lqb_changelog_demo"; private static final String DATABASE_CHANGE_LOG_LOCK_TABLE = "lqb_lock_demo"; @Resource private DataSource dataSource; /** * liquibase bean声明 */ @Bean public SpringLiquibase liquibase() { SpringLiquibase liquibase = new SpringLiquibase(); // Liquibase文件路径 liquibase.setChangeLog("classpath:sql/master.xml"); liquibase.setDataSource(dataSource); if (StringUtils.isNotBlank(contexts)) { liquibase.setContexts(contexts); } liquibase.setShouldRun(enable); liquibase.setResourceLoader(new DefaultResourceLoader()); // 覆盖Liquibase changelog表名 liquibase.setDatabaseChangeLogTable(DATABASE_CHANGE_LOG_TABLE); liquibase.setDatabaseChangeLogLockTable(DATABASE_CHANGE_LOG_LOCK_TABLE); return liquibase; } }
从里面的代码，可以看到还需要在sources目录下新建sql文件夹，然后添加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.1.xsd"> <changeSet id="v1.0.0-1" author="ylw" context="main"> <sqlFile path="classpath:/sql/v1.0.0/1.init.sql"/> <sqlFile path="classpath:/sql/v1.0.0/2.init-data.sql"/> <sqlFile path="classpath:/sql/v1.0.0/3.init-data-1.sql"/> </changeSet> </databaseChangeLog>
从配置文件里可以看到，定义了一个changeSet，里面有很多个sql脚本文件，分别是：
- 1.init.sql：一般写的都是
ddl脚本（注意：CREATE TABLE需要判断IF NOT EXISTS）； - 2.init-data.sql：一般写的都是
dml脚本（注意：这个文件的sql不能带有转义字符，Liquibase的一个bug） - 3.init-data-1.sql：把
2.init-data.sql文件带有转义的sql写入这里面。
文件结构如下：
step3：启动项目
启动项目的时候，会读取 “LiquibaseConfig” 的配置文件，然后就会在数据库里新建Liquibase相关的两张表（LiquibaseConfig里面定义的），这这两张表记录的是Liquibase的数据库脚本的升级过程，下次启动是就会先读这张表的数据，在必读master.xml文件来做脚本升级。
内容大致为：
lqb_changelog_demo：
| ID | AUTHOR | FILENAME | DATEEXECUTED | ORDEREXECUTED | EXECTYPE | MD5SUM | DESCRIPTION | COMMENTS | TAG | LIQUIBASE | CONTEXTS | LABELS | DEPLOYMENT_ID |
| v1.1.0-1 | yanglinwei | classpath:sql/master.xml | 2022-04-28 09:39:02 | 1 | EXECUTED | 8:8f1b76aeec445099b43f37831064a84b | sqlFile; sqlFile; sqlFile | 3.6.3 | main | 1138964834 |
lqb_lock_demo:
| ID | LOCKED | LOCKGRANTED | LOCKEDBY |
| 1 | 0 |
ok，到这里SpringBoot就集成好了Liquibase了。
03 Liquibase规范
使用Liquibase最重要的是规范的问题，这是个人编码习惯的问题，可选择性阅读。
3.1 代码结构
|___ resources
|_____sql
|__________版本号
|_______________序号.xxx.sql
|_______________序号.xxx.sql
|__________版本号
|_______________序号.xxx.sql
|_______________序号.xxx.sql
|_____master.xml
注意master.xml
- id：格式：版本号-编码，例如：v1.0.0-1;
- author：为创建人姓名拼音全小写
- context：主线版本或者hotfix，统一设置为main，其它情况根据实际情况命名
- sqlFile：加以只有一个
- sql：基于脚本配置分开管理原则，不建议使用
特别注意：
- 已提交的
changeSet禁止修改！ - 初始化建表脚本，建议使用
CREATE TABLE NOT EXISTS！ - sql禁止包含schema名称！
- 禁止使用存储过程！
- 禁止跨库操作！
- 如果
sql带有需转义的字符，sql单独放一个文件，这是Liquibase的一个bug！ - 初始化插入数据，使用
ON DUPLICATE KEY UPDATE id=id要避免主键冲突！
04 文末
本文主要讲解了SpringBoot如何集成数据库版本控制工具Liquibase，希望能帮助到到大家，谢谢阅读！
