Django ORM适配GaussDB开源开发任务
1 背景介绍
开源for Huawei(参考:https://developer.huaweicloud.com/programs/opensource/contributing/)通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
2 需求分析
2.1 项目影响力
1. Django的对象关系映射系统(Object-Relational Mapper, ORM)提供了丰富的数据查询接口, 让你无需使用原生SQL语句即可通过对模型的简单操作实现对数据库里的数据进行增删改查 。 查询得到的结果叫查询集(QuerySet), 所以这个接口被称为QuerySet API
· 主要功能:
o 模型定义:通过定义Python类(模型),自动映射到数据库的表中。模型定义的每个字段对应数据库中的列,开发者可以通过类属性定义数据类型和约束。
o CURD操作:创建、读取、更新、删除操作。
o 查询集:Django ORM提供了一个强大的查询API,允许开发者通过链式调用进行复杂的查询。
o 关系处理:支持处理多种数据库表关系,如One-to-One、ForeignKey、Many-to-Many等,通过定义模型字段即可实现复杂的表关联。
o 迁移(Migrations):Django ORM通过迁移系统自动管理数据库表的创建、修改和删除。
o 事务管理:支持数据库事务。
o 数据库抽象:Django ORM支持多种数据库后端(如PostgreSQL、MySQL、SQLite等),代码不依赖于具体的数据库,便于切换数据库。
· 所属社区:Django社区,有Django SoftWare Foundation(DSF)和全球开发者共同推进维护。
· 源代码地址:https://github.com/django/django。
· 官网主页:https://www.djangoproject.com/。
· 主要开发语言:Python。
· 用户使用情况:Django ORM被大量初创公司使用,特别是在构建MVP(最小可行产品)阶段。中小型企业通常使用Django ORM来构建和维护他们的Web应用和内部系统。一些大型企业、政府机构和非盈利性组织也使用Django ORM,它被用于构建高流量网站、内容管理系统和复杂的商业应用。知名用户和平台如Instagram、Pinterest、Mozilla等。在全球使用范围较广。
· 主要商业价值:
o 开发效率提升:Django ORM通过提供面向对象的数据库操作接口,避免了手写SQL,大大提升了开发效率。尤其对于初创公司或者需要快速迭代产品的企业,Django ORM可以缩短开发周期,降低开发成本。
o 数据库无关性:Django ORM提供了数据库无关的抽象层,使得应用程序可以在不同的数据库之前轻松切换。这对于企业扩展或者技术迁移时非常有价值,减少了数据库依赖的技术锁定问题。
o 维护和可扩展性:Django ORM简化了数据库结构的维护,通过Django的迁移系统可以轻松管理数据库表的创建、删除、修改等操作。对于需要频繁更新和扩展的项目,ORM提供了可靠的解决方案,减少了手动操作数据库的风险。
o 社区支持和安全性:Django ORM是Django框架的核心部分,得到了全球开源社区的支持和维护。Django社区持续更新和修复安全漏洞,确保ORM的安全性和稳定性,尤其适用于对安全性要求较高的行业如金融、电商等。
o 降低学习成本:对于企业来说Djang ORM学习曲线相对较低。
2.ORM与DB映射关系
3. 根据2023年Django开发者调查报告解读显示: Django仍然是74%开发者首选。
4. 项目数据:Fork 31.5K, Star 79.1K, Contributor 2569,最近一次提交:2024-9-7 star历史(https://star-history.com/):
2.2 任务目的和范围
任务的主要目的
本任务的主要目的是让Django社区支持GaussDB数据库,帮助拓展GaussDB的影响力,也方便Django ORM的用户数据库后端能够支持GaussDB。
能力要求
完成该任务需要具备微服务开发经验,熟悉Python Django项目的开发与Django核心。开发过程中主要使用Python语言,演示DEMO会涉及少量的Vue、TypeScirpt前端(可选)。
适配任务清单
生态 |
生态细类 |
是否需要验证 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
昇腾生态 |
指令 |
否 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
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 工作量评估和任务分解
3.1 工作量评估
任务 |
人/天 |
完成GaussDB数据库适配功能开发 |
2 |
完成DEMO设计和代码开发 |
2 |
基于CCE容器完成环境搭建和DEMO部署、验证 |
1 |
输出开发资料和博客 |
1 |
代码推送上游社区和更新社区资料 |
2 |
总计 |
8人天 |
3.2 完成GaussDB数据库适配功能开发
·可以使用兼容GaussDB的数据库驱动 psycopg2,但可能需要对其进行扩展或定制以支持GaussDB特有的功能。
·在GitCode完成项目Fork(https://github.com/django/django/tree/main/django/db/backends),并完成对GaussDB数据库引擎的适配开发,然后保证新的数据库引擎被正确导入和注册。
·在自定义的数据库引擎模块中,实现所有必要的数据库操作方法,并添加特定的方言支持。如果GaussDB有特定的SQL语法或函数,应该在数据库后端实现这些特性。
·如果GaussDB存在特定的数据类型,可能需要在Django的模型字段中去更新相对应的字段类型 https://github.com/django/django/tree/main/django/db/models/fields。
·Django ORM默认不支持分布式数据库。这可能需要开发中间件或自定义数据库路由来处理数据分片和查询路由。
3.3 完成GaussDB演示DEMO设计
参考下面的用例图:
在Django项目的settings.py文件中,配置数据库连接信息
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.gaussdb', # 使用自定义GaussDB引擎
'NAME': 'your_database',
'USER': 'your_username',
'PASSWORD': 'your_password',
'HOST': 'your_host',
'PORT': 'your_port',
}
}
3.4 DEMO开发、部署和验证
参考下面的部署架构:
Django ORM(对象关系映射)本身不直接使用DBAPI(数据库API),但是它是建立在DBAPI之上的,最终都需要依赖于DBAPI兼容的数据库驱动来与数据库进行通信。
为了简化用户开发,提供了一个项目脚手架。开发者可以在脚手架基础上,完成DEMO功能开发。可以参考: https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/blob/main/README.md 提供的指导,可以帮助您在华为云开通资源、编译DEMO和基于DEMO做增量代码开发。
3.5 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.com/blogs)发表博客,介绍完成这些任务的过程和心得。内容包括不限于如下内容:
·开源for Huawei的背景
·开源软件的功能介绍
·开发适配过程及碰到和解决的问题
·DEMO设计、开发、部署过程
·代码推送开源社区及互动过程
博客打上如下标签:
·开源(必选)
·开发者(必选)
·GaussDB数据库(可选)
·云数据库 GaussDB(可选)
· 鲲鹏(可选)
·昇腾(可选)
·鸿蒙(可选)
·对象存储 OBS(可选)
3.6 代码推送上游社区
将代码合并到Django官网主干代码;更新Django官网资料,包括版本说明、开发指南等。
Django仓库地址: https://github.com/django/django/tree/main/django/db/backends
4 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发 |
完成GaussDB数据库适配功能开发。举证提供PR链接。 |
是 |
|
|
代码质量:适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
是 |
|
|
提供相关文档,比如部署文档、使用文档、配置文档等 |
根据社区要求,完善相关的开发指南和部署指导 |
否 |
|
|
合入到开源项目主仓:代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
是 |
|
|
Deomo设计&开发:完成功能演示Demo的开发 |
举证提供DEMO仓库地址和DEMO开发提交记录。 |
是 |
|
|
Demo部署&验证:完成功能演示DEMO基于华为云鲲鹏环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
发布博客:发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
|
参考资料
1. 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南: https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
2. Django开发者调查报告解读:https://www.oschina.net/news/291755/django-developer-survey-2023
3. 基于psycopg2的官方文档: https://support.huaweicloud.com/distributed-devg-v3-gaussdb/gaussdb-12-0149.html
3. XXX开源软件For Huawei介绍、环境搭建、示例项目、开发和部署指南:华为开发wiki
4. JAVA/JavaScript语言DEMO环境准备、编译、开发和部署指南:https://bbs.huaweicloud.com/blogs/43342
- 点赞
- 收藏
- 关注作者
评论(0)