MyBatis-Plus数据库配置与数据源整合方案_Java

在使用 mybatis-plus（mp）进行开发时，正确配置和管理数据源是非常重要的一步。mybatis-plus 不仅支持 单数据源 的配置，还支持 多数据源 的配置和切换，适用于分布式系统中不同的数据库管理和访问场景。

本文将介绍 mybatis-plus 数据库配置与数据源整合 的常见方法，包括单数据源与多数据源的配置、配置文件与 spring 配置类的使用、以及如何进行数据源切换和管理。

1. 单数据源配置

1.1 单数据源配置概述

在大多数应用中，通常只需要一个数据源进行数据库的操作。mybatis-plus 支持通过 spring boot 自动配置来简化单数据源的配置。

1.2 数据源配置步骤

添加数据库依赖

首先，在 pom.xml 文件中添加 mybatis-plus 和数据库相关的依赖。

例如，使用 h2 数据库作为示例：

<dependencies>
    <!-- mybatis-plus 核心依赖 -->
    <dependency>
        <groupid>com.baomidou</groupid>
        <artifactid>mybatis-plus-core</artifactid>
        <version>3.4.3</version>
    </dependency>
    
    <!-- spring boot mybatis starter -->
    <dependency>
        <groupid>org.mybatis.spring.boot</groupid>
        <artifactid>mybatis-spring-boot-starter</artifactid>
        <version>2.2.0</version>
    </dependency>

    <!-- 数据库连接池（h2 示例） -->
    <dependency>
        <groupid>com.h2database</groupid>
        <artifactid>h2</artifactid>
        <scope>runtime</scope>
    </dependency>
</dependencies>

配置数据库连接

在 application.properties 或 application.yml 配置文件中添加数据源配置。

application.properties 配置示例：

# 数据库连接配置
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverclassname=org.h2.driver
spring.datasource.username=sa
spring.datasource.password=password
spring.datasource.hibernate.ddl-auto=update

# mybatis-plus 配置
mybatis-plus.mapper-locations=classpath:/mappers/**/*.xml
mybatis-plus.type-aliases-package=com.example.domain

在该配置中：

spring.datasource 用于配置数据库的连接信息。
mybatis-plus 配置了 mybatis-plus 的基础配置。

数据源自动配置

spring boot 会自动加载数据源和 mybatis-plus 配置，无需手动创建 datasource 和 sqlsessionfactory 等对象。你只需要创建 mapper 接口和实体类即可。

1.3 spring boot 自动配置

mybatis-plus 提供了开箱即用的自动配置。只要在 spring boot 项目中配置好数据源，mybatis-plus 会自动进行配置，无需额外的手动配置。

2. 多数据源配置

2.1 多数据源配置概述

在一些复杂的应用中，可能需要连接多个数据库源。比如，可能需要一个主数据库和多个副本数据库，或者在分布式系统中连接不同的数据库。

mybatis-plus 支持多数据源的配置和切换，具体可以通过配置不同的 datasource 来实现。

2.2 多数据源配置步骤

添加数据库依赖

首先，确保你已在 pom.xml 文件中添加所需数据库的依赖。

配置多个数据源

在 application.yml 中定义多个数据源配置。

例如，配置一个 主数据源 和一个 副数据源：

spring:
  datasource:
    # 主数据源配置
    primary:
      url: jdbc:mysql://localhost:3306/primarydb
      driver-class-name: com.mysql.cj.jdbc.driver
      username: root
      password: root
    # 副数据源配置
    secondary:
      url: jdbc:mysql://localhost:3306/secondarydb
      driver-class-name: com.mysql.cj.jdbc.driver
      username: root
      password: root

2.3 配置数据源和事务管理器

你需要在配置类中为每个数据源配置 datasource、sqlsessionfactory 和 transactionmanager。

@configuration
@enabletransactionmanagement
@mapperscan(basepackages = "com.example.mapper")
public class datasourceconfig {

