Spring Boot 动态数据源（Spring 注解数据源）

Stella981
• 阅读 524

本文实现案例场景：
某系统除了需要从自己的主要数据库上读取和管理数据外，还有一部分业务涉及到其他多个数据库，要求可以在任何方法上可以灵活指定具体要操作的数据库。

为了在开发中以最简单的方法使用，本文基于注解和AOP的方法实现，在spring boot框架的项目中，添加本文实现的代码类后，只需要配置好数据源就可以直接通过注解使用，简单方便。

一配置二使用
1. 启动类注册动态数据源
2. 配置文件中配置多个数据源
3. 在需要的方法上使用注解指定数据源

1、在启动类添加 @Import({DynamicDataSourceRegister.class, MProxyTransactionManagementConfiguration.class})

@SpringBootApplication @Import({DynamicDataSourceRegister.class}) // 注册动态多数据源 public class SpringBootSampleApplication {


<span class="hljs-comment">// 省略其他代码</span>



}

2、配置文件配置内容为：
（不包括项目中的其他配置，这里只是数据源相关的）

# 主数据源，默认的
 spring.datasource.driver-class-name=com.mysql.jdbc.Driver
 spring.datasource.url=jdbc:mysql://localhost:3306/test
 spring.datasource.username=root
 spring.datasource.password=123456



# 更多数据源 custom.datasource.names=ds1,ds2
 custom.datasource.ds1.driver-class-name=com.mysql.jdbc.Driver
 custom.datasource.ds1.url=jdbc:mysql://localhost:3306/test1
 custom.datasource.ds1.username=root
 custom.datasource.ds1.password=123456


custom.datasource.ds2.driver-class-name=com.mysql.jdbc.Driver
 custom.datasource.ds2.url=jdbc:mysql://localhost:3306/test2
 custom.datasource.ds2.username=root
 custom.datasource.ds2.password=123456

3、使用方法

package org.springboot.sample.service;



import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.util.List;


import org.springboot.sample.datasource.TargetDataSource;
 import org.springboot.sample.entity.Student;
 import org.springboot.sample.mapper.StudentMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.jdbc.core.RowMapper;
 import org.springframework.stereotype.Service;


