带你俯瞰ShardingSphere

什么是 ShardingSphere

首先引用官网上的介绍

Apache ShardingSphere 是一款分布式的数据库生态系统, 可以将任意数据库转换为分布式数据库,并通过数据分片、弹性伸缩、加密等能力对原有数据库进行增强。

Apache ShardingSphere 设计哲学为 Database Plus,旨在构建异构数据库上层的标准和生态。 它关注如何充分合理地利用数据库的计算和存储能力,而并非实现一个全新的数据库。 它站在数据库的上层视角,关注它们之间的协作多于数据库自身。

简单来说ShardingSphere是一款可广泛使用的生产级分表分库中间件,目前有超过10000个GitHub使用它,可以说其优秀的设计值得我们细说,如果你的项目需要考虑一款生产级别的分表分库中间件,这个绝对是首选。

说到 ShardingSphere 的起源,我们不得不提 Sharding-JDBC 框架,该框架是一款起源于当当网内部的应用框架,并于 2017 年初正式开源。从 Sharding-JDBC 到 Apache 顶级项目,ShardingSphere 的发展经历了不同的演进阶段。

ss的版本演进

目前ShardingSphere最新版本是5.X,最新版本是5.3.2,从5.0版本开始ShardingSphere开始进行重大重构,可以说5.0完全不兼容之前的版本,我们要讨论的版本就是最新的5.X版本。

分表分库分为垂直分片和水平分表两种,两者可以同时进行,目前市面上的主流分表分库产品主要有三种:

  • 客户端分片
    典型的中间件包括阿里巴巴的 TDDL以及 ShardingSphere
  • 代理服务器分片
    常见的开源框架有阿里的 Cobar 以及民间开源社区的 MyCat。而在 ShardingSphere 3.X 版本中,也添加了 Sharding-Proxy 模块来实现代理服务器分片。
  • 分布式数据库
    以PG为代表的CockroachDB,以及以MySql为代表的TiDB

ShardingSphere分布式部署架构

客户端分片
代理服务器分片

ShardingSphere的设计原理

Sharding-JDBC 的定位是一个轻量级 Java 框架,在 JDBC 层提供了扩展性服务。我们知道 JDBC 是一种开发规范,指定了 DataSource、Connection、Statement、PreparedStatement、ResultSet 等一系列接口。而各大数据库供应商通过实现这些接口提供了自身对 JDBC 规范的支持,使得 JDBC 规范成为 Java 领域中被广泛采用的数据库访问标准。

基于这一点,Sharding-JDBC 一开始的设计就完全兼容 JDBC 规范,Sharding-JDBC 对外暴露的一套分片操作接口与 JDBC 规范中所提供的接口完全一致。开发人员只需要了解 JDBC,就可以使用 Sharding-JDBC 来实现分库分表,Sharding-JDBC 内部屏蔽了所有的分片规则和处理逻辑的复杂性。显然,这种方案天生就是一种具有高度兼容性的方案,能够为开发人员提供最简单、最直接的开发支持。

ss与jdbc.PNG

客户端分片的实现分为几个步骤:

  • SQL解析
  • 路由
  • 改写
  • 执行
  • 执行结果归并

ShardingSphere源代码解读

首先看一下项目结构

ss的项目结构.PNG

阅读源代码有很多种方式,可以基于上面的分片执行步骤为切入点,也可以基于JDBC开发规范进行切入,其实我们习惯于从Hello Word开始,基于分片执行步骤可以强化我们的理解,从上面的项目我们可以看到有几大模块:

  • infra
  • feature
  • parser
  • jdbc
  • kernel

等还有很多其它模块,我们先看上面主流的三大模块,infra属于最高层的模块,涵盖了我们上面列出的5大步骤,分别对应parser,route,rewrite,excutor,merge;parser主要是交给parser模块解析,route底层的立即主要分散在feature和kernel,主要由7种路由方式:

  • Single 单播

  • Shardings 根据SQL路由,标准默认

  • SqlRouteFixture 默认固定路由

  • SqlrouteFailFixture 无效路由

  • ShadowSql 影子库路由

    影子库:实际中使用的数据库的完整数据库数据拷贝,比如进行压测数据隔离的影子数据库,与生产数据库应当使用相同的配置。
    目的:主要是为了环境隔离,将数据进行隔离:数据库(实例)隔离,数据表隔离等。
    在全链路压测环境下,主要实现的是压测数据和其它环境(生产)数据的隔离。

  • ReadwriteSplitting 读写分离理由

  • Broadcast 广播理由

Single主要的代码在kernel模块,而其他几个主要是在feature模块。

从Hello Word开始带你入门

