数据库中间件 Sharding-JDBC 源码分析 —— SQL 路由

1. 概述

本文分享分表分库路由相关的实现。涉及内容如下：

• SQL 路由器
• 路由引擎
• SQL 路由结果

SQL 路由大体流程如下：

第二个步骤其实是 SQL 的解析过程，在上一篇<>已经介绍了。所以，严格来说，SQL 解析过程是在路由阶段里的。

2. SQL 路由器

SQLRouter，SQL 路由器接口，共有两种实现：

• DatabaseHintSQLRouter：通过提示且仅路由至数据库的SQL路由器
• ParsingSQLRouter：需要解析的SQL路由器

它们实现 #parse() 进行 SQL 解析， #route() 进行 SQL 路由。

2.1 DatabaseHintSQLRouter

DatabaseHintSQLRouter，基于数据库提示的路由引擎。路由器工厂 SQLRouterFactory 创建路由器时，判断到使用数据库提示( Hint ) 时，创建 DatabaseHintSQLRouter。

    // DatabaseHintRoutingEngine.java
    public static SQLRouter createSQLRouter(final ShardingContext shardingContext) {
       return HintManagerHolder.isDatabaseShardingOnly() ? new DatabaseHintSQLRouter(shardingContext) : new ParsingSQLRouter(shardingContext);
    }

先来看下 HintManagerHolder、HintManager 部分相关的代码：

public final class HintManagerHolder {
    
    public static final String DB_TABLE_NAME = "DB_TABLE_NAME";
    
    public static final String DB_COLUMN_NAME = "DB_COLUMN_NAME";
    
    private static final ThreadLocal HINT_MANAGER_HOLDER = new ThreadLocal<>();
    
    /**
     * 判断是否当前只分库.
     * 
     * @return database sharding only or not
     */
    public static boolean isDatabaseShardingOnly() {
        return null != HINT_MANAGER_HOLDER.get() && HINT_MANAGER_HOLDER.get().isDatabaseShardingOnly();
    }
    
    /**
     * 清理线索分片管理器的本地线程持有者.
     */
    public static void clear() {
        HINT_MANAGER_HOLDER.remove();
    }

    /**
     * Get hint manager in current thread.
     * 
     * @return hint manager in current thread
     */
    public static HintManager get() {
        return HINT_MANAGER_HOLDER.get();
    }
}

public final class HintManager implements AutoCloseable {
    
    private final Map databaseShardingValues = new HashMap<>();
   
    @Getter
    private boolean databaseShardingOnly;
    
    /**
     * 获取线索分片管理器实例.
     *
     * @return  {@code HintManager} instance
     */
    public static HintManager getInstance() {
        HintManager result = new HintManager();
        HintManagerHolder.setHintManager(result);
        return result;
    }
    
    /**
     * 设置分库分片值.
     *
     * 
该方法适用于只分库的场景
     *
     * @param value sharding value
     */
    public void setDatabaseShardingValue(final Comparable value) {
        databaseShardingOnly = true;
        addDatabaseShardingValue(HintManagerHolder.DB_TABLE_NAME, HintManagerHolder.DB_COLUMN_NAME, value);
    }
    
}

那么如果要使用 DatabaseHintSQLRouter，我们只需要 HintManager.getInstance().setDatabaseShardingValue(库分片值) 即可。这里有两点要注意下：

• HintManager#getInstance()，每次获取到的都是新的 HintManager，多次赋值需要小心。
• HintManager#close()，使用完需要去清理，避免下个请求读到遗漏的线程变量。

Hint 方式主要使用场景：

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

2.2 ParsingSQLRouter

在我们平常的业务场景中，使用最多的是分片字段会在 SQL、数据库表结构中，其将采用 ParsingSQLRouter 进行 SQL 的解析和路由。

ParsingSQLRouter 使用 SQLParsingEngine 解析SQL（上篇文章已经介绍）。

ParsingSQLRouter 在路由时，会根据表情况使用 SimpleRoutingEngine 或 CartesianRoutingEngine 进行路由ParsingSQLRouter#route(parameters, sqlStatement):

private RoutingResult route(final List