/**


    

  • Student Service
    

    • 

  • @author 单红宇(365384722)
    

    • 

  • @myblog http://blog.csdn.net/catoop/
    

    • 

  • @create 2016年1月12日
     */
     @Service
     public class StudentService {
    

    @Autowired
     private JdbcTemplate jdbcTemplate;
    

    // MyBatis的Mapper方法定义接口
     @Autowired
     private StudentMapper studentMapper;
    

    @TargetDataSource(name="ds2")
     public List likeName(String name){
     return studentMapper.likeName(name);
     }
    

    public List likeNameByDefaultDataSource(String name){
     return studentMapper.likeName(name);
     }
    


    /**
    

      

    • 不指定数据源使用默认数据源
      

      • 

    • @return
      

      • 

    • @author SHANHY
      

      • 

    • @create 2016年1月24日
       */
       public List getList(){
       String sql = "SELECT ID,NAME,SCORE_SUM,SCORE_AVG, AGE FROM STUDENT";
       return (List) jdbcTemplate.query(sql, new RowMapper(){
      

       <span class="hljs-meta">@Override</span></br>
 <span class="hljs-function"><span class="hljs-keyword">public</span> Student <span class="hljs-title">mapRow</span><span class="hljs-params">(ResultSet rs, <span class="hljs-keyword">int</span> rowNum)</span> <span class="hljs-keyword">throws</span> SQLException </span>{</br>
     Student stu = <span class="hljs-keyword">new</span> Student();</br>
     stu.setId(rs.getInt(<span class="hljs-string">"ID"</span>));</br>
     stu.setAge(rs.getInt(<span class="hljs-string">"AGE"</span>));</br>
     stu.setName(rs.getString(<span class="hljs-string">"NAME"</span>));</br>
     stu.setSumScore(rs.getString(<span class="hljs-string">"SCORE_SUM"</span>));</br>
     stu.setAvgScore(rs.getString(<span class="hljs-string">"SCORE_AVG"</span>));</br>
     <span class="hljs-keyword">return</span> stu;</br>
 }

      

      }); }
      

      • 

    


    /**
    

      

    • 指定数据源
      

      • 

    • @return
      

      • 

    • @author SHANHY
      

      • 

    • @create 2016年1月24日
       */ @TargetDataSource(name="ds1")
       public List getListByDs1(){
       String sql = "SELECT ID,NAME,SCORE_SUM,SCORE_AVG, AGE FROM STUDENT";
       return (List) jdbcTemplate.query(sql, new RowMapper(){
      

       <span class="hljs-meta">@Override</span></br>
 <span class="hljs-function"><span class="hljs-keyword">public</span> Student <span class="hljs-title">mapRow</span><span class="hljs-params">(ResultSet rs, <span class="hljs-keyword">int</span> rowNum)</span> <span class="hljs-keyword">throws</span> SQLException </span>{</br>
     Student stu = <span class="hljs-keyword">new</span> Student();</br>
     stu.setId(rs.getInt(<span class="hljs-string">"ID"</span>));</br>
     stu.setAge(rs.getInt(<span class="hljs-string">"AGE"</span>));</br>
     stu.setName(rs.getString(<span class="hljs-string">"NAME"</span>));</br>
     stu.setSumScore(rs.getString(<span class="hljs-string">"SCORE_SUM"</span>));</br>
     stu.setAvgScore(rs.getString(<span class="hljs-string">"SCORE_AVG"</span>));</br>
     <span class="hljs-keyword">return</span> stu;</br>
 }

      

      }); }
      

      • 

    


    /**
    

      

    • 指定数据源
      

      • 

    • @return
      

      • 

    • @author SHANHY
      

      • 

    • @create 2016年1月24日
       */
       @TargetDataSource(name="ds2")
       public List getListByDs2(){
       String sql = "SELECT ID,NAME,SCORE_SUM,SCORE_AVG, AGE FROM STUDENT";
       return (List) jdbcTemplate.query(sql, new RowMapper(){
      

       <span class="hljs-meta">@Override</span></br>
 <span class="hljs-function"><span class="hljs-keyword">public</span> Student <span class="hljs-title">mapRow</span><span class="hljs-params">(ResultSet rs, <span class="hljs-keyword">int</span> rowNum)</span> <span class="hljs-keyword">throws</span> SQLException </span>{</br>
     Student stu = <span class="hljs-keyword">new</span> Student();</br>
     stu.setId(rs.getInt(<span class="hljs-string">"ID"</span>));</br>
     stu.setAge(rs.getInt(<span class="hljs-string">"AGE"</span>));</br>
     stu.setName(rs.getString(<span class="hljs-string">"NAME"</span>));</br>
     stu.setSumScore(rs.getString(<span class="hljs-string">"SCORE_SUM"</span>));</br>
     stu.setAvgScore(rs.getString(<span class="hljs-string">"SCORE_AVG"</span>));</br>
     <span class="hljs-keyword">return</span> stu;</br>
 }

      

      }); } }

要注意的是，在使用MyBatis时，注解@TargetDataSource 不能直接在接口类Mapper上使用。
按上面的代码中StudentMapper为接口，代码如下：

package org.springboot.sample.mapper;



import java.util.List;


import org.springboot.sample.entity.Student;


/**


    

  • StudentMapper，映射SQL语句的接口，无逻辑实现
    

    • 

  • @author 单红宇(365384722)
    

    • 

  • @myblog http://blog.csdn.net/catoop/
    

    • 

  • @create 2016年1月20日
     */ public interface StudentMapper {
    

    // 注解 @TargetDataSource 不可以在这里使用
     List likeName(String name);
    

    Student getById(int id);
    

    String getNameById(int id);
    

    • 



}

请将下面几个类放到Spring Boot项目中。
DynamicDataSource.java
DynamicDataSourceAspect.java
DynamicDataSourceContextHolder.java
DynamicDataSourceRegister.java
TargetDataSource.java
MProxyTransactionManagementConfiguration.java
MTransactionInterceptor.java

