sharding-jdbc分库分表的 4种分片策略

骑猪看日落 2023-01-17 08:49 156阅读 0赞

> 如果我一部分表做了分库分表，另一部分未做分库分表的表怎么处理？怎么才能正常访问？

这是一个比较典型的问题，我们知道分库分表是针对某些数据量持续大幅增长的表，比如用户表、订单表等，而不是一刀切将全部表都做分片。那么不分片的表和分片的表如何划分，一般有两种解决方案。

*  严格划分功能库，分片的库与不分片的库剥离开，业务代码中按需切换数据源访问
 *  默认数据源，以 `Sharding-JDBC` 为例，不给未分片表设置分片规则，它们就不会执行，因为找不到路由规则，如果我们设置一个默认数据源，在找不到规则时一律访问默认库。

# 配置数据源 ds-0
    spring.shardingsphere.datasource.ds-0.type=com.alibaba.druid.pool.DruidDataSource
    spring.shardingsphere.datasource.ds-0.driverClassName=com.mysql.jdbc.Driver
    spring.shardingsphere.datasource.ds-0.url=jdbc:mysql://47.94.6.5:3306/ds-0?useUnicode=true&characterEncoding=utf8&tinyInt1isBit=false&useSSL=false&serverTimezone=GMT
    spring.shardingsphere.datasource.ds-0.username=root
    spring.shardingsphere.datasource.ds-0.password=root
    
    # 默认数据源，未分片的表默认执行库
    spring.shardingsphere.sharding.default-data-source-name=ds-0

这篇我们针对具体的SQL使用场景，实践一下4种分片策略的用法，开始前先做点准备工作。

*  标准分片策略
 *  复合分片策略
 *  行表达式分片策略
 *  Hint分片策略

## 准备工作 ##

先创建两个数据库 `ds-0`、`ds-1`，两个库中分别建表 `t_order_0`、`t_order_1`、`t_order_2` 、`t_order_item_0`、`t_order_item_1`、`t_order_item_2` 6张表，下边实操看看如何在不同场景下应用 `sharding-jdbc` 的 4种分片策略。

`t_order_n` 表结构如下：

