SpringBoot入门建站全系列（三十）Mybatis多数据源进行数据库操作

SpringBoot入门建站全系列（三十）Mybatis多数据源进行数据库操作

一、概述

多数据源，就是有多个数据库的配置。

多数据源配置并不麻烦，使用起来和单数据源基本相同，但是，重要的是事务的控制。

这就牵扯到分布式事务控制，本篇只是讲述多数据源的使用，下一篇再讲述如何使用分布式事务控制中间件。

首发地址：
品茗IT-首发

如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以加入我们的java学习圈，点击即可加入，共同学习，节约学习时间，减少很多在学习中遇到的难题。

二、配置

本文假设你已经引入spring-boot-starter-web。已经是个SpringBoot项目了,如果不会搭建，可以打开这篇文章看一看《SpringBoot入门建站全系列（一）项目建立》。

2.1 Maven依赖

引入mybatis、数据库连接池、mysql-connector.

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
	<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
<dependency>
	<groupId>mysql</groupId>
	<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
	<groupId>org.apache.commons</groupId>
	<artifactId>commons-dbcp2</artifactId>
</dependency>

2.2 配置文件

在application.properties 中需要配置数据库相关信息的信息，如：

spring.datasource.master.type=org.apache.commons.dbcp2.BasicDataSource
spring.datasource.master.max-wait-millis=60000
spring.datasource.master.min-idle=20
spring.datasource.master.initial-size=2
spring.datasource.master.validation-query=SELECT 1
spring.datasource.master.connection-properties=characterEncoding=utf8
spring.datasource.master.validation-query=SELECT 1
spring.datasource.master.test-while-idle=true
spring.datasource.master.test-on-borrow=true
spring.datasource.master.test-on-return=false

spring.datasource.master.driverClassName = com.mysql.jdbc.Driver
spring.datasource.master.url=jdbc:mysql://127.0.0.1:3306/boot?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.master.username=cff
spring.datasource.master.password=123456

spring.datasource.slave.type=org.apache.commons.dbcp2.BasicDataSource
spring.datasource.slave.max-wait-millis=60000
spring.datasource.slave.min-idle=20
spring.datasource.slave.initial-size=2
spring.datasource.slave.validation-query=SELECT 1
spring.datasource.slave.connection-properties=characterEncoding=utf8
spring.datasource.slave.validation-query=SELECT 1
spring.datasource.slave.test-while-idle=true
spring.datasource.slave.test-on-borrow=true
spring.datasource.slave.test-on-return=false

spring.datasource.slave.driverClassName = com.mysql.jdbc.Driver
spring.datasource.slave.url=jdbc:mysql://127.0.0.1:3306/boot?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.slave.username=cff
spring.datasource.slave.password=123456

mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

注意，这里的配置：

• 虽然是spring.datasource开头，但是已经不是需要Spring自动装配的配置了；
• spring.datasource.master开头的配置，是需要我手动配置master数据源的配置；
• spring.datasource.slave开头的配置，是需要我手动配置slave数据源的配置；
• master和slave只是个名字而已，根据自己需要修改任何名称都行；
• mybatis.configuration.log-impl是mybatis自动装配的配置。

三、配置数据源

配置多个数据源，需要DataSource、TransactionManager、SqlSessionFactory

3.1 Master数据源

配置Master数据源，需要Master自己的DataSource、TransactionManager、SqlSessionFactory。

同时，指定MapperScan扫描的包路径，和对应的sqlSessionFactory。

package com.cff.springbootwork.atomikos.config;

import org.apache.commons.dbcp2.BasicDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
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.jdbc.datasource.DataSourceTransactionManager;

@Configuration
@MapperScan(basePackages = MasterDataSourceConfiguration.PACKAGE, sqlSessionFactoryRef = "masterSqlSessionFactory")
public class MasterDataSourceConfiguration {
	static final String PACKAGE = "com.cff.springbootwork.atomikos.dao.master";

