go-zero 集成 GORM 使用 GaussDB 开源体验任务
1 背景介绍
开源for Huawei（https://developer.huaweicloud.com/programs/opensource/contributing/） 通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki（https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
go-zero 是一个集成了各种工程实践的 web 和 rpc 框架，它通过弹性设计保障了大并发服务端的稳定性，经受了充分的实战检验。
源码地址：https://github.com/zeromicro/go-zero
官网主页：https://go-zero.dev/
主要开发语言：Go
LICENSE：MIT
维护者：go-zero team
项目数据：Fork 4K, Star 29.4K, Contributor 270，最近一次提交：2024-11-26
star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是帮助开源开发者体验开源for Huawei的过程，并熟悉GaussDB基础的开发能力。开发者需要在DEMO基础上，集成ORM框架并访问GaussDB。开源体验项目是开源for Huawei大部分DEMO设计的基础，通过完成本任务，可以帮助开发者熟悉开源for Huawei的开发流程。建议参与开源for Huawei的开发者都领取并完成这个任务。
l 能力要求
完成该任务需要具备微服务开发经验，使用过DevOps工具，熟悉云原生应用的开发和部署。开发过程中主要使用Go语言。本任务会使用GORM访问GaussDB数据库，开发者需要熟悉GORM的使用。
l 适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
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 工作量评估
|
任务 |
人/天 |
|
完成DEMO设计和功能开发 |
1 |
|
基于CCE容器完成环境搭建和DEMO验证 |
1 |
|
输出案例和博客 |
1 |
|
总计 |
3人天 |
4 任务分解
4.1 准备阶段
开始之前，参考“背景介绍”下载WIKI，根据README的步骤，本地编译和发布文档。阅读内容“Go示例项目-示例项目介绍”了解DEMO。
4.2 完成DEMO设计和功能开发
克隆Go示例项目（https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiDemoGo.git）到自己的仓库。
DEMO的部署图如下，具体可参考 README.md 文件描述：
开发功能点：
（1）定义 user.api 接口文件，包含对用户数据的增、删、改、查接口。
（2）在 internal/svc/servicecontext.go 中，集成GORM，并参考GORM的指南，在 user/internal/logic 中，开发一个数据库访问的示例，完成数据库的增、删、改、查操作。
4.3 基于CCE容器完成环境搭建和DEMO验证
参考WIKI“资源开通和规格信息”购买相关资源；参考WIKI“Go示例项目-在华为云部署示例项目”完成DEMO的部署。
部署和验证要求基于鲲鹏云（使用鲲鹏服务器、Euler操作系统和镜像）。
部署完成后，通过界面访问 http://IP:8081/user/list （IP地址为微服务SVC的公网访问地址）。 使用 Postman 测试新开发的增、删、改、查 REST 接口，验收报告需要提供接口测试结果的截图。
4.4 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。
内容包括不限于如下内容：
l 开源软件的功能介绍
l 开发适配过程及解决的问题
l DEMO设计、开发、部署过程
l 代码推送开源社区及互动过程
博客打上如下标签：
l 开源（必选）
l 开发者（必选）
l GaussDB数据库（可选）
l 云数据库 GaussDB（可选）
l 鲲鹏（可选）
l 昇腾（可选）
l 鸿蒙（可选）
l 对象存储 OBS（可选）
5 验收材料
参考验收报告模板：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/tree/main/zh_CN/docs/attachments 提供验收报告。本任务计划书要求的必须交付件参考下面的表格：
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发和验证。 |
完成计划书要求的DEMO功能开发，并在鲲鹏环境部署验证。 |
是 |
|
|
|
代码质量：适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
否 |
|
|
|
提供相关文档，比如部署文档、使用文档、配置文档等 |
根据社区要求，完善相关的开发指南和部署指导 |
否 |
|
|
|
合入到开源项目主仓：代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
否 |
|
|
|
Deomo设计&开发：完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
|
Demo部署&验证：完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
|
发布博客：发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
6 参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
2. 完成任务过程中，碰到问题可以在这里查询或者提问：
https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues
3. 开源软件 for Huawei 之 GORM 操作华为云数据库 GaussDB 攻略【最终章】：
https://bbs.huaweicloud.com/blogs/439075
4. GaussDB数据库驱动参考：https://support.huaweicloud.com/distributed-devg-v3-gaussdb/gaussdb-12-0056.html
- 点赞
- 收藏
- 关注作者
评论（0）