《ShardingSphere解读》16 改写引擎：如何理解装饰器模式下的 SQL 改写实现机制？

SQL 改写在分库分表框架中通常位于路由之后也是整个 SQL 执行流程中的重要环节因为开发人员是面向逻辑库与逻辑表所书写的 SQL并不能够直接在真实的数据库中执行SQL 改写用于将逻辑 SQL 改写为在真实数据库中可以正确执行的 SQL。事实上我们已经在前面的案例中看到了 SQL 改写的应用场景这个场景就是分布式主键的自动生成过程。在关系型数据库中自增主键是常见的功能特性而对于 ShardingSphere 而言这也是 SQL 改写的典型应用场景。今天我们就将基于自增主键这一场景来探讨ShardingSphere 中 SQL 改写的实现过程。ShardingSphere 改写引擎基本结构让我们先来看一下 BaseShardingEngine 中用于执行改写逻辑的 rewriteAndConvert 方法private Collection rewriteAndConvert(final String sql, final List parameters, final SQLRouteResult sqlRouteResult) { //构建 SQLRewriteContext SQLRewriteContext sqlRewriteContext new SQLRewriteContext(metaData.getRelationMetas(), sqlRouteResult.getSqlStatementContext(), sql, parameters); //构建 ShardingSQLRewriteContextDecorator 对 SQLRewriteContext 进行装饰 new ShardingSQLRewriteContextDecorator(shardingRule, sqlRouteResult).decorate(sqlRewriteContext); //判断是否根据数据脱敏列进行查询 boolean isQueryWithCipherColumn shardingProperties.getValue(ShardingPropertiesConstant.QUERY_WITH_CIPHER_COLUMN); //构建 EncryptSQLRewriteContextDecorator 对 SQLRewriteContext 进行装饰 new EncryptSQLRewriteContextDecorator(shardingRule.getEncryptRule(), isQueryWithCipherColumn).decorate(sqlRewriteContext); //生成 SQLTokens sqlRewriteContext.generateSQLTokens(); Collection result new LinkedHashSet(); for (RoutingUnit each : sqlRouteResult.getRoutingResult().getRoutingUnits()) { //构建 ShardingSQLRewriteEngine ShardingSQLRewriteEngine sqlRewriteEngine new ShardingSQLRewriteEngine(shardingRule, sqlRouteResult.getShardingConditions(), each); //执行改写 SQLRewriteResult sqlRewriteResult sqlRewriteEngine.rewrite(sqlRewriteContext); //保存改写结果 result.add(new RouteUnit(each.getDataSourceName(), new SQLUnit(sqlRewriteResult.getSql(), sqlRewriteResult.getParameters()))); } return result; }这段代码虽然内容不多但却完整描述了实现 SQL 改写的整体流程我们对核心代码都添加了注释这里面涉及的核心类也很多值得我们进行深入分析相关核心类的整体结构如下可以看到在整个类图中SQLRewriteContext 处于中间位置改写引擎 SQLRewriteEngine 和装饰器 SQLRewriteContextDecorator 都依赖于它。所以接下来让我们先来看一下这个 SQLRewriteContext并基于自增主键功能引出 SQL 改写引擎的基础组件 SQLToken。从自增主键功能看改写引擎中的核心类1. SQLRewriteContext从命名上讲与 SQLStatementContext 类似SQLRewriteContext 也是一个上下文对象让我们来看 SQLRewriteContext 中的变量定义//数据表和列的关系元数据 private final RelationMetas relationMetas; //SQLStatement 上下文 private final SQLStatementContext sqlStatementContext; //原始SQL private final String sql; //参数列表 private final List parameters; //SQLToken 列表 private final List sqlTokens new LinkedList(); //参数构建器 private final ParameterBuilder parameterBuilder; //SQLToken 生成器 private final SQLTokenGenerators sqlTokenGenerators new SQLTokenGenerators();在这里我们看到了前面已经介绍的 SQLStatementContext也看到了新的 SQLToken 和 SQLTokenGenerators。随着今天内容的演进这些对象都会逐一进行介绍这里我们先明确 SQLRewriteContext 中保存着用于 SQL 改写的各种相关信息。2. SQLToken接下来我们来看一下 SQLToken 对象该对象在改写引擎中重要性很高SQLRewriteEngine 正是基于 SQLToken 实现了 SQL 改写SQLToken 类的定义如下所示RequiredArgsConstructor Getter public abstract class SQLToken implements Comparable { private final int startIndex; Override public final int compareTo(final SQLToken sqlToken) { return startIndex - sqlToken.getStartIndex(); } }SQLToken 实际上是一个抽象类在 ShardingSphere 中存在了一大批 SQLToken 的子类。这些 SQLToken 多数跟 SQL 改写相关这部分类的包名中包含 rewrite而有些在改写的基础上还与后面要讲到的数据脱敏功能相关这部分类包名中还包含着 encrypt。数据脱敏也是 ShardingSphere 提供的一项非常实用的功能我们在讲到“模块六ShardingSphere 源码解析之治理与集成”时会有专题对其进行介绍。同时部分 SQLToken 位于 shardingsphere-rewrite-engine 工程中而有些则位于 sharding-core-rewrite 工程中这点也需要注意。结合 SQL 改写的常见场景很多 SQLToken 的含义可以从字面意思上直接理解。例如对 INSERT 语句而言如果使用数据库自增主键是不需要写入主键字段的但数据库的自增主键无法满足分布式场景下的主键唯一性因此 ShardingSphere 提供了分布式自增主键的生成策略能够自动地替换数据库现有的自增主键。举例说明我们案例中 health_record 表的主键是 record_id假定原始的 SQL 为INSERT INTO health_record (user_id, level_id, remark) values (1, 1, remark1)可以看到上述 SQL 中并未包含自增主键需要数据库自行填充在 ShardingSphere 中配置了自增主键后SQL 将被自动改写为INSERT INTO health_record (record_id, user_id, level_id, remark) values (471698773731577856, 1, 1, Remark1)显然改写后的 SQL 将在 INSERT 语句中增加主键列名称以及自动生成的自增主键值。从命名上看GeneratedKeyInsertColumnToken 对应上述的自动主键填充的场景这实际上属于常见的一种 SQL 改写策略也就是补列GeneratedKeyInsertColumnToken 的实现如下所示public final class GeneratedKeyInsertColumnToken extends SQLToken implements Attachable { private final String column; public GeneratedKeyInsertColumnToken(final int startIndex, final String column) { super(startIndex); this.column column; } Override public String toString() { return String.format(, %s, column); } }注意到这里多了一个 column 变量用于指定主键的所在列。我们再来跟踪 GeneratedKeyInsertColumnToken 的构造函数调用情况发现这个类是通过 GeneratedKeyInsertColumnTokenGenerator 创建出来的。接下来让我们一起看看 TokenGenerator。3. TokenGenerator顾名思义TokenGenerator 的作用是专门负责生成具体的 Token该接口定义如下public interface SQLTokenGenerator { //判断是否要生成 SQLToken boolean isGenerateSQLToken(SQLStatementContext sqlStatementContext); }该接口还有两个子接口分别是负责生成单个 SQLToken 的 OptionalSQLTokenGenerator 和负责生成批量 SQLToken 的 CollectionSQLTokenGeneratorpublic interface OptionalSQLTokenGenerator extends SQLTokenGenerator { //生成单个 SQLToken SQLToken generateSQLToken(SQLStatementContext sqlStatementContext); } public interface CollectionSQLTokenGenerator extends SQLTokenGenerator { //生成批量 SQLToken Collection generateSQLTokens(SQLStatementContext sqlStatementContext); }在 ShardingSphere和 SQLToken 一样TokenGenerator 的类层结构也比较复杂。对于 GeneratedKeyInsertColumnTokenGenerator 而言它还有一个抽象的基类即如下所示的 BaseGeneratedKeyTokenGeneratorpublic abstract class BaseGeneratedKeyTokenGenerator implements OptionalSQLTokenGenerator, SQLRouteResultAware { //是否生成 SQLToken protected abstract boolean isGenerateSQLToken(InsertStatement insertStatement); //生成 SQLToken protected abstract SQLToken generateSQLToken(SQLStatementContext sqlStatementContext, GeneratedKey generatedKey); … }这个抽象类留下了两个模板方法 isGenerateSQLToken 和 generateSQLToken交由子类进行实现在 GeneratedKeyInsertColumnTokenGenerator 中提供了这两个方法的实现过程public final class GeneratedKeyInsertColumnTokenGenerator extends BaseGeneratedKeyTokenGenerator { Override protected boolean isGenerateSQLToken(final InsertStatement insertStatement) { Optional sqlSegment insertStatement.findSQLSegment(InsertColumnsSegment.class); return sqlSegment.isPresent() !sqlSegment.get().getColumns().isEmpty(); } Override protected GeneratedKeyInsertColumnToken generateSQLToken(final SQLStatementContext sqlStatementContext, final GeneratedKey generatedKey) { Optional sqlSegment sqlStatementContext.getSqlStatement().findSQLSegment(InsertColumnsSegment.class); Preconditions.checkState(sqlSegment.isPresent()); //构建 GeneratedKeyInsertColumnToken return new GeneratedKeyInsertColumnToken(sqlSegment.get().getStopIndex(), generatedKey.getColumnName()); } }我们看到在上述 generateSQLToken 方法中通过利用在 SQL 解析引擎中获取的 InsertColumnsSegment 以及从用于生成分布式主键的 GeneratedKey 中获取对应的主键列我们就可以构建一个 GeneratedKeyInsertColumnToken。装饰器 SQLRewriteContextDecorator现在既然已经获取了 SQLToken让我们再次回到前面提到的 SQLRewriteContext。我们知道 SQLRewriteContext 是一个上下文对象保存着与 SQL 改写相关的很多数据信息同时对于这些信息其构建过程会根据不同的应用场景而有所不同。基于这些应用场景ShardingSphere 的改写引擎提供了 SQLRewriteContextDecorator 接口public interface SQLRewriteContextDecorator { //对SQLRewriteContext 执行装饰 void decorate(SQLRewriteContext sqlRewriteContext); }顾名思义SQLRewriteContextDecorator 是一种装饰器模式的具体应用在 ShardingSphere 中只存在两种具体的 SQLRewriteContextDecorator一种是用于分片处理的 ShardingSQLRewriteContextDecorator一种是用于数据脱敏的 EncryptSQLRewriteContextDecorator我们将在“30 | 数据脱敏如何基于改写引擎实现低侵入性数据脱敏方案”中进行详细介绍。今天我们关注的是前一种 ShardingSQLRewriteContextDecorator 的实现过程public final class ShardingSQLRewriteContextDecorator implements SQLRewriteContextDecorator { private final ShardingRule shardingRule; private final SQLRouteResult sqlRouteResult; Override public void decorate(final SQLRewriteContext sqlRewriteContext) { //参数改写 for (ParameterRewriter each : new ShardingParameterRewriterBuilder(shardingRule, sqlRouteResult).getParameterRewriters(sqlRewriteContext.getRelationMetas())) { if (!sqlRewriteContext.getParameters().isEmpty() each.isNeedRewrite(sqlRewriteContext.getSqlStatementContext())) { each.rewrite(sqlRewriteContext.getParameterBuilder(), sqlRewriteContext.getSqlStatementContext(), sqlRewriteContext.getParameters()); } } //SQLTokenGenerators 初始化 sqlRewriteContext.addSQLTokenGenerators(new ShardingTokenGenerateBuilder(shardingRule, sqlRouteResult).getSQLTokenGenerators()); } }这段代码不长包含了两部分内容一个是参数改写另一个是 SQLTokenGenerators 初始化下面我将分别讲解1. 参数改写参数改写部分又引入了几个新类。首当其冲的是 ParameterRewriter 以及构建它的 ParameterRewriterBuilder。1ParameterRewriter我们先来看 ParameterRewriter 的定义public interface ParameterRewriter { //判断是否需要改写 boolean isNeedRewrite(SQLStatementContext sqlStatementContext); //执行参数改写 void rewrite(ParameterBuilder parameterBuilder, SQLStatementContext sqlStatementContext, List parameters); }基于自增主键功能这里以 ShardingGeneratedKeyInsertValueParameterRewriter 为例看一下 ParameterRewriter 的实现方式它的 isNeedRewrite 方法如下所示Override public boolean isNeedRewrite(final SQLStatementContext sqlStatementContext) { return sqlStatementContext instanceof InsertSQLStatementContext sqlRouteResult.getGeneratedKey().isPresent() sqlRouteResult.getGeneratedKey().get().isGenerated(); }显然输入的 SQL 应该是一种 InsertSQLStatement并且只有在路由结果已经包含了 GeneratedKey 的情况下才执行这种改写。2ParameterRewriterBuilder在介绍 rewrite 方法之前我们先来理解ParameterBuilder的概念ParameterBuilder 是一种参数构建器public interface ParameterBuilder { List getParameters(); }ParameterBuilder 有两个实现类分别是 StandardParameterBuilder 和 GroupedParameterBuilder。其中GroupedParameterBuilder 保存着 StandardParameterBuilder 的一个集合只适用于 InsertSQLStatement。了解了这层关系之后我们再来看 ShardingGeneratedKeyInsertValueParameterRewriter 的 rewrite 方法Override public void rewrite(final ParameterBuilder parameterBuilder, final SQLStatementContext sqlStatementContext, final List parameters) { Preconditions.checkState(sqlRouteResult.getGeneratedKey().isPresent()); ((GroupedParameterBuilder) parameterBuilder).setDerivedColumnName(sqlRouteResult.getGeneratedKey().get().getColumnName()); Iterator generatedValues sqlRouteResult.getGeneratedKey().get().getGeneratedValues().descendingIterator(); int count 0; int parametersCount 0; for (List each : ((InsertSQLStatementContext) sqlStatementContext).getGroupedParameters()) { parametersCount ((InsertSQLStatementContext) sqlStatementContext).getInsertValueContexts().get(count).getParametersCount(); Comparable generatedValue generatedValues.next(); if (!each.isEmpty()) { //使用 GroupedParameterBuilder 进行补列和设置参数 ((GroupedParameterBuilder) parameterBuilder).getParameterBuilders().get(count).addAddedParameters(parametersCount, Lists.newArrayList(generatedValue)); } count; } }因为这个 ParameterRewriter 面向 InsertSQLStatement所以这里用到了 GroupedParameterBuilder并通过 SQLRouteResult 获取 GeneratedKey。我们设置了 GroupedParameterBuilder 中的 DerivedColumnName 为 GeneratedKey 的主键 Column并通过一个循环添加了对应的 Index 和 Parameter也就是完成了所需的补列操作。这部分的操作实际上可以与 GeneratedKey 的生成过程结合起来一起看以便加深理解在之前提到的 createGeneratedKey 方法也是通过一个循环对 GeneratedKey 进行赋值。private static GeneratedKey createGeneratedKey(final ShardingRule shardingRule, final InsertStatement insertStatement, final String generateKeyColumnName) { GeneratedKey result new GeneratedKey(generateKeyColumnName, true); for (int i 0; i getSQLTokenGenerators(); }在 SQLTokenGeneratorBuilder 的实现类 ShardingTokenGenerateBuilder 中可以看到内置了很多 TokenGenerator包含我们在前面提到过的 GeneratedKeyInsertColumnTokenGeneratorprivate Collection buildSQLTokenGenerators() { Collection result new LinkedList(); addSQLTokenGenerator(result, new TableTokenGenerator()); … addSQLTokenGenerator(result, new OffsetTokenGenerator()); addSQLTokenGenerator(result, new RowCountTokenGenerator()); addSQLTokenGenerator(result, new GeneratedKeyInsertColumnTokenGenerator()); … return result; }改写引擎 SQLRewriteEngine在 ShardingSphere 中SQLRewriteEngine 接口代表了改写引擎的入口public interface SQLRewriteEngine { //基于 SQLRewriteContext 执行 SQL 改写 SQLRewriteResult rewrite(SQLRewriteContext sqlRewriteContext); }SQLRewriteEngine 接口只有一个方法即根据输入的 SQLRewriteContext 返回一个 SQLRewriteResult 对象。我们通过前面的介绍已经了解到可以通过装饰器类对 SQLRewriteContext 进行装饰从而满足不同场景的需要。注意到 SQLRewriteEngine 接口只有两个实现类分别是 DefaultSQLRewriteEngine 和 ShardingSQLRewriteEngine。我们重点关注 ShardingSQLRewriteEngine但在介绍这个改写引擎类之前我们先要介绍一下SQLBuilder 接口从定义上可以看出 SQLBuilder 的目的就是构建最终可以执行的 SQL 语句public interface SQLBuilder { //生成 SQL String toSQL(); }SQLBuilder 接口有一个抽象的实现类 AbstractSQLBuilder它的 toSQL 方法如下所示Override public final String toSQL() { if (context.getSqlTokens().isEmpty()) { return context.getSql(); } Collections.sort(context.getSqlTokens()); StringBuilder result new StringBuilder(); result.append(context.getSql().substring(0, context.getSqlTokens().get(0).getStartIndex())); //根据 SQLToken 拼装目标 SQL for (SQLToken each : context.getSqlTokens()) { result.append(getSQLTokenText(each)); result.append(getConjunctionText(each)); } return result.toString(); }可以看到如果 SQLRewriteContext 的 sqlTokens 为空就直接返回保存在 SQLRewriteContext 中的最终 SQL反之会构建一个保存 SQL的StringBuilder然后依次添加每个 SQLTokenText 以及连接词 ConjunctionText从而拼装成一个完整的 SQL 语句。注意到这里获取 SQLTokenText 的方法是一个模板方法需要 AbstractSQLBuilder 的子类进行实现//获取 SQLToken 文本 protected abstract String getSQLTokenText(SQLToken sqlToken);作为 AbstractSQLBuilder的一个实现类ShardingSQLBuilder 的 getSQLTokenText 方法就包含了 SQL 改写的一些场景Override protected String getSQLTokenText(final SQLToken sqlToken) { if (sqlToken instanceof RoutingUnitAware) { return ((RoutingUnitAware) sqlToken).toString(routingUnit); } if (sqlToken instanceof LogicAndActualTablesAware) { return ((LogicAndActualTablesAware) sqlToken).toString(getLogicAndActualTables()); } return sqlToken.toString(); }对于输入的 SQLToken这里有两个特殊的处理即判断是否实现了 RoutingUnitAware 接口或 LogicAndActualTablesAware 接口。我们发现实现 RoutingUnitAware 接口的只有 ShardingInsertValuesToken而实现 LogicAndActualTablesAware 的则有 IndexToken 和 TableToken 两个 SQLToken。这里以实现了 LogicAndActualTablesAware 的 TableToken 为例展开讨论。表名改写就是将逻辑表名改写为真实表名的过程是一个典型的需要对 SQL 进行改写的场景。我们考虑最简单表名改写场景如果逻辑 SQL 为SELECT user_name FROM user WHERE user_id 1;那么这里的逻辑表名为 user。假设我们配置了分片键 user_id并且 user_id 1 的情况将路由至分片表 user_1那么改写之后的 SQL 应该为SELECT user_name FROM user_1 WHERE user_id 1;可以看到这里的真实表名应该是 user_1 而不是 user在用于改写表名的 TableToken 中它的 toString 如下所示Override public String toString(final Map logicAndActualTables) { String actualTableName logicAndActualTables.get(tableName.toLowerCase()); actualTableName null actualTableName ? tableName.toLowerCase() : actualTableName; return Joiner.on().join(quoteCharacter.getStartDelimiter(), actualTableName, quoteCharacter.getEndDelimiter()); }这里的逻辑并不复杂只是根据逻辑表名从 logicAndActualTables 中获取真实表名 actualTableName然后进行字符串拼装而已。那么这个 logicAndActualTables 是从何而来呢logicAndActualTables 的构建过程是在 ShardingSQLBuilder 中private Map getLogicAndActualTables() { Map result new HashMap(); Collection tableNames getContext().getSqlStatementContext().getTablesContext().getTableNames(); for (TableUnit each : routingUnit.getTableUnits()) { String logicTableName each.getLogicTableName().toLowerCase(); result.put(logicTableName, each.getActualTableName()); result.putAll(getLogicAndActualTablesFromBindingTable(routingUnit.getMasterSlaveLogicDataSourceName(), each, tableNames)); } return result; }上述代码实际上也只是做了数据结构的拼装我们沿着这里的 getLogicAndActualTablesFromBindingTable 方法继续往下看会发现根据 logicTable 获取 actualTable 的过程实际上是发生在 BindingTableRule 中public String getBindingActualTable(final String dataSource, final String logicTable, final String otherActualTable) { int index -1; for (TableRule each : tableRules) { index each.findActualTableIndex(dataSource, otherActualTable); if (-1 ! index) { break; } } if (-1 index) { throw new ShardingConfigurationException(Actual table [%s].[%s] is not in table config, dataSource, otherActualTable); } for (TableRule each : tableRules) { if (each.getLogicTable().equals(logicTable.toLowerCase())) { return each.getActualDataNodes().get(index).getTableName().toLowerCase(); } } throw new ShardingConfigurationException(Cannot find binding actual table, data source: %s, logic table: %s, other actual table: %s, dataSource, logicTable, otherActualTable); }而 BindingTableRule 又依赖于 TableRule 中保存的 ActualDataNodes 来完成 ActualTableIndex和ActualTable 的计算。回想起我们在案例中配置的分库分表规则这里再次感受到了以 TableRule 和 BindingTableRule为 代表的各种 Rule 对象在 ShardingSphere 的串联作用当 ShardingSQLBuilder 完成 SQL 的构建之后我们再回到 ShardingSQLRewriteEngine这个时候我们对它的 rewrite 方法就比较明确了Override public SQLRewriteResult rewrite(final SQLRewriteContext sqlRewriteContext) { return new SQLRewriteResult(new ShardingSQLBuilder(sqlRewriteContext, shardingRule, routingUnit).toSQL(), getParameters(sqlRewriteContext.getParameterBuilder())); }改写引擎的输出 SQLRewriteResult 对象就包含了最终的 SQL 以及配套的参数列表public final class SQLRewriteResult { private final String sql; private final List parameters; }讲完 ShardingSQLRewriteEngine 之后我们最后回到 BaseShardingEngine 的 rewriteAndConvert 方法。现在该方法中除了 EncryptSQLRewriteContextDecorator 部分的内容涉及数据脱敏功能其他的部分我们应该都能明白整体的执行流程。该方法最终返回的是一个 RouteUnit 列表RouteUnit 中又包含了 SQLUnitpublic final class RouteUnit { //目标数据源名 private final String dataSourceName; //SQL 单元 private final SQLUnit sqlUnit; } public final class SQLUnit { //目标 SQL private final String sql; //参数列表 private final List parameters; }可以看到最终的结果实际上就是目标数据库、目标 SQL 以及相关参数一旦我们获取了这些信息之后我们就可以执行一条 SQL 语句。从源码解析到日常开发在今天的内容中我们可以明显感受到装饰器模式的强大作用。装饰器模式允许向一个现有的对象添加新的功能同时又不改变其结构这种模式创建了一个装饰类用来包装原有的类并在保持类方法签名完整性的前提下提供了额外的功能。同时我们注意到在 ShardingSphere 中装饰器模式的作用对象是一个SQLRewriteContext上下文对象这是一种值得学习的做法。在日常开发过程中我们可以把需要根据不同场景进行不同处理的信息存储在一个上下文对象中然后基于装饰器模式对这些信息进行装饰。两者的无缝集成可以在很多应用场景下完成基于子类实现方式所不能完成的功能从而为对象动态添加一些额外的职责。小结与预告今天完整介绍了 ShardingSphere 中改写引擎的基本结构和各个核心类。改写引擎在设计上使用了装饰器模式完成了从逻辑 SQL 到目标 SQL 的改写过程我们也针对自增主键和表名改写这两个典型的应用场景给出了对应的实现原理和源码分析。请注意改写引擎在 ShardingSphere 中不仅仅只用于这些场景在后面我们还会看到它在数据脱敏等场景下的应用。最后给你留一道思考题ShardingSphere 中如何通过装饰器模式对 SQL 改写的上下文进行装饰欢迎你在留言区与大家讨论我将逐一点评解答。现在我们已经针对输入的逻辑 SQL 通过改写引擎获取了目标 SQL有了目标 SQL 接下来就可以执行 SQL 了这就是下一篇中要开始介绍的 ShardingSphere 执行引擎要做的事情。