Spring动态数据源实现读写分离详解

Spring动态数据源实现读写分离攻略

什么是读写分离

读写分离是数据库的一种分布式架构模式，将对数据库的读写操作分别由不同的服务器处理，以提高系统的性能和可靠性。一般而言，写操作对数据库数据的更新，而读操作则是对数据的查询。读写分离的优点是可以扩展系统读性能，降低写性能对读性能的影响，提升系统的整体性能。

动态数据源实现读写分离

在Spring应用中，实现读写分离通常采用动态数据源的方式。数据源是应用程序连接到数据库的关键组件，动态数据源允许在应用运行时根据需要动态选择不同的数据源。

动态数据源的实现一般包括以下步骤：

1. 创建数据源配置类；
2. 创建动态数据源类；
3. 创建数据源路由类；
4. 在应用中使用动态数据源。

步骤一：创建数据源配置类

在数据源配置类中，定义主、从数据源的相关信息，并将它们注入到Bean容器中，供后续使用。关键的代码：

@Configuration
public class DataSourceConfig {

    @Bean
    @Primary
    public DataSource masterDataSource() {
        // 主数据源配置
    }

    @Bean
    public DataSource slaveDataSource() {
        // 从数据源配置
    }

    @Bean
    public DataSource dynamicDataSource() {
        // 动态数据源配置
    }

}

步骤二：创建动态数据源类

DynamicDataSource类继承自AbstractRoutingDataSource，它重写determineCurrentLookupKey方法确定当前的数据源。关键的代码：

public class DynamicDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDataSource();
    }

}

步骤三：创建数据源路由类

DataSourceContextHolder类是实现动态选择数据源的关键。在这个类中，定义一个ThreadLocal变量，存储当前选择的数据源。

public class DataSourceContextHolder {

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

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

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

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

}

步骤四：在应用中使用动态数据源

在使用数据库时，将数据源路由类设置为当前数据源，并执行查询或更新操作。关键的代码如下：

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @Transactional(readOnly = true)
    public List<User> findByUsername(String username) {
        DataSourceContextHolder.setDataSource("slaveDataSource");
        List<User> users = userDao.findByUsername(username);
        DataSourceContextHolder.clearDataSource();
        return users;
    }

    @Transactional
    public void save(User user) {
        DataSourceContextHolder.setDataSource("masterDataSource");
        userDao.save(user);
        DataSourceContextHolder.clearDataSource();
    }

}

示例

示例一：多数据源配置

如果我们使用的数据库有多个读数据库，我们以较为简单的方式进行配置。下面是主数据源和两个从数据源的配置类。

@Configuration
public class DataSourceConfig {

    @Bean
    @Primary
    public DataSource masterDataSource() {
        // 主数据源配置
    }

    @Bean(name="slaveDataSource1")
    public DataSource slaveDataSource1() {
        // 第一个从数据源配置
    }

    @Bean(name="slaveDataSource2")
    public DataSource slaveDataSource2() {
        // 第二个从数据源配置
    }

    @Bean
    public DataSource dynamicDataSource() {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        DataSource master = masterDataSource();
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceType.master.name(), master);
        targetDataSources.put(DataSourceType.slave1.name(), slaveDataSource1());
        targetDataSources.put(DataSourceType.slave2.name(), slaveDataSource2());
        dynamicDataSource.setDefaultTargetDataSource(master);
        dynamicDataSource.setTargetDataSources(targetDataSources);
        return dynamicDataSource;
    }

}

示例二：注解方式切换数据源

如果我们想根据业务层来切换数据源，我们可以使用注解的方式，使用AOP进行拦截。下面是一个实现示例。

首先在DataSourceType中定义数据源类型：

public enum DataSourceType {
    master, 
    slave1,
    slave2
}

定义注解，用于标记切换数据源的方法：

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD })
public @interface TargetDataSource {
    DataSourceType value();
}

创建切面类，在BeforeAdvice方法中根据注解中指定的数据源类型切换数据源：

@Component
@Aspect
public class DynamicDataSourceAspect {

    @Before("@annotation(targetDataSource)")
    public void beforeSwitchDataSource(TargetDataSource targetDataSource) {
        String dataSourceKey = targetDataSource.value().name();
        DataSourceContextHolder.setDataSource(dataSourceKey);
    }

    @After("@annotation(targetDataSource)")
    public void afterSwitchDataSource(TargetDataSource targetDataSource) {
        DataSourceContextHolder.clearDataSource();
    }

}

在Service中使用注解切换数据源：

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDao userDao;

    @TargetDataSource(DataSourceType.master)
    @Transactional
    public void save(User user) {
        userDao.save(user);
    }

    @TargetDataSource(DataSourceType.slave1)
    @Transactional(readOnly = true)
    public List<User> findByUsername(String username) {
        return userDao.findByUsername(username);
    }

    @TargetDataSource(DataSourceType.slave2)
    @Transactional(readOnly = true)
    public User findById(Long id) {
        return userDao.findById(id);
    }

}

这样，在Controller等调用Service接口的地方，就可以很方便地根据注解来切换数据源了。

总结

动态数据源是实现读写分离的常用方式，它允许在应用运行时动态选择数据源。我们可以通过配置、注解等方式来实现数据源的动态切换。在使用数据源时，需要注意数据源的选用，保证数据的一致性和正确性。