devbox
很楠不爱3
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

MyBatis-Plus--使用雪花算法生成主键ID--使用/分析_mybatisplus雪花算法生成id

作者：很楠不爱3 | 2024-04-22 20:15:55

赞

踩

mybatisplus雪花算法生成id

原文网址：MyBatis-Plus--使用雪花算法生成主键ID--使用/分析_IT利刃出鞘的博客-CSDN博客

简介

说明

        本文介绍MyBatis-Plus如何使用其自带的雪花算法生成主键ID。

MyBatis-Plus自带的雪花算法

  • MyBatis-Plus自带雪花算法
  • MyBatis-Plus默认使用雪花算法生成ID。
    • 虽然默认是雪花算法ID，建议显式指定@TableId的type属性为IdType.ASSIGN_ID。
  • 若没有配置机器号，则默认生成机器号（通过物理网卡地址和jvm的进程ID生成机器号）。
    • 雪花算法是需要指定不同的机器号的，如果机器号相同，则可能会生成相同的ID。

MyBatis-Plus的雪花算法示例

建库建表

  1. DROP DATABASE IF EXISTS mp;
  2. CREATE DATABASE mp DEFAULT CHARACTER SET utf8;
  3. USE mp;
  4.  
  5. DROP TABLE IF EXISTS `t_user`;
  6. SET NAMES utf8mb4;
  7.  
  8. CREATE TABLE `t_user`
  9. (
  10.     `id`           BIGINT(0) NOT NULL,
  11.     `user_name`    VARCHAR(64) NOT NULL COMMENT '用户名（不能重复）',
  12.     `nick_name`    VARCHAR(64) NULL COMMENT '昵称（可以重复）',
  13.     `email`        VARCHAR(64) COMMENT '邮箱',
  14.     `create_time`  DATETIME(0) NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  15.     `update_time`  DATETIME(0) NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间',
  16.     `deleted_flag` BIGINT(0) NOT NULL DEFAULT 0 COMMENT '0：未删除 其他：已删除',
  17.     PRIMARY KEY (`id`) USING BTREE,
  18.     UNIQUE KEY `index_user_name_deleted_flag` (`user_name`, `deleted_flag`),
  19.     KEY `index_create_time`(`create_time`)
  20. ) ENGINE = InnoDB COMMENT = '用户';

依赖

引入MyBatis-Plus依赖。

  1. <dependency>
  2.     <groupId>com.baomidou</groupId>
  3.     <artifactId>mybatis-plus-boot-starter</artifactId>
  4.     <version>3.5.1</version>
  5. </dependency>

整个pom.xml为：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.3.12.RELEASE</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.example</groupId>
  12.     <artifactId>MyBatis-Plus_Single</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>MyBatis-Plus_Single</name>
  15.     <description>Demo project for Spring Boot</description>
  16.  
  17.     <properties>
  18.         <java.version>1.8</java.version>
  19.     </properties>
  20.  
  21.     <dependencies>
  22.         <dependency>
  23.             <groupId>org.springframework.boot</groupId>
  24.             <artifactId>spring-boot-starter-web</artifactId>
  25.         </dependency>
  26.  
  27.         <dependency>
  28.             <groupId>com.baomidou</groupId>
  29.             <artifactId>mybatis-plus-boot-starter</artifactId>
  30.             <version>3.5.1</version>
  31.         </dependency>
  32.  
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-test</artifactId>
  36.             <scope>test</scope>
  37.         </dependency>
  38.  
  39.         <dependency>
  40.             <groupId>mysql</groupId>
  41.             <artifactId>mysql-connector-java</artifactId>
  42.         </dependency>
  43.  
  44.         <dependency>
  45.             <groupId>org.projectlombok</groupId>
  46.             <artifactId>lombok</artifactId>
  47.         </dependency>
  48.  
  49.         <dependency>
  50.             <groupId>com.github.xiaoymin</groupId>
  51.             <artifactId>knife4j-spring-boot-starter</artifactId>
  52.             <version>3.0.3</version>
  53.         </dependency>
  54.  
  55.     </dependencies>
  56.  
  57.     <build>
  58.         <plugins>
  59.             <plugin>
  60.                 <groupId>org.springframework.boot</groupId>
  61.                 <artifactId>spring-boot-maven-plugin</artifactId>
  62.             </plugin>
  63.         </plugins>
  64.     </build>
  65.  
  66. </project>

配置

