Mybatis 是什么
Mybatis 是一个基于 JDBC 实现的，支持普通 SQL 查询、存储过程和高级映射的优秀持久层框架，去掉了几乎所有的 JDBC 代码和参数的手工设置以及对结果集的检索封装。
Mybatis 主要思想是将程序中大量的 SQL 语句剥离出来，配置在配置文件中，以实现 SQL 的灵活配置。在所有 ORM 框架中都有一个非常重要的媒介——PO（持久化对象），PO 的作用就是完成持久化操作，通过该对象对数据库执行增删改的操作，以面向对象的方式操作数据库。
SpringBoot 整合 Mybatis 框架实现多数据源操作
当我们使用 SpringBoot 整合 Mybatis 时，我们通常会遇到多数据源的问题。在这种情况下，我们需要使用动态数据源来处理多个数据源。本文将介绍如何使用 SpringBoot 整合 Mybatis 的多数据源和动态数据源。
应用场景
项目需要同时连接两个不同的数据库 A, B，并且它们都为主从架构，一台写库，多台读库。
选择和配置 Maven 依赖
使用 SpringBoot 整合 Mybatis 需要添加 Maven 起步依赖，如下所示。
<dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>x.x.x</version></dependency><dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId></dependency><dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>x.x.xx</version></dependency>
复制代码
这些依赖将帮助我们整合 Mybatis 和 Druid 数据源。
禁掉 DataSourceAutoConfiguration
首先，要将 spring boot 自带的 DataSourceAutoConfiguration 禁掉，因为它会读取 application.properties 文件的 spring.datasource.* 属性并自动配置单数据源。
去除 DataSourceAutoConfiguration
在 @SpringBootApplication 注解中添加 exclude 属性即可。
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})public class WebApplication { public static void main(String[] args) { SpringApplication.run(WebApplication.class, args); }}
复制代码
定制化配置对应的数据源
由于我们禁掉了自动数据源配置，因些下一步就需要手动将这些数据源创建出来。
配置主、从数据源
当接下来，我们需要配置数据源时，我们需要在 application.properties 文件中创建多个数据源的配置块。为了区分不同的数据源，我们可以使用 spring.datasource.druid.* 前缀。
以下是一个示例，我们定义了两个数据源：主数据源和从数据源，并且我们使用 Druid 数据源来管理它们。在 application.properties 中的配置如下所示：
主数据源
spring.datasource.druid.master.url=jdbc:mysql://localhost:3306/master?useUnicode=true&characterEncoding=utf-8&useSSL=falsespring.datasource.druid.master.username=rootspring.datasource.druid.master.password=rootspring.datasource.druid.master.driver-class-name=com.mysql.jdbc.Driver
复制代码
从数据源
spring.datasource.druid.slave.url=jdbc:mysql://localhost:3306/slave?useUnicode=true&characterEncoding=utf-8&useSSL=falsespring.datasource.druid.slave.username=rootspring.datasource.druid.slave.password=rootspring.datasource.druid.slave.driver-class-name=com.mysql.jdbc.Driver
复制代码
通过以上配置，我们成功地定义了两个数据源，并使用了 Druid 数据源来管理它们。这样的配置可以确保应用程序能够顺利地访问并管理多个数据源。
配置 Mybatis 和定义主从数据源对象
接下来，我们需要配置 Mybatis。我们需要为每个数据源创建一个 SqlSessionFactory。以下是一个示例：
@Configuration@MapperScan(basePackages = "com.xx.xxx.mapper")public class DynamicDataSourceConfiguration {
@Bean(name = "masterDataSource") // application.properteis中对应属性的前缀 @ConfigurationProperties(prefix = "spring.datasource.druid.master") public DataSource masterDataSource() { return DruidDataSourceBuilder.create().build(); }
@Bean(name = "slaveDataSource") // application.properteis中对应属性的前缀 @ConfigurationProperties(prefix = "spring.datasource.druid.slave") public DataSource slaveDataSource() { return DruidDataSourceBuilder.create().build(); }
@Bean(name = "dynamicDataSource") public DataSource dynamicDataSource(@Qualifier("masterDataSource") DataSource masterDataSource, @Qualifier("slaveDataSource") DataSource slaveDataSource) { DynamicDataSource dynamicDataSource = new DynamicDataSource(); Map<Object, Object> targetDataSources = new HashMap<>(); targetDataSources.put(DataSourceType.MASTER, masterDataSource); targetDataSources.put(DataSourceType.SLAVE, slaveDataSource); dynamicDataSource.setTargetDataSources(targetDataSources); dynamicDataSource.setDefaultTargetDataSource(masterDataSource); return dynamicDataSource; }}
复制代码
方案 1：MapperScan 配置扫描
在启动类中添加对 mapper 包扫描 @MapperScan。
@SpringBootApplication@MapperScan("com.xxx.xxx.xxx")
复制代码
在这个示例中，我们创建了两个 SqlSessionFactory：masterSqlSessionFactory 和 slaveSqlSessionFactory。我们还创建了一个动态数据源，它可以根据需要切换到不同的数据源。我们使用 @Qualifier 注释来指定每个数据源的名称。
方案 1：手动编程配置对应的 SessionFactory
// 需要为每个数据源创建一个SqlSessionFactory。以下是一个示例： @Bean(name = "masterSqlSessionFactory") public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource) throws Exception { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setDataSource(masterDataSource); bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/master/*.xml")); return bean.getObject(); }
// 需要为每个数据源创建一个SqlSessionFactory。以下是一个示例： @Bean(name = "slaveSqlSessionFactory") public SqlSessionFactory slaveSqlSessionFactory(@Qualifier("slaveDataSource") DataSource slaveDataSource) throws Exception { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setDataSource(slaveDataSource); bean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/slave/*.xml")); return bean.getObject(); }
@Bean(name = "sqlSessionTemplate") public SqlSessionTemplate sqlSessionTemplate(@Qualifier("dynamicDataSource") DataSource dynamicDataSource) throws Exception { return new SqlSessionTemplate(dynamicDataSource); }
复制代码
添加了上面的配置注解之后，会进行扫描所有的 Mybatis 的 Mapper 接口类，进行注入到对应的 Spring 的上下文中。此外还有另外一种方式就只通过 @MapperScan 的 sqlSessionFactoryRef 方式指定对应的 SessionFactory 并且定义扫描方式。
方案 2：注解编程配置对应的 SessionFactory
接下来需要配置两个 mybatis 的 SqlSessionFactory 分别使用不同的数据源：
@Configuration@MapperScan(basePackages = {"com.xxxx.mapper"}, sqlSessionFactoryRef = "masterSqlSessionFactory") public class MasterSqlSessionFactoryConfiguration { @Autowired @Qualifier("masterDataSource") private DataSource masterDataSource; @Bean public SqlSessionFactory sqlSessionFactory1() throws Exception { SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean(); factoryBean.setDataSource(masterDataSource); return factoryBean.getObject(); } @Bean public SqlSessionTemplate sqlSessionTemplate1() throws Exception { SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory1()); // 使用上面配置的Factory return template; } }
复制代码
经过上面的配置后，com.xxxx.mapper 下的 Mapper 接口，都会使用 master 数据源。同理可配第二个 SqlSessionFactory:
@Configuration@MapperScan(basePackages = {"com.xxxx.dao"}, sqlSessionFactoryRef = "slaveSqlSessionFactory") public class SlaveSqlSessionFactoryConfiguration { @Autowired @Qualifier("slaveDataSource") private DataSource slaveDataSource; @Bean public SqlSessionFactory sqlSessionFactory2() throws Exception { SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean(); factoryBean.setDataSource(slaveDataSource); return factoryBean.getObject(); } @Bean public SqlSessionTemplate sqlSessionTemplate1() throws Exception { SqlSessionTemplate template = new SqlSessionTemplate(sqlSessionFactory2()); // 使用上面配置的Factory return template; } }
复制代码
完成这些配置后，假设有 2 个 Mapper：com.xxxx.mapper.XXXMapper 和 com.xxxx.dao.Mapper，使用前者时会自动连接 master 库，后者连接 slave 库。
创建静态数据源
接下来，我们要针对于多数据源和及动态数据源进行实现对应的落地方案，希望可以帮助到大家，动态数据源: 通过 AOP 在不同数据源之间动态切换。
/** * @return */ @Bean(name = "dynamicDataSource") public DataSource dataSource() { DynamicDataSource dynamicDataSource = new DynamicDataSource(); // 默认数据源 dynamicDataSource.setDefaultTargetDataSource(dataSource1()); // 配置多数据源 Map<Object, Object> dsMap = new HashMap(5); dsMap.put("masterDataSource", dataSource1()); dsMap.put("slaveDataSource", dataSource2()); dynamicDataSource.setTargetDataSources(dsMap); return dynamicDataSource; }
复制代码
动态数据源实现处理
使用动态数据源的初衷，是能在应用层做到读写分离，即在程序代码中控制不同的查询方法去连接不同的库。除了这种方法以外，数据库中间件也是个不错的选择，它的优点是数据库集群对应用来说只暴露为单库，不需要切换数据源的代码逻辑。
定义数据源切换上下文
首先定义一个 ContextHolder, 用于保存当前线程使用的数据源名：
public class DataSourceContextHolder { /** * 默认数据源 */ public static final String DEFAULT_DS = "masterDataSource"; private static final ThreadLocal<String> contextHolder = new ThreadLocal<>(); // 设置数据源名 public static void setDB(String dbType) { contextHolder.set(dbType); }
// 获取数据源名 public static String getDB() { return (contextHolder.get()); }
// 清除数据源名 public static void clearDB() { contextHolder.remove(); }}
复制代码
定义动态切换数据源
我们需要创建一个动态数据源来管理多个数据源，自定义一个 javax.sql.DataSource 接口的实现，这里只需要继承 Spring 为我们预先实现好的父类 AbstractRoutingDataSource 即可。
public class DynamicDataSource extends AbstractRoutingDataSource { @Override protected Object determineCurrentLookupKey() { return DataSourceContextHolder.getDB(); }}
复制代码
在这个示例中，我们使用 DataSourceContextHolder 来获取当前线程的数据源类型。DataSourceContextHolder 是一个自定义的类，它使用 ThreadLocal 来存储当前线程的数据源类型。
AOP 的方式实现数据源动态切换
通过自定义注解 @DS 用于在编码时指定方法使用哪个数据源。
@Retention(RetentionPolicy.RUNTIME)@Target({ ElementType.METHOD })public @interface DS { String value() default "masterDataSource";}
复制代码
AOP 切面实现运行切换机制
编写 AOP 切面，实现切换数据源逻辑，我们需要在运行时切换数据源。
@Aspect@Componentpublic class DynamicDataSourceAspect { @Before("@annotation(DS)") public void beforeSwitchDS(JoinPoint point){ //获得当前访问的class Class<?> className = point.getTarget().getClass(); //获得访问的方法名 String methodName = point.getSignature().getName(); //得到方法的参数的类型 Class[] argClass = ((MethodSignature)point.getSignature()).getParameterTypes(); String dataSource = DataSourceContextHolder.DEFAULT_DS; try { // 得到访问的方法对象 Method method = className.getMethod(methodName, argClass); // 判断是否存在@DS注解 if (method.isAnnotationPresent(DS.class)) { DS annotation = method.getAnnotation(DS.class); // 取出注解中的数据源名 dataSource = annotation.value(); } } catch (Exception e) { e.printStackTrace(); } // 切换数据源 DataSourceContextHolder.setDB(dataSource); } @After("@annotation(DS)") public void afterSwitchDS(JoinPoint point){ DataSourceContextHolder.clearDB(); }}
复制代码
完成上述配置后，在先前 SqlSessionFactory 配置中指定使用 DynamicDataSource 就可以在 Service 中愉快的切换数据源了。
@Autowired private CXXMapper userAMapper; @DS("masterDataSource") public String ds1() { return userAMapper.selectByPrimaryKey(1).getName(); } @DS("slaveDataSource") public String ds2() { return userAMapper.selectByPrimaryKey(1).getName(); }
复制代码
手动编程实现运行切换机制
我们使用 DataSourceContextHolder 来设置当前线程的数据源类型。在 getAllUsers 方法中，我们使用主数据源。在 getUserById 方法中，我们使用从数据源。
@Servicepublic class UserServiceImpl implements UserService {
@Autowired private UserMapper userMapper;
@Override public List<User> getAllUsers() { DataSourceContextHolder.setDataSourceType(DataSourceType.MASTER); return userMapper.getAllUsers(); }
@Override public User getUserById(int id) { DataSourceContextHolder.setDataSourceType(DataSourceType.SLAVE); return userMapper.getUserById(id); }}
复制代码
评论