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

2022-04-10 17:28:04

因为升级使用springboot2.x java 11 的关系，根据官方文档和网上其他作者配置的怎么也配置不成功，最后自己一步一步升级引入依赖，修改增加接口注入来源，最后成功。

升级成功后的源码地址

https://github.com/foxiswho/java-spring-boot-uid-generator-baidu

部分升级说明

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

官方代码地址：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>
        <!--for Mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
            <version>8.0.12</version>
        </dependency>
        <!-- druid -->
        <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

相关文章