    @bean(name = "primarydatasource")
    @primary
    @configurationproperties(prefix = "spring.datasource.primary")
    public datasource datasourceprimary() {
        return datasourcebuilder.create().build();
    }

    @bean(name = "secondarydatasource")
    @configurationproperties(prefix = "spring.datasource.secondary")
    public datasource datasourcesecondary() {
        return datasourcebuilder.create().build();
    }

    // 配置主数据源的事务管理器
    @bean(name = "transactionmanagerprimary")
    @primary
    public datasourcetransactionmanager transactionmanagerprimary(@qualifier("primarydatasource") datasource datasource) {
        return new datasourcetransactionmanager(datasource);
    }

    // 配置副数据源的事务管理器
    @bean(name = "transactionmanagersecondary")
    public datasourcetransactionmanager transactionmanagersecondary(@qualifier("secondarydatasource") datasource datasource) {
        return new datasourcetransactionmanager(datasource);
    }

    // 配置主数据源的 sqlsessionfactory
    @bean(name = "sqlsessionfactoryprimary")
    @primary
    public sqlsessionfactory sqlsessionfactoryprimary(@qualifier("primarydatasource") datasource datasource) throws exception {
        sqlsessionfactorybean factorybean = new sqlsessionfactorybean();
        factorybean.setdatasource(datasource);
        return factorybean.getobject();
    }

    // 配置副数据源的 sqlsessionfactory
    @bean(name = "sqlsessionfactorysecondary")
    public sqlsessionfactory sqlsessionfactorysecondary(@qualifier("secondarydatasource") datasource datasource) throws exception {
        sqlsessionfactorybean factorybean = new sqlsessionfactorybean();
        factorybean.setdatasource(datasource);
        return factorybean.getobject();
    }
}

2.4 动态切换数据源

在应用中使用动态数据源切换，spring 提供了 @primary 和 @qualifier 注解来指定哪个数据源为主数据源，哪一个为副数据源。在进行操作时，通过动态切换数据源来控制操作目标。

public class dynamicdatasourcecontextholder {
    private static final threadlocal<string> contextholder = new threadlocal<>();

    public static void setdatasource(string datasource) {
        contextholder.set(datasource);
    }

    public static string getdatasource() {
        return contextholder.get();
    }

    public static void cleardatasource() {
        contextholder.remove();
    }
}

切换数据源时：

dynamicdatasourcecontextholder.setdatasource("primary");  // 切换到主数据源

3. 自动配置与手动配置的区别

3.1 自动配置

spring boot 提供了自动配置功能，mybatis-plus 默认会通过配置文件自动配置数据源、sqlsessionfactory 和事务管理器等组件。如果项目只涉及单一数据源，spring boot 会根据 application.properties 或 application.yml 中的配置自动进行数据源配置。

自动配置的好处

减少配置：只需在配置文件中配置数据源，spring boot 会自动完成其余的配置工作。
简化管理：对于单数据源应用，使用自动配置更为简单，开发者只需关注业务代码。

自动配置示例

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root

spring boot 会根据以上配置自动初始化 datasource、sqlsessionfactory、transactionmanager 等组件。

3.2 手动配置

对于复杂的项目，尤其是涉及多数据源的情况，开发者通常需要手动配置数据源、sqlsessionfactory、事务管理器等。

这种方式提供了更大的灵活性，可以在不同的数据源之间进行细粒度的控制和切换。

手动配置的好处

灵活性：可以手动控制每个数据源的配置，例如动态数据源切换、多个数据库连接等。
扩展性：适用于需要自定义配置、插件等场景。

手动配置示例

@configuration
public class mybatisconfig {
    @bean
    public datasource datasource() {
        return datasourcebuilder.create().url("jdbc:mysql://localhost:3306/mydb")
                                .username("root")
                                .password("root")
                                .build();
    }

    @bean
    public sqlsessionfactory sqlsessionfactory(@qualifier("datasource") datasource datasource) throws exception {
        sqlsessionfactorybean factorybean = new sqlsessionfactorybean();
        factorybean.setdatasource(datasource);
        return factorybean.getobject();
    }
}