从源码看ShardingSphere设计-总览篇

如果是早期使用过ShardingSphere的开发者，大多都知道ShardingSphere源于sharding-jdbc。sharding-jdbc 1.x版本主要功能就是分库分表、读写分离、分布式主键；在2.x版本增加了orchestration，3.x版本中增加了sharding-proxy、opentracing等功能，4.x版本进入了apache基金会，增加了加解密、影子表、扩容等。除了这些功能层面，在代码上其实各个版本对代码都进行了大量的重构，例如早期SQL的解析使用的alibaba的druid，后来又实现了一个简化版的SQL解析器，再后来统一基于antlr重新改写；早期内核引擎还有优化引擎等，后面重构到了重写引擎了；正在开发的5.x目标是pluggable，对代码结构、包类名能都有较大调整，对开发者也更友好。作为一名开发者，我觉得ShardingSphere不止是一个数据库中间件，而是一个围绕SQL、DB的开发平台和工具集。同时其代码质量也很高，对其进行源码分析更是可以学到很多软件设计与开发的知识。

本文不介绍ShardingSphere的具体功能，关于ShardingSphere功能，官网有更完整的介绍https://shardingsphere.apache.org/document/current/en/overview

本系列基于的源码是当前最新release版本4.1.1，但涉及到差异较大的也会跟5.0.0-RC1-SNAPSHOT进行比较。4.1.1版本共有18个子项目，具体名称分类如下：

sharding-sphere 4.1.1代码目录

根据功能划分，本系列会包含多个章节篇幅：

1. 总览
2. 解析引擎
3. 路由引擎
4. 改写引擎
5. 执行引擎
6. 归并引擎
7. 事务篇
8. JDBC篇
9. Proxy篇
10. Ochestration篇
11. 扩容篇
12. 5.x代码变化

---

本文为总览篇，会通过快速浏览下其执行流程，了解涉及到的类与方法的职责与定位，从而对ShardingSphere的内核形成一个整体认识，另外会总结下使用的设计模式、代码结构、代码风格，以及4.1.1版本中目前存在的问题。

代码调用分析

我们看源代码，需要一个入口，ShardingSphere中最成熟、使用率最高的莫过于sharding-jdbc，因此我们就从sharding-jdbc作为代码分析的切入点。从名字就可以看出sharding-jdbc支持JDBC，熟悉JDBC规范的开发者都知道其核心就是DataSource、Connection、Statement、PrepareStatement等接口，在sharding-jdbc中，这些接口的实现类分别对应ShardingDataSource、ShardingConnection、ShardingStatment、ShardingPreparedStatement类。接下来就从一条查询SQL出发，顺着方法的调用脉络看下这些类的代码：

为了在代码分析过程中更好的定位在调用链所处位置，会在通过加标题来注明接下来代码所属于的功能范畴。

JDBC

org.apache.shardingsphere.shardingjdbc.jdbc.core.datasource.ShardingDataSource

public class ShardingDataSource extends AbstractDataSourceAdapter {
        private final ShardingRuntimeContext runtimeContext;
…
    @Override
    public final ShardingConnection getConnection() {
        return new ShardingConnection(getDataSourceMap(), runtimeContext, TransactionTypeHolder.get());
    }
}

org.apache.shardingsphere.shardingjdbc.jdbc.core.connection.ShardingConnection

public final class ShardingConnection extends AbstractConnectionAdapter {
       …
    @Override
    public PreparedStatement prepareStatement(final String sql) throws SQLException {
        return new ShardingPreparedStatement(this, sql);
}
…
    @Override
    public Statement createStatement(final int resultSetType, final int resultSetConcurrency, final int resultSetHoldability) {
        return new ShardingStatement(this, resultSetType, resultSetConcurrency, resultSetHoldability);
    }
…
}

org.apache.shardingsphere.shardingjdbc.jdbc.core.statement.ShardingStatement

/**
 * Statement that support sharding.
 */
public final class ShardingStatement extends AbstractStatementAdapter {
…
@Override
    public ResultSet executeQuery(final String sql) throws SQLException {
        if (Strings.isNullOrEmpty(sql)) {
            throw new SQLException(SQLExceptionConstant.SQL_STRING_NULL_OR_EMPTY);
        }
        ResultSet result;
        try {
            executionContext = prepare(sql);
            List queryResults = statementExecutor.executeQuery();
            MergedResult mergedResult = mergeQuery(queryResults);
            result = new ShardingResultSet(statementExecutor.getResultSets(), mergedResult, this, executionContext);
        } finally {
            currentResultSet = null;
        }
        currentResultSet = result;
        return result;
}
…
}

org.apache.shardingsphere.shardingjdbc.jdbc.core.statement.ShardingPreparedStatement

 /**
 * PreparedStatement that support sharding.
 */
public final class ShardingPreparedStatement extends AbstractShardingPreparedStatementAdapter {
    …
 public ResultSet executeQuery() throws SQLException {
        ResultSet result;
        try {
            clearPrevious();
            prepare();
            initPreparedStatementExecutor();
            MergedResult mergedResult = mergeQuery(preparedStatementExecutor.executeQuery());
            result = new ShardingResultSet(preparedStatementExecutor.getResultSets(), mergedResult, this, executionContext);
        } finally {
            clearBatch();
        }
        currentResultSet = result;
        return result;
    }

可以看到，真正进行sql解析、路由都在Statement实现类中。
我们以ShardingPreparedStatement.executeQuery()为例，看看整个流程。
clearPrevious()负责PreparedStatementExecutor的重置，因为一个Statement可以多次执行多个SQL，每次执行完SQL，PreparedStatementExecutor会记录真实的Statement，connection，该方法负责关闭statement，清理记录的参数、连接等。

public void clear() throws SQLException {
        clearStatements();
        statements.clear();
        parameterSets.clear();
        connections.clear();
        resultSets.clear();
        inputGroups.clear();
    }

executeQuery方法中剩余的代码则完成SQL的解析、路由、改写、执行与合并。

SQL处理流程

Prepare引擎

接下来看下prepare，这个方法其实完成prepare引擎的执行和自增key的生成添加。

private void prepare() {
        executionContext = prepareEngine.prepare(sql, getParameters());
        findGeneratedKey().ifPresent(generatedKey -> generatedValues.add(generatedKey.getGeneratedValues().getLast()));
    }

prepare引擎并不在官方内核引擎范围，因为它完成的事其实就是调用解析引擎、路由引擎、改写引擎进行SQL的解析、路由操作，相当于这些内核引擎的编排执行，其对应的类图如下：
其对应的类层次如下：

看下prepare引擎的prepare方法
org.apache.shardingsphere.underlying.pluggble.prepare.BasePrepareEngine

public ExecutionContext prepare(final String sql, final List