SpringBoot利用自定義注解實現(xiàn)多數(shù)據(jù)源

更新時間：2022年10月13日 08:33:25 作者：look-word

這篇文章主要為大家詳細介紹了SpringBoot如何利用自定義注解實現(xiàn)多數(shù)據(jù)源效果，文中的示例代碼講解詳細，具有一定的借鑒價值，需要的可以了解一下

前置學習

需要了解注解、Aop、SpringBoot整合Mybatis的使用。

數(shù)據(jù)準備

基礎項目代碼：https://gitee.com/J_look/spring-boot-all-demo

數(shù)據(jù)庫SQL 項目中有提供，修改基本信息即可

行動起來

添加依賴

利用 AOP 可以實現(xiàn)對某些代碼的解耦，不需要硬編碼編寫。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

開啟AOP支持

也可以像圖中一樣，也開啟事務管理器，下文會演示事務失效的問題。

定義枚舉

這里定義的枚舉，代表我們不同的數(shù)據(jù)庫。

public enum DataSourceType {
    MYSQL_DATASOURCE1,
    MYSQL_DATASOURCE2,
}

定義數(shù)據(jù)源管理器

由于本人實力原因，解答不了大家這里的疑惑。大致功能通過修改本地線程的值，來實現(xiàn)數(shù)據(jù)源的切換。

@Component
@Primary
public class DataSourceManagement extends AbstractRoutingDataSource {

    public static ThreadLocal<String> flag = new ThreadLocal<>();

    /**
     * 注入數(shù)據(jù)源
     */
    @Resource
    private DataSource mysqlDataSource1;
    /**
     * 注入數(shù)據(jù)源
     */
    @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);
        // 設置數(shù)據(jù)源來源
        super.setTargetDataSources(targetDataSource);
        // 設置默認數(shù)據(jù)源
        super.setDefaultTargetDataSource(mysqlDataSource1);
        super.afterPropertiesSet();
    }
}

自定義注解

@target：表示自定義注解能用在哪里

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {
    DataSourceType value() default DataSourceType.MYSQL_DATASOURCE1;
}

定義切面類

可以看到，我們的切面類采用的是環(huán)繞通知，博主在寫這篇文章之前，做過大量測試，也參考過比較多的文章，總結(jié)以下幾點：

采用前置通知，雖然能實現(xiàn)數(shù)據(jù)源的切換，但是會導致事務失效。(推薦視頻)
采用環(huán)繞通知，事務不會失效，但是切換數(shù)據(jù)源卻實現(xiàn)不了。(由Bean的加載順序?qū)е碌?，下文中的@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注解只能用于類或者方法上, 錯誤出現(xiàn)在:[" +
                        target.toString() + " " + method.toString() + "];");
            }
        }
        // 切換數(shù)據(jù)源
        DataSourceManagement.flag.set(annotation.value().name());
        Object result = null;
        try {
            // 執(zhí)行目標代碼
            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));
    }
}

觀察執(zhí)行日志可知，數(shù)據(jù)源的切換實現(xiàn)了，事務也沒有失效。