application.yml

  1. spring:
  2.   datasource:
  3.     driver-class-name: com.mysql.cj.jdbc.Driver
  4.     url: jdbc:mysql://127.0.0.1:3306/mp?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
  5.     username: root
  6.     password: 222333
  7.  
  8. #mybatis-plus配置控制台打印完整带参数SQL语句
  9. mybatis-plus:
  10.   configuration:
  11.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

MyBatis-Plus配置类

启动类上加注解：

@MapperScan("com.example.demo.**.mapper")

代码

Entity

  1. package com.example.demo.user.entity;
  2.  
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableId;
  5. import com.baomidou.mybatisplus.annotation.TableLogic;
  6. import com.baomidou.mybatisplus.annotation.TableName;
  7. import lombok.Data;
  8.  
  9. import java.time.LocalDateTime;
  10.  
  11. @Data
  12. @TableName(value = "t_user")
  13. public class User {
  14.     @TableId(value = "id", type = IdType.ASSIGN_ID)
  15.     // 等价于：
  16.     // @TableId(value = "id", type = IdType.AUTO)
  17.     private Long id;
  18.  
  19.     /**
  20.      * 用户名（不能重复）
  21.      */
  22.     private String userName;
  23.  
  24.     /**
  25.      * 昵称（可以重复）
  26.      */
  27.     private String nickName;
  28.  
  29.     /**
  30.      * 邮箱
  31.      */
  32.     private String email;
  33.  
  34.     /**
  35.      * 创建时间
  36.      */
  37.     private LocalDateTime createTime;
  38.  
  39.     /**
  40.      * 修改时间
  41.      */
  42.     private LocalDateTime updateTime;
  43.  
  44.     /**
  45.      * 0：未删除 其他：已删除
  46.      */
  47.     @TableLogic(delval = "id")
  48.     private Long deletedFlag;
  49. }

Mapper

  1. package com.example.demo.user.mapper;
  2.  
  3. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  4. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  5. import com.example.demo.user.entity.User;
  6. import org.springframework.stereotype.Repository;
  7.  
  8. @Repository
  9. public interface UserMapper extends BaseMapper<User> {
  10. }

Service

接口

  1. package com.example.demo.user.service;
  2.  
  3. import com.baomidou.mybatisplus.extension.service.IService;
  4. import com.example.demo.user.entity.User;
  5.  
  6. public interface UserService extends IService<User> {
  7. }

实现

  1. package com.example.demo.user.service.impl;
  2.  
  3. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  4. import com.example.demo.user.entity.User;
  5. import com.example.demo.user.mapper.UserMapper;
  6. import com.example.demo.user.service.UserService;
  7. import org.springframework.stereotype.Service;
  8.  
  9. @Service
  10. public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
  11. }

Controller

  1. package com.example.demo.user.controller;
  2.  
  3. import com.example.demo.user.entity.User;
  4. import com.example.demo.user.service.UserService;
  5. import io.swagger.annotations.Api;
  6. import io.swagger.annotations.ApiOperation;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.web.bind.annotation.PostMapping;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.springframework.web.bind.annotation.RestController;
  11.  
  12. import java.util.ArrayList;
  13. import java.util.List;
  14.  
  15. @Api(tags = "增删改查")
  16. @RestController
  17. @RequestMapping("/crud")
  18. public class CRUDController {
  19.     @Autowired
  20.     private UserService userService;
  21.  
  22.     // 其他代码
  23.  
  24.     @ApiOperation("批量添加")
  25.     @PostMapping("/addBatch")
  26.     public List<User> addBatch() {
  27.         List<User> users = new ArrayList<>();
  28.         for (long i = 0; i < 10; i++) {
  29.             User user = new User();
  30.             user.setUserName("Iron Man" + i);
  31.  
  32.             users.add(user);
  33.         }
  34.         userService.saveBatch(users);
  35.         return users;
  36.     }
  37. }

测试

访问：http://localhost:8080/doc.html

结果

访问如下位置：

可以发现，生成的ID是19位的数，而且是增加的。这就是雪花算法的生成的ID的现象。

原理分析

MyBatis-Plus默认用雪花算法

ID的类型默认是ASSIGN_ID

MyBatis-Plus的ID生成算法的配置方式如下：

application.yml：

  1. mybatis-plus:
  2.   global-config:
  3.     db-config:
  4.       #id类型。
  5.       id-type: ASSIGN_ID # 默认为ASSIGN_ID

id-type默认是： ASSIGN_ID，代码如下：