package org.springboot.sample.datasource;



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


/**


    

  • 动态数据源
    

    • 

  • @author 单红宇(365384722)
    

    • 

  • @myblog http://blog.csdn.net/catoop/
    

    • 

  • @create 2016年1月22日 */ public class DynamicDataSource extends AbstractRoutingDataSource {
    

    @Override protected Object determineCurrentLookupKey() {
     return DynamicDataSourceContextHolder.getDataSourceType();
     }
    

    • 



} 

package org.springboot.sample.datasource;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.annotation.After;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
/\*\* \* 切换数据源Advice
 \* \* @author 单红宇(365384722)
 \* @myblog http://blog.csdn.net/catoop/
 \* @create 2016年1月23日
 \*/ @Aspect
 @Order(-1)// 保证该AOP在@Transactional之前执行 @Component public class DynamicDataSourceAspect {
 private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceAspect.class);
 @Before("@annotation(ds)") public void changeDataSource(JoinPoint point, TargetDataSource ds) throws Throwable {
 String dsId = ds.name();
 if (!DynamicDataSourceContextHolder.containsDataSource(dsId)) {
 logger.error("数据源\[{}\]不存在，使用默认数据源 > {}", ds.name(), point.getSignature());
 } else {
 logger.debug("Use DataSource : {} > {}", ds.name(), point.getSignature());
 DynamicDataSourceContextHolder.setDataSourceType(ds.name());
 } } @After("@annotation(ds)")
 public void restoreDataSource(JoinPoint point, TargetDataSource ds) {
 logger.debug("Revert DataSource : {} > {}", ds.name(), point.getSignature());
 DynamicDataSourceContextHolder.clearDataSourceType();
 } } 
package org.springboot.sample.datasource;
 import java.util.ArrayList;
 import java.util.List;
 public class DynamicDataSourceContextHolder {
 private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();
 public static List<String> dataSourceIds = new ArrayList<>(); 
 public static void setDataSourceType(String dataSourceType) {
 contextHolder.set(dataSourceType);
 }
 public static String getDataSourceType() {
 return contextHolder.get();
 } public static void clearDataSourceType() {
 contextHolder.remove();
 } /\*\* \* 判断指定DataSrouce当前是否存在
 \* \* @param dataSourceId
 \* @return
 \* @author SHANHY
 \* @create 2016年1月24日
 \*/ public static boolean containsDataSource(String dataSourceId){
 return dataSourceIds.contains(dataSourceId);
 } } 
