SpringBoot - 自定义注解完成数据库切库

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
云数据库 RDS PostgreSQL,集群系列 2核4GB
简介: SpringBoot - 自定义注解完成数据库切库

为什么会有数据库切库一说

首先,许多项目都有主库与从库,有的主库后面甚至会有很多个从库,主从库之间的通常同步也很快,这为数据库切库提供了一个基础,因为可以去不同的数据库查询,得到相同的结果(如果不同的数据库是完全不同的,这个不在我们这篇文章讨论的范围之内,那个属于让项目支持多个数据源)

其次,随着项目越来越大、操作的用户越来越多,对数据库的请求操作越来越多,很容易想到的是将读写请求分开,将写请求交给主库处理,读请求直接从某个从库读取。这样可以极大的减少大量对主库的请求,提升主库的性能。

接下来具体说一下如何通过自定义注解完成切库(代码使用springboot实现):

第一步、定义我们自己的切库注解类

自定义注解有几点需要注意:

1)@Target 是作用的目标,接口、方法、类、字段、包等等,具体看:ElementType

2)@Retention 是注解存在的范围,RUNTIME代表的是注解会在class字节码文件中存在,在运行时可以通过反射获取到,具体看:RetentionPolicy

3)允许的变量,通常都要给定默认值,比如我们使用一个service时,可以@Service,也可以@Service("xxxx")

@Retention(RetentionPolicy.RUNTIME)
@Target({
ElementType.METHOD})
public@interfaceRoutingDataSource {
Stringvalue() defaultDataSources.MASTER_DB;
}

第二步、定义需要使用的数据库及配置

1、数据库配置:application.properties,这里要注意不同db的前缀区别

##datasourcemaster#spring.datasource.type=com.alibaba.druid.pool.DruidDataSourcespring.datasource.driver-class-name=com.mysql.jdbc.Driverspring.datasource.url=jdbc:mysql://localhost:3306/master?characterEncoding=UTF-8spring.datasource.username=rootspring.datasource.password=466420182##datasourceslave#spring.datasourceSlave.type=com.alibaba.druid.pool.DruidDataSourcespring.datasourceSlave.driver-class-name=com.mysql.jdbc.Driverspring.datasourceSlave.url=jdbc:mysql://localhost:3306/slave?characterEncoding=UTF-8spring.datasourceSlave.username=rootspring.datasourceSlave.password=466420182

2、定义支持的数据源id:

publicinterfaceDataSources {
StringMASTER_DB="masterDB";
StringSLAVE_DB="slaveDB";
}

3、定义数据库实体类并配置为多数据源的形式

这里不要忽略了通过 MapperScan 指定需要扫描的mybatis的接口类

@ConfigurationpublicclassDatasourceConfig {
//destroy-method="close"的作用是当数据库连接不使用的时候,就把该连接重新放到数据池中,方便下次使用调用.@Bean(destroyMethod="close", name=DataSources.MASTER_DB)
@ConfigurationProperties(prefix="spring.datasource")
publicDataSourcedataSource() {
returnDataSourceBuilder.create().type(DruidDataSource.class).build();
    }
@Bean(destroyMethod="close", name=DataSources.SLAVE_DB)
@ConfigurationProperties(prefix="spring.datasourceSlave")
publicDataSourcedataSourceSlave() {
returnDataSourceBuilder.create().type(DruidDataSource.class).build();
    }
}

4、配置成动态数据源:

@Configuration@MapperScan(basePackages= {"com.xxx.dao"})  // 这里需要替换为实际的路径publicclassMybatisConfig {
@Autowired@Qualifier(Datasources.MASTER_DB)
privateDataSourcemasterDB;
@Autowired@Qualifier(DataSources.SLAVE_DB)
privateDataSourceslaveDB;
/*** 动态数据源*/@Bean(name="dynamicDataSource")
publicDataSourcedynamicDataSource() {
DynamicDataSourcedynamicDataSource=newDynamicDataSource();
// 默认数据源dynamicDataSource.setDefaultTargetDataSource(masterDB);
// 配置多数据源Map<Object, Object>dsMap=Maps.newHashMap();
dsMap.put(DataSources.MASTER_DB, masterDB);
dsMap.put(DataSources.SLAVE_DB, slaveDB);
dynamicDataSource.setTargetDataSources(dsMap);
returndynamicDataSource;
    }
@Bean@ConfigurationProperties(prefix="mybatis")
publicSqlSessionFactoryBeansqlSessionFactoryBean() {
SqlSessionFactoryBeansqlSessionFactoryBean=newSqlSessionFactoryBean();
// 配置数据源,此处配置为关键配置,如果没有将 dynamicDataSource 作为数据源则不能实现切换sqlSessionFactoryBean.setDataSource(dynamicDataSource());
returnsqlSessionFactoryBean;
    }
}

第三步、使用ThreadLocal安全的管理当前进程使用的数据源连接

@Slf4jpublicclassDataSourceContextHolder {
/*** 默认数据源*/publicstaticfinalStringDEFAULT_DATASOURCE=DataSources.MASTER_DB;
privatestaticfinalThreadLocal<String>contextHolder=newThreadLocal<>();
// 设置数据源名publicstaticvoidsetDB(StringdbType) {
log.debug("切换到{}数据源", dbType);
contextHolder.set(dbType);
    }
