Liquibase 在 Spring Boot 中的使用詳細(xì)介紹

更新時(shí)間：2024年12月03日 14:43:40 作者：顏淡慕瀟

Liquibase 提供了靈活的變更集機(jī)制,支持創(chuàng)建表、修改列、填充數(shù)據(jù)、回滾變更等多種操作,本文將通過(guò)多個(gè)豐富的示例,詳細(xì)講解如何在 Spring Boot項(xiàng)目中使用 Liquibase,感興趣的朋友跟隨小編一起看看吧

Liquibase 是一個(gè)強(qiáng)大的數(shù)據(jù)庫(kù)版本控制工具，能夠幫助開發(fā)者管理和追蹤數(shù)據(jù)庫(kù)結(jié)構(gòu)和數(shù)據(jù)的變更。通過(guò)與 Spring Boot的集成，Liquibase 提供了便捷的數(shù)據(jù)庫(kù)遷移和版本控制功能。本文將通過(guò)多個(gè)豐富的示例，詳細(xì)講解如何在 Spring Boot項(xiàng)目中使用 Liquibase。

1. 項(xiàng)目準(zhǔn)備

1.1 創(chuàng)建 Spring Boot 項(xiàng)目

訪問(wèn) Spring Initializr 創(chuàng)建新的 Spring Boot 項(xiàng)目，選擇以下依賴項(xiàng)：

Spring Web
Spring Data JPA
MySQL Driver（或其他數(shù)據(jù)庫(kù)驅(qū)動(dòng)）
Liquibase Migration

下載并解壓縮生成的項(xiàng)目。

1.2 添加 Maven 依賴

在 pom.xml 中，確保添加 Liquibase 的依賴：

<dependency>
    <groupId>org.liquibase</groupId>
    <artifactId>liquibase-core</artifactId>
    <version>4.x.x</version> <!-- 使用最新版本 -->
</dependency>

同時(shí)確保包含 Spring Data JPA 和數(shù)據(jù)庫(kù)驅(qū)動(dòng)的依賴，例如 MySQL：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

1.3 配置數(shù)據(jù)庫(kù)連接

在 src/main/resources/application.properties 中配置數(shù)據(jù)庫(kù)連接信息：

spring.datasource.url=jdbc:mysql://localhost:3306/my_database?useSSL=false&serverTimezone=UTC
spring.datasource.username=my_user
spring.datasource.password=my_password
spring.jpa.hibernate.ddl-auto=none
spring.liquibase.change-log=classpath:db/changelog/db.changelog-master.xml

2. 示例 1：創(chuàng)建用戶表

2.1 創(chuàng)建變更日志文件

在 src/main/resources/db/changelog 目錄下創(chuàng)建一個(gè)變更日志文件 db.changelog-master.xml，并定義用戶表的創(chuàng)建。

<?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-4.3.xsd">
    <changeSet id="1" author="authorName">
        <createTable tableName="users">
            <column name="id" type="int">
                <constraints primaryKey="true" autoIncrement="true"/>
            </column>
            <column name="name" type="varchar(100)">
                <constraints nullable="false"/>
            </column>
            <column name="email" type="varchar(100)">
                <constraints unique="true"/>
            </column>
            <column name="created_at" type="timestamp">
                <constraints nullable="false" defaultValueComputed="CURRENT_TIMESTAMP"/>
            </column>
        </createTable>
    </changeSet>
</databaseChangeLog>

2.2 啟動(dòng)應(yīng)用程序

運(yùn)行應(yīng)用程序：

mvn spring-boot:run

2.3 驗(yàn)證結(jié)果

使用數(shù)據(jù)庫(kù)管理工具檢查 my_database，確認(rèn) users 表已成功創(chuàng)建。

SHOW TABLES; -- 查看數(shù)據(jù)庫(kù)中的所有表
SELECT * FROM users; -- 查看 users 表

3. 示例 2：添加列和修改列類型

3.1 修改變更日志文件

在 db.changelog-master.xml 中添加新的變更集，用于向 users 表添加 age 列并修改 name 列的類型。

<changeSet id="2" author="authorName">
    <addColumn tableName="users">
        <column name="age" type="int"/>
    </addColumn>
</changeSet>
<changeSet id="3" author="authorName">
    <modifyDataType tableName="users" columnName="name" newDataType="varchar(255)"/>
</changeSet>

3.2 再次啟動(dòng)應(yīng)用程序

重新啟動(dòng)應(yīng)用程序，Liquibase 會(huì)檢測(cè)到新的變更集并應(yīng)用。

mvn spring-boot:run

3.3 驗(yàn)證結(jié)果

使用數(shù)據(jù)庫(kù)管理工具，檢查 users 表，確認(rèn) age 列已經(jīng)添加，并且 name 列的類型已更新。

DESCRIBE users; -- 查看 users 表的結(jié)構(gòu)

4. 示例 3：創(chuàng)建訂單表并添加外鍵約束

4.1 修改變更日志文件

在 db.changelog-master.xml 中添加新的變更集，用于創(chuàng)建 orders 表并添加外鍵約束。

<changeSet id="4" author="authorName">
    <createTable tableName="orders">
        <column name="id" type="int">
            <constraints primaryKey="true" autoIncrement="true"/>
        </column>
        <column name="user_id" type="int"/>
        <column name="product" type="varchar(100)">
            <constraints nullable="false"/>
        </column>
        <column name="quantity" type="int">
            <constraints nullable="false"/>
        </column>
        <column name="order_date" type="timestamp">
            <constraints defaultValueComputed="CURRENT_TIMESTAMP"/>
        </column>
        <foreignKeyConstraint baseTableName="orders" baseColumnNames="user_id"
            referencedTableName="users" referencedColumnNames="id" 
            constraintName="fk_user_id"/>
    </createTable>
