Beego 适配 GaussDB 开源验证任务
1 背景介绍
开源for Huawei（参考：https://developer.huaweicloud.com/programs/opensource/contributing/） 通过和公司、高校、社区的开发者合作，完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发，帮助繁荣Huawei的基础生态，同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前，开发者可以下载 开源for Huawei Wiki（参考：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview） 了解详细的开发步骤，技术准备，以及开发过程需要的各种资源。
2 需求分析
2.1 开源软件基本情况
Beego 是一个用于 Go 编程语言的开源、高性能 Web 框架，可用于快速开发 Go 中的企业应用程序，包括 RESTful API、Web 应用程序和后端服务。它的灵感来自 Tornado、Sinatra 和 Flask，Beego 在中国具备大量的用户基础。
源码地址：https://github.com/beego/beego
官网主页：http://beego.vip/
主要开发语言：Go
LICENSE：Apache 2.0
维护者：Beego 开源社区（个人社区）
项目数据：Fork 5.6K, Star 31.6K, Contributor 402，最近一次提交：2024-10-31
star历史（https://star-history.com/）：
2.2 任务目的和范围
本任务的主要目的是让 Beego ORM 支持 GaussDB 数据库，帮助拓展 GaussDB 的影响力，也方便 Beego 框架的用户可以使用华为云数据库 GaussDB 。
- 能力要求
完成该任务需要具备 Go 微服务开发经验，使用过 DevOps 工具，熟悉 GaussDB 数据库驱动，熟悉 ORM 的设计原理和使用方法。
- 适配任务清单
|
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
|
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
|
CANN |
否 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
|
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
|
数据库生态 |
GaussDB |
是 |
使用GaussDB功能。 |
否 |
|
|
|
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 完成GaussDB演示DEMO设计
按照 OpenSourceForHuaweiWiki Issues 开源软件连接GaussDB驱动选择和问题记录(Go) 方案二的描述：使用 GaussDB 商业驱动 openGauss-connector-go-pq 替换 PostgreSQL 原生驱动，和开源软件针对 PostgreSQL 提供的扩展模块。验证使用该方案是否可行，功能适配程度怎么样，有没有什么问题。
- 首先在 GitCode 完成 OpenSourceForHuaweiDemoGo 项目 Fork，并完成 GaussDB 数据库适配需要的脚本和代码开发。
- 按照 OpenSourceForHuaweiDemoGo 提供用户信息的 RESTful 接口，具体包括4个接口：用户列表接口、添加用户接口、修改用户接口、删除用户接口。
- 提供 Beego 示例代码的镜像，使用该镜像，能够操作 GaussDB 数据库。
参考：
OpenSourceForHuaweiDemoGo 地址：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiDemoGo
OpenSourceForHuaweiWiki Issues 地址：https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues/24
参考下面的模块图：
DEMO的简单部署图如下：
4.2 DEMO开发、部署和验证
根据DEMO设计，完成演示功能开发和部署。要求使用CCE容器（Euler镜像）进行部署。
4.3 在华为云开发者论坛输出博客
访问华为云开发者论坛（参考：https://bbs.huaweicloud.com/blogs）发表博客，介绍完成这些任务的过程和心得。
内容包括不限于如下内容：
- 开源for Huawei的背景
- 开源软件的功能介绍
- 开发适配过程及碰到和解决的问题
- DEMO设计、开发、部署过程
- 代码推送开源社区及互动过程
博客打上如下标签：
- 开源（必选）
- 开发者（必选）
- GaussDB数据库（可选）
- 云数据库 GaussDB（可选）
- 鲲鹏（可选）
- 昇腾（可选）
- 鸿蒙（可选）
- 对象存储 OBS（可选）
5 验收材料
|
验收细则 |
评分说明 |
是否为验收必选项 |
结果（通过/不通过） |
开发者举证 |
|
功能开发：完成与华为三大根技术生态（鲲鹏云、昇腾云、鸿蒙）适配的功能开发和验证。 |
按照计划书要求，完成Beego在鲲鹏服务器的安装和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 之 GoFrame 操作华为云数据库 GaussDB 攻略：
https://bbs.huaweicloud.com/blogs/439594
- 点赞
- 收藏
- 关注作者
评论（0）