写这篇文章的初衷是应为最近一直在学习spring boot相关的一些东西,而在spring boot整合mybatis中相关的博客有很多,可多数都是描述不清然人产生疑惑,或者干脆就是存在问题。尤其是在事务管理这里,大家说的都很含糊,于是在经过最近自己的学习后,决定把自己整理的资历拿出了分享。
##多数据源
关于多数据源的实现,这里提供两种思路
-
通过指定不同包下的dao层实现来解决
-
通过service层动态指定数据源
下面会对这两种思路做分别的实现。
##一.多数据源的基本配置
开始前我们先准备两个库,这里使用MySQL数据库
test库和test_bac用来模拟两个数据源
在两个库下分别创建一张user表
CREATE TABLE user
(
id
int(11) NOT NULL,
user_name
varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
age
int(11) DEFAULT NULL,
sex
bit(1) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
- 首先创建一个空spring boot工程
- 工程结构如下
- pom.xml如下
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.wxy</groupId>
<artifactId>double-data-source</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>double-data-source</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.7.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2.在application.properties中配置数据库信息
# test库
spring.datasource.db1.url=jdbc:mysql://127.0.0.1:3306/test?characterEncoding=UTF-8
spring.datasource.db1.username=root
spring.datasource.db1.password=root
spring.datasource.db1.driver-class-name=com.mysql.jdbc.Driver
# 连接池配置
# 省略
# tes_bac库
spring.datasource.db2.url=jdbc:mysql://127.0.01:3306/test_bac?characterEncoding=UTF-8
spring.datasource.db2.username=root
spring.datasource.db2.password=root
spring.datasource.db2.driver-class-name=com.mysql.jdbc.Driver
其中db1和db2分别区分了两个数据源
3.在spring boot的启动类里面使用@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
目的是将spring boot自带的DataSourceAutoConfiguration禁掉,因为它会读取application.properties文件的spring.datasource.*
4.上一步中,我们禁用了spring boot 的数据源的自动配置,因此我们要手动添加配置,新建一个config包,并建一个DataSourceConfig.java类,来配置我们的数据源。
DataSourceConfig.java如下
package com.wxy.doubledatasource.config;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
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 javax.sql.DataSource;
@Configuration
public class DataSourceConfig {
// 手动定义数据源的名字,后面自动注入的时候就用这个名字,两个数据源名字不同,自己定义就好
@Bean(name = "db1")
// application.properteis中对应属性的前缀
@ConfigurationProperties(prefix = "spring.datasource.db1")
// 因为使用了多数据源,所以一定要在一个数据源加上这个注解,否则会报错
@Primary
public DataSource dataSource1() {
return DataSourceBuilder.create().build();
}
// 手动定义数据源的名字,后面自动注入的时候就用这个名字,两个数据源名字不同,自己定义就好,如果还有其他数据源,就写多少个
@Bean(name = "db2")
// application.properteis中对应属性的前缀
@ConfigurationProperties(prefix = "spring.datasource.db2")
public DataSource dataSource2() {
return DataSourceBuilder.create().build();
}
}
- 接下来我们还需要配置SQLSessionFactory,数据源与sqlsessionfactory是一一对应的,这里以第一个数据源为例,因为后面无论有多少个都是差不多的,只自动注入的数据源会有所差别。
package com.wxy.doubledatasource.config;
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.io.support.PathMatchingResourcePatternResolver;
import javax.sql.DataSource;
@Configuration
// 指定不同数据源所用的dao,调用不同的dao以启用不同的数据源。
@MapperScan(basePackages = {"com.wxy.doubledatasource.dao.db1"}, sqlSessionFactoryRef = "sqlSessionFactory1")
public class MybatisDB1Config {
@Autowired
@Qualifier("db1")// 指定db1数据源,即我们在DataSourceConfig中设置的@bean("db1")对应
private DataSource db1;
@Bean
@Primary// 只有主数据源需要,与DataSourceConfig中的对应
public SqlSessionFactory sqlSessionFactory1() throws Exception {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(db1); // 使用db1数据源, 连接test库
// 可以在这里指定是否使用mapper映射文件,这里为了简单就没有配置,如果需要配置的话,要加到resources目录下面,
// 否则需要在pom文件中设置对静态文件的加载
// factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:/*.xml"));
return factoryBean.getObject();
}
@Bean
@Primary
public SqlSessionTemplate sqlSessionTemplate1() throws Exception {
SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory1()); // 使用上面配置的Factory
return template;
}
}
6.下面我们开始使用刚刚配制好的数据源,首先把刚刚指定的dao层的包建好,然后建对应的接口,以简单的插入为例
package com.wxy.doubledatasource.dao.db1;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
@Mapper
public interface UserDao1 {
@Insert("insert into user values(#{id}, #{userName}, #{age}, #{sex})")
int insert(@Param("id") int id, @Param("userName") String userName, @Param("age") int age, @Param("sex") boolean sex);
}
7.这样就可以使用了,还有事务