SpringBoot整合Mysql主从库，动态分配数据源

最近在做MySql的读写分离，遇到一个大问题，有时会出现主从库串的情况，但是又不知道什么原因，写了个demo，干脆把从库的用户设定为只读权限，这样就只能报错而不能串库。在学习了大神们的文章后，终于把问题解决了，在这里详细记录一下。

创建一个只读账户：

GRANT SElECT ON *.* TO 'root_readonly'@'%' IDENTIFIED BY "123456";
flush privileges;

环境说明
SpringBoot 2.1.4
mysql数据库
阿里巴巴的druid数据源，便于监控
aop动态切换数据源

首先是pom文件，最主要的几个架包
<!-- druid数据源 -->
         <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.16</version>
         </dependency>
         <!-- mysql数据库 -->
         <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- 开启事务 -->
         <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>
        <!-- aop切面-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
第二，配置数据源，为了便于测试，建了两个账户，一个可读写账户，一个只读账户；
#指定数据源
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#xml文件扫描位置，默认是resources文件夹
mybatis.mapper-locations=classpath:mapper/*.xml
#mybatis.type-aliases-package=com.example.demo.entity

#主库
spring.datasource.master.url=jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=GMT%2B8
spring.datasource.master.username=root
spring.datasource.master.password=123456
spring.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver

#从库
spring.datasource.slave.url=jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=GMT%2B8
spring.datasource.slave.username=root_readonly
spring.datasource.slave.password=123456
spring.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driver
第三，核心配置文件

第一个文件DataSourceAop，该文件负责数据源动态切换；

import java.util.Date;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

import com.example.demo.config.DynamicDataSource.DatabaseType;

/**
 * 使用切面对读写进行分离,Order(1)是解决串库的问题
 * @author 程就人生
 * @date 2019年5月6日
 * @Description 
 *
 */
@Aspect
@Component
@Order(1)
public class DataSourceAop {
    
    private final Logger logger = LoggerFactory.getLogger(DataSourceAop.class);
    
    //公共参数，创建时间
    private static final String CREATE_DATE = "createDate";
    //修改时间
    private static final String UPDATE_DATE = "updateDate";
    
    /**
     * 只读方法的设置
     */
    @Pointcut("execution(* com.example.demo.service.impl..*.select*(..))"
            + "|| execution(* com.example.demo.service.impl..*.find*(..))"
            + "|| execution(* com.example.demo.service.impl..*.get*(..))")
    public void readonlyPointcut(){
        
    }
    
    /**
     * 读写方法的设置
     */
    @Pointcut("execution(* com.example.demo.service.impl..*.save*(..))"
            + "|| execution(* com.example.demo.service.impl..*.update*(..))"
            + "|| execution(* com.example.demo.service.impl..*.insert*(..))"
            + "|| execution(* com.example.demo.service.impl..*.add*(..))")
    public void writePointcut(){
        
    }
    
    /**
     * 具体切入
     * @param joinPoint
     */
    @Before("writePointcut()")
    public void setDataBaseMaster(JoinPoint joinPoint) {
        DynamicDataSource.setDataBaseType(DatabaseType.primaryDataSource);       
        
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();        
            
          Object[] args = joinPoint.getArgs();
    
          if (args != null && args.length > 0) {
              Object argument = args[0];
              BeanWrapper beanWrapper = new BeanWrapperImpl(argument);
              logger.info("----------主库------" + signature.getMethod().getName());
              //新增时设置创建时间
              if(signature.getMethod().getName().contains("add") 
                      || signature.getMethod().getName().contains("save") 
                      || signature.getMethod().getName().contains("insert")){
                // 设置创建时间和修改时间
                if (beanWrapper.isWritableProperty(CREATE_DATE)) {
                    beanWrapper.setPropertyValue(CREATE_DATE, new Date());
                }
              }
              //修改时间设置
              if (beanWrapper.isWritableProperty(UPDATE_DATE)) {
                  beanWrapper.setPropertyValue(UPDATE_DATE, new Date());
              }          
          }
    }
    
    /**
     * 具体切入
     * @param joinPoint
     */
    @Before("readonlyPointcut()")
    public void setDataBaseSlave(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature(); 
        DynamicDataSource.setDataBaseType(DatabaseType.readonlyDataSource);
        logger.info("----------从库------" + signature.getMethod().getName());
    }
}

第二个文件，DruidConfig，主要负责配置文件的读取，以及监控的配置；

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

import javax.sql.DataSource;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;

/**
 * 使用阿里巴巴的Druid配置多数据源
 * 需要在配置文件中指定，spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
 * @author 程就人生
 * @date 2019年5月5日
 * @Description 
 *
 */
@Configuration
public class DruidConfig {  
    
    @Primary
    @Bean(name = "primaryDataSource")
    @Qualifier("primaryDataSource")
    @ConfigurationProperties(prefix="spring.datasource.master")
    public DataSource druidPrimary(){       
        return new DruidDataSource();   
    }   
    
    @Bean(name = "readonlyDataSource")
    @Qualifier("readonlyDataSource")
    @ConfigurationProperties(prefix="spring.datasource.slave")
    public DataSource druidReadonly(){      
        return new DruidDataSource();   
    }
    
