Java实战系列(1):基于ShardingSphere Hint策略实现SpringBoot多数据源动态路由

张开发
2026/4/11 0:18:40 15 分钟阅读

分享文章

Java实战系列(1):基于ShardingSphere Hint策略实现SpringBoot多数据源动态路由
1. ShardingSphere Hint策略的核心价值在实际业务开发中我们经常会遇到需要动态切换数据源的场景。比如电商系统中用户数据和订单数据可能分布在不同的数据库实例SaaS应用中不同租户的数据需要隔离存储。传统做法是通过手动切换DataSource对象或者AOP切面实现但这些方案要么侵入性强要么灵活性不足。ShardingSphere的Hint策略提供了一种更优雅的解决方案。它通过ThreadLocal机制允许开发者在运行时动态指定数据源路由规则。我去年在开发一个金融风控系统时就深有体会 - 当需要同时访问客户基础信息库和交易记录库时HintManager就像个智能交通指挥员精确地将SQL请求引导到目标数据库。与基于SQL解析的路由方式相比Hint策略最大的特点是绕过SQL分析。举个例子当我们需要强制查询主库时比如刚写入后立即查询的场景Hint可以直接指定主库路由避免了从库延迟导致的数据不一致问题。这种编程式的控制方式特别适合以下三种典型场景读写分离强制读主库重要业务查询需要获取最新数据多租户数据隔离根据租户ID自动路由到对应数据库业务分库像用户库、订单库等垂直分库场景2. 环境搭建与基础配置2.1 项目初始化我们先从创建一个标准的SpringBoot项目开始。推荐使用IDEA的Spring Initializr选择这些基础依赖Spring Web提供Web能力MyBatis Plus简化数据库操作Lombok减少样板代码pom.xml关键配置如下dependencies !-- 基础SpringBoot Starter -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency !-- 数据库相关 -- dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId version8.0.28/version /dependency dependency groupIdcom.baomidou/groupId artifactIdmybatis-plus-boot-starter/artifactId version3.5.2/version /dependency !-- ShardingSphere -- dependency groupIdorg.apache.shardingsphere/groupId artifactIdsharding-jdbc-spring-boot-starter/artifactId version5.2.1/version /dependency /dependencies2.2 数据库准备为了模拟真实场景我们在本地MySQL创建两个数据库-- 用户库 CREATE DATABASE ds_user; USE ds_user; CREATE TABLE t_user ( id BIGINT PRIMARY KEY AUTO_INCREMENT, username VARCHAR(50) NOT NULL ); -- 订单库 CREATE DATABASE ds_order; USE ds_order; CREATE TABLE t_order ( id BIGINT PRIMARY KEY AUTO_INCREMENT, user_id BIGINT NOT NULL, amount DECIMAL(10,2) NOT NULL );注意这里我特意把表名改为t_user和t_order避免使用MySQL关键字带来的问题。在实际项目中规范的表命名可以省去很多麻烦。3. Hint策略的完整实现3.1 配置多数据源application.yml的核心配置如下spring: shardingsphere: datasource: names: ds_user,ds_order ds_user: type: com.zaxxer.hikari.HikariDataSource driver-class-name: com.mysql.cj.jdbc.Driver jdbc-url: jdbc:mysql://localhost:3306/ds_user username: root password: 123456 ds_order: type: com.zaxxer.hikari.HikariDataSource driver-class-name: com.mysql.cj.jdbc.Driver jdbc-url: jdbc:mysql://localhost:3306/ds_order username: root password: 123456 sharding: default-database-strategy: hint: algorithm-class-name: com.example.sharding.algorithm.CustomHintAlgorithm这里有几个关键点需要注意数据源名称(ds_user,ds_order)需要与后续算法中的逻辑一致使用HikariCP作为连接池是生产级推荐MySQL 8需要使用cj.jdbc驱动3.2 实现Hint分片算法创建CustomHintAlgorithm类实现HintShardingAlgorithm接口public class CustomHintAlgorithm implements HintShardingAlgorithmString { Override public CollectionString doSharding( CollectionString availableTargetNames, HintShardingValueString shardingValue) { CollectionString result new LinkedHashSet(); for (String value : shardingValue.getValues()) { for (String datasourceName : availableTargetNames) { if (datasourceName.endsWith(value)) { result.add(datasourceName); } } } return result; } }这个算法的核心逻辑是根据HintManager设置的值如user或order匹配对应的数据源名称。我采用endsWith而不是equals是为了让代码更具扩展性 - 比如未来可以有ds_user_01、ds_user_02等分库场景。3.3 使用HintManager控制路由在Service层实现动态切换Service public class OrderService { Autowired private OrderMapper orderMapper; public Order getOrderWithUser(Long orderId) { Order order null; try (HintManager hintManager HintManager.getInstance()) { // 先查订单库 hintManager.setDatabaseShardingValue(order); order orderMapper.selectById(orderId); // 再查用户库 hintManager.setDatabaseShardingValue(user); User user userMapper.selectById(order.getUserId()); order.setUser(user); } return order; } }这里使用了try-with-resources语法确保HintManager总是能被正确关闭。我在实际项目中就遇到过因为忘记close()导致的线程污染问题 - 某个线程的路由规则意外影响了其他线程。4. 高级应用与优化4.1 结合AOP实现自动路由为了减少样板代码我们可以定义注解和切面Target(ElementType.METHOD) Retention(RetentionPolicy.RUNTIME) public interface RouteDataSource { String value(); } Aspect Component public class DataSourceRouteAspect { Around(annotation(routeDataSource)) public Object around(ProceedingJoinPoint joinPoint, RouteDataSource routeDataSource) throws Throwable { try (HintManager hintManager HintManager.getInstance()) { hintManager.setDatabaseShardingValue(routeDataSource.value()); return joinPoint.proceed(); } } }使用方式变得非常简单RouteDataSource(user) public User getUser(Long id) { return userMapper.selectById(id); }4.2 读写分离特殊处理有时候我们需要强制读主库public User getFreshUser(Long id) { try (HintManager hintManager HintManager.getInstance()) { // 强制主库路由 hintManager.setMasterRouteOnly(); return userMapper.selectById(id); } }这个特性在金融交易等对数据实时性要求高的场景特别有用。4.3 性能优化建议HintManager复用在同一个业务方法中多次切换数据源时不要重复创建HintManager连接池配置根据业务压力调整各数据源的连接池参数监控集成通过ShardingSphere的Metrics功能监控路由情况5. 踩坑记录与解决方案5.1 事务管理问题在Transactional方法中使用Hint策略时需要注意Spring的事务管理器会缓存Connection解决方法在事务方法开始前就设置好Hint值Transactional public void businessMethod() { // 必须在事务内第一个操作前设置 HintManager hintManager HintManager.getInstance(); try { hintManager.setDatabaseShardingValue(user); // 业务操作... } finally { hintManager.close(); } }5.2 线程池污染在异步任务中使用Hint时务必注意// 错误示例 - 会导致路由信息泄露到其他任务 executor.execute(() - { HintManager hintManager HintManager.getInstance(); try { hintManager.setDatabaseShardingValue(user); // 业务逻辑 } finally { hintManager.close(); } }); // 正确做法 - 使用ThreadLocal传递 executor.execute(() - { try (HintManager hintManager HintManager.getInstance()) { hintManager.setDatabaseShardingValue(user); // 业务逻辑 } });5.3 YAML配置陷阱注意缩进问题导致的配置失效# 错误配置缩进不正确 sharding: default-database-strategy: # 这里少缩进 hint: algorithm-class-name: ... # 正确配置 sharding: default-database-strategy: hint: algorithm-class-name: ...6. 真实业务场景案例去年我在开发一个跨境电商平台时遇到了这样的需求基础数据用户、商品存放在AWS东京区域订单数据由于合规要求必须存放在新加坡区域报表查询需要同时访问两个区域的数据通过ShardingSphere Hint策略我们实现了这样的架构public OrderDetail getGlobalOrderDetail(String orderId) { OrderDetail detail new OrderDetail(); try (HintManager hintManager HintManager.getInstance()) { // 查询新加坡订单数据 hintManager.setDatabaseShardingValue(sg_order); Order order orderMapper.selectById(orderId); detail.setOrder(order); // 查询东京用户数据 hintManager.setDatabaseShardingValue(jp_user); User user userMapper.selectById(order.getUserId()); detail.setUser(user); } return detail; }这个方案相比跨库JOIN或者数据同步等方案具有以下优势完全避免数据跨境传输的合规风险各区域数据库可以独立扩展代码侵入性小业务开发无需关心底层存储位置在性能方面通过合理使用连接池和批处理跨境查询的延迟可以控制在可接受范围内平均约200ms。对于实时性要求不高的场景我们还增加了本地缓存进一步降低延迟。

更多文章