Mybatis注解實(shí)現(xiàn)多數(shù)據(jù)源讀寫分離詳解

更新時(shí)間：2019年09月22日 15:47:42 作者：hy_xiaobin

這篇文章主要給大家介紹了關(guān)于Mybatis注解實(shí)現(xiàn)多數(shù)據(jù)源讀寫分離的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或者使用Mybatis具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧

首先需要建立兩個(gè)庫進(jìn)行測(cè)試，我這里使用的是master_test和slave_test兩個(gè)庫，兩張庫都有一張同樣的表（偷懶，喜喜），表結(jié)構(gòu)

表名 t_user

| 字段名 | 類型 | 備注 |
| :------: | :------: | :------: |
| id | int | 主鍵自增ID |
| name | varchar | 名稱 |

表中分別添加兩條不同數(shù)據(jù)，方便測(cè)試

主數(shù)據(jù)庫記錄name為xiaobin，從庫為xiaoliu

開始使用Springboot 整合mybatis，首先引入pom文件

  <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.4.RELEASE</version>
  </parent>
  <groupId>com.xiaobin</groupId>
  <artifactId>mysql_master_slave</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <java.version>1.8</java.version>
    <lombok.version>1.18.6</lombok.version>
    <mybatis.version>1.3.2</mybatis.version>
    <lombox.version>1.18.6</lombox.version>
  </properties>

  <dependencies>
    <!-- 添加web啟動(dòng)坐標(biāo) -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- 添加lombok工具坐標(biāo) -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>${lombok.version}</version>
    </dependency>
    <!-- 添加springboot 測(cè)試坐標(biāo) -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    <!-- 添加lombox 測(cè)試坐標(biāo) -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>${lombox.version}</version>
    </dependency>
    <!-- 添加mybatis依賴坐標(biāo) -->
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>${mybatis.version}</version>
    </dependency>
    <!-- 添加mysql驅(qū)動(dòng)器坐標(biāo) -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <!-- 添加druid數(shù)據(jù)源坐標(biāo) -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid-spring-boot-starter</artifactId>
      <version>1.1.10</version>
    </dependency>
    <!-- 添加AOP坐標(biāo) -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>

  </dependencies>
</project>

動(dòng)態(tài)數(shù)據(jù)源配置

這里使用的數(shù)據(jù)源為druid，實(shí)現(xiàn)數(shù)據(jù)源之間的切換用@DataSource自定義注解，配置Aop進(jìn)行切換

application.yml 配置文件

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
     xiaobin-master: # 主數(shù)據(jù)源
      driverClassName: com.mysql.jdbc.Driver
      username: root
      password: root
      url: jdbc:mysql://localhost:3306/master_test?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8
     xiaobin-slave: # 從數(shù)據(jù)源
      driverClassName: com.mysql.jdbc.Driver
      username: root
      password: root
      url: jdbc:mysql://localhost:3306/slave_test?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8
mybatis:
 mapper-locations: classpath:mapper/*.xml

多數(shù)據(jù)源配置類

package com.xiaobin.config;

import com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 11:42
 * 備注：多數(shù)據(jù)源配置信息
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

@Configuration
@Component
public class DynamicDataSourceConfig {


  @Bean
  @ConfigurationProperties("spring.datasource.druid.xiaobin-master")
  public DataSource xiaobinMasterDataSource(){
    return DruidDataSourceBuilder.create().build();
  }


  @Bean
  @ConfigurationProperties("spring.datasource.druid.xiaobin-slave")
  public DataSource xiaobinSlaveDataSource(){
    return DruidDataSourceBuilder.create().build();
  }

  @Bean
  @Primary
  public DynamicDataSource dataSource(DataSource xiaobinMasterDataSource, DataSource xiaobinSlaveDataSource) {
    Map<Object, Object> targetDataSources = new HashMap<>();
    targetDataSources.put("xiaobin-master",xiaobinMasterDataSource);
    targetDataSources.put("xiaobin-slave", xiaobinSlaveDataSource);
    return new DynamicDataSource(xiaobinMasterDataSource, targetDataSources);
  }

}

動(dòng)態(tài)數(shù)據(jù)源切換類

package com.xiaobin.config;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
import org.springframework.lang.Nullable;

import javax.sql.DataSource;
import java.util.Map;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 11:51
 * 備注：動(dòng)態(tài)數(shù)據(jù)源
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

public class DynamicDataSource extends AbstractRoutingDataSource {

  private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

  public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
    super.setDefaultTargetDataSource(defaultTargetDataSource);
    super.setTargetDataSources(targetDataSources);
    super.afterPropertiesSet();
  }

  @Override
  protected Object determineCurrentLookupKey() {
    return getDataSource();
  }

  public static void setDataSource(String dataSource) {
    contextHolder.set(dataSource);
  }

  public static String getDataSource() {
    return contextHolder.get();
  }

  public static void clearDataSource() {
    contextHolder.remove();
  }
}

自定義@DataSource注解

在需要切換數(shù)據(jù)的Dao添加此注解

package com.xiaobin.annotation;

import java.lang.annotation.*;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 11:53
 * 備注：自定義數(shù)據(jù)源選擇注解
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
  String name() default "";
}

Aop切面類配置

package com.xiaobin.aspect;

import com.xiaobin.annotation.DataSource;
import com.xiaobin.config.DynamicDataSource;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 11:54
 * 備注：
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

@Aspect
@Component
public class DataSourceAspect {

  @Pointcut("@annotation(com.xiaobin.annotation.DataSource)")
  public void dataSourcePointCut() {

  }


  @Around("dataSourcePointCut()")
  public Object around(ProceedingJoinPoint point) throws Throwable {
    MethodSignature signature = (MethodSignature) point.getSignature();
    Method method = signature.getMethod();


    DataSource dataSource = method.getAnnotation(DataSource.class);
    if(dataSource == null){
      DynamicDataSource.setDataSource("xiaobin-master");
    }else {
      DynamicDataSource.setDataSource(dataSource.name());
    }

    try {
      return point.proceed();
    } finally {
      DynamicDataSource.clearDataSource();
    }
  }
}

啟動(dòng)配置注解信息，重要（不然運(yùn)行會(huì)報(bào)錯(cuò)）

package com.xiaobin;

import com.xiaobin.config.DynamicDataSourceConfig;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.context.annotation.Import;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 11:17
 * 備注：
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

@SpringBootApplication(exclude= {DataSourceAutoConfiguration.class})
@MapperScan(basePackages = "com.xiaobin.mapper")
@Import({DynamicDataSourceConfig.class})
public class StartApp {
  public static void main(String[] args) {
    SpringApplication.run(StartApp.class);
  }
}

測(cè)試controller

package com.xiaobin.api;

import com.xiaobin.Entity.TUser;
import com.xiaobin.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * 創(chuàng)建時(shí)間： 2019/9/22 12:08
 * 備注：
 * 碼農(nóng)自學(xué)交流小群：260532022，歡迎大家的加入，分享學(xué)習(xí)是一件開心事
 **/

@RestController
@RequestMapping
public class UserController {

  @Autowired
  private UserMapper userMapper;

  @GetMapping("/{name}/list")
  public List<TUser> list(@PathVariable("name")String name){
    if(name.equals("master")){
      return userMapper.queryAllWithMaster();
    }else{
      return userMapper.queryAllWithSlave();
    }
  }
}

效果圖

更具路徑傳值，進(jìn)行主從數(shù)據(jù)源切換