springboot + mybatis配置多數(shù)據(jù)源示例
在實(shí)際開(kāi)發(fā)中,我們一個(gè)項(xiàng)目可能會(huì)用到多個(gè)數(shù)據(jù)庫(kù),通常一個(gè)數(shù)據(jù)庫(kù)對(duì)應(yīng)一個(gè)數(shù)據(jù)源。
代碼結(jié)構(gòu):

簡(jiǎn)要原理:
1)DatabaseType列出所有的數(shù)據(jù)源的key---key
2)DatabaseContextHolder是一個(gè)線程安全的DatabaseType容器,并提供了向其中設(shè)置和獲取DatabaseType的方法
3)DynamicDataSource繼承AbstractRoutingDataSource并重寫(xiě)其中的方法determineCurrentLookupKey(),在該方法中使用DatabaseContextHolder獲取當(dāng)前線程的DatabaseType
4)MyBatisConfig中生成2個(gè)數(shù)據(jù)源DataSource的bean---value
5)MyBatisConfig中將1)和4)組成的key-value對(duì)寫(xiě)入到DynamicDataSource動(dòng)態(tài)數(shù)據(jù)源的targetDataSources屬性(當(dāng)然,同時(shí)也會(huì)設(shè)置2個(gè)數(shù)據(jù)源其中的一個(gè)為DynamicDataSource的defaultTargetDataSource屬性中)
6)將DynamicDataSource作為primary數(shù)據(jù)源注入到SqlSessionFactory的dataSource屬性中去,并且該dataSource作為transactionManager的入?yún)?lái)構(gòu)造DataSourceTransactionManager
7)使用的時(shí)候,在dao層或service層先使用DatabaseContextHolder設(shè)置將要使用的數(shù)據(jù)源key,然后再調(diào)用mapper層進(jìn)行相應(yīng)的操作,建議放在dao層去做(當(dāng)然也可以使用spring aop+自定注解去做)
注意:在mapper層進(jìn)行操作的時(shí)候,會(huì)先調(diào)用determineCurrentLookupKey()方法獲取一個(gè)數(shù)據(jù)源(獲取數(shù)據(jù)源:先根據(jù)設(shè)置去targetDataSources中去找,若沒(méi)有,則選擇defaultTargetDataSource),之后在進(jìn)行數(shù)據(jù)庫(kù)操作。
1、假設(shè)有兩個(gè)數(shù)據(jù)庫(kù),配置如下
application.properties
#the first datasource jdbc.driverClassName = com.mysql.jdbc.Driver jdbc.url = jdbc:mysql://xxx:3306/mytestdb?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf-8 jdbc.username = root jdbc.password = 123 #the second datasource jdbc2.driverClassName = com.mysql.jdbc.Driver jdbc2.url = jdbc:mysql://xxx:3306/mytestdb2?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf-8 jdbc2.username = root jdbc2.password = 123
說(shuō)明:在之前的配置的基礎(chǔ)上,只增加了上述的第二個(gè)數(shù)據(jù)源。
2、DatabaseType
package com.xxx.firstboot.common.datasource;
/**
* 列出所有的數(shù)據(jù)源key(常用數(shù)據(jù)庫(kù)名稱(chēng)來(lái)命名)
* 注意:
* 1)這里數(shù)據(jù)源與數(shù)據(jù)庫(kù)是一對(duì)一的
* 2)DatabaseType中的變量名稱(chēng)就是數(shù)據(jù)庫(kù)的名稱(chēng)
*/
public enum DatabaseType {
mytestdb,mytestdb2
}
作用:列舉數(shù)據(jù)源的key。
3、DatabaseContextHolder
package com.xxx.firstboot.common.datasource;
/**
* 作用:
* 1、保存一個(gè)線程安全的DatabaseType容器
*/
public class DatabaseContextHolder {
private static final ThreadLocal<DatabaseType> contextHolder = new ThreadLocal<>();
public static void setDatabaseType(DatabaseType type){
contextHolder.set(type);
}
public static DatabaseType getDatabaseType(){
return contextHolder.get();
}
}
作用:構(gòu)建一個(gè)DatabaseType容器,并提供了向其中設(shè)置和獲取DatabaseType的方法
4、DynamicDataSource
package com.xxx.firstboot.common.datasource;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
/**
* 動(dòng)態(tài)數(shù)據(jù)源(需要繼承AbstractRoutingDataSource)
*/
public class DynamicDataSource extends AbstractRoutingDataSource {
protected Object determineCurrentLookupKey() {
return DatabaseContextHolder.getDatabaseType();
}
}
作用:使用DatabaseContextHolder獲取當(dāng)前線程的DatabaseType
5、MyBatisConfig
package com.xxx.firstboot.common;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.sql.DataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
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.env.Environment;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import com.alibaba.druid.pool.DruidDataSourceFactory;
import com.xxx.firstboot.common.datasource.DatabaseType;
import com.xxx.firstboot.common.datasource.DynamicDataSource;
/**
* springboot集成mybatis的基本入口 1)創(chuàng)建數(shù)據(jù)源(如果采用的是默認(rèn)的tomcat-jdbc數(shù)據(jù)源,則不需要)
* 2)創(chuàng)建SqlSessionFactory 3)配置事務(wù)管理器,除非需要使用事務(wù),否則不用配置
*/
@Configuration // 該注解類(lèi)似于spring配置文件
@MapperScan(basePackages = "com.xxx.firstboot.mapper")
public class MyBatisConfig {
@Autowired
private Environment env;
/**
* 創(chuàng)建數(shù)據(jù)源(數(shù)據(jù)源的名稱(chēng):方法名可以取為XXXDataSource(),XXX為數(shù)據(jù)庫(kù)名稱(chēng),該名稱(chēng)也就是數(shù)據(jù)源的名稱(chēng))
*/
@Bean
public DataSource myTestDbDataSource() throws Exception {
Properties props = new Properties();
props.put("driverClassName", env.getProperty("jdbc.driverClassName"));
props.put("url", env.getProperty("jdbc.url"));
props.put("username", env.getProperty("jdbc.username"));
props.put("password", env.getProperty("jdbc.password"));
return DruidDataSourceFactory.createDataSource(props);
}
@Bean
public DataSource myTestDb2DataSource() throws Exception {
Properties props = new Properties();
props.put("driverClassName", env.getProperty("jdbc2.driverClassName"));
props.put("url", env.getProperty("jdbc2.url"));
props.put("username", env.getProperty("jdbc2.username"));
props.put("password", env.getProperty("jdbc2.password"));
return DruidDataSourceFactory.createDataSource(props);
}
/**
* @Primary 該注解表示在同一個(gè)接口有多個(gè)實(shí)現(xiàn)類(lèi)可以注入的時(shí)候,默認(rèn)選擇哪一個(gè),而不是讓@autowire注解報(bào)錯(cuò)
* @Qualifier 根據(jù)名稱(chēng)進(jìn)行注入,通常是在具有相同的多個(gè)類(lèi)型的實(shí)例的一個(gè)注入(例如有多個(gè)DataSource類(lèi)型的實(shí)例)
*/
@Bean
@Primary
public DynamicDataSource dataSource(@Qualifier("myTestDbDataSource") DataSource myTestDbDataSource,
@Qualifier("myTestDb2DataSource") DataSource myTestDb2DataSource) {
Map<Object, Object> targetDataSources = new HashMap<>();
targetDataSources.put(DatabaseType.mytestdb, myTestDbDataSource);
targetDataSources.put(DatabaseType.mytestdb2, myTestDb2DataSource);
DynamicDataSource dataSource = new DynamicDataSource();
dataSource.setTargetDataSources(targetDataSources);// 該方法是AbstractRoutingDataSource的方法
dataSource.setDefaultTargetDataSource(myTestDbDataSource);// 默認(rèn)的datasource設(shè)置為myTestDbDataSource
return dataSource;
}
/**
* 根據(jù)數(shù)據(jù)源創(chuàng)建SqlSessionFactory
*/
@Bean
public SqlSessionFactory sqlSessionFactory(DynamicDataSource ds) throws Exception {
SqlSessionFactoryBean fb = new SqlSessionFactoryBean();
fb.setDataSource(ds);// 指定數(shù)據(jù)源(這個(gè)必須有,否則報(bào)錯(cuò))
// 下邊兩句僅僅用于*.xml文件,如果整個(gè)持久層操作不需要使用到xml文件的話(只用注解就可以搞定),則不加
fb.setTypeAliasesPackage(env.getProperty("mybatis.typeAliasesPackage"));// 指定基包
fb.setMapperLocations(
new PathMatchingResourcePatternResolver().getResources(env.getProperty("mybatis.mapperLocations")));//
return fb.getObject();
}
/**
* 配置事務(wù)管理器
*/
@Bean
public DataSourceTransactionManager transactionManager(DynamicDataSource dataSource) throws Exception {
return new DataSourceTransactionManager(dataSource);
}
}
作用:
- 通過(guò)讀取application.properties文件生成兩個(gè)數(shù)據(jù)源(myTestDbDataSource、myTestDb2DataSource)
- 使用以上生成的兩個(gè)數(shù)據(jù)源構(gòu)造動(dòng)態(tài)數(shù)據(jù)源dataSource
- @Primary:指定在同一個(gè)接口有多個(gè)實(shí)現(xiàn)類(lèi)可以注入的時(shí)候,默認(rèn)選擇哪一個(gè),而不是讓@Autowire注解報(bào)錯(cuò)(一般用于多數(shù)據(jù)源的情況下)
- @Qualifier:指定名稱(chēng)的注入,當(dāng)一個(gè)接口有多個(gè)實(shí)現(xiàn)類(lèi)的時(shí)候使用(在本例中,有兩個(gè)DataSource類(lèi)型的實(shí)例,需要指定名稱(chēng)注入)
- @Bean:生成的bean實(shí)例的名稱(chēng)是方法名(例如上邊的@Qualifier注解中使用的名稱(chēng)是前邊兩個(gè)數(shù)據(jù)源的方法名,而這兩個(gè)數(shù)據(jù)源也是使用@Bean注解進(jìn)行注入的)
- 通過(guò)動(dòng)態(tài)數(shù)據(jù)源構(gòu)造SqlSessionFactory和事務(wù)管理器(如果不需要事務(wù),后者可以去掉)
6、使用
ShopMapper:
package com.xxx.firstboot.mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Result;
import org.apache.ibatis.annotations.Results;
import org.apache.ibatis.annotations.Select;
import com.xxx.firstboot.domain.Shop;
public interface ShopMapper {
@Select("SELECT * FROM t_shop WHERE id = #{id}")
@Results(value = { @Result(id = true, column = "id", property = "id"),
@Result(column = "shop_name", property = "shopName") })
public Shop getShop(@Param("id") int id);
}
ShopDao:
package com.xxx.firstboot.dao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import com.xxx.firstboot.common.datasource.DatabaseContextHolder;
import com.xxx.firstboot.common.datasource.DatabaseType;
import com.xxx.firstboot.domain.Shop;
import com.xxx.firstboot.mapper.ShopMapper;
@Repository
public class ShopDao {
@Autowired
private ShopMapper mapper;
/**
* 獲取shop
*/
public Shop getShop(int id) {
DatabaseContextHolder.setDatabaseType(DatabaseType.mytestdb2);
return mapper.getShop(id);
}
}
注意:首先設(shè)置了數(shù)據(jù)源的key,然后調(diào)用mapper(在mapper中會(huì)首先根據(jù)該key從動(dòng)態(tài)數(shù)據(jù)源中查詢(xún)出相應(yīng)的數(shù)據(jù)源,之后取出連接進(jìn)行數(shù)據(jù)庫(kù)操作)
ShopService:
package com.xxx.firstboot.service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.xxx.firstboot.dao.ShopDao;
import com.xxx.firstboot.domain.Shop;
@Service
public class ShopService {
@Autowired
private ShopDao dao;
public Shop getShop(int id) {
return dao.getShop(id);
}
}
ShopController:
package com.xxx.firstboot.web;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.xxx.firstboot.domain.Shop;
import com.xxx.firstboot.service.ShopService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
@RestController
@RequestMapping("/shop")
@Api("shopController相關(guān)api")
public class ShopController {
@Autowired
private ShopService service;
@ApiOperation("獲取shop信息,測(cè)試多數(shù)據(jù)源")
@RequestMapping(value = "/getShop", method = RequestMethod.GET)
public Shop getShop(@RequestParam("id") int id) {
return service.getShop(id);
}
}
補(bǔ):其實(shí)DatabaseContextHolder和DynamicDataSource完全可以合為一個(gè)類(lèi)
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Hadoop環(huán)境配置之hive環(huán)境配置詳解
這篇文章主要介紹了Hadoop環(huán)境配置之hive環(huán)境配置,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-12-12
J2ee 高并發(fā)情況下監(jiān)聽(tīng)器實(shí)例詳解
這篇文章主要介紹了J2ee 高并發(fā)情況下監(jiān)聽(tīng)器實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-02-02
使用jsoup解析html的table中的文本信息實(shí)例
今天小編就為大家分享一篇使用jsoup解析html的table中的文本信息實(shí)例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-05-05
詳細(xì)聊聊SpringBoot中動(dòng)態(tài)切換數(shù)據(jù)源的方法
在大型分布式項(xiàng)目中,經(jīng)常會(huì)出現(xiàn)多數(shù)據(jù)源的情況,下面這篇文章主要給大家介紹了關(guān)于SpringBoot中動(dòng)態(tài)切換數(shù)據(jù)源的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2021-09-09
Java Swing實(shí)現(xiàn)簡(jiǎn)單的體重指數(shù)(BMI)計(jì)算器功能示例
這篇文章主要介紹了Java Swing實(shí)現(xiàn)簡(jiǎn)單的體重指數(shù)(BMI)計(jì)算器功能,涉及Java Swing窗口組件布局、響應(yīng)及數(shù)值運(yùn)算相關(guān)操作技巧,需要的朋友可以參考下2017-12-12

