Spring-基于Spring使用自定义注解及Aspect实现数据库切换操作

下面是详细讲解基于Spring使用自定义注解及Aspect实现数据库切换操作的完整攻略。

简介

随着项目规模的增大，往往需要使用多个数据库，每个库分配到不同的模块或者不同的服务。如何快速方便地切换数据库是我们需求的核心，本文主要介绍基于Spring使用自定义注解及Aspect实现数据库切换操作。

准备工作

1. 首先需要安装Spring Framework，建议使用Maven下载安装。
2. 本方案同时使用MyBatis，需要对应的MyBatis版本。

实现步骤

1. 定义注解

定义一个DatabaseSwitch注解，用于标记需要切换的数据库名称。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DatabaseSwitch {
    String value() default "dataSourceA";
}

2. 定义切面

定义一个切面DatabaseSwitchAspect，实现切换数据库的逻辑。

@Aspect
@Component
public class DatabaseSwitchAspect {

    @Around("@annotation(com.example.demo.annotation.DatabaseSwitch)")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        try {
            MethodSignature signature = (MethodSignature) pjp.getSignature();
            DatabaseSwitch databaseSwitch = signature.getMethod().getAnnotation(DatabaseSwitch.class);
            String dataSource = databaseSwitch.value();
            DatabaseContextHolder.setDataSource(dataSource);
            return pjp.proceed();
        } finally {
            DatabaseContextHolder.clearDataSource();
        }
    }

}

3. 配置多数据源

在application.yml或者application.properties中配置数据源信息。

spring:
  datasource:
    dataSourceA:
      type: com.zaxxer.hikari.HikariDataSource
      driver-class-name: com.mysql.jdbc.Driver
      jdbc-url: jdbc:mysql://127.0.0.1:3306/dataSourceA?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false
      username: root
      password: root
    dataSourceB:
      type: com.zaxxer.hikari.HikariDataSource
      driver-class-name: com.mysql.jdbc.Driver
      jdbc-url: jdbc:mysql://127.0.0.1:3306/dataSourceB?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false
      username: root
      password: root

4. 定义数据源切换器

定义一个线程安全的数据源切换器DatabaseContextHolder，用于存储当前线程所使用的数据源名称。

public class DatabaseContextHolder {

    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

    public static void setDataSource(String dataSource) {
        contextHolder.set(dataSource);
    }

    public static String getDataSource() {
        return contextHolder.get();
    }

    public static void clearDataSource() {
        contextHolder.remove();
    }

}

5. 配置MapperScan注解

在MapperScan注解中加入特定数据源的信息，用于指定Mapper接口的扫描路径。

@Configuration
@MapperScan(basePackages = {"com.example.demo.dao.dsA"}, sqlSessionFactoryRef = "sqlSessionFactoryA")
public class DataSourceAConfig {

    @Bean(name = "dataSourceA")
    @ConfigurationProperties(prefix = "spring.datasource.dataSourceA")
    public DataSource dataSourceA() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "sqlSessionFactoryA")
    public SqlSessionFactory sqlSessionFactoryA(@Qualifier("dataSourceA") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        return bean.getObject();
    }

    @Bean(name = "dataSourceTransactionManagerA")
    public DataSourceTransactionManager dataSourceTransactionManagerA(@Qualifier("dataSourceA") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

}

6. 定义Mapper接口

在Mapper接口中加上@DatabaseSwitch注解，指定使用的数据源。

public interface UserMapper {

    @DatabaseSwitch("dataSourceA")
    @Select("SELECT id,name,age FROM user")
    List<User> getUserFromDataSourceA();

    @DatabaseSwitch("dataSourceB")
    @Select("SELECT id,name,age FROM user")
    List<User> getUserFromDataSourceB();

}

7. 使用注解调用

在需要使用注解的方法上添加@DatabaseSwitch注解即可。

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    public List<User> getUserFromDataSourceA() {
        return userMapper.getUserFromDataSourceA();
    }

    public List<User> getUserFromDataSourceB() {
        return userMapper.getUserFromDataSourceB();
    }

}

示例

这里展示两个示例：

示例1：查询数据源A中所有的用户信息

@RequestMapping(value = "/getUserFromDataSourceA", method = RequestMethod.GET)
@ResponseBody
public List<User> getUserFromDataSourceA() {
    return userService.getUserFromDataSourceA();
}

示例2：查询数据源B中所有的用户信息

@RequestMapping(value = "/getUserFromDataSourceB", method = RequestMethod.GET)
@ResponseBody
public List<User> getUserFromDataSourceB() {
    return userService.getUserFromDataSourceB();
}

结束语

通过自定义注解及Aspect实现数据库切换操作，既方便了开发人员，也保证了数据源的切换安全性和精确性，同时给项目后期扩展带来了极大的便利。