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

 更新时间:2025年02月28日 10:58:20   作者:drebander  
本文详细介绍了在MyBatis-Plus中进行数据库配置与数据源整合的常见方法,包括单数据源和多数据源的配置步骤,以及如何使用SpringBoot的自动配置和手动配置来管理数据源,通过合理的配置,开发者可以简化数据库操作,实现高效的数据库管理和复杂的应用架构

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

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

1. 单数据源配置

1.1 单数据源配置概述

在大多数应用中,通常只需要一个数据源进行数据库的操作。MyBatis-Plus 支持通过 Spring Boot 自动配置来简化单数据源的配置。

1.2 数据源配置步骤

  1. 添加数据库依赖

首先,在 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>
  1. 配置数据库连接

application.propertiesapplication.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 的基础配置。
  1. 数据源自动配置

Spring Boot 会自动加载数据源和 MyBatis-Plus 配置,无需手动创建 DataSourceSqlSessionFactory 等对象。你只需要创建 Mapper 接口和实体类即可。

1.3 Spring Boot 自动配置

MyBatis-Plus 提供了开箱即用的自动配置。只要在 Spring Boot 项目中配置好数据源,MyBatis-Plus 会自动进行配置,无需额外的手动配置。

2. 多数据源配置

2.1 多数据源配置概述

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

MyBatis-Plus 支持多数据源的配置和切换,具体可以通过配置不同的 DataSource 来实现。

2.2 多数据源配置步骤

  1. 添加数据库依赖

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

  1. 配置多个数据源

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 配置数据源和事务管理器

你需要在配置类中为每个数据源配置 DataSourceSqlSessionFactoryTransactionManager

@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.propertiesapplication.yml 中的配置自动进行数据源配置。

自动配置的好处

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

自动配置示例

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

Spring Boot 会根据以上配置自动初始化 DataSourceSqlSessionFactoryTransactionManager 等组件。

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();
    }
}

4. 总结

  • 单数据源配置:对于大多数应用,MyBatis-Plus 配置单数据源时,可以通过 Spring Boot 的自动配置功能快速完成。
  • 多数据源配置:在复杂的应用场景中,可以手动配置多个数据源,通过动态切换实现数据库的负载均衡和高可用性。
  • 自动配置与手动配置的区别:自动配置适用于单数据源的场景,简化了配置过程,而手动配置则提供了更大的灵活性,适用于多数据源的管理和动态切换。

通过合适的配置和管理,MyBatis-Plus 可以帮助开发者在 Spring Boot 应用中高效管理数据源、简化数据库操作,并根据需求实现更加复杂的数据库架构。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Springboot+Poi导入Excel表格实现过程详解

    Springboot+Poi导入Excel表格实现过程详解

    这篇文章主要介绍了Springboot+Poi导入Excel表格实现过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • SpringCloud OpenFeign Post请求400错误解决方案

    SpringCloud OpenFeign Post请求400错误解决方案

    这篇文章主要介绍了SpringCloud OpenFeign Post请求400错误解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • Spring @Conditional注解示例详细讲解

    Spring @Conditional注解示例详细讲解

    @Conditional是Spring4新提供的注解,它的作用是按照一定的条件进行判断,满足条件给容器注册bean,这篇文章主要介绍了Spring @Conditional注解示例详细讲解,需要的朋友可以参考下
    2022-11-11
  • Java执行Linux命令简单代码举例

    Java执行Linux命令简单代码举例

    这篇文章主要给大家介绍了关于Java执行Linux命令的相关资料,在开发的过程中要善于利用JAVA面向对象编程的优势,与Linux/Unix命令或Shell脚本的优势,并将二者相结合,需要的朋友可以参考下
    2023-12-12
  • Spring Security+JWT简述(附源码)

    Spring Security+JWT简述(附源码)

    SpringSecurity是一个强大的可高度定制的认证和授权框架,对于Spring应用来说它是一套Web安全标准,下面这篇文章主要给大家介绍了关于Spring Security+JWT简述的相关资料,需要的朋友可以参考下
    2023-04-04
  • Java实现文件上传的两种方法(uploadify和Spring)

    Java实现文件上传的两种方法(uploadify和Spring)

    这篇文章主要为大家详细介绍了Java实现文件上传的两种方法,uploadify和Spring实现文件上传,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Java文件下载ZIP报错:Out of Memory的问题排查

    Java文件下载ZIP报错:Out of Memory的问题排查

    本文主要介绍了Java项目中下载大文件(超过2G的ZIP文件)时出现内存溢出(OutOfMemory:JavaHeapSpace)的问题,具有一定的参考价值,感兴趣的可以了解一下
    2025-01-01
  • Java 泛型详解(超详细的java泛型方法解析)

    Java 泛型详解(超详细的java泛型方法解析)

    这篇文章主要介绍了深入理解java泛型Generic,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下,希望对你有帮助
    2021-07-07
  • java中建立0-10m的消息(字符串)实现方法

    java中建立0-10m的消息(字符串)实现方法

    下面小编就为大家带来一篇java中建立0-10m的消息(字符串)实现方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • Java开发实现的Socket双向通信功能示例

    Java开发实现的Socket双向通信功能示例

    这篇文章主要介绍了Java开发实现的Socket双向通信功能,结合实例形式分析了java基于socket实现的服务器端与客户端双向通信相关操作技巧,需要的朋友可以参考下
    2018-01-01

最新评论