MyBatis 多数据源支持

在复杂的企业级应用中，使用多个数据源是一个常见需求。MyBatis 是一个优秀的持久层框架，它通过灵活的配置和插件支持，可以方便地实现多数据源的管理。本文将介绍如何使用 MyBatis 配置和使用多个数据源。

1. 为什么需要多数据源？

多数据源的需求场景包括：

• 分库分表：数据量过大时，将数据分散到多个库中以提高查询性能。
• 读写分离：将读操作和写操作分别放到不同的数据库中，提高系统的并发处理能力。
• 多租户：不同租户的数据存储在不同的数据库中，保障数据隔离性。

2. 配置多数据源

以 Spring Boot 项目为例，以下步骤将详细介绍如何配置 MyBatis 支持多数据源。

2.1 添加依赖

在 pom.xml 文件中添加 MyBatis-Spring-Boot-Starter 及多数据源相关依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>3.4.5</version>
</dependency>

2.2 配置数据源

在 application.yml 文件中配置多个数据源：

spring:
  datasource:
    primary:
      url: jdbc:mysql://localhost:3306/primary_db
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
    secondary:
      url: jdbc:mysql://localhost:3306/secondary_db
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver

2.3 创建数据源配置类

创建 DataSourceConfig 类来配置多个数据源：

import com.zaxxer.hikari.HikariDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.boot.context.properties.ConfigurationProperties;

import javax.sql.DataSource;

@Configuration
@MapperScan(basePackages = "com.example.mapper.primary", sqlSessionFactoryRef = "primarySqlSessionFactory")
public class PrimaryDataSourceConfig {

    @Bean(name = "primaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    @Primary
    public DataSource primaryDataSource() {
        return new HikariDataSource();
    }

    @Bean(name = "primarySqlSessionFactory")
    @Primary
    public SqlSessionFactory primarySqlSessionFactory(@Qualifier("primaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource);
        sessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/primary/*.xml"));
        return sessionFactoryBean.getObject();
    }

    @Bean(name = "primaryTransactionManager")
    @Primary
    public DataSourceTransactionManager primaryTransactionManager(@Qualifier("primaryDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

@Configuration
@MapperScan(basePackages = "com.example.mapper.secondary", sqlSessionFactoryRef = "secondarySqlSessionFactory")
public class SecondaryDataSourceConfig {

    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return new HikariDataSource();
    }

    @Bean(name = "secondarySqlSessionFactory")
    public SqlSessionFactory secondarySqlSessionFactory(@Qualifier("secondaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource);
        sessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/secondary/*.xml"));
        return sessionFactoryBean.getObject();
    }

    @Bean(name = "secondaryTransactionManager")
    public DataSourceTransactionManager secondaryTransactionManager(@Qualifier("secondaryDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

2.4 配置 Mapper

在 src/main/resources/mapper/primary 和 src/main/resources/mapper/secondary 目录下分别创建主数据源和次数据源的 Mapper XML 文件。

例如，在 src/main/resources/mapper/primary/UserMapper.xml 中：

<mapper namespace="com.example.mapper.primary.UserMapper">
    <select id="selectAllUsers" resultType="com.example.domain.User">
        SELECT * FROM users
    </select>
</mapper>

在 src/main/resources/mapper/secondary/OrderMapper.xml 中：

<mapper namespace="com.example.mapper.secondary.OrderMapper">
    <select id="selectAllOrders" resultType="com.example.domain.Order">
        SELECT * FROM orders
    </select>
</mapper>

2.5 创建 Mapper 接口

在 com.example.mapper.primary 和 com.example.mapper.secondary 包中分别创建主数据源和次数据源的 Mapper 接口。

例如，在 com.example.mapper.primary.UserMapper 中：

import com.example.domain.User;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface UserMapper {
    List<User> selectAllUsers();
}

在 com.example.mapper.secondary.OrderMapper 中：

import com.example.domain.Order;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface OrderMapper {
    List<Order> selectAllOrders();
}

2.6 使用多数据源

在 Service 层使用多个数据源：

import com.example.domain.User;
import com.example.mapper.primary.UserMapper;
import com.example.domain.Order;
import com.example.mapper.secondary.OrderMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;

    public List<User> getAllUsers() {
        return userMapper.selectAllUsers();
    }
}

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;

    public List<Order> getAllOrders() {
        return orderMapper.selectAllOrders();
    }
}

3. 总结

在复杂的企业级应用中，使用多个数据源是一个常见需求。本文详细介绍了如何使用 MyBatis 配置和使用多个数据源，包括配置数据源、创建数据源配置类、配置 Mapper、创建 Mapper 接口以及在 Service 层使用多个数据源。通过这些步骤，可以轻松实现 MyBatis 多数据源的支持，提高系统的扩展性和灵活性。

进一步学习 MyBatis 多数据源支持，可以参考以下资源：

• MyBatis 官方文档
• Spring Boot 官方文档

希望本文对你有所帮助，能够更好地利用 MyBatis 的多数据源支持来实现高效的数据库管理。