ASSIGN_ID使用雪花算法实现

        MyBatis的MybatisParameterHandler#populateKeys方法里对ID进行填充，里边调用到IdentifierGenerator#nextId获取ID：

        IdentifierGenerator是一个接口，其默认实现类是：DefaultIdentifierGenerator，其调用Sequence的nextId()获取ID：

点进去看看这个Sequence：

 可以发现，这就是雪花算法！

不配置机器号时的处理逻辑

结论

        MyBatis-Plus生成机器序号的方法是：前5位作为dataCenterId（通过MAC地址生成），后5位作为workerId（通过MAC地址结合JVM的PID生成）。

分析

        DefaultIdentifierGenerator有个构造函数，若没有配置workerId和dataCenterId，则会调用无参构造方法。

上边会调用到Sequence的构造方法：Sequence#Sequence(java.net.InetAddress)，如下图所示

追踪dataCenterId和workerId的方法：

  1. package com.baomidou.mybatisplus.core.toolkit;
  2.  
  3. import org.apache.ibatis.logging.Log;
  4. import org.apache.ibatis.logging.LogFactory;
  5.  
  6. import java.lang.management.ManagementFactory;
  7. import java.net.InetAddress;
  8. import java.net.NetworkInterface;
  9. import java.util.concurrent.ThreadLocalRandom;
  10.  
  11. /**
  12.  * 分布式高效有序 ID 生产黑科技(sequence)
  13.  *
  14.  * <p>优化开源项目：https://gitee.com/yu120/sequence</p>
  15.  *
  16.  * @author hubin
  17.  * @since 2016-08-18
  18.  */
  19. public class Sequence {
  20.  
  21.     // 其他代码
  22.     
  23.     /**
  24.      * 获取 maxWorkerId
  25.      */
  26.     protected long getMaxWorkerId(long datacenterId, long maxWorkerId) {
  27.         StringBuilder mpid = new StringBuilder();
  28.         mpid.append(datacenterId);
  29.         String name = ManagementFactory.getRuntimeMXBean().getName();
  30.         if (StringUtils.isNotBlank(name)) {
  31.             /*
  32.              * GET jvmPid
  33.              */
  34.             mpid.append(name.split(StringPool.AT)[0]);
  35.         }
  36.         /*
  37.          * MAC + PID 的 hashcode 获取16个低位
  38.          */
  39.         return (mpid.toString().hashCode() & 0xffff) % (maxWorkerId + 1);
  40.     }
  41.  
  42.     /**
  43.      * 数据标识id部分
  44.      */
  45.     protected long getDatacenterId(long maxDatacenterId) {
  46.         long id = 0L;
  47.         try {
  48.             if (null == this.inetAddress) {
  49.                 this.inetAddress = InetAddress.getLocalHost();
  50.             }
  51.             NetworkInterface network = NetworkInterface.getByInetAddress(this.inetAddress);
  52.             if (null == network) {
  53.                 id = 1L;
  54.             } else {
  55.                 byte[] mac = network.getHardwareAddress();
  56.                 if (null != mac) {
  57.                     id = ((0x000000FF & (long) mac[mac.length - 2]) | (0x0000FF00 & (((long) mac[mac.length - 1]) << 8))) >> 6;
  58.                     id = id % (maxDatacenterId + 1);
  59.                 }
  60.             }
  61.         } catch (Exception e) {
  62.             logger.warn(" getDatacenterId: " + e.getMessage());
  63.         }
  64.         return id;
  65.     }
  66. }

MyBatis-Plus的雪花算法工具类

说明

        MyBatis-Plus也提供了一个雪花算法工具类，想用的可以使用：com.baomidou.mybatisplus.core.toolkit.IdWorker。

用法

  1. public static void main(String[] args) {
  2.     // 返回值  1385106677482582018
  3.     System.out.println(IdWorker.getId());
  4.     // 返回值 "1385106677482582019"
  5.     System.out.println(IdWorker.getIdStr());
  6. }

注意

        这只是个工具类，与MyBatis-Plus和它的ID默认的雪花算法无关。

        在github中有一个很流行的分布式统一ID生成框架也叫idworker，需要和mybatis-plus中自带的Idworker工具类区分开来。它是一个基于zookeeper和snowflake算法的分布式统一ID生成工具，通过zookeeper自动注册机器（最多1024台），无需手动指定workerId和dataCenterId。idworker官网：https://github.com/imadcn/idworker

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/很楠不爱3/article/detail/470318
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号