sharding-jdbc5.0.0分表實踐

IAyue發表於2022-02-10
JDBC

本文基於shardingsphere-jdbc-core-spring-boot-starter 5.0.0，請注意不同版本的sharding-jdbc配置可能有不一樣的地方，本文不一定適用於其它版本

相關的maven配置如下:

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
       <dependency>
            <groupId>org.apache.shardingsphere</groupId>
            <artifactId>shardingsphere-jdbc-core-spring-boot-starter</artifactId>
            <version>5.0.0</version>
        </dependency>
      <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

以下為單庫分表的配置，根據物件的trade_no欄位hash後mod進行分片，把資料分散到12個表中

spring:
  shardingsphere:
    datasource:  ##資料來源配置
      ds0:
        driver-class-name: com.mysql.jc.jdbc.Driver
        jdbc-url: jdbc:mysql://...
        password: ...
        type: com.zaxxer.hikari.HikariDataSource
        username: root
      names: ds0
    mode:
      type: Memory
    props:
      sql-show: false ##為true時會列印sharding-jdbc生成的邏輯sql跟實際執行語句
    rules: ##分片規則配置
      sharding:
        binding-tables:
        - trade_info
        sharding-algorithms:
          trade-info-inline:  #分片演算法配置
            props:
              sharding-count: '12'
            type: HASH_MOD
        tables:
          trade_info:
            actual-data-nodes: ds0.trade_info_$->{0..11}
            table-strategy:
              standard:
                sharding-algorithm-name: trade-info-inline  ##使用的分片演算法名
                sharding-column: trade_no  ##分片鍵

jpa提供了TABLE（使用一個特定的資料庫表格來儲存主鍵,在使用時從該表取資料做為主鍵）、SEQUENCE（由底層資料庫的序列來生成主鍵，需要資料庫支援序列）、IDENTITY（由資料庫自動生成主鍵,主要在自增ID列使用 ）三種生成主鍵值的策略。但對於分庫分表來講都不太適用，所以自定義了一個使用雪花演算法來生成主鍵值

public class SnowFlakeIdGenerator implements IdentifierGenerator {

    @Override
    public Serializable generate(SharedSessionContractImplementor sharedSessionContractImplementor, Object o) throws HibernateException {
        return SnowFlakeUtil.nextId();
    }

    @Override
    public boolean supportsJdbcBatchInserts() {
        return true;
    }
}

實體類id的配置

    @Id
    @GenericGenerator(name = "snowflake",strategy = "com.****.****.****.SnowFlakeIdGenerator")
    @GeneratedValue(generator = "snowflake")
    private Long id;

配置完後，試了下新增、刪除、查詢都沒有問題，但更新記錄的時候出錯了，報錯資訊為ShardingSphereException: Can not update sharding key, logic table: [**], column: [**]。從報錯資訊看來是因為我更新了原有記錄的分片鍵，奇怪的是我並沒有更新分片鍵，呼叫棧中最開始出錯的程式碼如下：

    public void preValidate(ShardingRule shardingRule, SQLStatementContext<UpdateStatement> sqlStatementContext, List<Object> parameters, ShardingSphereSchema schema) {
        this.validateMultipleTable(shardingRule, sqlStatementContext);
        UpdateStatement sqlStatement = (UpdateStatement)sqlStatementContext.getSqlStatement();
        String tableName = (String)sqlStatementContext.getTablesContext().getTableNames().iterator().next();
        Iterator var7 = sqlStatement.getSetAssignment().getAssignments().iterator();

        String shardingColumn;
        Optional shardingColumnSetAssignmentValue;
        Optional shardingValue;
        do {
            AssignmentSegment each;
            do {
                if (!var7.hasNext()) {
                    return;
                }

                each = (AssignmentSegment)var7.next();
                shardingColumn = ((ColumnSegment)each.getColumns().get(0)).getIdentifier().getValue();
            } while(!shardingRule.isShardingColumn(shardingColumn, tableName));

            shardingColumnSetAssignmentValue = this.getShardingColumnSetAssignmentValue(each, parameters);
            shardingValue = Optional.empty();
            Optional<WhereSegment> whereSegmentOptional = sqlStatement.getWhere();
            if (whereSegmentOptional.isPresent()) {
                shardingValue = this.getShardingValue((WhereSegment)whereSegmentOptional.get(), parameters, shardingColumn);
            }
        } while(shardingColumnSetAssignmentValue.isPresent() && shardingValue.isPresent() && shardingColumnSetAssignmentValue.get().equals(shardingValue.get()));

        throw new ShardingSphereException("Can not update sharding key, logic table: [%s], column: [%s].", new Object[]{tableName, shardingColumn});
    }

這方法在做的事情就是，如果update語句的set裡面存在分片鍵，將會從where中獲取的分片鍵的值，然後將where語句中獲取到分片鍵值跟set語句中的分片鍵值比較是否發生改變，發生改變就會丟擲ShardingSphereException。比如我的trade_info表分片鍵為trade_no，執行的更新語句為update trade_info t set t.trade_no = 123,t.a = 1 where t.trade_no = 123，這段程式碼就會去比較set中trade_no與where中trade_no的值是否一樣，不一樣或者where中沒有分片鍵而set中包含分片鍵就會拋異常。

列印了一下執行的update語句，我提交的更新語句為update t set t.b = ? where t.a = ?，被sharding-jdbc攔下來檢查時語句變成了update t set t.a = ? ,t.b = ?,t.c = ? where t.id = ? ，語句發生了兩個變化：我原本語句只是更新了物件的部分屬性，執行語句變成了全量更新；where子句被改變了，原本更新的條件是t.a=?，提交執行時變成了t.id=?。原因是JPA對語句做了優化，修改了我寫的語句，實體類中加上註解@DynamicUpdate，更新時只更新發生改變的欄位，解決了問題。

更多的功能配置可以參考官方文件:https://shardingsphere.apache.org/document/5.0.0/cn/user-manual/shardingsphere-jdbc/

相關文章