项目里面虽然有example,但是确实结构混乱,也不完整,这里找到一篇官方的例子可以参考,例子主要分为两段,第一段是创建数据源,第二段是使用数据源执行SQL,如果你熟悉JDBC的话,以上的用法除了配置外,其它的是不是毫无违和感。

主要对象是ShardingSphereDataSourceFactory,下面带你进行源代码解读。

我们从createDataSource方法看起,主要是new 了一个ShardingSphereDataSource对象,如下:


    public ShardingSphereDataSource(final String databaseName, final ModeConfiguration modeConfig) throws SQLException {
        this.databaseName = databaseName;
        contextManager = createContextManager(databaseName, modeConfig, new LinkedHashMap<>(), new LinkedList<>(), new Properties());
        jdbcContext = new JDBCContext(contextManager.getDataSourceMap(databaseName));
        contextManagerInitializedCallback(databaseName, contextManager);
    }

这里面内容虽然少,但是大有文章,为避免进入代码海洋,我只是做大致解读:

  • createContextManager方法用来创建ContextManager对象,这个对象承载了所有配置信息,包括分片分表规则,数据源信息(datasource)等,ContextManager初始化时会根据上下文初始信息来构造上面说的内容,ContextManager采用ShardingSphere提供的SPI机制加载ContextManagerBuilder,ContextManagerBuilder为一个SPI扩展接口,这个接口3个实现,主要是根据不同的部署模式进行上下文加载,主要是集群和单机模式。
  • 有了ContextManager之后我们就可以数据源名称从ContextManager缓存的数据源对象集合来获取DataSource信息了,有了DataSource之后那么后面就好办了,我们根据DataSource创建Connection,Statement,然后执行SQL。

以上获取到到DataSource实际是一个ShardingSphereDataSource,我们查看其getConnection方法可以知道Connection是怎么创建的,其实是最终调用org.apache.shardingsphere.driver.state.DriverStateContext#getConnection的方法处理,使用也是SPI的机制来加载DriverState。


   public static Connection getConnection(final String databaseName, final ContextManager contextManager, final JDBCContext jdbcContext) {
        return TypedSPILoader.getService(
                DriverState.class, contextManager.getInstanceContext().getInstance().getState().getCurrentState().name()).getConnection(databaseName, contextManager, jdbcContext);
    }

DriverState有三种实现,默认是OKDriverState,我们可以看到这个类的getConnection方法创建的其实是ShardingSphereConnection对象

    @Override
    public Connection getConnection(final String databaseName, final ContextManager contextManager, final JDBCContext jdbcContext) {
        return new ShardingSphereConnection(databaseName, contextManager, jdbcContext);
    }

ShardingSphereConnection的prepareStatement方法创建的是ShardingSpherePreparedStatement,那么最后我们直接看它的executeQuery方法的核心逻辑,因为方法比较长,我们只截取主流程代码


@Override
    public ResultSet executeQuery() throws SQLException {
        ResultSet result;
        try {
            // ...... 其它分支,有兴趣自己查看
            executionContext = createExecutionContext(queryContext);
            List<QueryResult> queryResults = executeQuery0();
            MergedResult mergedResult = mergeQuery(queryResults);
            List<ResultSet> resultSets = getResultSets();
            if (null == columnLabelAndIndexMap) {
                columnLabelAndIndexMap = ShardingSphereResultSetUtils.createColumnLabelAndIndexMap(sqlStatementContext, resultSets.get(0).getMetaData());
            }
            result = new ShardingSphereResultSet(resultSets, mergedResult, this, selectContainsEnhancedTable, executionContext, columnLabelAndIndexMap);
            // CHECKSTYLE:OFF
        } catch (final RuntimeException ex) {
            // CHECKSTYLE:ON
            handleExceptionInTransaction(connection, metaDataContexts);
            throw SQLExceptionTransformEngine.toSQLException(ex, metaDataContexts.getMetaData().getDatabase(connection.getDatabaseName()).getProtocolType().getType());
        } finally {
            clearBatch();
        }
        currentResultSet = result;
        return result;
    }

这个方法虽然不长,但是涵盖我们上面说的主要执行过程,createExecutionContext用于创建执行上下文,主要是做SQL解析和路由两件事情,executeQuery0主要是调用执行引擎来执行SQL,mergeQuery是用来做结果归并,代码是不是非常清晰?确实是值得我们学习,为避免大家陷入代码海洋,今天就点到为止,大家有兴趣可以下载代码进行赏读。

结语,伟大的框架值得我们花时间会研究和阅读,今天是端午节,祝大家端午安康,附上苏轼的词一首

【浣溪沙.端午】
【宋】苏轼
轻汗微微透碧纨,明朝端午浴芳兰。流香涨腻满晴川。
彩线轻缠红玉臂,小符斜挂绿云鬟。佳人相见一千年。

端午安康
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容