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

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
云数据库 RDS MySQL,高可用系列 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了。如果你的系统已经有主库、从库之分了,那么赶紧在你的系统里利用起来吧。

扩展

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

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
目录
相关文章
|
2月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
373 2
|
3月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
536 128
|
3月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
295 12
|
3月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
550 5
存储 人工智能 机器人
105 0
|
3月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
184 0
探索Spring Boot的@Conditional注解的上下文配置
|
3月前
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
133 0
Spring中最大化@Lazy注解,实现资源高效利用
|
3月前
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
359 1
使用Spring的@Retryable注解进行自动重试
|
3月前
|
Java 测试技术 编译器
@GrpcService使用注解在 Spring Boot 中开始使用 gRPC
本文介绍了如何在Spring Boot应用中集成gRPC框架,使用`@GrpcService`注解实现高效、可扩展的服务间通信。内容涵盖gRPC与Protocol Buffers的原理、环境配置、服务定义与实现、测试方法等,帮助开发者快速构建高性能的微服务系统。
573 0
|
3月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
421 0

热门文章

最新文章