强制路由 #

简介 #

DBPlusEngine 使用 ThreadLocal 管理分片键值进行强制路由。可以通过编程的方式向 HintManager 中添加分片值，该分片值仅在当前线程内生效。
DBPlusEngine 还可以通过 SQL 中增加注释的方式进行强制路由。

Hint 的主要使用场景：

分片字段不存在 SQL 和数据库表结构中，而存在于外部业务逻辑。
强制在主库进行某些数据操作。

操作步骤 #

调用 HintManager.getInstance() 获取 HintManager 实例；
调用 HintManager.addDatabaseShardingValue，HintManager.addTableShardingValue 方法设置分片键值；
执行 SQL 语句完成路由和执行；
调用 HintManager.close 清理 ThreadLocal 中的内容。

配置示例 #

使用 Hint 分片 #

规则配置 #

Hint 分片算法需要用户实现 org.apache.shardingsphere.sharding.api.sharding.hint.HintShardingAlgorithm 接口。 DBPlusEngine 在进行路由时，将会从 HintManager 中获取分片值进行路由操作。

参考配置如下：

rules:
- !SHARDING
  tables:
    t_order:
      actualDataNodes: demo_ds_${0..1}.t_order_${0..1}
      databaseStrategy:
        hint:
          algorithmClassName: xxx.xxx.xxx.HintXXXAlgorithm
      tableStrategy:
        hint:
          algorithmClassName: xxx.xxx.xxx.HintXXXAlgorithm
  defaultTableStrategy:
    none:
  defaultKeyGenerateStrategy:
    type: SNOWFLAKE
    column: order_id

props:
    sql-show: true

获取 HintManager #

HintManager hintManager = HintManager.getInstance();

添加分片键值 #

使用 hintManager.addDatabaseShardingValue 来添加数据源分片键值。
使用 hintManager.addTableShardingValue 来添加表分片键值。

分库不分表情况下，强制路由至某一个分库时，可使用 hintManager.setDatabaseShardingValue 方式设置分片值。

清除分片键值 #

分片键值保存在 ThreadLocal 中，所以需要在操作结束时调用 hintManager.close() 来清除 ThreadLocal 中的内容。

hintManager 实现了 AutoCloseable 接口，可推荐使用 try with resource 自动关闭。

完整代码示例 #

// Sharding database and table with using HintManager
String sql = "SELECT * FROM t_order";
try (HintManager hintManager = HintManager.getInstance();
     Connection conn = dataSource.getConnection();
     PreparedStatement preparedStatement = conn.prepareStatement(sql)) {
    hintManager.addDatabaseShardingValue("t_order", 1);
    hintManager.addTableShardingValue("t_order", 2);
    try (ResultSet rs = preparedStatement.executeQuery()) {
        while (rs.next()) {
            // ...
        }
    }
}

// Sharding database without sharding table and routing to only one database with using HintManager
String sql = "SELECT * FROM t_order";
try (HintManager hintManager = HintManager.getInstance();
     Connection conn = dataSource.getConnection();
     PreparedStatement preparedStatement = conn.prepareStatement(sql)) {
    hintManager.setDatabaseShardingValue(3);
    try (ResultSet rs = preparedStatement.executeQuery()) {
        while (rs.next()) {
            // ...
        }
    }
}

使用 SQL 注释的方式 #

使用规范 #

SQL Hint 功能需要用户提前开启解析注释的配置，设置 sqlCommentParseEnabled 为 true。注释格式暂时只支持/* */，内容需要以ShardingSphere hint:开始，可选的属性包括：

{table}.SHARDING_DATABASE_VALUE：用于添加 {table} 表对应的数据源分片键值，多个属性使用逗号分隔；
{table}.SHARDING_TABLE_VALUE：用于添加 {table} 表对应的表分片键值，多个属性使用逗号分隔。

分库不分表情况下，强制路由至某一个分库时，可使用 SHARDING_DATABASE_VALUE 方式设置分片，无需指定 {table}。

完整示例 #

/* SHARDINGSPHERE_HINT: t_order.SHARDING_DATABASE_VALUE=1, t_order.SHARDING_TABLE_VALUE=1 */
SELECT * FROM t_order;