数据库中间件 Sharding-JDBC 源码分析 —— SQL 改写

1. 概述

本文分享SQL 改写的源码实现。主要涉及两方面：

1. SQL 改写：改写 SQL，解决分库分表后，查询结果需要聚合，需要对 SQL 进行调整，例如分页。
2. SQL 生成：生成分表分库的执行 SQL。

SQLRewriteEngine，SQL 重写引擎，实现 SQL 改写、生成功能。

2. SQLToken

SQLToken 在本文中很重要，所以即使在《SQL 解析》已经分享过，我们也换个姿势，再来一次。

SQLToken，SQL 标记对象接口。SQLRewriteEngine 基于 SQLToken 实现 SQL 改写。SQL 解析器在 SQL 解析过程中，很重要的一个目的是标记需要 SQL 改写的部分，也就是 SQLToken。

各 SQLToken 生成条件如下：

1. GeneratedKeyToken 自增主键标记对象

   • 插入SQL自增列不存在并且客户端设置了自增主键属性 generate-key-column： INSERT INTO t_order(nickname) VALUES... 中没有自增列 order_id

2. TableToken 表标记对象

   • 查询的表名： SELECT * FROM t_order 的 t_order

3. ItemsToken 选择项标记对象

   • AVG 查询列： SELECT AVG(price) FROM t_order 的 AVG(price)

   • ORDER BY 字段不在查询列： SELECT order_id FROM t_order ORDER BY create_time 的 create_time

   • GROUP BY 字段不在查询列： SELECT COUNT(order_id) FROM t_order GROUP BY user_id 的 user_id

   • 自增主键未在插入列中并且客户端设置了自增主键属性 generate-key-column： INSERT INTO t_order(nickname) VALUES... 中没有自增列 order_id

4. OffsetToken 分页偏移量标记对象

   • 分页有偏移量，但不是占位符 ?

5. RowCountToken 分页长度标记对象

   • 分页有长度，但不是占位符 ?

6. OrderByToken 排序标记对象

   • 有 GROUP BY 条件，无 ORDER BY 条件： SELECT COUNT(*) FROM t_order GROUP BY order_id 的 order_id

3. SQL 改写

SQLRewriteEngine#rewrite() 实现了 SQL改写 功能。

public SQLBuilder rewrite(final boolean isRewriteLimit) {
        SQLBuilder result = new SQLBuilder();
        if (sqlTokens.isEmpty()) {
            result.appendLiterals(originalSQL);
            return result;
        }
        int count = 0;
        // 对 SQLToken 根据起始位置进行排序
        sortByBeginPosition();
        for (SQLToken each : sqlTokens) {
            if (0 == count) {
                // 拼接第一个 SQLToken 前的字符串
                result.appendLiterals(originalSQL.substring(0, each.getBeginPosition()));
            }
            //  拼接每个 SQLToken
            if (each instanceof TableToken) {
                appendTableToken(result, (TableToken) each, count, sqlTokens);
            } else if (each instanceof IndexToken) {
                appendIndexToken(result, (IndexToken) each, count, sqlTokens);
            } else if (each instanceof ItemsToken) {
                appendItemsToken(result, (ItemsToken) each, count, sqlTokens);
            } else if (each instanceof RowCountToken) {
                appendLimitRowCount(result, (RowCountToken) each, count, sqlTokens, isRewriteLimit);
            } else if (each instanceof OffsetToken) {
                appendLimitOffsetToken(result, (OffsetToken) each, count, sqlTokens, isRewriteLimit);
            } else if (each instanceof OrderByToken) {
                appendOrderByToken(result, count, sqlTokens);
            }
            count++;
        }
        return result;
    }

SQL 改写以 SQLToken 为间隔，顺序改写。

顺序：调用sortByBeginPosition()将 SQLToken 按照 beginPosition 升序。
间隔：遍历 SQLToken，逐个拼接。

SQLBuilder，SQL 构建器。下文会大量用到，我们看下实现代码。

public final class SQLBuilder {
    
    // 段集合
    private final List