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使用吧！