首页 > 软件编程 > java > SpringBoot集成Liquibase

SpringBoot集成Liquibase的详细步骤

2024-12-02 09:12:59 作者：颜淡慕潇

Liquibase 是一个强大的数据库版本控制工具,能够与 Spring Boot
无缝集成,以简化数据库迁移和管理的过程,以下是从开始集成到最终运行的详细步骤,需要的朋友可以参考下

1. 创建 Spring Boot 项目

首先，您需要创建一个 Spring Boot 项目。您可以使用 Spring Initializr（https://start.spring.io/）来创建项目，选择以下依赖项：

Spring Web
Spring Data JPA
MySQL Driver（或您所使用的数据库驱动）
Liquibase Migration

生成基本项目结构

在 Spring Initializr 中选择适当的项目设置后，下载生成的项目并解压缩。

2. 添加 Maven 依赖

如果您在生成项目时没有选择 Liquibase，您需要手动添加 Liquibase 依赖。在 pom.xml 中添加如下依赖：

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

确保在依赖项中包含 Spring Data JPA 和数据库驱动，例如 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>

3. 配置数据库连接

在 src/main/resources/application.properties 或 application.yml 中配置数据库连接信息：

application.properties 示例

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

4. 创建变更日志文件

在 src/main/resources/db/changelog 目录下创建 db.changelog-master.xml 文件，并定义数据库变更。

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-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 defaultValueComputed="CURRENT_TIMESTAMP"/>
            </column>
        </createTable>
    </changeSet>

    <changeSet id="2" author="authorName">
        <addColumn tableName="users">
            <column name="age" type="int"/>
        </addColumn>
    </changeSet>

    <changeSet id="3" 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>

</databaseChangeLog>

5. 运行 Spring Boot 应用

在 IDE 中运行应用程序，或使用命令行：

mvn spring-boot:run

启动应用程序

当 Spring Boot 应用启动时，Liquibase 会自动检测 db.changelog-master.xml 中定义的变更，并应用到数据库中。您将看到控制台输出，显示 Liquibase 正在执行的变更集。

6. 验证数据库变更

使用数据库管理工具（如 MySQL Workbench，DBeaver 等）连接到 my_database，并检查 users 和 orders 表是否已成功创建。

检查表

您可以运行以下 SQL 查询来验证：

SHOW TABLES; -- 查看数据库中的所有表

SELECT * FROM users; -- 查看 users 表
SELECT * FROM orders; -- 查看 orders 表

7. 监控和维护

Liquibase 在数据库中创建了一个 databasechangelog 表，记录所有已应用的变更集。您可以查询此表以获取变更历史：

SELECT * FROM databasechangelog;

8. 回滚变更（可选）

如果需要撤销某次变更，可以使用 Liquibase 的回滚功能。例如，您可以创建一个回滚文件并使用命令行回滚：

liquibase rollbackCount 1

这将回滚最近的一个变更集。

总结

通过上述步骤，您已经成功地将 Liquibase 集成到 Spring Boot 应用中。Liquibase 提供了强大的数据库版本控制和迁移功能，使得管理数据库变更变得简单而高效。通过使用 Liquibase，您可以确保数据库结构与应用代码的同步，并能够轻松管理和维护数据库的演变。

以上就是SpringBoot集成Liquibase的详细步骤的详细内容，更多关于SpringBoot集成Liquibase的资料请关注脚本之家其它相关文章！