将liquibase添加到现有spring boot项目的正确方法

Question

我有一个现有的spring boot项目和一个数据库。现在，我想添加liquibase来处理进一步的数据库迁移。做这件事的正确步骤是什么？

我已经跟随本文添加liquibase并生成Changelog。我发现的大多数文章都在讨论从零开始在项目中使用liquibase，或者对实现并不太详细。到目前为止，我已经完成了以下工作：

<dependencies>
    //..other dependencies
    <dependency>
        <groupId>org.liquibase</groupId>
        <artifactId>liquibase-core</artifactId>
    </dependency>
    <dependency>
        <groupId>org.liquibase</groupId>
        <artifactId>liquibase-maven-plugin</artifactId>
        <version>3.6.2</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>3.6.2</version>
            <configuration>
                <propertyFile>src/main/resources/liquibase.properties</propertyFile>
            </configuration>
        </plugin>
    </plugins>
</build>

在src/main/resources下添加了

url=jdbc:mysql://localhost:3306/demodb
username=root
password=root
driver=com.mysql.jdbc.Driver
outputChangeLogFile=src/main/resources/db/changelog/changes/demodb-changelog.xml

更新了src/main/resources下的application.properties文件以处理changelogs

#Hibernate
spring.datasource.url=jdbc:mysql://localhost:3306/demodb
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=root

#Jpa
spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect

#Liquibase
spring.liquibase.change-log=classpath:db/changelog/db.changelog-master.xml

在src/main/resources/db/changelog下创建db.changelog-master.xml文件

<?xml version="1.0" encoding="UTF-8"?>

<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog/1.9" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation = "http://www.liquibase.org/xml/ns/dbchangelog/1.9
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-1.9.xsd">

</databaseChangeLog>

mvn liquibase:generateChangeLog

然后，为了同步执行的当前changelogs，在LiquiBase.properties中添加：

changeLogFile=src/main/resources/db/changelog/changes/demodb-changelog.xml

然后从终点站跑出来：

mvn liquibase:changelogSync

现在，DatabaseChangelog表包含了执行的changelogs的条目。

<include file="db/changelog/changes/demodb-changelog.xml"/>

Caused by: liquibase.exception.MigrationFailedException: 
Migration failed for change set db/changelog/changes/demodb-changelog.xml
Reason: liquibase.exception.DatabaseException: Table 'abc' already exists

我可以在db.changelog-master.xml中不使用include标记来运行应用程序，但是我想所有的changelog文件都需要在这里列出，因为如果我要在另一台机器上运行这个应用程序来从头创建整个数据库，就需要所有的changelog文件。

那么如何配置liquibase只运行尚未执行的changelogs呢？

Answer 1

这里的问题是databaseChangelog表中存储的filename字段。

Liquibase不仅通过ID或ID和author确定变更集的标识，而是根据以下三个字段的值确定变更集的标识:ID、author、filename。

当您运行MVN LiquiBase:update或MVN LiquiBase:ChangelogSync时，changelog的文件名为src/main/resources/db/changelog/changes/demodb-changelog.xml。这是由liquibase存储到每个表行的databaseChangelog.filename字段中的值。

但是，当您启动spring-boot应用程序时，changelog的文件名是类路径:db/changelog/db.changelog-master.xml，changelog的文件名是db/changelog/changes/demodb-changelog.xml。

然后，Liquibase检查已经应用了哪些变更集。

它检查databaseChangelog表中每个变更集的ID、author和filename文件名以及db/changelog/changes/demodb-changelog.xml文件中的每个变更集，发现没有任何匹配，因为filename字段不同。在数据库中，它的值是src/main/resources/DB/changelog/changes/demodb-changelog.xml。

src/main/resources/db/changelog/changes/demodb-changelog.xml != db/changelog/changes/demodb-changelog.xml

所以，Liquibase认为这是不同的变更集，并尝试应用它们。它失败，因为表已经存在。但是，如果您将更改集更改为可以多次应用的内容，您将看到，Liqibase为DatabaseChangelog表中的行创建了一个新的集合，该集合具有相同的ID、相同的Author，但Filename...

老实说，我不知道怎么解决这个问题。这看起来像是Spring Boot中Liquibase如何工作的一个基本问题。在spring-boot应用程序start上读取changelog文件时，它们必须在类路径中，尤其是在使用默认fat-jar的情况下。但是当您将Liquibase作为maven插件运行时， 它们通常在本地文件系统上 （这不是真的，请参阅我的“更新2”）。

也许有一些解决办法存在，请在评论中添加它，我会更新答案。

更新

如果您在所有的ChangeLogs/ChangeSet中仔细地设置它，它应该可以工作。

db/changelog/changes/demodb-changelog.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"
        logicalFilePath="db/changelog/changes/demodb-changelog.xml">

</databaseChangeLog>

但是要注意 标记。它支持包含原始*.sql文件。并且不能为它们设置LogicalFilePath。在 标记上设置的LogicalFilePath也不继承。

只是不要在maven插件的ChangelogFile属性中指定前缀src/main/resources。这样，maven将在类路径中搜索changelog，而不是在文件系统中。因此，在执行liquibase maven插件之前，必须首先执行MVN process-resources。

因此，liquibase maven插件的ChangelogFile属性(liquibase.properties文件）应该如下所示：

changeLogFile=db/changelog/changes/demodb-changelog.xml

然后，当你跑的时候

mvn process-resources liquibase:changelogSync

Liquibase将在databaseChangelog表中创建记录，其中filename字段等于db/changelog/changes/demodb-changelog.xml，该字段等于filename，由spring-boot在启动时运行迁移时使用(classpath:前缀由Liquibase在比较文件名时自动删除）。最后，这让Liquibase明白，这些都是相同的变更集，它们已经被应用了。