SpringBoot整合Liquibase的示例代碼

Posted on by

SpringBoot整合Liquibase雖然不難但坑還是有一點的，主要集中在配置路徑相關的地方，在此記錄一下整合的步驟，方便以後自己再做整合時少走彎路，當然也希望能幫到大傢~

整合有兩種情況

  1. 在啟動項目時自動執行腳本，若新添加瞭Liquibase腳本需要重啟項目才能執行腳本
  2. 在不啟動項目時也能通過插件或指令手動讓它執行腳本

整合要麼隻整合1，要麼1、2一起整合

隻整合2不整合1的話，項目啟動時會生成liquibase相關的bean時報錯

整合1

引入Maven依賴

這裡導入瞭Liquibase的包和連接MySQL數據庫的包

<!-- https://mvnrepository.com/artifact/org.liquibase/liquibase-core -->
<dependency>
    <groupId>org.liquibase</groupId>
    <artifactId>liquibase-core</artifactId>
    <version>3.6.2</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

在SpringBoot配置文件中配置

配置中liquibase相關的隻需要配置根changelog的位置，數據庫相關配置liquibase會自己去拿datasource下面的，註意url需要加上時區serverTimezone

spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://localhost:3306/test_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
  liquibase:
    change-log: classpath:/db/liquibaseChangeLogFile.xml

配置liquibaseChangeLogFile.xml

同樣需要註意xml文件的路徑，按照上述配置的話該文件在src/main/resources/db/liquibaseChangeLogFile.xml

<?xml version="1.0" encoding="utf-8"?>
<databaseChangeLog
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
                        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.4.xsd">
                        
<!--relativeToChangelogFile="true"表示根據該changeLog的相對路徑尋找changeLog文件-->
    <includeAll path="changelog/" relativeToChangelogFile="true"/>
</databaseChangeLog>

配置changeLog.xml

  • 按照上述的配置的話，changeLog文件應該放在src/main/resources/db/changelog/
  • 下面簡單寫一個changelog來測試
<?xml version="1.0" encoding="utf-8"?>
<databaseChangeLog
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.4.xsd">
    <changeSet id="20201212-01-2344" author="RR">
        <createTable tableName="test_table">
            <column name="id" type="VARCHAR(32)" remarks="表ID">
                <constraints primaryKey="true"/>
            </column>
            <column name="user_name" type="VARCHAR(16)" remarks="用戶名">
                <constraints nullable="false"/>
            <column name="age" type="TINYINT">
            <column name="create_date" type="TIMESTAMP" remarks="創建日期" defaultValueComputed="CURRENT_TIMESTAMP"/>
        </createTable>
    </changeSet>
    
</databaseChangeLog>

整合情況：

按照上面的流程配置完，在啟動項目時，它就會執行未執行過的Lisquibase腳本瞭~

整合2

有時候想不啟動或不重啟項目時執行Liquibase腳本，此時就應該整合2

引入Maven插件

引入的插件版本和上面的依賴包的版本號保持一致，不過我也沒有考究過不一致會怎樣，有興趣的小夥伴可以試試 ，不過不一致看得不會難受嗎在這裡的configuration標簽中，配置好要讀取的liquibase相關信息的配置文件，並且註意好路徑

<build>
    <plugins>
        <plugin>
            <groupId>org.liquibase</groupId>
            <artifactId>liquibase-maven-plugin</artifactId>
            <version>3.6.2</version>
            <configuration>
                <propertyFile>src/main/resources/liquibase.properties</propertyFile>
                <!--配置參數，以禁用彈出的對話框，該對話框將確認非本地數據庫上的遷移-->
                <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
            </configuration>
        </plugin>
    </plugins>
</build>

配置Liquibase.properties

註意配置文件的路徑應跟在配置Maven插件時聲明的一致，即src/main/resources/liquibase.properties配置好如下的五個屬性，註意url需要加上時區serverTimezone註意changeLogFile項的路徑，它是一個相對路徑，該配置會在下面展示

#配置都整合在yml配置文件裡瞭，若想不啟動時執行liquibase腳本該配置不能省！！！！
driver-class-name=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/test_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
username=root
password=root
changeLogFile=db/liquibaseChangeLogFile.xml

配置liquibaseChangeLogFile.xml

在整合1的時候就已經配置好瞭~

配置changeLog.xml

按照上述的配置的話，changeLog文件應該放在src/main/resources/db/changelog/下面再寫一個liquibase腳本

<?xml version="1.0" encoding="utf-8"?>
<databaseChangeLog
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.4.xsd">
    <changeSet id="20201213-01-1525" author="RR">
        <insert tableName="test_table">
            <column name="id" value="34f0186001df406fbb373845c579e6a6"/>
            <column name="user_name" value="小明"/>
            <column name="age" value="18"/>
        </insert>
    </changeSet>
</databaseChangeLog>

測試整合情況

  • 先mvn clean和install一下!!! 否則不能找到我們寫的xml文件
  • 在maven插件中找到liquibase:update，雙擊即可~

補充：下面給大傢分享一段示例代碼講解下spring boot 整合 liquibase

1.添加依賴

<dependency>
   <groupId>org.liquibase</groupId>
   <artifactId>liquibase-core</artifactId>
   <version>3.8.3</version>
</dependency>
<dependency>
   <groupId>org.liquibase</groupId>
   <artifactId>liquibase-maven-plugin</artifactId>
   <version>3.8.3</version>
</dependency>
<plugin>
   <groupId>org.liquibase</groupId>
   <artifactId>liquibase-maven-plugin</artifactId>
   <version>3.8.3</version>
   <configuration>
      <propertyFile>src/main/resources/db/liquibase.properties</propertyFile>
   </configuration>
</plugin>

2.創建liquibase.properties 內容如下

url=jdbc:postgresql://127.0.0.1:5432/ems_factorymodeldb
username=name
password=password
driver=org.postgresql.Driver
outputChangeLogFile=src/main/resources/liquibase-outputChangeLog.xml

3.創建 db.changelog-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">
    <!--  版本更新迭代  -->
    <include file="classpath:db/changelogs/liquibase-changeLog.xml" relativeToChangelogFile="false"></include>
    <!--  現有數據  -->
    <includeAll path="./currentdatas" relativeToChangelogFile="true"/>
    <!--  數據初始化 腳本  -->
    <!-- <includeAll path="./defaultdatas" relativeToChangelogFile="true"/>-->
</databaseChangeLog>

4.增加配置

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

到此這篇關於SpringBoot整合Liquibase的文章就介紹到這瞭,更多相關SpringBoot整合Liquibase內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：