SpringBoot2.x 集成百度 uidgenerator 轻松搞定全局ID生成器

╰半橙微兮° 2022-11-06 04:00 213阅读 0赞

## 你知道的越多，不知道的就越多，业余的像一棵小草！ ##

你来，我们一起精进！你不来，我和你的竞争对手一起精进！

## 编辑：业余草 ##

foxwho.blog.csdn.net/article/details/90200602

## 推荐：https://www.xttblog.com/?p=5162 ##

最近有网友给我私信，说公司要使用分布式 ID，问我有没有相关实现代码。我这里找了一个，分享给大家！

![format_png][]

分布式 ID 的生成方案有很多，有的还带有管理界面。比如下面这个：

![format_png 1][]

方案虽然有很多，但是这些方案核心思想都很类似，我们采用开源项目最好要有大厂背景，这样出了问题也能也好的被修复。今天推荐的这个源码项目使用的 Java11，并且 Springboot 使用的是 2.x 的版本。这个版本的难点是，根据官方文档和网上其他作者配置的怎么也配置不成功，最后只能自己一步一步升级引入依赖，修改增加接口注入来源，最后成功。

## 部分升级说明 ##

这里的升级，是升级 官方 代码依赖

官方代码地址：https://github.com/baidu/uid-generator

*  升级spring boot 版本：2.0.7.RELEASE
 *  升级 mybatis，mybatis-spring 版本
 *  升级 mysql-connector-java 版本：8.0.12
 *  升级 junit 版本

## 创建数据库存 ##

导入官网数据库SQL

> https://github.com/baidu/uid-generator/blob/master/src/main/scripts/WORKER\_NODE.sql

也就是一张表

我这里是在demo库中，创建了这张表

DROP TABLE IF EXISTS WORKER_NODE;
    CREATE TABLE WORKER_NODE
    (
        ID BIGINT NOT NULL AUTO_INCREMENT COMMENT 'auto increment id',
        HOST_NAME VARCHAR(64) NOT NULL COMMENT 'host name',
        PORT VARCHAR(64) NOT NULL COMMENT 'port',
        TYPE INT NOT NULL COMMENT 'node type: ACTUAL or CONTAINER',
        LAUNCH_DATE DATE NOT NULL COMMENT 'launch date',
        MODIFIED TIMESTAMP NOT NULL COMMENT 'modified time',
        CREATED TIMESTAMP NOT NULL COMMENT 'created time',
        PRIMARY KEY(ID)
    )
        COMMENT='DB WorkerID Assigner for UID Generator',ENGINE = INNODB;

如果报错，基本上是时间问题，因为mysql 低版本控制比较严格，解决方法有多种方式

**方式一:**

直接把TIMESTAMP改成DATETIME 即可

**方式二:**

执行SQL 语句前先执行:

set sql_mode="NO_ENGINE_SUBSTITUTION";

## mysql 配置信息更改 ##

因为升级到8.x ,配置文件部分也要跟着修改

uid-generator 下，测试文件夹下的资源包uid/mysql.properties

以下修改为

mysql.driver=com.mysql.cj.jdbc.Driver

修改完成后，配置好数据库相关参数，这样单元测试即可执行成功

## 案例 ##

计划将全局生成唯一ID作为一个服务提供者，供其他微服务使用调用

这里创建了一个项目，项目中包含两个子项目一个是uid-generator官方本身，当然你也可以不需要放到本项目中，直接使用官方的自行打包即可，一个是uid-provider 服务提供者

以下说明的主要是服务提供者

## 创建 子项目 uid-provider ##

POM配置文件如下

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>java-spring-boot-uid-generator-baidu</artifactId>
            <groupId>com.foxwho.demo</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>uid-provider</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
                <version>8.0.12</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>1.1.16</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${lombok.version}</version>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>com.foxwho.demo</groupId>
                <artifactId>uid-generator</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </project>

## 复制 mapper ##

先在uid-provider项目资源包路径下创建mapper文件夹，然后到官方uid-generator资源包路径下`META-INF/mybatis/mapper/WORKER_NODE.xml` 复制`WORKER_NODE.xml`文件，粘贴到该文件夹mapper内

## cache id 配置文件 ##

先在uid-provider项目资源包路径下创建uid文件夹，然后到官方uid-generator 测试 \[注意:这里是测试资源包\] 资源包路径下`uid/cached-uid-spring.xml` 复制`cached-uid-spring.xml`文件，粘贴到该文件夹uid内

最后根据需要 配置参数，可以看官方说明

## 创建 spring boot 启动入口 ##

主要就是加上注解`@MapperScan("com.baidu.fsg.uid")`让mybatis能扫描到Mapper类的包的路径

package com.foxwho.demo;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.builder.SpringApplicationBuilder;
    
    
    @SpringBootApplication
    @MapperScan("com.baidu.fsg.uid")
    public class ConsumerApplication {
    
    
        public static void main(String[] args) {
            new SpringApplicationBuilder(ConsumerApplication.class).run(args);
        }
    }

## 创建配置 ##

package com.foxwho.demo.config;
    
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.ImportResource;
    
    @Configuration
    @ImportResource(locations = { "classpath:uid/cached-uid-spring.xml" })
    public class UidConfig {
    }

创建服务接口

package com.foxwho.demo.service;
    
    import com.baidu.fsg.uid.UidGenerator;
    import org.springframework.stereotype.Service;
    
    import javax.annotation.Resource;
    
    
    @Service
    public class UidGenService {
        @Resource(name = "cachedUidGenerator")
        private UidGenerator uidGenerator;
    
        public long getUid() {
            return uidGenerator.getUID();
        }
    }

主要说明一下@Resource(name = "cachedUidGenerator") 以往错误都是少了这里，没有标明注入来源

## 控制器 ##

package com.foxwho.demo.controller;
    
    import com.foxwho.demo.service.UidGenService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class UidController {
        @Autowired
        private UidGenService uidGenService;
    
        @GetMapping("/uidGenerator")
        public String UidGenerator() {
            return String.valueOf(uidGenService.getUid());
        }
    
        @GetMapping("/")
        public String index() {
            return "index";
        }
    }

## 项目配置文件 ##

server.port=8080
    
    spring.datasource.url=jdbc:mysql://127.0.0.1:3306/demo?useUnicode=true&characterEncoding=utf-8&useSSL=false
    spring.datasource.username=root
    spring.datasource.password=root
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    
    mybatis.mapper-locations=classpath:mapper/*.xml
    mybatis.configuration.map-underscore-to-camel-case=true

## 启动项目 ##

从启动入口，启动

访问浏览器

> http://localhost:8080/uidGenerator

页面输出

> 13128615512260612

最后，需要源码的可以加我微信：dart996，免费获取！

[format_png]: /images/20221023/137006c7d888478fb1918e2f24e476db.png
[format_png 1]: /images/20221023/55c73d61983846a396fb929e3bcadcf3.png