Mybatis 自定义注解 自动切换数据源

Mybatis 自定义注解 自动切换数据源

1.创建数据源枚举 DataSources.java

package mybatis.utils;

public enum DataSources {
	/**
	 * 默认数据源 IT 数据源
	 * 本地数据库
	 */
	DATASOURCE,
	/**
	 * TG
	 */
	TG, 
	/**
	 * WB
	 */
	WB;
}

2.创建数据源管理器 DataSourceTypeManager.java

package mybatis.utils;

/**
 * 数据源管理器
 * @author callens
 *
 */
public class DataSourceTypeManager {
	
	/**
	 * 用于确保多线程安全问题
	 */
	private static final ThreadLocal<DataSources> dataSourceTypes=new InheritableThreadLocal<DataSources>() {

		@Override
		protected DataSources initialValue() {
			return DataSources.DATASOURCE; //设置默认数据源
		}
	};
	
	/**
	 * 获取DataSource的数据源名称
	 * @return
	 */
	public static DataSources get() {
		return dataSourceTypes.get();
	}
	
	/**
	 * 根据数据源名称，设置数据源
	 * @param dataSourceType
	 */
	public static void set(DataSources dataSourceType) {
		dataSourceTypes.set(dataSourceType);
	}
	
	/**
	 * 重置数据源，并设置数据源为默认数据源
	 */
	public static void reset() {
		dataSourceTypes.set(DataSources.DATASOURCE);
	}
}

3.创建 数据源切换管理器 ThreadLocalRountingDataSource.java

package mybatis.utils;

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

/**
 * 数据源切换管理器，需继承AbstractRoutingDataSource，此类有Spring提供
 * @author xxyf55
 *
 */
public class ThreadLocalRountingDataSource extends AbstractRoutingDataSource{

	@Override
	protected Object determineCurrentLookupKey() {
		return DataSourceTypeManager.get();
	}
}

4.在spring中进行配置

 
 <bean id="restuctureDataSource" class="mybatis.utils.ThreadLocalRountingDataSource">
    	<property name="defaultTargetDataSource" ref="dataSource" />
    	<property name="targetDataSources">
    		<map key-type="mybatis.utils.DataSources">
    			<entry key="DATASOURCE" value-ref="dataSource"></entry>
    			<entry key="TG" value-ref="tg"></entry>
    			<entry key="WB" value-ref="wb"></entry>
    		</map>
    	</property>
    </bean>
    
    <!-- 配置MyBatis -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<!-- 注入数据库连接池 -->
        <property name="dataSource" ref="restuctureDataSource"/>
    </bean>
    
    <!-- 本地数据库 -->
	<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
		init-method="init" destroy-method="close" lazy-init="false">
		<property name="driverClassName" value="oracle.jdbc.OracleDriver" />
	</bean>
	<bean id="wb" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close">
		<property name="driverClassName" value="oracle.jdbc.OracleDriver" />
	</bean>
	<bean id="tg" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close">
		<property name="driverClassName" value="oracle.jdbc.OracleDriver" />
	</bean>

5.添加自定义注解 TargetDataSource.java

package mybatis.utils;

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;

/**
 * 自定义注解，用于获取当前方法需要调用的数据源
 * <br> 改作用为获取数据源配置信息，使用不同的数据源进行操作数据
 * <br> 当前不支持分布式事物
 * <br> 若使用分布式事物，则需要进行自定义
 * @author callens
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {

	DataSources dataSource() default DataSources.DATASOURCE;
	
}

6.添加AOP DynamicDataSourceAspect.java

package mybatis.utils.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Repository;

import lombok.extern.slf4j.Slf4j;
import mybatis.utils.DataSourceTypeManager;
import mybatis.utils.DataSources;
import mybatis.utils.TargetDataSource;

@Aspect
@Order(-1)
@Repository
@Slf4j
public class DynamicDataSourceAspect {
	/**
	 * 设置需要拦截的请求
	 */
	@Pointcut("execution(* mybatis.mapper..*(..))")
	public void pointCut() {
		
	}
	
	@Before("@annotation(targetDataSource)")
	public void doBefore(JoinPoint joinPoint,TargetDataSource targetDataSource) throws Throwable {
		if(targetDataSource==null) {
			DataSourceTypeManager.set(DataSources.DATASOURCE);
			log.debug("this used datasource is {}",DataSources.DATASOURCE);
		}else {
			DataSources dataSource=targetDataSource.dataSource();
			log.debug("this used datasource is {}",dataSource);
			DataSourceTypeManager.set(dataSource);
		}
	}
	
	@After("@annotation(targetDataSource)")
	public void doAfter(JoinPoint joinPoint,TargetDataSource targetDataSource) {
		DataSourceTypeManager.reset();
	}
	
	/**
	 * 当AOP切换数据源失败的时候，重置数据源
	 * @param joinPoint
	 * @param targetDataSource
	 * @param e
	 */
	@AfterThrowing(value="@annotation(targetDataSource)",throwing="e")
	public void doException(JoinPoint joinPoint,TargetDataSource targetDataSource,Throwable e) {
		DataSourceTypeManager.reset();
	}
}

7.如何使用

package mybatis.mapper.cc;

import java.util.List;

import com.shine.pb.entity.ScyxProductPO;
import com.shine.pb.query.ShineQueryInfo;
import mybatis.utils.DataSources;
import mybatis.utils.TargetDataSource;

import org.apache.ibatis.annotations.Param;

public  interface CCMapper {

    @TargetDataSource(dataSource=DataSources.tg)
    List<PO> getDetail(@Param("page")Page page, @Param("po")PO po);
    
    List<PO> getList(@Param("page")Page page, @Param("po")PO po);
}

如果在mapper的接口中写入自定的注解，并标注所使用的数据源，则mybatis会自动切换到所标注的数据源

如果不进行定义，则使用默认的数据源

核心逻辑

ThreadLocalRountingDataSource类数据源切换管理器，需继承AbstractRoutingDataSource，此类由Spring提供

DataSourceTypeManager数据源管理器 用于保证线程安全，其所用为设置数据源，获取数据源，重置数据源等

DataSources 枚举类，用于保存数据源的id使其对应到spring中

TargetDataSource 自定义注解

DynamicDataSourceAspect AOP拦截类，拦截Mapper接口请求，获取写入的自定义注解，绑定需要使用的数据源