CREATE TABLE `t_order_0` (
      `order_id` bigint(200) NOT NULL,
      `order_no` varchar(100) DEFAULT NULL,
      `user_id` bigint(200) NOT NULL,
      `create_name` varchar(50) DEFAULT NULL,
      `price` decimal(10,2) DEFAULT NULL,
      PRIMARY KEY (`order_id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC;

`t_order_item_n` 表结构如下：

CREATE TABLE `t_order_item_0` (
      `item_id` bigint(100) NOT NULL,
      `order_id` bigint(200) NOT NULL,
      `order_no` varchar(200) NOT NULL,
      `item_name` varchar(50) DEFAULT NULL,
      `price` decimal(10,2) DEFAULT NULL,
      PRIMARY KEY (`item_id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC;

分片策略分为`分表策略`和`分库策略`，它们实现分片算法的方式基本相同，不同是一个对库`ds-0`、`ds-1`，一个对表 `t_order_0` ··· `t_order_n` 等做处理。

## 标准分片策略 ##

**使用场景**：SQL 语句中有`>`，`>=`, `<=`，`<`，`=`，`IN` 和 `BETWEEN AND` 操作符，都可以应用此分片策略。

标准分片策略（`StandardShardingStrategy`），它只支持对单个分片健（字段）为依据的分库分表，并提供了两种分片算法 `PreciseShardingAlgorithm`（精准分片）和 `RangeShardingAlgorithm`（范围分片）。

在使用标准分片策略时，精准分片算法是必须实现的算法，用于 SQL 含有 `=` 和 `IN` 的分片处理；范围分片算法是非必选的，用于处理含有 `BETWEEN AND` 的分片处理。

> “
> 
> 一旦我们没配置范围分片算法，而 SQL 中又用到 `BETWEEN AND` 或者 `like`等，那么 SQL 将按全库、表路由的方式逐一执行，查询性能会很差需要特别注意。

接下来自定义实现 `精准分片算法` 和 `范围分片算法`。

### 1、精准分片算法 ###

#### 1.1 精准分库算法 ####

实现自定义精准分库、分表算法的方式大致相同，都要实现 `PreciseShardingAlgorithm` 接口，并重写 `doSharding()` 方法，只是配置稍有不同，而且它只是个空方法，得我们自行处理分库、分表逻辑。**其他分片策略亦如此**。

SELECT * FROM t_order where  order_id = 1 or order_id in （1,2,3）;

下边我们实现精准分库策略，通过对分片健 `order_id` 取模的方式（怎么实现看自己喜欢）计算出 SQL 该路由到哪个库，计算出的分片库信息会存放在分片上下文中，方便后续分表中使用。

public class MyDBPreciseShardingAlgorithm implements PreciseShardingAlgorithm<Long> {
    
        @Override
        public String doSharding(Collection<String> databaseNames, PreciseShardingValue<Long> shardingValue) {
    
            /**
             * databaseNames 所有分片库的集合
             * shardingValue 为分片属性，其中 logicTableName 为逻辑表，columnName 分片健（字段），value 为从 SQL 中解析出的分片健的值
             */
            for (String databaseName : databaseNames) {
                String value = shardingValue.getValue() % databaseNames.size() + "";
                if (databaseName.endsWith(value)) {
                    return databaseName;
                }
            }
            throw new IllegalArgumentException();
        }
    }

其中 `Collection<String>` 参数在几种分片策略中使用一致，在分库时值为所有分片库的集合 `databaseNames`，分表时为对应分片库中所有分片表的集合 `tablesNames`；`PreciseShardingValue` 为分片属性，其中 `logicTableName` 为逻辑表，`columnName` 分片健（字段），`value` 为从 SQL 中解析出的分片健的值。

![图片][d2f0c502a07854feda5693db4b522c83.png]

而 `application.properties` 配置文件中只需修改分库策略名 `database-strategy` 为标准模式 `standard`，分片算法 `standard.precise-algorithm-class-name` 为自定义的精准分库算法类路径。

### 分库策略
    # 分库分片健
    spring.shardingsphere.sharding.tables.t_order.database-strategy.standard.sharding-column=order_id
    # 分库分片算法
    spring.shardingsphere.sharding.tables.t_order.database-strategy.standard.precise-algorithm-class-name=com.xiaofu.sharding.algorithm.dbAlgorithm.MyDBPreciseShardingAlgorithm

#### 1.2 精准分表算法 ####

精准分表算法同样实现 `PreciseShardingAlgorithm` 接口，并重写 `doSharding()` 方法。

public class MyTablePreciseShardingAlgorithm implements PreciseShardingAlgorithm<Long> {
    
        @Override
        public String doSharding(Collection<String> tableNames, PreciseShardingValue<Long> shardingValue) {
    
            /**
             * tableNames 对应分片库中所有分片表的集合
             * shardingValue 为分片属性，其中 logicTableName 为逻辑表，columnName 分片健（字段），value 为从 SQL 中解析出的分片健的值
             */
            for (String tableName : tableNames) {
                /**
                 * 取模算法，分片健 % 表数量
                 */
                String value = shardingValue.getValue() % tableNames.size() + "";
                if (tableName.endsWith(value)) {
                    return tableName;
                }
            }
            throw new IllegalArgumentException();
        }
    }

分表时 `Collection<String>` 参数为上边计算出的分片库，对应的所有分片表的集合 `tablesNames`；`PreciseShardingValue` 为分片属性，其中 `logicTableName` 为逻辑表，`columnName` 分片健（字段），`value` 为从 SQL 中解析出的分片健的值。

![图片][ffaf94151e87a7c706f5585d686e73e1.png]

`application.properties` 配置文件也只需修改分表策略名 `database-strategy` 为标准模式 `standard`，分片算法 `standard.precise-algorithm-class-name` 为自定义的精准分表算法类路径。

# 分表策略
    # 分表分片健
    spring.shardingsphere.sharding.tables.t_order.table-strategy.standard.sharding-column=order_id
    # 分表算法
    spring.shardingsphere.sharding.tables.t_order.table-strategy.standard.precise-algorithm-class-name=com.xiaofu.sharding.algorithm.tableAlgorithm.MyTablePreciseShardingAlgorithm

> “
> 
> **看到这不难发现，自定义分库和分表算法的实现基本是一样的，所以后边我们只演示分库即可**

### 2、范围分片算法 ###

**使用场景**：当我们 SQL中的分片健字段用到 `BETWEEN AND`操作符会使用到此算法，会根据 SQL中给出的分片健值范围值处理分库、分表逻辑。

SELECT * FROM t_order where  order_id BETWEEN 1 AND 100;

自定义范围分片算法需实现 `RangeShardingAlgorithm` 接口，重写 `doSharding()` 方法，下边我通过遍历分片健值区间，计算每一个分库、分表逻辑。

/**
     * @author xinzhifu
     * @description 范围分库算法
     * @date 2020/11/2 12:06
     */
    public class MyDBRangeShardingAlgorithm implements RangeShardingAlgorithm<Integer> {
    
        @Override
        public Collection<String> doSharding(Collection<String> databaseNames, RangeShardingValue<Integer> rangeShardingValue) {
    
            Set<String> result = new LinkedHashSet<>();
            // between and 的起始值
            int lower = rangeShardingValue.getValueRange().lowerEndpoint();
            int upper = rangeShardingValue.getValueRange().upperEndpoint();
            // 循环范围计算分库逻辑
            for (int i = lower; i <= upper; i++) {
                for (String databaseName : databaseNames) {
                    if (databaseName.endsWith(i % databaseNames.size() + "")) {
                        result.add(databaseName);
                    }
                }
            }
            return result;
        }
    }

和上边的一样 `Collection<String>` 在分库、分表时分别代表分片库名和表名集合，`RangeShardingValue` 这里取值方式稍有不同， `lowerEndpoint` 表示起始值， `upperEndpoint` 表示截止值。

![图片][5bf0f08d283fcfa21b02a22beae14f04.png]

在配置上由于范围分片算法和精准分片算法，同在标准分片策略下使用，所以只需添加上 `range-algorithm-class-name` 自定义范围分片算法类路径即可。

# 精准分片算法
    spring.shardingsphere.sharding.tables.t_order.database-strategy.standard.precise-algorithm-class-name=com.xiaofu.sharding.algorithm.dbAlgorithm.MyDBPreciseShardingAlgorithm
    # 范围分片算法
    spring.shardingsphere.sharding.tables.t_order.database-strategy.standard.range-algorithm-class-name=com.xiaofu.sharding.algorithm.dbAlgorithm.MyDBRangeShardingAlgorithm

## 复合分片策略 ##

**使用场景**：SQL 语句中有`>`，`>=`, `<=`，`<`，`=`，`IN` 和 `BETWEEN AND` 等操作符，不同的是复合分片策略支持对多个分片健操作。

下面我们实现同时以 `order_id`、`user_id` 两个字段作为分片健，自定义复合分片策略。

SELECT * FROM t_order where  user_id =0  and order_id = 1;

我们先修改一下原配置，`complex.sharding-column` 切换成 `complex.sharding-columns` 复数，分片健上再加一个 `user_id` ，分片策略名变更为 `complex` ，`complex.algorithm-class-name` 替换成我们自定义的复合分片算法。

### 分库策略
    # order_id,user_id 同时作为分库分片健
    spring.shardingsphere.sharding.tables.t_order.database-strategy.complex.sharding-column=order_id,user_id
    # 复合分片算法
    spring.shardingsphere.sharding.tables.t_order.database-strategy.complex.algorithm-class-name=com.xiaofu.sharding.algorithm.dbAlgorithm.MyDBComplexKeysShardingAlgorithm

自定义复合分片策略要实现 `ComplexKeysShardingAlgorithm` 接口，重新 `doSharding()`方法。

public class MyDBComplexKeysShardingAlgorithm implements ComplexKeysShardingAlgorithm<Integer> {
    
    
        @Override
        public Collection<String> doSharding(Collection<String> databaseNames, ComplexKeysShardingValue<Integer> complexKeysShardingValue) {
    
            // 得到每个分片健对应的值
            Collection<Integer> orderIdValues = this.getShardingValue(complexKeysShardingValue, "order_id");
            Collection<Integer> userIdValues = this.getShardingValue(complexKeysShardingValue, "user_id");
    
            List<String> shardingSuffix = new ArrayList<>();
            // 对两个分片健同时取模的方式分库
            for (Integer userId : userIdValues) {
                for (Integer orderId : orderIdValues) {
                    String suffix = userId % 2 + "_" + orderId % 2;
                    for (String databaseName : databaseNames) {
                        if (databaseName.endsWith(suffix)) {
                            shardingSuffix.add(databaseName);
                        }
                    }
                }
            }
            return shardingSuffix;
        }
    
        private Collection<Integer> getShardingValue(ComplexKeysShardingValue<Integer> shardingValues, final String key) {
            Collection<Integer> valueSet = new ArrayList<>();
            Map<String, Collection<Integer>> columnNameAndShardingValuesMap = shardingValues.getColumnNameAndShardingValuesMap();
            if (columnNameAndShardingValuesMap.containsKey(key)) {
                valueSet.addAll(columnNameAndShardingValuesMap.get(key));
            }
            return valueSet;
        }
    }

`Collection<String>` 用法还是老样子，由于支持多分片健 `ComplexKeysShardingValue` 分片属性内用一个分片健为 `key`，分片健值为 `value` 的 `map`来存储分片键属性。

![图片][595513ceacf933405215acb7b55e2151.png]

## 行表达式分片策略 ##

行表达式分片策略（`InlineShardingStrategy`），在配置中使用 `Groovy` 表达式，提供对 SQL语句中的 `=` 和 `IN` 的分片操作支持，它只支持单分片健。

行表达式分片策略适用于做简单的分片算法，无需自定义分片算法，省去了繁琐的代码开发，是几种分片策略中最为简单的。

它的配置相当简洁，这种分片策略利用`inline.algorithm-expression`书写表达式。

比如：`ds-$->{order_id % 2}` 表示对 `order_id` 做取模计算，`$` 是个通配符用来承接取模结果，最终计算出分库`ds-0` ··· `ds-n`，整体来说比较简单。

# 行表达式分片键
    sharding.jdbc.config.sharding.tables.t_order.database-strategy.inline.sharding-column=order_id
    # 表达式算法
    sharding.jdbc.config.sharding.tables.t_order.database-strategy.inline.algorithm-expression=ds-$->{order_id % 2}

## Hint分片策略 ##

Hint分片策略（`HintShardingStrategy`）相比于上面几种分片策略稍有不同，这种分片策略无需配置分片健，分片健值也不再从 SQL中解析，而是由外部指定分片信息，让 SQL在指定的分库、分表中执行。`ShardingSphere` 通过 `Hint` API实现指定操作，实际上就是把分片规则`tablerule` 、`databaserule`由集中配置变成了个性化配置。

举个例子，如果我们希望订单表`t_order`用 `user_id` 做分片健进行分库分表，但是 `t_order` 表中却没有 `user_id` 这个字段，这时可以通过 Hint API 在外部手动指定分片健或分片库。

下边我们这边给一条无分片条件的SQL，看如何指定分片健让它路由到指定库表。

SELECT * FROM t_order;

使用 Hint分片策略同样需要自定义，实现 `HintShardingAlgorithm` 接口并重写 `doSharding()`方法。

public class MyTableHintShardingAlgorithm implements HintShardingAlgorithm<String> {
    
        @Override
        public Collection<String> doSharding(Collection<String> tableNames, HintShardingValue<String> hintShardingValue) {
    
            Collection<String> result = new ArrayList<>();
            for (String tableName : tableNames) {
                for (String shardingValue : hintShardingValue.getValues()) {
                    if (tableName.endsWith(String.valueOf(Long.valueOf(shardingValue) % tableNames.size()))) {
                        result.add(tableName);
                    }
                }
            }
            return result;
        }
    }

自定义完算法只实现了一部分，还需要在调用 SQL 前通过 `HintManager` 指定分库、分表信息。由于每次添加的规则都放在 `ThreadLocal` 内，所以要先执行 `clear()` 清除掉上一次的规则，否则会报错；`addDatabaseShardingValue` 设置分库分片健键值，`addTableShardingValue`设置分表分片健键值。`setMasterRouteOnly` 读写分离强制读主库，避免造成主从复制导致的延迟。

// 清除掉上一次的规则，否则会报错
    HintManager.clear();
    // HintManager API 工具类实例
    HintManager hintManager = HintManager.getInstance();
    // 直接指定对应具体的数据库
    hintManager.addDatabaseShardingValue("ds",0);
    // 设置表的分片健
    hintManager.addTableShardingValue("t_order" , 0);
    hintManager.addTableShardingValue("t_order" , 1);
    hintManager.addTableShardingValue("t_order" , 2);
    
    // 在读写分离数据库中，Hint 可以强制读主库
    hintManager.setMasterRouteOnly();

debug 调试看到，我们对 `t_order` 表设置分表分片健键值，可以在自定义的算法 `HintShardingValue` 参数中成功拿到。

![图片][2093f7ea64d83f41c9158157eef73490.png]

`properties` 文件中配置无需再指定分片健，只需自定义的 Hint分片算法类路径即可。

# Hint分片算法
    spring.shardingsphere.sharding.tables.t_order.table-strategy.hint.algorithm-class-name=com.xiaofu.sharding.algorithm.tableAlgorithm.MyTableHintShardingAlgorithm

[d2f0c502a07854feda5693db4b522c83.png]: /images/20221021/f2553146d55a427fb8ea790f829838fd.png
[ffaf94151e87a7c706f5585d686e73e1.png]: /images/20221021/58a4370d67724e5c8d1ce401d9882c85.png
[5bf0f08d283fcfa21b02a22beae14f04.png]: /images/20221021/a4fc15882a724087bece092bc326a91b.png
[595513ceacf933405215acb7b55e2151.png]: /images/20221021/61cb4a4d59fb422f844f574f8e936838.png
[2093f7ea64d83f41c9158157eef73490.png]: /images/20221021/8904f0f192b5462c8f9cebc1f2e749d0.png