如何使用SpringBoot2.0.7+MyBatis+DB+Durid实现多数据源项目
Hello，大家好，我是Steafan，今天为大家带来多数据源环境的配置，亲测可用，且配置相对网上其他教程的配置相对简单。本片博文是使用yml配置源的方式来实现项目多数据源环境，请朋友们知晓。
一、配置依赖
二、多数据源yml文件中的配置
spring:
# 配置多数据源
datasource:
#使用druid连接池
type: com.alibaba.druid.pool.DruidDataSource
# 配置主数据源，注意节点的位置
primary:
datasource:
#druid相关配置
druid:
driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
url:
username:
password:
# 连接池配置
initial-size: 5
min-idle: 5
max-active: 20
# 连接等待超时时间
max-wait: 30000
# 配置检测可以关闭的空闲连接间隔时间
time-between-eviction-runs-millis: 60000
# 配置连接在池中的最小生存时间
min-evictable-idle-time-millis: 300000
# validation-query: select '1' from dual
validation-query: SELECT 'x' #FROM DUAL
test-while-idle: true
test-on-borrow: false
test-on-return: false
# 打开PSCache，并且指定每个连接上PSCache的大小
pool-prepared-statements: true
max-open-prepared-statements: 20
max-pool-prepared-statement-per-connection-size: 20
# 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙
filters: stat
# Spring监控AOP切入点，如x.y.z.service.*,配置多个英文逗号分隔
# aop-patterns: cn.servie.*
# WebStatFilter配置
web-stat-filter:
enabled: true
# 添加过滤规则
url-pattern: /*
# 忽略过滤的格式
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*,/actuator/*'
# StatViewServlet配置
stat-view-servlet:
enabled: true
# 访问路径为/druid时，跳转到StatViewServlet
url-pattern:
# 是否能够重置数据
reset-enable: false
# 需要账号密码才能访问控制台
login-username:
login-password:
# IP白名单
# allow: 127.0.0.1
# IP黑名单（共同存在时，deny优先于allow）
# deny: 192.168.1.218
# 配置StatFilter
# filter:
# stat:
# log-slow-sql: true
# 配置从数据源（额外数据源），注意节点的位置
back:
datasource:
#druid相关配置
druid:
driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
url:
username:
password:
# 连接池配置
initial-size: 5
min-idle: 5
max-active: 20
# 连接等待超时时间
max-wait: 30000
# 配置检测可以关闭的空闲连接间隔时间
time-between-eviction-runs-millis: 60000
# 配置连接在池中的最小生存时间
min-evictable-idle-time-millis: 300000
# validation-query: select '1' from dual
validation-query: SELECT 'x' #FROM DUAL
test-while-idle: true
test-on-borrow: false
test-on-return: false
# 打开PSCache，并且指定每个连接上PSCache的大小
pool-prepared-statements: true
max-open-prepared-statements: 20
max-pool-prepared-statement-per-connection-size: 20
#监控统计拦截的filters
filters: stat
# 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙
# Spring监控AOP切入点，如x.y.z.service.*,配置多个英文逗号分隔
# aop-patterns: cn.servie.*
# WebStatFilter配置
web-stat-filter:
enabled: true
# 添加过滤规则
url-pattern: /*
# 忽略过滤的格式
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*,/actuator/*'
# StatViewServlet配置
stat-view-servlet:
enabled: true
# 访问路径为/druid时，跳转到StatViewServlet
url-pattern:
# 是否能够重置数据
reset-enable: false
# 需要账号密码才能访问控制台
login-username:
login-password:
# IP白名单
# allow: 127.0.0.1
# IP黑名单（共同存在时，deny优先于allow）
# deny: 192.168.1.218
# 配置StatFilter
# filter:
# stat:
# log-slow-sql: true
# druid:
# # 数据库访问配置, 使用druid数据源
# db-type: com.alibaba.druid.pool.DruidDataSource
# driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
# url:
# username:
# password:
#mybatis:
# config-location: classpath:config/mybatis-config.xml
# # type-aliases扫描路径
# type-aliases-package:
# # mapper xml实现扫描路径
# mapper-locations: classpath:mapper/*.xml
# property:
# order: BEFORE
# # 开启驼峰自动转换
## configuration:
## map-underscore-to-camel-case: true
##mappers 多个接口时逗号隔开
#mapper:
# mappers:
# not-empty: false
# identity: SQLSERVER
# order: after
#pagehelper
#pagehelper:
# helperDialect: sqlserver
# reasonable: true
# supportMethodsArguments: true
# params: count=countSql
注意： StatFilter、Durid、mybatis、mappers、pagehelper这些不需要再单独额外的进行配置
三、在项目中新建config配置文件包，并在其中创建多个数据源的配置类
1、配置主数据源（注意各配置类所引入的包）
@Data
@Configuration
// 前缀为primary.datasource.druid的配置信息
@ConfigurationProperties(prefix = "primary.datasource.druid")
@MapperScan(basePackages = PrimaryDataBaseConfig.PACKAGE, sqlSessionFactoryRef = "primarySqlSessionFactory")
public class PrimaryDataBaseConfig {
/**
* dao层的包路径
*/
static final String PACKAGE = "你的路径";
/**
* mapper文件的相对路径
*/
private static final String MAPPER_LOCATION = "你的路径";
private String filters;
private String url;
private String username;
private String password;
private String driverClassName;
private int initialSize;
private int minIdle;
private int maxActive;
private long maxWait;
private long timeBetweenEvictionRunsMillis;
private long minEvictableIdleTimeMillis;
private String validationQuery;
private boolean testWhileIdle;
private boolean testOnBorrow;
private boolean testOnReturn;
private boolean poolPreparedStatements;
private int maxPoolPreparedStatementPerConnectionSize;
// 主数据源使用@Primary注解进行标识
@Primary
@Bean(name = "primaryDataSource")
public DataSource primaryDataSource() throws SQLException {
DruidDataSource druid = new DruidDataSource();
// 监控统计拦截的filters
druid.setFilters(filters);
// 配置基本属性
druid.setDriverClassName(driverClassName);
druid.setUsername(username);
druid.setPassword(password);
druid.setUrl(url);
//初始化时建立物理连接的个数
druid.setInitialSize(initialSize);
//最大连接池数量
druid.setMaxActive(maxActive);
//最小连接池数量
druid.setMinIdle(minIdle);
//获取连接时最大等待时间，单位毫秒。
druid.setMaxWait(maxWait);
//间隔多久进行一次检测，检测需要关闭的空闲连接
druid.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
//一个连接在池中最小生存的时间
druid.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
//用来检测连接是否有效的sql
druid.setValidationQuery(validationQuery);
//建议配置为true，不影响性能，并且保证安全性。
druid.setTestWhileIdle(testWhileIdle);
//申请连接时执行validationQuery检测连接是否有效
druid.setTestOnBorrow(testOnBorrow);
druid.setTestOnReturn(testOnReturn);
//是否缓存preparedStatement，也就是PSCache，oracle设为true，mysql设为false。分库分表较多推荐设置为false
druid.setPoolPreparedStatements(poolPreparedStatements);
// 打开PSCache时，指定每个连接上PSCache的大小
druid.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
return druid;
}
// 创建该数据源的事务管理
@Primary
@Bean(name = "primaryTransactionManager")
public DataSourceTransactionManager primaryTransactionManager() throws SQLException {
return new DataSourceTransactionManager(primaryDataSource());
}
// 创建Mybatis的连接会话工厂实例
@Primary
@Bean(name = "primarySqlSessionFactory")
public SqlSessionFactory primarySqlSessionFactory(@Qualifier("primaryDataSource") DataSource primaryDataSource) throws Exception {
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(primaryDataSource); // 设置数据源bean
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
.getResources(PrimaryDataBaseConfig.MAPPER_LOCATION)); // 设置mapper文件路径
return sessionFactory.getObject();
}
}
2、配置从数据源（额外数据源）（注意各配置类所引入的包）
@Data
@Configuration
@ConfigurationProperties(prefix = "back.datasource.druid")
@MapperScan(basePackages = BackDataBaseConfig.PACKAGE, sqlSessionFactoryRef = "backSqlSessionFactory")
public class BackDataBaseConfig {
/**
* dao层的包路径
*/
static final String PACKAGE = "你的路径";
/**
* mapper文件的相对路径
*/
private static final String MAPPER_LOCATION = "你的路径";
private String filters;
private String url;
private String username;
private String password;
private String driverClassName;
private int initialSize;
private int minIdle;
private int maxActive;
private long maxWait;
private long timeBetweenEvictionRunsMillis;
private long minEvictableIdleTimeMillis;
private String validationQuery;
private boolean testWhileIdle;
private boolean testOnBorrow;
private boolean testOnReturn;
private boolean poolPreparedStatements;
private int maxPoolPreparedStatementPerConnectionSize;
@Bean(name = "backDataSource")
public DataSource backDataSource() throws SQLException {
DruidDataSource druid = new DruidDataSource();
// 监控统计拦截的filters
druid.setFilters(filters);
// 配置基本属性
druid.setDriverClassName(driverClassName);
druid.setUsername(username);
druid.setPassword(password);
druid.setUrl(url);
//初始化时建立物理连接的个数
druid.setInitialSize(initialSize);
//最大连接池数量
druid.setMaxActive(maxActive);
//最小连接池数量
druid.setMinIdle(minIdle);
//获取连接时最大等待时间，单位毫秒。
druid.setMaxWait(maxWait);
//间隔多久进行一次检测，检测需要关闭的空闲连接
druid.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
//一个连接在池中最小生存的时间
druid.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
//用来检测连接是否有效的sql
druid.setValidationQuery(validationQuery);
//建议配置为true，不影响性能，并且保证安全性。
druid.setTestWhileIdle(testWhileIdle);
//申请连接时执行validationQuery检测连接是否有效
druid.setTestOnBorrow(testOnBorrow);
druid.setTestOnReturn(testOnReturn);
//是否缓存preparedStatement，也就是PSCache，oracle设为true，mysql设为false。分库分表较多推荐设置为false
druid.setPoolPreparedStatements(poolPreparedStatements);
// 打开PSCache时，指定每个连接上PSCache的大小
druid.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
return druid;
}
@Bean(name = "backTransactionManager")
public DataSourceTransactionManager backTransactionManager() throws SQLException {
return new DataSourceTransactionManager(backDataSource());
}
@Bean(name = "backSqlSessionFactory")
public SqlSessionFactory backSqlSessionFactory(@Qualifier("backDataSource") DataSource backDataSource) throws Exception {
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(backDataSource);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
.getResources(BackDataBaseConfig.MAPPER_LOCATION));
return sessionFactory.getObject();
}
}
注意：
1、@ConfigurationProperties注解会和yml配置源中配置的primary、back等自定义的标签节点进行绑定，即在yml中使用自定义的配置节点来配置项目。
2、各数据源配置类中需要注意mapperLocation的配置位置和配置方法，路径一定要正确。
四、配置多数据源中需要注意的地方
1、使用多数据源需要在项目中区分不同的dao层，即mapper的实现层interface，不同dao层要在不同的dao层包中，这样才行
2、使用多数据源需要在项目中新建不同的dao层所对应的xml的实现文件夹，分开建立才行
3、一些实体类pojo层，service层及实现，controller层不需要单独再新建包来区分。
4、在多数据源环境下，写sql或操作dao层mapper时，在指定表名时，直接指定就可以，不需要有多余的配置，因为在配置多数据源的配置类中以及yml文件中已经指名了不同数据源，springboot会根据yml文件中的多数据源配置来自动扫描不同的配置源，从而去匹配项目中不同的数据表。
5、springboot使用yml的方式去配置数据源，必须指名主数据源，即一定要加@Primary注解来声明主数据源是哪个配置类，其他非主数据源不需要添加（也不需要添加其他额外的注解），否则springboot无法扫描多数据源配置，从而在项目启动时发生错误。
6、如果还需要添加其他数据源，则只需要在yml中再指定一个额外的数据源节点，然后再新建一个数据源配置类即可，springboot即可自动扫描。
感谢大家关注，提前祝大家国庆快乐，工作顺心，生活愉快！！！！！！