《ShardingSphere解读》04 配置驱动：ShardingSphere 中的配置体系是如何设计的？

ShardingSphere 提供了高度抽象的配置体系开发者只需通过声明式配置即可定义分片规则、读写分离策略、数据脱敏规则等而无需关心底层的复杂实现。那么这套配置体系究竟是如何设计的它包含了哪些核心概念不同的配置方式背后又遵循着怎样的实现原理本篇将深入剖析 ShardingSphere 的配置体系为你揭开其神秘面纱。一、行表达式配置的“语法糖”在深入配置体系之前必须先了解 ShardingSphere 中一个极其实用的功能——行表达式。它是一种轻量级的动态表达式语言用于简化配置中的重复性描述尤其在定义数据节点和分片算法时发挥着重要作用。1.1 行表达式的基本语法行表达式的使用非常直观只需要在配置中使用${expression}或$-{expression}形式即可。其中${begin..end}表示从begin到end的范围区间而多个${expression}之间用.连接表示多个范围的笛卡尔积。例如表达式ds${0..1}.user${0..1}将解析为ds0.user0ds0.user1ds1.user0ds1.user1这一过程可以用下图直观展示除了范围表示法行表达式还支持枚举${[enum1, enum2, ...]}。因此上面的表达式也可以写成ds${[0,1]}.user${[0,1]}效果完全相同。1.2 行表达式在分片算法中的应用行表达式另一个典型应用场景是配置分片算法。例如我们见过这样的配置ds${age % 2}它表示根据age字段对 2 取模动态路由到ds0或ds1。这种表达方式极大地简化了分片算法的配置开发者无需编写复杂的 Java 代码只需一行表达式即可完成。1.3 注意事项由于${expression}与 Spring 属性占位符如${...}存在冲突当在 Spring 环境中使用时推荐采用$-{expression}的形式以避免解析混淆。行表达式作为配置的“语法糖”让 ShardingSphere 的配置变得更加简洁、直观。接下来我们将正式进入配置体系的核心看看 ShardingSphere 到底定义了哪些配置项。二、ShardingSphere 核心配置解析ShardingSphere 的配置体系以规则为中心每种功能分片、读写分离、数据脱敏等对应一个规则配置类。其中分片引擎是最核心的功能其配置也是最复杂的。下面我们以分片引擎为例逐一剖析其核心配置项。2.1 ShardingRuleConfiguration分片规则的顶层入口ShardingRuleConfiguration是所有分片相关配置的容器它聚合了多个子配置包括表规则、绑定表、广播表、默认策略等。其类结构如下各属性含义如下属性类型说明tableRuleConfigsCollectionTableRuleConfiguration表分片规则列表每个逻辑表对应一个配置是必须配置的项。bindingTableGroupsCollectionString绑定表组将具有相同分片规则的主表与子表关联避免跨库关联查询。broadcastTablesCollectionString广播表指那些数据量小、需要同步到所有分片的表如字典表。defaultDataSourceNameString默认数据源当分片规则无法匹配时路由到该数据源。defaultDatabaseShardingStrategyConfigShardingStrategyConfiguration默认分库策略若表规则未指定分库策略则使用此默认策略。defaultTableShardingStrategyConfigShardingStrategyConfiguration默认分表策略若表规则未指定分表策略则使用此默认策略。defaultKeyGeneratorConfigKeyGeneratorConfiguration默认自增列生成器配置。masterSlaveRuleConfigsCollectionMasterSlaveRuleConfiguration读写分离规则配置可定义多个主从架构。encryptRuleConfigEncryptRuleConfiguration数据脱敏规则配置。2.2 TableRuleConfiguration表级分片规则TableRuleConfiguration是实际定义逻辑表如何分片的配置类。其核心属性如下logicTable逻辑表名在 SQL 中使用的表名例如t_order。actualDataNodes真实数据节点由数据源名和表名组成支持行表达式。例如ds${0..1}.t_order${0..1}。databaseShardingStrategyConfig分库策略决定 SQL 路由到哪个数据源。tableShardingStrategyConfig分表策略决定 SQL 路由到该数据源下的哪张表。keyGeneratorConfig分布式主键生成器配置如雪花算法、UUID 等。2.3 ShardingStrategyConfiguration分片策略的抽象ShardingStrategyConfiguration是一个空接口其实现类代表了不同的分片策略。类层次结构如下StandardShardingStrategy标准分片策略支持单分片键并提供精确分片算法PreciseShardingAlgorithm和范围分片算法RangeShardingAlgorithm。ComplexShardingStrategy复合分片策略支持多分片键使用ComplexKeysShardingAlgorithm。InlineShardingStrategy行表达式分片策略通过行表达式定义分片算法如age % 2。HintShardingStrategy强制路由分片策略通过 Hint 方式指定分片目标不依赖 SQL 中的分片键。NoneShardingStrategy无分片策略适用于不需要分片的表。2.4 KeyGeneratorConfiguration分布式主键生成器分布式环境下数据库自增主键无法保证全局唯一因此需要引入分布式主键生成器。KeyGeneratorConfiguration用于配置生成器public class KeyGeneratorConfiguration { private String column; // 自增列名 private String type; // 生成器类型如 SNOWFLAKE、UUID private Properties props; // 生成器属性如雪花算法的 workerId }ShardingSphere 内置了雪花算法SNOWFLAKE和 UUID 两种实现开发者也可通过 SPI 机制自定义。三、四种配置方式详解ShardingSphere 提供了四种配置方式以适应不同的开发场景和团队偏好。下面逐一介绍其特点及使用示例。3.1 Java 代码配置Java 代码配置是最原始的方式直接使用 ShardingSphere 提供的 API 构建配置对象。优点是类型安全、IDE 友好适合对底层原理的学习和定制化开发缺点是配置变更需重新编译不利于动态管理。示例构建分片数据源// 配置真实数据源 MapString, DataSource dataSourceMap new HashMap(); dataSourceMap.put(ds0, createDataSource(jdbc:mysql://localhost:3306/ds0)); dataSourceMap.put(ds1, createDataSource(jdbc:mysql://localhost:3306/ds1)); // 配置 t_order 表规则 TableRuleConfiguration orderTableRule new TableRuleConfiguration(t_order, ds${0..1}.t_order${0..1}); orderTableRule.setDatabaseShardingStrategyConfig(new InlineShardingStrategyConfiguration(user_id, ds${user_id % 2})); orderTableRule.setTableShardingStrategyConfig(new InlineShardingStrategyConfiguration(order_id, t_order${order_id % 2})); // 配置分片规则 ShardingRuleConfiguration shardingRuleConfig new ShardingRuleConfiguration(); shardingRuleConfig.getTableRuleConfigs().add(orderTableRule); // 获取数据源 DataSource dataSource ShardingDataSourceFactory.createDataSource(dataSourceMap, shardingRuleConfig, new Properties());3.2 Yaml 配置Yaml 配置是 ShardingSphere 官方推荐的配置方式具有结构清晰、可读性强、易于版本管理等优点。配置可独立于代码存放通过加载 Yaml 文件动态创建数据源。示例分片配置sharding.yamldataSources: ds0: !!com.zaxxer.hikari.HikariDataSource driverClassName: com.mysql.jdbc.Driver jdbcUrl: jdbc:mysql://localhost:3306/ds0 username: root password: root ds1: !!com.zaxxer.hikari.HikariDataSource driverClassName: com.mysql.jdbc.Driver jdbcUrl: jdbc:mysql://localhost:3306/ds1 username: root password: root shardingRule: tables: t_order: actualDataNodes: ds${0..1}.t_order${0..1} databaseStrategy: inline: shardingColumn: user_id algorithmExpression: ds${user_id % 2} tableStrategy: inline: shardingColumn: order_id algorithmExpression: t_order${order_id % 2} bindingTables: - t_order defaultDataSourceName: ds0加载 Yaml 文件File yamlFile new File(path/to/sharding.yaml); DataSource dataSource YamlShardingDataSourceFactory.createDataSource(yamlFile);3.3 Spring Boot 配置Spring Boot 已成为 Java 微服务的事实标准ShardingSphere 提供了spring-boot-starter只需在application.properties或application.yml中添加配置即可。示例Spring Boot 分片配置# 数据源定义 spring.shardingsphere.datasource.namesds0,ds1 spring.shardingsphere.datasource.ds0.typecom.zaxxer.hikari.HikariDataSource spring.shardingsphere.datasource.ds0.driver-class-namecom.mysql.jdbc.Driver spring.shardingsphere.datasource.ds0.jdbc-urljdbc:mysql://localhost:3306/ds0 spring.shardingsphere.datasource.ds0.usernameroot spring.shardingsphere.datasource.ds0.passwordroot spring.shardingsphere.datasource.ds1.typecom.zaxxer.hikari.HikariDataSource spring.shardingsphere.datasource.ds1.driver-class-namecom.mysql.jdbc.Driver spring.shardingsphere.datasource.ds1.jdbc-urljdbc:mysql://localhost:3306/ds1 spring.shardingsphere.datasource.ds1.usernameroot spring.shardingsphere.datasource.ds1.passwordroot # 分片规则 spring.shardingsphere.sharding.tables.t_order.actual-data-nodesds$-{0..1}.t_order$-{0..1} spring.shardingsphere.sharding.tables.t_order.database-strategy.inline.sharding-columnuser_id spring.shardingsphere.sharding.tables.t_order.database-strategy.inline.algorithm-expressionds$-{user_id % 2} spring.shardingsphere.sharding.tables.t_order.table-strategy.inline.sharding-columnorder_id spring.shardingsphere.sharding.tables.t_order.table-strategy.inline.algorithm-expressiont_order$-{order_id % 2} spring.shardingsphere.sharding.binding-tablest_order # 属性配置 spring.shardingsphere.props.sql.showtrue通过这四种方式开发者可以根据项目实际情况灵活选择。其中Yaml 和 Spring Boot 配置是当前最主流的用法。四、配置体系的实现原理了解了配置的使用方式后我们不禁要问这些配置是如何转化为 ShardingSphere 内部对象的其底层实现机制是什么下面以 Yaml 配置为例深入剖析配置体系的实现原理。4.1 从 ShardingRuleConfiguration 到 DataSource无论采用哪种配置方式最终目标都是构建一个DataSource对象供应用使用。以 Java 代码配置为例ShardingDataSourceFactory是入口public final class ShardingDataSourceFactory { public static DataSource createDataSource( MapString, DataSource dataSourceMap, ShardingRuleConfiguration shardingRuleConfig, Properties props) throws SQLException { return new ShardingDataSource(dataSourceMap, new ShardingRule(shardingRuleConfig, dataSourceMap.keySet()), props); } }ShardingRule是对ShardingRuleConfiguration的封装内部完成了规则校验、策略初始化等操作。因此配置体系的核心就是将外部配置Yaml/Spring转换为ShardingRuleConfiguration对象。4.2 Yaml 配置的加载与转换ShardingSphere 为 Yaml 配置设计了一套完整的解析与转换机制核心类图如下流程如下加载 Yaml 文件YamlEngine.unmarshal(yamlFile, YamlRootShardingConfiguration.class)通过 SnakeYAML 库将文件内容解析为YamlRootShardingConfiguration对象。获取 Yaml 规则从YamlRootShardingConfiguration中获取YamlShardingRuleConfiguration。转换为核心规则调用ShardingRuleConfigurationYamlSwapper.swap(yamlShardingRuleConfiguration)将 Yaml 配置对象转换为ShardingRuleConfiguration。创建 DataSource将dataSourceMap、转换后的ShardingRuleConfiguration和props传入ShardingDataSourceFactory.createDataSource最终得到DataSource。其中ShardingRuleConfigurationYamlSwapper的swap方法实现了字段的一一映射代码结构清晰例如Override public ShardingRuleConfiguration swap(final YamlShardingRuleConfiguration yamlConfiguration) { ShardingRuleConfiguration result new ShardingRuleConfiguration(); // 转换表规则 for (EntryString, YamlTableRuleConfiguration entry : yamlConfiguration.getTables().entrySet()) { YamlTableRuleConfiguration tableRuleConfig entry.getValue(); tableRuleConfig.setLogicTable(entry.getKey()); result.getTableRuleConfigs().add(tableRuleConfigurationYamlSwapper.swap(tableRuleConfig)); } // 转换绑定表 result.getBindingTableGroups().addAll(yamlConfiguration.getBindingTables()); // 转换默认策略 if (null ! yamlConfiguration.getDefaultDatabaseStrategy()) { result.setDefaultDatabaseShardingStrategyConfig( shardingStrategyConfigurationYamlSwapper.swap(yamlConfiguration.getDefaultDatabaseStrategy())); } // ... 其他字段 return result; }4.3 Spring 命名空间与 Spring Boot 的实现Spring 命名空间和 Spring Boot Starter 的实现原理类似都是通过 Spring 的扩展机制将配置转换为 ShardingSphere 的内部对象。Spring 命名空间通过实现NamespaceHandler和BeanDefinitionParser将 XML 元素解析为对应的BeanDefinition最终创建出DataSource实例。Spring Boot Starter通过Configuration和ConditionalOnProperty等注解自动加载配置并创建DataSource。其核心是ShardingSphereAutoConfiguration类它读取spring.shardingsphere前缀的配置构建规则对象并返回数据源。由于篇幅限制这里不再展开后续将专门讲解 ShardingSphere 与 Spring 的集成原理。五、小结本篇深入剖析了 ShardingSphere 的配置体系从行表达式这一“语法糖”入手详细介绍了分片核心配置项ShardingRuleConfiguration、TableRuleConfiguration、ShardingStrategyConfiguration、KeyGeneratorConfiguration的含义与作用。随后我们对比了四种配置方式Java 代码、Yaml、Spring 命名空间、Spring Boot并给出了具体示例。最后从源码层面揭示了 Yaml 配置的加载与转换机制帮助读者理解配置体系的底层实现。掌握配置体系是熟练使用 ShardingSphere 的基础。后续我们将基于这些配置深入探讨分片引擎的执行流程、读写分离、数据脱敏等高级功能。思考题在 ShardingSphere 中配置体系相关的核心类之间存在什么样的关联关系结合本篇的类图尝试画出 Yaml 配置到核心配置的完整转换链条。欢迎在评论区分享你的理解。