package org.springboot.sample.datasource;
 import java.util.HashMap;
 import java.util.Map;
 import javax.sql.DataSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.MutablePropertyValues;
 import org.springframework.beans.PropertyValues;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.GenericBeanDefinition;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
 import org.springframework.boot.bind.RelaxedDataBinder;
 import org.springframework.boot.bind.RelaxedPropertyResolver;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.support.DefaultConversionService;
 import org.springframework.core.env.Environment;
 import org.springframework.core.type.AnnotationMetadata;
 /\*\* \* 动态数据源注册<br/>
 \* 启动动态数据源请在启动类中（如SpringBootSampleApplication）
 \* 添加 @Import(DynamicDataSourceRegister.class)
 \* \* @author 单红宇(365384722)
 \* @myblog http://blog.csdn.net/catoop/
 \* @create 2016年1月24日
 \*/ public class DynamicDataSourceRegister
 implements ImportBeanDefinitionRegistrar, EnvironmentAware { 
 private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceRegister.class);
 private ConversionService conversionService = new DefaultConversionService(); 
 private PropertyValues dataSourcePropertyValues;
 // 如配置文件中未指定数据源类型，使用该默认值
 private static final Object DATASOURCE\_TYPE\_DEFAULT = "org.apache.tomcat.jdbc.pool.DataSource"; // private static final Object DATASOURCE\_TYPE\_DEFAULT =
 // "com.zaxxer.hikari.HikariDataSource";
 // 数据源
 private DataSource defaultDataSource;
 private Map<String, DataSource> customDataSources = new HashMap<>();
 @Override
 public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 Map<Object, Object> targetDataSources = new HashMap<Object, Object>(); // 将主数据源添加到更多数据源中
 targetDataSources.put("dataSource", defaultDataSource);
 DynamicDataSourceContextHolder.dataSourceIds.add("dataSource");
 // 添加更多数据源
 targetDataSources.putAll(customDataSources);
 for (String key : customDataSources.keySet()) {
 DynamicDataSourceContextHolder.dataSourceIds.add(key);
 } // 创建DynamicDataSource
 GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
 beanDefinition.setBeanClass(DynamicDataSource.class);
 beanDefinition.setSynthetic(true);
 MutablePropertyValues mpv = beanDefinition.getPropertyValues();
 mpv.addPropertyValue("defaultTargetDataSource", defaultDataSource);
 mpv.addPropertyValue("targetDataSources", targetDataSources);
 registry.registerBeanDefinition("dataSource", beanDefinition);
 logger.info("Dynamic DataSource Registry");
 } /\*\* \* 创建DataSource
 \* \* @param type
 \* @param driverClassName
 \* @param url
 \* @param username
 \* @param password
 \* @return
 \* @author SHANHY
 \* @create 2016年1月24日
 \*/ @SuppressWarnings("unchecked")
 public DataSource buildDataSource(Map<String, Object> dsMap) {
 try {
 Object type = dsMap.get("type");
 if (type == null)
 type = DATASOURCE\_TYPE\_DEFAULT;// 默认DataSource
 Class<? extends DataSource> dataSourceType;
 dataSourceType = (Class<? extends DataSource>) Class.forName((String) type);
 String driverClassName = dsMap.get("driver-class-name").toString();
 String url = dsMap.get("url").toString();
 String username = dsMap.get("username").toString();
 String password = dsMap.get("password").toString();
 DataSourceBuilder factory = DataSourceBuilder.create().driverClassName(driverClassName).url(url)
 .username(username).password(password).type(dataSourceType);
 return factory.build();
 } catch (ClassNotFoundException e) {
 e.printStackTrace();
 }
 return null;
 } /\*\*
 \* 加载多数据源配置 \*/ @Override public void setEnvironment(Environment env) {
 initDefaultDataSource(env);
 initCustomDataSources(env);
 } /\*\* \* 初始化主数据源 \* \* @author SHANHY \* @create 2016年1月24日 \*/ private void initDefaultDataSource(Environment env) {
 // 读取主数据源
 RelaxedPropertyResolver propertyResolver = new RelaxedPropertyResolver(env, "spring.datasource.");
 Map<String, Object> dsMap = new HashMap<>();
 dsMap.put("type", propertyResolver.getProperty("type"));
 dsMap.put("driver-class-name", propertyResolver.getProperty("driver-class-name"));
 dsMap.put("url", propertyResolver.getProperty("url"));
 dsMap.put("username", propertyResolver.getProperty("username"));
 dsMap.put("password", propertyResolver.getProperty("password"));
 defaultDataSource = buildDataSource(dsMap);
 dataBinder(defaultDataSource, env);
 } /\*\* \* 为DataSource绑定更多数据
 \* \* @param dataSource
 \* @param env
 \* @author SHANHY
 \* @create 2016年1月25日
 \*/
 private void dataBinder(DataSource dataSource, Environment env){
 RelaxedDataBinder dataBinder = new RelaxedDataBinder(dataSource);
 //dataBinder.setValidator(new LocalValidatorFactory().run(this.applicationContext));
 dataBinder.setConversionService(conversionService);
 dataBinder.setIgnoreNestedProperties(false);//false
 dataBinder.setIgnoreInvalidFields(false);//false
 dataBinder.setIgnoreUnknownFields(true);//true
 if(dataSourcePropertyValues == null){
 Map<String, Object> rpr = new RelaxedPropertyResolver(env, "spring.datasource").getSubProperties(".");
 Map<String, Object> values = new HashMap<>(rpr);
 // 排除已经设置的属性
 values.remove("type");
 values.remove("driver-class-name");
 values.remove("url");
 values.remove("username");
 values.remove("password");
 dataSourcePropertyValues = new MutablePropertyValues(values);
 }
 dataBinder.bind(dataSourcePropertyValues);
 } /\*\* \* 初始化更多数据源 \* \* @author SHANHY \* @create 2016年1月24日 \*/ private void initCustomDataSources(Environment env) {
 // 读取配置文件获取更多数据源，也可以通过defaultDataSource读取数据库获取更多数据源
 RelaxedPropertyResolver propertyResolver = new RelaxedPropertyResolver(env, "custom.datasource.");
 String dsPrefixs = propertyResolver.getProperty("names");
 for (String dsPrefix : dsPrefixs.split(",")) {// 多个数据源
 Map<String, Object> dsMap = propertyResolver.getSubProperties(dsPrefix + ".");
 DataSource ds = buildDataSource(dsMap);
 customDataSources.put(dsPrefix, ds);
 dataBinder(ds, env);
 }
 }
 } 
