SpringBoot自定义注解实现多数据源
前置学习
需要了解 注解、Aop、SpringBoot整合Mybatis的使用。
数据准备
基础项目代码：https://gitee.com/J_look/spring-boot-all-demo
数据库SQL 项目中有提供，修改基本信息即可
行动起来
添加依赖
利用 AOP 可以实现对某些代码的解耦，不需要硬编码编写。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
开启AOP支持
也可以像图中一样，也开启事务管理器，下文会演示事务失效的问题。
定义枚举
这里定义的枚举，代表我们不同的数据库。
public enum DataSourceType {
MYSQL_DATASOURCE1,
MYSQL_DATASOURCE2,
}
定义数据源管理器
由于本人实力原因，解答不了大家这里的疑惑。大致功能
通过修改本地线程的值，来实现数据源的切换。
@Component
@Primary
public class DataSourceManagement extends AbstractRoutingDataSource {
public static ThreadLocal<String> flag = new ThreadLocal<>();
/**
* 注入数据源
*/
@Resource
private DataSource mysqlDataSource1;
/**
* 注入数据源
*/
@Resource
private DataSource mysqlDataSource2;
public DataSourceManagement() {
flag.set(DataSourceType.MYSQL_DATASOURCE1.name());
}
@Override
protected Object determineCurrentLookupKey() {
return flag.get();
}
@Override
public void afterPropertiesSet() {
Map<Object, Object> targetDataSource = new ConcurrentHashMap<>();
targetDataSource.put(DataSourceType.MYSQL_DATASOURCE1.name(), mysqlDataSource1);
targetDataSource.put(DataSourceType.MYSQL_DATASOURCE2.name(), mysqlDataSource2);
// 设置数据源来源
super.setTargetDataSources(targetDataSource);
// 设置默认数据源
super.setDefaultTargetDataSource(mysqlDataSource1);
super.afterPropertiesSet();
}
}
自定义注解
@target：表示自定义注解能用在哪里
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {
DataSourceType value() default DataSourceType.MYSQL_DATASOURCE1;
}
定义切面类
可以看到，我们的切面类采用的是环绕通知，博主在写这篇文章之前，做过大量测试，也参考过比较多的文章，总结以下几点：
- 采用
前置通知，虽然能实现数据源的切换，但是会导致事务失效。(推荐视频)- 采用
环绕通知，事务不会失效，但是切换数据源却实现不了。(由Bean的加载顺序导致的，下文中的@Order就可以解决，@Transactional默认级别是最后加载。可以查看日志信息知晓。)
@Component
@Aspect
@Slf4j
@Order(Ordered.LOWEST_PRECEDENCE-1) // Bean加载顺序
public class TargetDataSourceAspect {
@Around("@within(TargetDataSource) || @annotation(TargetDataSource)")
public Object beforeNoticeUpdateDataSource(ProceedingJoinPoint joinPoint) {
TargetDataSource annotation = null;
Class<? extends Object> target = joinPoint.getTarget().getClass();
if (target.isAnnotationPresent(TargetDataSource.class)) {
// 判断类上是否标注着注解
annotation = target.getAnnotation(TargetDataSource.class);
log.info("类上标注了注解");
} else {
Method method = ((MethodSignature) joinPoint.getSignature()).getMethod();
if (method.isAnnotationPresent(TargetDataSource.class)) {
// 判断方法上是否标注着注解，如果类和方法上都没有标注，则报错
annotation = method.getAnnotation(TargetDataSource.class);
log.info("方法上标注了注解");
} else {
throw new RuntimeException("@TargetDataSource注解只能用于类或者方法上, 错误出现在:[" +
target.toString() + " " + method.toString() + "];");
}
}
// 切换数据源
DataSourceManagement.flag.set(annotation.value().name());
Object result = null;
try {
// 执行目标代码
result = joinPoint.proceed();
} catch (Throwable e) {
e.printStackTrace();
}
return result;
}
}
Service
启动测试类：
import look.word.datasource.service.BookService;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import javax.annotation.Resource;
/**
* @author : look-word
* 2022-10-10 23:11
**/
@SpringBootTest
public class TestBookMapper {
@Resource
private BookService bookService;
@Test
void updatePrice() {
System.out.println(bookService.updatePrice(1, 777));
}
}
观察执行日志可知，数据源的切换实现了，事务也没有失效。
参考文章：