Bucket4j适配GaussDB开源验证任务
1 背景介绍
开源for Huawei(参考:https://developer.huaweicloud.com/programs/opensource/contributing/) 通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview) 了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
2 需求分析
Bucket4j 是一个用于 Java 的强大速率限制库,可灵活控制资源访问速率,保护系统资源并提升用户体验。 主要功能:
· Bucket4j 是一个 Java 速率限制库,用于控制对资源的访问速率。它可以限制在特定时间内对某个操作的执行次数,确保系统资源不被过度消耗。
· 提供多种速率限制策略,如固定速率限制、弹性速率限制等。可以根据不同的业务需求选择合适的限制策略。
· 支持分布式环境下的速率限制,可以通过外部存储(如数据库、缓存等)来实现跨多个节点的统一速率限制。
· 提供简洁的 API,易于集成到现有的 Java 应用程序中。
所属社区:个人开发,使用 Apache License 2.0。
源代码地址:https://github.com/vladimir-bukhtoyarov/bucket4j。
主要开发语言:Java。
用户使用情况:在一些 Java 开发的企业级应用和互联网服务中得到应用,特别是那些需要对用户请求或系统资源进行精细控制的场景。例如,在 API 网关、微服务架构中,可以使用 Bucket4j 来限制对后端服务的访问速率,防止系统过载。
主要商业价值:
· 保护系统资源:通过速率限制,可以防止系统被过度请求压垮,确保系统的稳定性和可用性。
· 提升用户体验:避免因系统过载导致的响应缓慢或失败,提高用户对系统的满意度。
· 优化资源分配:可以根据业务需求合理分配系统资源,提高资源利用率。
· 支持业务策略:可以实现各种业务策略,如付费用户和免费用户的不同访问速率限制等。
项目数据:Fork 286, Star 2.3k Contributor 51 最近一次提交:2024-9-18
star历史(https://star-history.com/):
2.1 任务目的和范围
本任务的主要目的是验证Bucket4j使用GaussDB进行分布式流控。参考:https://bucket4j.com/8.14.0/toc.html#bucket4j-postgresql
l 能力要求
完成该任务需要具备微服务开发经验,熟悉Bucket4j的设计原理和使用方法。开发过程中主要使用java语言。
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验证 |
2 |
输出开发资料和博客 |
1 |
总计 |
3人/天 |
4 任务分解
4.1 完成DEMO设计和功能验证
l 使用开源for Huawei提供的公共DEMO,参考: https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview。 在DEMO项目中的resource-server开发一个REST接口,引入guassdb驱动,使用Bucket4j完成对该接口的限流。
l Bucket4j已经支持PostgreSQL进行分布式限流,验证方案采用替换GaussDB商业驱动,并使用PostgreSQL配置的方案。 参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/issues/23
l 开发过程中遇到任何问题,包括不限于:流程问题,环境问题,设计问题,设计改善等。可以在demo指南的git项目中提交issue。
DEMO部署图:
4.2 DEMO开发、部署和验证
l 根据DEMO设计,完成演示功能开发和部署。要求使用CCE容器(Euler镜像)进行部署
l 点击前端按钮,产生调用,调用接口成功。模拟大量调用,产生限流效果。
4.3 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.com/blogs)发表博客,介绍完成这些任务的过程和心得。
内容包括不限于如下内容:
l 开源软件的功能介绍
l 开发适配过程及碰到的问题
l DEMO设计、开发、部署过程
l 代码推送开源社区及互动过程
博客打上如下标签:
l 开源(必选)
l 开发者(必选)
l GaussDB数据库(可选)
l 云数据库 GaussDB(可选)
l 鲲鹏(可选)
l 昇腾(可选)
l 鸿蒙(可选)
l 对象存储 OBS(可选)
5 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发和验证。 |
完成GaussDB数据库适配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. Spring Data JPA适配GaussDB开源验证任务心得:
https://bbs.huaweicloud.com/blogs/438331
- 点赞
- 收藏
- 关注作者
评论(0)