package org.springboot.sample.datasource; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /\*\* \* 在方法上使用，用于指定使用哪个数据源 \* \* @author 单红宇(365384722)
 \* @myblog http://blog.csdn.net/catoop/
 \* @create 2016年1月23日 \*/ @Target({ ElementType.METHOD, ElementType.TYPE })
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface TargetDataSource {
 String name();
 }

本文代码博主是经过测试后没有问题才发出来共享给大家的。对于连接池参数配置会应用到所有数据源上。
比如配置一个：

spring.datasource.maximum-pool-size=80

那么我们所有的数据源都会自动应用上。

<!-- 登录查看 begin -->
    <!-- 登录查看 end -->
spring框架stringmeta前端前端
点赞
收藏
评论区
推荐文章
blmius blmius
•
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时，报错：原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等，这样可以更容易地在不同的环境中使用MySQL。全局s
4149
0
0
helloworld_34035044 helloworld_34035044
•
2年前
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时，如何在新增行里自动增加id呢？能新增整数排序id吗？目前可以在新增行里自动增加id，但只能用uuid函数增加UUID编码，不能新增整数排序id。uuid函数说明：获取一个UUID，可以在填报表中用来创建数据ID语法：uuid()或uuid(sep)参数说明：sep布尔值，生成的uuid中是否包含分隔符''，缺省为
1160
0
0
待兔 待兔
•
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
1089
0
0
Jacquelyn38 Jacquelyn38
•
3年前
2020年前端实用代码段，为你的工作保驾护航
有空的时候，自己总结了几个代码段，在开发中也经常使用，谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
2402
0
0
Stella981 Stella981
•
3年前
Django之Django模板
1、问：html页面从数据库中读出DateTimeField字段时，显示的时间格式和数据库中存放的格式不一致，比如数据库字段内容为2012082616:00:00，但是页面显示的却是Aug.26,2012,4p.m.答：为了页面和数据库中显示一致，需要在页面格式化时间，需要添加<td{{dayrecord.p\_time|date:
1007
0
0
Wesley13 Wesley13
•
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败，请联系管理员！');中国在东8区所以加8方法二：selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
1333
0
0
Wesley13 Wesley13
•
3年前
00：Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork)，斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟，已经成为Web应用程序的首选开发语言。Java是简单易学，完全面向对象，安全可靠，与平台无关的编程语言。
1271
0
0
Stella981 Stella981
•
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段，id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
1189
0
0
Wesley13 Wesley13
•
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
1538
0
0
Python进阶者 Python进阶者
•
10个月前
Excel中这日期老是出来00：00：00，怎么用Pandas把这个去除
大家好，我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下：这日期老是出来00：00：00，怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下：pd.toexcel之前把这
523
0
0
Stella981
Stella981
Lv1
接天莲叶无穷碧，映日荷花别样红。
文章
1.7w
粉丝
42
获赞
28
热门文章
OpenVPN下载、安装、配置及使用详解
GitHub神器，一个可以白嫖全网无损音乐的神器
OpenWrt 路由器过滤广告的N种方法
Python—执行系统命令的四种方法（os.system、os.popen、commands、subprocess）
SS端加密以及obfs混淆