多平台统一管理软件接口,如何实现多平台统一管理软件接口
874
2023-01-20
详解Spring Boot工程集成全局唯一ID生成器 UidGenerator的操作步骤
Spring Boot中全局唯一流水号ID生成器集成实验
概述
流水号生成器(全局唯一 ID生成器)是服务化系统的基础设施,其在保障系统的正确运行和高可用方面发挥着重要作用。而关于流水号生成算法首屈一指的当属 Snowflake 雪花算法,然而 Snowflake本身很难在现实项目中直接使用,因此实际应用时需要一种可落地的方案。
UidGenerator 由百度开发,是java实现的, 基于 Snowflake算法的唯一ID生成器。UidGenerator以组件形式工作在应用项目中, 支持自定义workerId位数和初始化策略, 从而适用于 docker等虚拟化环境下实例自动重启、漂移等场景。
本文就在项目中来集成 UidGenerator这一工程来作为项目的全局唯一 ID生成器。
本文内容脑图如下:
基础工程创建
只需创建一个 Multi-Moudule的 Maven项目即可,然后我们集成进两个 Module:
uid-generator : 源码在此
uid-consumer :消费者( 使用uid-generator产生全局唯一的流水号 )
uid-generator 模块我就不多说了,源码拿过来即可,无需任何改动;而关于 uid-consumer 模块,先在 pom.xml中添加相关依赖如下:
然后在 application.properties配置文件中添加一些配置(主要是 MySQL和 MyBatis配置)
server.port=9999
spring.datasource.url=jdbc:mysql://xxx.xxx.xxx.xxx:3306/xxx?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=xxx
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.configuration.map-underscore-to-camel-case=true
完成之后工程缩影如下图所示:
下面我们来一步步集成 UidGenerator 的源码。
数据库建表
首先去 MySQL数据库中建一个名为 WORKER_NODE 的数据表,其 sql如下:
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;
Spring详细配置
CachedUidGenerator 配置
UidGenerator 有两个具体的实现类,分别是 DefaultUidGenerator 和 CachedUidGenerator ,不过官方也推荐了对于性能比较敏感的项目应使用后者,因此本文也使用 CachedUidGenerator ,而对于 DefaultUidGenerator 不做过多阐述。
我们引入 UidGenerator源码中的 cached-uid-spring.xml 文件,里面都是默认配置,我目前没有做任何修改
xsi:schemaLocation=" http://springframework.org/schema/beans http://springframework.org/schema/beans/spring-beans-3.1.xsd">
xsi:schemaLocation="
http://springframework.org/schema/beans http://springframework.org/schema/beans/spring-beans-3.1.xsd">
Mybatis Mapper XML 配置
即原样引入 UidGenerator源码中关于工作节点(Worker Node)操作的 mapper xml 文件: WORKER_NODE.xml ,其内容如下:
type="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity">
type="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity">
parameterType="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity"> INSERT INTO WORKER_NODE (HOST_NAME, PORT, TYPE, LAUNCH_DATE, MODIFIED, CREATED) VALUES ( #{hostName}, #{port}, #{type}, #{launchDate}, NOW(), NOW())
parameterType="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity">
INSERT INTO WORKER_NODE
(HOST_NAME,
PORT,
TYPE,
LAUNCH_DATE,
MODIFIED,
CREATED)
VALUES (
#{hostName},
#{port},
#{type},
#{launchDate},
NOW(),
NOW())
SELECT
ID,
HOST_NAME,
PORT,
TYPE,
LAUNCH_DATE,
MODIFIED,
CREATED
FROM
WORKER_NODE
WHERE
HOST_NAME = #{host} AND PORT = #{port}
编写业务代码
config 类创建与配置
新建 UidConfig 类,为我们引入上文的 cached-uid-spring.xml 配置
@Configuration
@ImportResource(locatioAgULiAns = { "classpath:uid/cached-uid-spring.xml" })
public class UidConfig {
}
service 类创建与配置
新建 UidGenService ,引入 UidGenerator 生成 UID的业务接口
@Service
public class UidGenService {
@Resource
private UidGenerator uidGenerator;
AgULiA public long getUid() {
return uidGenerator.getUID();
}
}
controller 创建与配置
新建 UidTestController ,目的是方便我们用浏览器测试接口并观察效果:
@RestController
public class UidTestController {
@Autowired
private UidGenService uidGenService;
@GetMapping("/testuid")
public String test() {
return String.valueOf( uidGenService.getUid() );
}
}
实验测试
我们每启动一次 Spring Boot工程,其即会自动去 MySQL数据的 WORKER_NODE 表中插入一行关于工作节点的记录,类似下图所示:
接下来我们浏览器访问: http://localhost:9999/testuid
OK,全局唯一流水号ID已经成功生成并返回!
总结
以上所述是给大家介绍的Spring Boot工程集成全局唯一ID生成器 UidGenerator,希望对大家有所帮助,如果大家有任何疑问请给我留言,会及时回复大家的。在此也非常感谢大家对我们网站的支持!
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~