UidGenerator适配GaussDB开源开发任务
1 背景介绍
开源for Huawei （参考：https://developer.huaweicloud.com/programs/opensource/contributing/）通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki （参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
UidGenerator是Java实现的, 基于Snowflake 算法的唯一ID生成器。UidGenerator以组件形式工作在应用项目中, 支持自定义workerId位数和初始化策略, 从而适用于docker等虚拟化环境下实例自动重启、漂移等场景。在实现上, UidGenerator通过借用未来时间来解决sequence天然存在的并发限制; 采用RingBuffer来缓存已生成的UID, 并行化UID的生产和消费, 同时对CacheLine补齐，避免了由RingBuffer带来的硬件级「伪共享」问题. 最终单机QPS可达600万。
源码地址：https://github.com/baidu/uid-generator
主要开发语言：Java
LICENSE：Apache-2.0 license
维护者：百度
项目数据：Fork 1.6K, Star 5.5K, Contributor 2，最近一次提交：2018-11-28
star历史（https://star-history.com/）：
2.2 任务目的和范围
在互联网系统设计开发中，我们需要接口能够达到高性能，高并发和高可用要求，同时需要保证数据的唯一性，传统的数据库自增，uuid等方式无法满足要求，就需要一个性能好，可靠的分布式id组件来解决这个痛点。百度uid-generator采用雪花算法方案来设计分布式ID。 目前uid-generator示例中只写了支持mysql,其它数据库未得到验证，本次任务希望从架构角度出发，修改代码架构，让uid-generator能够支持多种数据库,例如GaussDB、openGauss、达梦、人大金仓、南大通用、神舟通用、PostgreSql、MariaDB、SqlServer、oracle等。并以GaussDB作为目标数据库进行验证。验证通过之后以华为开源示例项目servicecomb-fence为演示环境演示，制作镜像上架云商店，方便华为云CCE用户快速集成使用uid-generator，以此来扩展华为云生态影响力。
• 能力要求
完成该任务需要具备华为云CCE使用经验，Java微服务开发经验，了解分布式ID解决方案，GaussDB使用。
• 适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
|
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
否 |
使用GaussDB的驱动和SQL实现适配逻辑。 |
|
|
GaussDB(DWS) |
否 |
使用GaussDB（DWS）功能。 |
否 |
使用GaussDB(DWS)的驱动和SQL实现适配逻辑。 |
|
存储生态 |
OBS |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
|
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
3 工作量评估
|
任务 |
人/天 |
|
完成GaussDB适配功能开发 |
2 |
|
完成DEMO设计和功能验证 |
1 |
|
基于CCE完成环境搭建和DEMO验证 |
1 |
|
输出开发资料和博客 |
1 |
|
总计 |
5人天 |
4 任务分解
4.1 完成GaussDB适配功能开发验证
• Fork代码到个人仓库
• 利用如策略模式等一些设计模式调整代码以支持多种数据库
• 以GaussDB为验证数据库进行验证
• 设计适配验证的Demo
• 部署到华为云CCE完成适配验证
适配脚本：
https://github.com/baidu/uid-generator/blob/master/src/main/scripts/WORKER_NODE.sql
4.2 完成Uid-generator演示DEMO设计
参考下面的用例图：
DEMO的简单部署图如下：
4.3 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
4.4 在华为云开发者论坛输出博客
访问华为云开发者论坛 （参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。
内容包括不限于如下内容：
• 开源for Huawei的背景
• 开源软件的功能介绍
• 开发适配过程及碰到和解决的问题
• DEMO设计、开发、部署过程
• 代码推送开源社区及互动过程
博客打上如下标签：
• 开源（必选）
• 开发者（必选）
• GaussDB数据库（可选）
• 云数据库 GaussDB（可选）
• 鲲鹏（可选）
• 昇腾（可选）
• 鸿蒙（可选）
• 对象存储 OBS（可选）
5 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发和验证。 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
|
|
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
|
|
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
|
|
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
6 参考资料
1. 使用指南：
https://gitee.com/baidu/uid-generator/blob/master/README.zh_cn.md
2. 完成任务过程中，碰到问题可以在这里查询或者提问：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues
- 点赞
- 收藏
- 关注作者
评论（0）