// 获取数据源名publicstaticStringgetDB() {
return (contextHolder.get());
    }
// 清除数据源名publicstaticvoidclearDB() {
contextHolder.remove();
    }
}

第四步、通过编写切面,对所有我们自定义切库注解的方法进行拦截,动态的选择数据源

这里是为下一步提供铺垫,动态调整DataSourceContextHolder里存储的值,使用threadLocal来管理是为了避免多线程之间互相影响。

自定义注解,核心的处理就是写处理这个注解的逻辑,然后通过指定的拦截方案根据当前的数据做一些动态的处理。比如Spring提供的@Controller、@Service等注解,都是需要我们在配置文件里配置好需要扫描的路径,然后项目启动时,spring根据配置去指定路径读取这些配置,然后这些类才可以被spring进行管理。

这里不要忽略了默认数据源要选择主库,如果切库出现什么问题,比如配置错误等,可以保证访问主库来得到正确的结果;另外,请求完了不要忘记调用提供的clearDB的操作,防止threadLocal误用带来的内存泄露。

@Aspect@Component@Slf4jpublicclassDynamicDataSourceAspect {
@Before("@annotation(RoutingDataSource)")
publicvoidbeforeSwitchDS(JoinPointpoint){
//获得当前访问的classClass<?>className=point.getTarget().getClass();
//获得访问的方法名StringmethodName=point.getSignature().getName();
//得到方法的参数的类型Class[] argClass= ((MethodSignature)point.getSignature()).getParameterTypes();
StringdataSource=DataSourceContextHolder.DEFAULT_DATASOURCE;
try {
// 得到访问的方法对象Methodmethod=className.getMethod(methodName, argClass);
// 判断是否存在@DS注解if (method.isAnnotationPresent(RoutingDataSource.class)) {
RoutingDataSourceannotation=method.getAnnotation(RoutingDataSource.class);
// 取出注解中的数据源名dataSource=annotation.value();
            }
        } catch (Exceptione) {
log.error("routing datasource exception, "+methodName, e);
        }
// 切换数据源DataSourceContextHolder.setDB(dataSource);
    }
@After("@annotation(RoutingDataSource)")
publicvoidafterSwitchDS(JoinPointpoint){
DataSourceContextHolder.clearDB();
    }
}

第五步、动态的取出我们在切面里设置的数据源的字符串即可

这里需要把原理介绍一下,在连接数据库时其实是先选择一个配置好的spring管理的datasource的id,就是我们之前在 DatasourceConfig 类里定义的Datasource实体类的id:masterDB 和 slaveDB。然后根据id去spring的上下文选择配置,进行数据库连接。有兴趣的可以看一下源码。

@Slf4jpublicclassDynamicDataSourceextendsAbstractRoutingDataSource {
@OverrideprotectedObjectdetermineCurrentLookupKey() {
log.debug("数据源为{}", DataSourceContextHolder.getDB());
returnDataSourceContextHolder.getDB();
    }
}

第六步、取消自动配置数据源,使用我们这里定义的数据源配置

在SpringBoot启动类上通常直接使用@SpringBootApplication就可以了,这里需要调整为:

@SpringBootApplication(exclude= {
DataSourceAutoConfiguration.class})

使用

如何使用呢,我们简单演示一下:

@ServicepublicclassDataSourceRoutingService {
@ResourceprivateSysUserMappersysUserMapper;
@RoutingDataSource(DataSources.MASTER_DB) // 这个注解这时是可以省略,因为默认就是访问主库publicSysUsertest1(intid) {
returnsysUserMapper.selectByPrimaryKey(id);
    }
@RoutingDataSource(DataSources.SLAVE_DB)
publicSysUsertest2(intid) {
returnsysUserMapper.selectByPrimaryKey(id);
    }
}

如此,数据库切库就OK了。如果你的系统已经有主库、从库之分了,那么赶紧在你的系统里利用起来吧。

扩展

这里呢,还可以支持多个扩展。比如现在一个主库后面有多个从库,在切面拿到需要切换从库时,还可以选择随机选择一个,或者根据类名、方法名或业务配置等选择某一个从库,这样不但可以分担每个从库的压力,也可以有针对性的让指定的读请求打到指定的从库上。如果有多个主库,也可以有更多的选择~

相关实践学习
如何快速连接云数据库RDS MySQL
本场景介绍如何通过阿里云数据管理服务DMS快速连接云数据库RDS MySQL,然后进行数据表的CRUD操作。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
目录
相关文章
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
52 0
|
1月前
|
Java 数据库连接 测试技术
SpringBoot入门 - 添加内存数据库H2
SpringBoot入门 - 添加内存数据库H2
48 3
SpringBoot入门 - 添加内存数据库H2
|
9天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
52 14
|
20小时前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
|
20小时前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
20小时前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
27天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
41 4
|
27天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
102 2
|
27天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
46 2
|
27天前
|
Java 关系型数据库 数据库连接
使用 Spring Boot 执行数据库操作:全面指南
使用 Spring Boot 执行数据库操作:全面指南
99 1