</changeSet>

4.2 啟動(dòng)應(yīng)用程序

再次運(yùn)行應(yīng)用程序：

mvn spring-boot:run

4.3 驗(yàn)證結(jié)果

使用數(shù)據(jù)庫(kù)管理工具檢查 my_database，確認(rèn) orders 表已成功創(chuàng)建，并且 user_id 列與 users 表的 id 列建立了外鍵關(guān)系。

SHOW TABLES; -- 查看數(shù)據(jù)庫(kù)中的所有表
SELECT * FROM orders; -- 查看 orders 表

5. 示例 4：數(shù)據(jù)填充

5.1 創(chuàng)建數(shù)據(jù)填充變更集

在 db.changelog-master.xml 中添加一個(gè)新的變更集，用于插入初始數(shù)據(jù)。

<changeSet id="5" author="authorName">
    <insert tableName="users">
        <column name="name" value="John Doe"/>
        <column name="email" value="john@example.com"/>
        <column name="age" value="30"/>
    </insert>
    <insert tableName="users">
        <column name="name" value="Jane Smith"/>
        <column name="email" value="jane@example.com"/>
        <column name="age" value="25"/>
    </insert>
</changeSet>

5.2 啟動(dòng)應(yīng)用程序

再次啟動(dòng)應(yīng)用程序，Liquibase 會(huì)自動(dòng)將數(shù)據(jù)插入 users 表。

mvn spring-boot:run

5.3 驗(yàn)證結(jié)果

檢查 users 表，確認(rèn)數(shù)據(jù)已正確插入。

SELECT * FROM users; -- 查看 users 表中的數(shù)據(jù)

6. 示例 5：回滾變更

6.1 添加回滾操作

在 db.changelog-master.xml 中，您可以為變更集添加回滾操作。例如，為創(chuàng)建 users 表的變更集添加回滾邏輯：

<changeSet id="1" author="authorName">
    <createTable tableName="users">
        <column name="id" type="int">
            <constraints primaryKey="true" autoIncrement="true"/>
        </column>
        <column name="name" type="varchar(100)">
            <constraints nullable="false"/>
        </column>
        <column name="email" type="varchar(100)">
            <constraints unique="true"/>
        </column>
        <column name="created_at" type="timestamp">
            <constraints nullable="false" defaultValueComputed="CURRENT_TIMESTAMP"/>
        </column>
    </createTable>
    <rollback>
        <dropTable tableName="users"/>
    </rollback>
</changeSet>

6.2 執(zhí)行回滾

如果需要回滾到之前的狀態(tài)，可以使用以下命令：

mvn liquibase:rollback -Dliquibase.rollbackCount=1

6.3 驗(yàn)證回滾結(jié)果

運(yùn)行回滾命令后，使用數(shù)據(jù)庫(kù)管理工具確認(rèn) users 表已被刪除。

SHOW TABLES; -- 查看數(shù)據(jù)庫(kù)中的所有表

7. 示例 6：使用 YAML 配置文件

除了 XML，Liquibase 還支持使用 YAML 格式的變更日志。以下是一個(gè)使用 YAML 的示例。

7.1 創(chuàng)建 YAML 變更日志文件

在 src/main/resources/db/changelog 目錄下創(chuàng)建一個(gè)名為 db.changelog-master.yaml 的文件：

databaseChangeLog:
  - changeSet:
      id: 1
      author: authorName
      changes:
        - createTable:
            tableName: users
            columns:
              - column:
                  name: id
                  type: int
                  constraints:
                    primaryKey: true
                    autoIncrement: true
              - column:
                  name: name
                  type: varchar(100)
                  constraints:
                    nullable: false
              - column:
                  name: email
                  type: varchar(100)
                  constraints:
                    unique: true
              - column:
                  name: created_at
                  type: timestamp
                  constraints:
                    nullable: false
                    defaultValueComputed: CURRENT_TIMESTAMP

7.2 更新配置

在 application.properties 中更新 spring.liquibase.change-log 的路徑：

spring.liquibase.change-log=classpath:db/changelog/db.changelog-master.yaml

7.3 啟動(dòng)應(yīng)用程序

再次啟動(dòng)應(yīng)用程序，Liquibase 會(huì)根據(jù) YAML 配置創(chuàng)建 users 表。

mvn spring-boot:run

8. 總結(jié)

通過(guò)以上豐富的示例，我們展示了如何在 Spring Boot 項(xiàng)目中使用 Liquibase 進(jìn)行數(shù)據(jù)庫(kù)版本控制和變更管理。Liquibase 提供了靈活的變更集機(jī)制，支持創(chuàng)建表、修改列、填充數(shù)據(jù)、回滾變更等多種操作。無(wú)論是使用 XML 還是 YAML 格式，Liquibase 都能夠幫助開發(fā)者有效管理數(shù)據(jù)庫(kù)的演變，使得開發(fā)過(guò)程更加高效和可靠。

到此這篇關(guān)于Liquibase 在 Spring Boot 中的使用--詳細(xì)介紹的文章就介紹到這了,更多相關(guān) Spring Boot Liquibase使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: