如何在Spring Boot中使用Liquibase-MongoDB？求实现示例

很高兴能帮到你！Liquibase对MongoDB的支持确实已经比较成熟了，结合Spring Boot使用其实和关系型数据库的流程类似，只是变更集的写法会适配MongoDB的语法。下面我一步步给你演示具体的配置和示例：

1. 添加Maven/Gradle依赖 #

首先得引入Spring Boot的Liquibase starter和Liquibase的MongoDB扩展，同时别忘了MongoDB的驱动依赖：

Maven示例 #

<dependencies>
    <!-- Spring Boot Liquibase Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-liquibase</artifactId>
    </dependency>
    <!-- Liquibase MongoDB Extension -->
    <dependency>
        <groupId>org.liquibase.ext</groupId>
        <artifactId>liquibase-mongodb</artifactId>
        <version>4.25.0</version> <!-- 建议使用和Liquibase核心匹配的版本 -->
    </dependency>
    <!-- MongoDB Driver -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-mongodb</artifactId>
    </dependency>
</dependencies>

Gradle示例 #

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-liquibase'
    implementation 'org.liquibase.ext:liquibase-mongodb:4.25.0'
    implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
}

2. 配置application.yml/application.properties #

在配置文件里指定MongoDB连接信息和Liquibase的基础配置，注意Liquibase需要单独配置MongoDB连接：

application.yml示例 #

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/your_database_name
  liquibase:
    enabled: true
    change-log: classpath:/db/changelog/db.changelog-master.yaml
    url: mongodb://localhost:27017/your_database_name
    # user: your_username # 有认证需求时填写
    # password: your_password # 有认证需求时填写

application.properties示例 #

spring.data.mongodb.uri=mongodb://localhost:27017/your_database_name
spring.liquibase.enabled=true
spring.liquibase.change-log=classpath:/db/changelog/db.changelog-master.yaml
spring.liquibase.url=mongodb://localhost:27017/your_database_name
# spring.liquibase.user=your_username
# spring.liquibase.password=your_password

3. 编写Liquibase变更集 #

MongoDB的变更集使用专属的change types，比如createCollection、insert、createIndex等，下面是一个完整的示例：

首先创建主变更文件db.changelog-master.yaml（用来管理所有子变更文件）：

databaseChangeLog:
  - include:
      file: classpath:/db/changelog/changelog-20240520-initial-setup.yaml

然后创建具体的初始化变更文件changelog-20240520-initial-setup.yaml：

databaseChangeLog:
  - changeSet:
      id: 1
      author: your_name
      changes:
        - createCollection:
            collectionName: users
            capped: false
            autoIndexId: true
  - changeSet:
      id: 2
      author: your_name
      changes:
        - insert:
            collectionName: users
            documents:
              - { "_id": 1, "username": "john_doe", "email": "john@example.com", "active": true }
              - { "_id": 2, "username": "jane_smith", "email": "jane@example.com", "active": true }
  - changeSet:
      id: 3
      author: your_name
      changes:
        - createIndex:
            collectionName: users
            indexName: idx_users_email
            keys:
              email: 1
            unique: true

4. 启动应用验证 #

启动你的Spring Boot项目后，Liquibase会自动执行以下操作：

• 创建databasechangelog和databasechangeloglock集合（用来跟踪变更执行记录）
• 按照变更集定义创建users集合、插入测试数据并创建唯一索引

你可以通过MongoDB客户端连接数据库，确认这些操作是否生效。

常见注意事项 #

• 确保Liquibase核心版本和MongoDB扩展版本匹配，避免兼容性问题
• 如果MongoDB开启了认证，务必在配置中填写正确的用户名和密码
• 变更集的id和author组合要唯一，Liquibase会以此判断变更是否已执行

内容的提问来源于stack exchange，提问作者Mayank Gupta