揭开 Spring 自定义注解多数据源实现的奥秘

2023-10-25 10:39:37

使用自定义注解实现 Spring 多数据源，轻松管理复杂数据场景

场景分析

在现代软件开发中，应用程序经常需要与多个数据库交互。这可能是由于业务复杂性、数据隔离或访问不同类型数据库的需求。

Spring 的多数据源机制

Spring 提供了一个强大而灵活的机制来管理多数据源。它通过 DataSource 和 TransactionManager 接口来实现。DataSource 表示一个数据库连接，而 TransactionManager 控制事务的行为。

使用自定义注解实现

为了灵活地管理数据源并与业务代码解耦，我们可以创建自定义注解，比如 @DataSource。这个注解可以用来标注需要使用特定数据源的方法或类。

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSource {
    String value() default "default";
}

数据源拦截器

为了拦截使用 @DataSource 注解标注的方法或类，我们需要一个数据源拦截器。这个拦截器将根据注解中的数据源名称获取数据源，并将其设置到 ThreadLocal 中，以便后续操作使用。

public class DataSourceInterceptor implements MethodInterceptor {

    private final Map<String, DataSource> dataSourceMap;

    public DataSourceInterceptor(Map<String, DataSource> dataSourceMap) {
        this.dataSourceMap = dataSourceMap;
    }

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        String dataSourceName = invocation.getMethod().getAnnotation(DataSource.class).value();
        DataSource dataSource = dataSourceMap.get(dataSourceName);
        if (dataSource == null) {
            dataSource = dataSourceMap.get("default");
        }
        DataSourceContextHolder.setDataSource(dataSource);
        try {
            return invocation.proceed();
        } finally {
            DataSourceContextHolder.clearDataSource();
        }
    }
}

配置和使用

在 Spring 配置文件中，我们需要注册自定义注解和数据源拦截器。

<bean id="dataSourceInterceptor" class="com.example.DataSourceInterceptor">
    <property name="dataSourceMap" ref="dataSourceMap" />
</bean>

<aop:config>
    <aop:pointcut id="dataSourcePointcut" expression="@annotation(com.example.DataSource)" />
    <aop:advisor advice-ref="dataSourceInterceptor" pointcut-ref="dataSourcePointcut" />
</aop:config>

在代码中，使用 @DataSource 注解标注需要使用特定数据源的方法或类。

@Service
public class UserService {

    @DataSource("userDataSource")
    public User getUserById(Long id) {
        // 从 userDataSource 中获取用户
    }
}

优势

使用自定义注解实现多数据源有以下优势：