	@Bean(name = "masterDataSource")
	@ConfigurationProperties(prefix = "spring.datasource.master")
	@Primary
	public BasicDataSource masterDataSource() {
		BasicDataSource dataSource = new BasicDataSource();
		return dataSource;
	}

	@Bean(name = "masterTransactionManager")
	@Primary
	public DataSourceTransactionManager masterTransactionManager() {
		return new DataSourceTransactionManager(masterDataSource());
	}

	@Bean(name = "masterSqlSessionFactory")
	@Primary
	public SqlSessionFactory masterSqlSessionFactory() throws Exception {
		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
		sessionFactory.setDataSource(masterDataSource());
		return sessionFactory.getObject();
	}
}

这里面，

• 新建了一个BasicDataSource，bean名称加个master以做区分，BasicDataSource的属性通过@ConfigurationProperties(prefix = “spring.datasource.master”)注入，同时，加上@Primary标明它是首选。
• @Primary注解只能加在某一个数据源上，不能所有数据源配置都加，不然会报错。
• 新建了一个masterTransactionManager，处理masterDataSource的事务。
• 新建了masterSqlSessionFactory，处理masterDataSource的SqlSession。

3.2 Slave数据源

配置Slave数据源，需要Slave自己的DataSource、TransactionManager、SqlSessionFactory。

同时，指定MapperScan扫描的包路径，和对应的sqlSessionFactory。

package com.cff.springbootwork.atomikos.config;

import org.apache.commons.dbcp2.BasicDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;

@Configuration
@MapperScan(basePackages = SlaveDataSourceConfiguration.PACKAGE, sqlSessionFactoryRef = "slaveSqlSessionFactory")
public class SlaveDataSourceConfiguration {
	static final String PACKAGE = "com.cff.springbootwork.atomikos.dao.slave";

	@Bean(name = "slaveDataSource")
	@ConfigurationProperties(prefix = "spring.datasource.slave")
	public BasicDataSource slaveDataSource() {
		BasicDataSource dataSource = new BasicDataSource();
		return dataSource;
	}

	@Bean(name = "slaveTransactionManager")
	public DataSourceTransactionManager slaveTransactionManager() {
		return new DataSourceTransactionManager(slaveDataSource());
	}

	@Bean(name = "slaveSqlSessionFactory")
	public SqlSessionFactory slaveSqlSessionFactory() throws Exception {
		final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
		sessionFactory.setDataSource(slaveDataSource());
		return sessionFactory.getObject();
	}
}

这里面，

• 新建了一个BasicDataSource，bean名称加个slave以做区分，BasicDataSource的属性通过@ConfigurationProperties(prefix = “spring.datasource.slave”)注入，注意，这个地方不能加上@Primary注解。
• 新建了一个slaveTransactionManager，处理slaveDataSource的事务。
• 新建了slaveSqlSessionFactory，处理slaveDataSource的SqlSession。

四、测试Mapper

Mapper的写法无任何改变，只不过，要注意不同mapper放在上面不同数据源指定的包路径下。

4.1 Master数据源的Mapper

新建一个UserInfoMasterDao，处理master数据源的用户表。

UserInfoMasterDao：

package com.cff.springbootwork.atomikos.dao.master;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;

import com.cff.springbootwork.atomikos.domain.UserInfo;

@Mapper
public interface UserInfoMasterDao {
	@Select({
		"<script>",
	        "SELECT ",
	        "user_name as userName,passwd,name,mobile,valid, user_type as userType",
	        "FROM user_info",
	        "WHERE user_name = #{userName,jdbcType=VARCHAR}",
	   "</script>"})
	UserInfo findByUserName(@Param("userName") String userName);
	
	@Update({
        "<script>",
        " update user_info set",
        " name = #{name, jdbcType=VARCHAR}, mobile = #{mobile, jdbcType=VARCHAR}",
        " where user_name=#{userName}",
        "</script>"
    })
    int update(UserInfo userInfo);
}

4.2 Slave数据源的Mapper

新建一个UserInfoSlaveDao，处理Slave数据源的用户表。

