ShardingSphere-ShardingJDBC 内置行表达式算法详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00357/article/details/148362693

ShardingSphere-ShardingJDBC 内置行表达式算法详解

shardingsphere 项目地址: https://gitcode.com/gh_mirrors/shard/shardingsphere

什么是行表达式算法

在ShardingSphere-ShardingJDBC中，行表达式算法是一种用于简化分片配置的表达式语言。它允许开发者通过简洁的语法来定义数据分片规则，特别是对于分片表名的生成逻辑。这种机制极大地简化了分库分表场景下的配置工作。

行表达式的几种实现类型

ShardingSphere提供了多种行表达式实现方式，每种方式适用于不同的场景：

1. Groovy语法实现（GROOVY）

这是最常用的行表达式实现，使用Groovy语法来定义表达式。

语法特点：

使用${ expression }或$->{ expression }标识表达式
支持Groovy的所有操作
${begin..end}表示范围区间
${[unit1, unit2, unit_x]}表示枚举值

示例解析：

<GROOVY>t_order_${1..3} → 生成t_order_1, t_order_2, t_order_3
<GROOVY>${['online', 'offline']}_table${1..3} → 生成6个组合表名

技术原理： 这种实现实际上是在运行时解析Groovy脚本，将表达式转换为具体的表名列表。它支持复杂的逻辑运算和组合，非常适合需要灵活配置的场景。

2. 标准列表实现（LITERAL）

这种实现直接使用标准列表，不做任何表达式解析。

适用场景：

当Groovy表达式在GraalVM Native Image环境下使用不便时
需要直接指定明确表名列表时

示例：

<LITERAL>t_order_1, t_order_2, t_order_3 → 直接输出相同内容
<LITERAL>t_order_${1..3} → 不会解析表达式，原样输出

3. 固定时间间隔实现（INTERVAL）

这是一种专门为时间分片设计的实现，使用键值对语法定义时间范围。

键值说明：

P：前缀，如t_order_
SP：时间戳格式，如yyyyMMdd
DIA：时间间隔量
DIU：时间间隔单位
DL：时间下限
DU：时间上限
C：日历系统（可选）

示例解析：

<INTERVAL>P=t_order_;SP=yyyy_MM;DIA=1;DIU=Months;DL=2023_10;DU=2023_12 → 生成3个月份的表名
<INTERVAL>P=t_order_;SP=GGGGyyyy_MM_dd;DIA=1;DIU=Days;DL=平成0001_12_05;DU=平成0001_12_06;C=Japanese → 支持日本日历系统

技术细节： 这种实现内部使用Java的DateTimeFormatter进行时间格式化，支持各种时间单位和日历系统，非常适合按时间分片的场景。

4. GraalVM Espresso实现（ESPRESSO）

这是一种实验性实现，通过GraalVM Truffle的Espresso实现在GraalVM Native Image环境下支持Groovy语法。

特点：

语法与GROOVY实现相同
需要额外依赖
目前仅支持Linux amd64环境

使用限制： 由于是实验性功能，不建议在生产环境使用，除非你明确了解其限制条件。

自定义实现

当内置实现不能满足需求时，可以创建自定义的行表达式解析器。

实现步骤：

实现InlineExpressionParser接口
在META-INF/services/下注册实现类
在配置中使用自定义类型标识

应用场景：

需要从外部系统获取表名列表
需要实现特殊的分片逻辑
需要集成其他表达式语言

配置使用指南

在实际配置中，行表达式通常用于以下场景：

actualDataNodes：定义实际的数据节点
algorithm-expression：定义分片算法表达式

示例配置：

rules:
- !SHARDING
  tables:
    t_order: 
      actualDataNodes: <LITERAL>ds_0.t_order_0, ds_0.t_order_1
      tableStrategy: 
        standard:
          shardingColumn: order_id
          shardingAlgorithmName: t_order_inline
  shardingAlgorithms:
    t_order_inline:
      type: INLINE
      props:
        algorithm-expression: t_order_${order_id % 2}

注意事项：