SpringBoot-JPA整合ShardingShpere自定义分布式主键

分布式主键简介

​在分布式环境下，由于分库分表导致数据水平拆分后无法使用单表自增主键，因此我们需要一种全局唯一id生成策略作为分布式主键。当前有如下解决方案。

• UUID（Universally Unique Identifie）

• Snowflake（Twitter提供的雪花算法）

• Leaf 算法（Leaf-segment 数据库方案和Leaf-snowflake方案）

• Redis 计数器

• Zookeeper

• 数据库自增ID

• 数据库多主模式

• 号段模式

• TinyID（滴滴）

• UidGenerator（百度）

内置的主键生成器

ShardingShpere 提供了 UUID、SnowFlake 两种分布式主键生成策略 ，默认使用雪花算法（snowflake）。

UUID

​ UUID 是 Universally Unique Identifier 的缩写，它是在一定的范围内唯一的机器生成的标识符。

​ UUID 具有如下特点：1.经由一定的算法机器生成，算法定义了网卡MAC地址、时间戳、名字空间（Namespace）、随机或伪随机数、时序等元素，以及从这些元素生成UUID的算法。2. UUID 的复杂性决定了不能直接从一个UUID知道哪个对象和它关联。3. 在特定的范围内重复可能性极小。

SnowFlake

​ ShardingSphere默认提供的分布式主键生成策略。

​ Snowflake 能够保证不同进程主键的不重复性，以及相同进程内主键的有效性。

​ 在同一个进程中，Snowflake 通过时间位保证不重复，如果时间相同则是通过序列位保证。生成的主键在分布式环境可以认为是总体有效的，这就保证了对索引字段的插入的高效性。

​ 雪花算法生成的主键的二进制表示形式包含4部分，从高位到低位分别为：1bit符号位、41bit时间戳位、10bit工作进程位以及12bit序列号位。

​ 雪花算法能够保证全局唯一，存在的问题，如时钟回拨可能导致产生重复序列。

版本依赖

• JDK 8
• SpringBoot 2.4.3
• ShardingShpere 5.0
• hutool 5.3.10

源码

1、添加maven依赖

<dependency>
  <groupId>cn.hutool</groupId>
  <artifactId>hutool-all</artifactId>
  <version>5.3.10</version>
</dependency>

2、主键生成类

public final class MyShadingKeyGenerate implements KeyGenerateAlgorithm {

    @Override
    public synchronized Comparable<?> generateKey() {
        // 参数1为终端ID 参数2为数据中心ID
        Snowflake snowflake = IdUtil.createSnowflake(1, 1);
        Long id = snowflake.nextId();
        return id;
    }

    @Override
    public String getType() {
        return "ShadingKeyGenerate";
    }

    @Override
    public Properties getProps() {
        return null;
    }

    @Override
    public void setProps(Properties props) {
    }

    @Override
    public void init() {
    }
}

3、配置SPI

在resources 目录下新建META-INFO文件夹，再建services文件夹，在该目录下新建文件名为 org.apache.shardingsphere.sharding.spi.KeyGenerateAlgorithm，将自定义分布式主键的类保存到文件中：

com.kang.jpa.facility.MyShadingKeyGenerate

4、配置 application.yml

spring:
  shardingsphere:
    rules:
      sharding:
        key-generators:
          snowflake:
            type: ShadingKeyGenerate
            props:
              worker-id: 1
        tables:
          user:
            #雪花算法
            key-generate-strategy:
              column: id
              key-generator-name: snowflake

5、验证

启动项目，发送保存记录，查看 user_x 主键信息。

參考

​ https://shardingsphere.apache.org/document/current/cn/dev-manual/sharding/#shardingalgorithm