UserInfoSlaveDao：

package com.cff.springbootwork.atomikos.dao.slave;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;

import com.cff.springbootwork.atomikos.domain.UserInfo;

@Mapper
public interface UserInfoSlaveDao {
	@Select({
		"<script>",
	        "SELECT ",
	        "user_name as userName,passwd,name,mobile,valid, user_type as userType",
	        "FROM user_info",
	        "WHERE user_name = #{userName,jdbcType=VARCHAR}",
	   "</script>"})
	UserInfo findByUserName(@Param("userName") String userName);
	
	@Update({
        "<script>",
        " update user_info set",
        " name = #{name, jdbcType=VARCHAR}, mobile = #{mobile, jdbcType=VARCHAR}",
        " where user_name=#{userName}",
        "</script>"
    })
    int update(UserInfo userInfo);
}

五、测试Service

写一个普通的UserInfoService，注入两个mapper即可使用。

UserInfoService:

package com.cff.springbootwork.atomikos.service;

import java.util.ArrayList;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.cff.springbootwork.atomikos.dao.master.UserInfoMasterDao;
import com.cff.springbootwork.atomikos.dao.slave.UserInfoSlaveDao;
import com.cff.springbootwork.atomikos.domain.UserInfo;

@Service
public class UserInfoService {
	@Autowired
	UserInfoMasterDao userInfoMasterDao;

	@Autowired
	UserInfoSlaveDao userInfoSlaveDao;

	public List<UserInfo> getUserInfoByUserName(String userName) {
		UserInfo userInfoMaster = userInfoMasterDao.findByUserName(userName);
		UserInfo userInfoSlave = userInfoSlaveDao.findByUserName(userName);

		List<UserInfo> list = new ArrayList<>();
		list.add(userInfoMaster);
		list.add(userInfoSlave);
		return list;
	}

	@Transactional(rollbackFor = Exception.class)
	public List<UserInfo> update(UserInfo userInfo) {
		userInfoMasterDao.update(userInfo);
		userInfoSlaveDao.update(userInfo);
		int i = 1 / 0;
		return getUserInfoByUserName(userInfo.getUserName());
	}
}

注意，我这里的update方法中，写了一个int i = 1 / 0;,是为了测试无分布式事务支持的时候事务是如何处理的。

六、测试Web

package com.cff.springbootwork.atomikos.web;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.cff.springbootwork.atomikos.domain.UserInfo;
import com.cff.springbootwork.atomikos.service.UserInfoService;

@RestController
@RequestMapping("/mybatis")
public class MybatisRest {

	@Autowired
	UserInfoService userInfoService;

	@RequestMapping(value = "/mybatis/{name}", method = { RequestMethod.GET })
	public List<UserInfo> testMybatis(@PathVariable("name") String name) {
		return userInfoService.getUserInfoByUserName(name);
	}
	
	@RequestMapping(value = "/update")
	public List<UserInfo> update(@RequestBody UserInfo userInfo) {
		return userInfoService.update(userInfo);
	}
}

七、实体

UserInfo:

完整实体，请访问《SpringBoot入门建站全系列（三十）Mybatis多数据源进行数据库操作》查看。

七、结论

• 多数据源的使用和普通使用方法完全一样，只不过要多配置一下。
• 多数据源的事务无法正常回滚，需要分布式事务控制。
• 多数据源的事务，会回滚第一个，第二个回滚不了。

品茗IT-博客专题:https://www.pomit.cn/lecture.html汇总了Spring专题、Springboot专题、SpringCloud专题、web基础配置专题。

快速构建项目

Spring项目快速开发工具：

一键快速构建Spring项目工具

一键快速构建SpringBoot项目工具

一键快速构建SpringCloud项目工具

一站式Springboot项目生成

Mysql一键生成Mybatis注解Mapper

Spring组件化构建

SpringBoot组件化构建

SpringCloud服务化构建

喜欢这篇文章么，喜欢就加入我们一起讨论SpringBoot使用吧！