    /**
     * 配置Druid的监控
     * 1.配置一个管理后台的Servlet,对数据库进行可视化管理
     * @return
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Bean   
    public ServletRegistrationBean statViewServlet(){       
        ServletRegistrationBean bean =new ServletRegistrationBean(new StatViewServlet() , "/druid/*");              
        Map<String,String> initParams=new HashMap<>();              
        initParams.put("loginUsername", "root");        
        initParams.put("loginPassword", "admin");       
        initParams.put("allow", "");//默认就是允许所有访问。       
        //initParams.put("deny","");
        //拒绝访问的ip               
        bean.setInitParameters(initParams);     
        return bean;    
    }       
    
    /**
     * 2.配置一个监控的filter  
     * @return
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Bean   
    public FilterRegistrationBean webStatFilter(){      
        FilterRegistrationBean bean =new FilterRegistrationBean();      
        bean.setFilter(new WebStatFilter());        
        Map<String,String> initParams=new HashMap<>();              
        initParams.put("exclusions", "*.js,*.css,/druid/*");        
        bean.setInitParameters(initParams);             
        //拦截所有请求        
        bean.setUrlPatterns(Arrays.asList("/*"));               
        return bean;    
        
    }   
}

第三个文件，DynamicDataSource，主要负责动态数据源的定义及获取；

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

/**
 * 动态数据源（需要继承AbstractRoutingDataSource）
 */
public class DynamicDataSource extends AbstractRoutingDataSource{
    
    /**
     * 列出所有的数据源key（常用数据库名称来命名）
     * 注意：
     * 1）这里数据源与数据库是一对一的
     */
    public enum DatabaseType {
        //主库
        primaryDataSource,
        //从库
        readonlyDataSource
    }
    
   private static final ThreadLocal<DatabaseType> contextHolder = new ThreadLocal<>();
    
   public static void setDataBaseType(DatabaseType type){
       contextHolder.set(type);
   }
    
    public static DatabaseType getDataBaseType(){
        DatabaseType db = contextHolder.get();
        if (db == null)
            db = DatabaseType.primaryDataSource;
        return db;
    }
    
    public Object determineCurrentLookupKey() {
        return getDataBaseType();
    }

    /**
     * 清理链接类型
     */
    public static void clearDbType() {
        contextHolder.remove();
    }

}

第四个文件，MybatisConfig文件的配置，以及事物的管理；

import java.util.HashMap;
import java.util.Map;

import javax.sql.DataSource;

import com.example.demo.config.DynamicDataSource.DatabaseType;

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.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

/**
* SpringBoot集成MyBatis的基本入口 
* 1）创建数据源(如果采用的是默认的tomcat-jdbc数据源，则不需要)
* 2）创建SqlSessionFactory 
* 3）配置事务管理器，除非需要使用事务，否则不用配置
* 该配置类用于配置自动扫描器，用于扫描自定义的mapper接口,MyBatis会针对这些接口生成代理来调用对应的XMl中的SQL
*/
@Configuration
@MapperScan(value = "com.example.demo.dao")//,sqlSessionTemplateRef = "sqlSessionTemplatePrimary"
public class MybatisConfig {
    
    /**
     * @Primary 该注解表示在同一个接口有多个实现类可以注入的时候，默认选择哪一个，而不是让@autowire注解报错
     * @Qualifier 根据名称进行注入，通常是在具有相同的多个类型的实例的一个注入（例如有多个DataSource类型的实例）
     */
    @Bean
    public DynamicDataSource dataSource(@Qualifier("primaryDataSource") DataSource primaryDataSource,
            @Qualifier("readonlyDataSource") DataSource readonlyDataSource) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DatabaseType.primaryDataSource, primaryDataSource);
        targetDataSources.put(DatabaseType.readonlyDataSource, readonlyDataSource);

        DynamicDataSource dataSource = new DynamicDataSource();
        dataSource.setTargetDataSources(targetDataSources);// 该方法是AbstractRoutingDataSource的方法
        dataSource.setDefaultTargetDataSource(primaryDataSource);// 默认的datasource设置为myTestDbDataSource

        return dataSource;
    }
    
    @Bean
    public SqlSessionFactory sqlSessionFactory(DynamicDataSource dataSource) throws Exception{
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        //配置xml目录
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        bean.setMapperLocations(resolver.getResources("classpath*:mapper/*.xml"));
        return bean.getObject();
    }
    
    /**
     * 配置事务管理器
     */
    @Bean
    public DataSourceTransactionManager transactionManager(DynamicDataSource dataSource) throws Exception {
        return new DataSourceTransactionManager(dataSource);
    }
}

Controller、service、mapper及xml文件省略。

最后，测试
第二个数据源

第一个数据源

调用查询和新增，查看控制台：

2019-07-31 21:13:08.784  INFO 17544 --- [nio-8080-exec-7] com.example.demo.config.DataSourceAop    : ----------主库------insertSelective
2019-07-31 21:13:15.825  INFO 17544 --- [nio-8080-exec-9] com.example.demo.config.DataSourceAop    : ----------从库------selectByPrimaryKey

pom文件中架包的引入十分关键，只有引入了mybatis-spring-boot-starter才会开启事务，在项目启动时就注册了事务。引入spring-boot-starter-aop架包，才能进行aop切面注入。

总结
在测试事务的过程中，要确保数据库是支持事务的，如果数据库不支持事务，那么程序这边怎么配置都没有用。

查看mysql数据库是否支持事务，查看InnoDB一项，是否都为yes，不支持事务时要开启事务；

#查看事务状态
show engines;   
#开启事务
alter table t_user ENGINE=INNODB

参考资料：
https://www.liaoxuefeng.com/article/1182502273240832

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 218,525评论 6赞 507
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,203评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 164,862评论 0赞 354
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,728评论 1赞 294
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,743评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,590评论 1赞 305
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,330评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,244评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,693评论 1赞 314
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3赞 336
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,723评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,343评论 3赞 330
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1赞 270
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3赞 370
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2赞 355