README
¶
简体中文 | English
注意: main 分支在开发过程中可能处于不可用状态，请通过 Releases 去获取稳定版本代码。
蓝鲸 Go 开发框架基于 Gin & 蓝鲸 PaaS 平台 的能力，通过集成统一登录，云 API，对象存储等服务，帮助 SaaS 开发者快速开发 Web 服务。
功能特性
蓝鲸 Go 开发框架推出全新版本，包含以下特性：
- 全新设计的 Demo 功能，直观展示框架能力，助力开发者快速上手体验
- 内置统一登录，支持用户身份认证 & 基础的 API 访问权限控制
- 集成 MySQL、Redis、对象存储（bk-repo）等平台提供的增强服务
- 集成 GORM 组件，支持数据库加密、版本控制及多级缓存机制
- 内置定时 / 异步任务框架，支持任务调度，降低复杂任务开发成本
- 无缝集成蓝鲸可视化能力，提供实时监控看板 & APM 性能追踪
- 自动生成 Swagger API 接口文档 & 支持多语言国际化（i18n）
- 支持通过蓝鲸 Buildpack 或 Dockerfile 构建模式部署
快速开始
开发者可以通过阅读 开发使用指南 来了解如何快速上手使用蓝鲸 Go 开发框架。
支持
- PaaS 产品白皮书
- 蓝鲸智云 - 学习社区
- 蓝鲸 DevOps 在线视频教程
- 蓝鲸社区版交流 QQ 群：495299374
- 蓝鲸运维开发交流 QQ 群：878501914
蓝鲸社区
- BK-PaaS：蓝鲸 PaaS 平台是开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理 SaaS 应用。
- BK-APIGW：蓝鲸 API 网关是高性能，高可用的 API 托管服务，帮助开发者创建、发布、维护、监控和保护 API。
- BK-CI：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
- BK-BCS：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
- BK-SOPS：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统。
- BK-JOB：蓝鲸作业平台（Job）是一套运维脚本管理系统，具备海量任务并发处理能力。
- BK-CMDB：蓝鲸配置平台是一个面向资产及应用的企业级配置管理平台。
贡献
如果你有好的意见或建议，欢迎给我们提 Issues 或 PullRequests，为蓝鲸开源社区贡献力量。关于分支、Issue 及 PR，请查看 代码贡献指南。
腾讯开源激励计划 鼓励开发者的参与和贡献，期待你的加入。
协议
本项目基于 MIT 协议，详细请参考 LICENSE
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
account
Package account 提供不同版本的用户认证后端
|
Package account 提供不同版本的用户认证后端 |
|
apis/asynctask
Package asynctask ...
|
Package asynctask ... |
|
apis/asynctask/handler
Package handler ...
|
Package handler ... |
|
apis/asynctask/serializer
Package serializer ...
|
Package serializer ... |
|
apis/basic
Package basic ...
|
Package basic ... |
|
apis/basic/handler
Package handler ...
|
Package handler ... |
|
apis/basic/serializer
Package serializer ...
|
Package serializer ... |
|
apis/cache
Package cache 实现缓存实例 (redis/内存缓存)
|
Package cache 实现缓存实例 (redis/内存缓存) |
|
apis/cache/handler
Package handler ...
|
Package handler ... |
|
apis/cache/serializer
Package serializer ...
|
Package serializer ... |
|
apis/cloudapi
Package cloudapi ...
|
Package cloudapi ... |
|
apis/cloudapi/handler
Package handler ...
|
Package handler ... |
|
apis/cloudapi/serializer
Package serializer ...
|
Package serializer ... |
|
apis/crud
Package crud ...
|
Package crud ... |
|
apis/crud/handler
Package handler ...
|
Package handler ... |
|
apis/crud/serializer
Package serializer ...
|
Package serializer ... |
|
apis/objstorage
Package objstorage ...
|
Package objstorage ... |
|
apis/objstorage/handler
Package handler ...
|
Package handler ... |
|
apis/objstorage/serializer
Package serializer ...
|
Package serializer ... |
|
async
Package async 提供一个简单的异步 / 定时任务封装： 1.
|
Package async 提供一个简单的异步 / 定时任务封装： 1. |
|
async/task
Package task 包含异步任务实现
|
Package task 包含异步任务实现 |
|
cache/memory
Package memory 提供内存缓存服务（基于 freecache 封装，内存预分配 + LRU 算法） ref: https://github.com/coocood/freecache
|
Package memory 提供内存缓存服务（基于 freecache 封装，内存预分配 + LRU 算法） ref: https://github.com/coocood/freecache |
|
cache/redis
Package redis 提供 Redis 缓存服务
|
Package redis 提供 Redis 缓存服务 |
|
common/probe
Package probe provides health probes for components
|
Package probe provides health probes for components |
|
config
Package config 管理蓝鲸 SaaS 配置项，支持从配置文件 / 环境变量中读取配置
|
Package config 管理蓝鲸 SaaS 配置项，支持从配置文件 / 环境变量中读取配置 |
|
docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
i18n
Package i18n provide i18n (Internationalization) support
|
Package i18n provide i18n (Internationalization) support |
|
infras/cloudapi/cmsi
Package cmsi 提供邮件，短信等消息发送能力
|
Package cmsi 提供邮件，短信等消息发送能力 |
|
infras/database
Package database 提供了数据库相关的封装，目前实现的是主流的 gorm + mysql SaaS 开发者可根据需要替换为其他 orm（如 SQLBoiler，Ent）或者其他数据库（如 mongodb） 如果对性能要有很高的话，也可以考虑 sqlx，这是一个高性能的标准 sql 库增强 & 扩展包， 其缺点是没有提供完整的 ORM 功能（如自动迁移，关系处理等等），开发者用起来不太方便（需要写不少的 SQL）
|
Package database 提供了数据库相关的封装，目前实现的是主流的 gorm + mysql SaaS 开发者可根据需要替换为其他 orm（如 SQLBoiler，Ent）或者其他数据库（如 mongodb） 如果对性能要有很高的话，也可以考虑 sqlx，这是一个高性能的标准 sql 库增强 & 扩展包， 其缺点是没有提供完整的 ORM 功能（如自动迁移，关系处理等等），开发者用起来不太方便（需要写不少的 SQL） |
|
infras/objstorage
Package objstorage 提供对象存储相关封装，目前接入的是蓝盾制品库（bkrepo） 如果 SaaS 开发者需要使用其他云对象存储（如 COS，S3, Ceph 等），可参考相关实现
|
Package objstorage 提供对象存储相关封装，目前接入的是蓝盾制品库（bkrepo） 如果 SaaS 开发者需要使用其他云对象存储（如 COS，S3, Ceph 等），可参考相关实现 |
|
infras/otel
Package otel 用于初始化 OpenTelemetry
|
Package otel 用于初始化 OpenTelemetry |
|
infras/otel/otel-resty
Package otelresty provides OpenTelemetry middleware for resty
|
Package otelresty provides OpenTelemetry middleware for resty |
|
infras/redis
Package redis 提供了 Redis 相关的封装（基于 redis/go-redis/v9） SaaS 开发者查阅该文档以了解使用方法：https://redis.uptrace.dev/guide/go-redis.html
|
Package redis 提供了 Redis 相关的封装（基于 redis/go-redis/v9） SaaS 开发者查阅该文档以了解使用方法：https://redis.uptrace.dev/guide/go-redis.html |
|
logging/slog-resty
Package slogresty 实现 resty.Logger 接口
|
Package slogresty 实现 resty.Logger 接口 |
|
migration
Package migration stores all database migrations
|
Package migration stores all database migrations |
|
model
Package model 用于存放数据库模型
|
Package model 用于存放数据库模型 |
|
router
Package router 是项目 API 服务的主路由入口
|
Package router 是项目 API 服务的主路由入口 |
|
utils/crypto
Package crypto 提供各类算法加解密
|
Package crypto 提供各类算法加解密 |
|
utils/envx
Package envx 提供环境变量相关工具
|
Package envx 提供环境变量相关工具 |
|
utils/ginx
Package ginx 提供一些 Gin 框架相关的工具
|
Package ginx 提供一些 Gin 框架相关的工具 |
|
utils/testing
Package testing 提供一些单元测试用的工具
|
Package testing 提供一些单元测试用的工具 |
|
utils/uuidx
Package uuidx 提供一些 uuid 相关的工具
|
Package uuidx 提供一些 uuid 相关的工具 |
|
version
Package version 提供版本信息
|
Package version 提供版本信息 |
|
web/handler
Package handler ...
|
Package handler ... |
Click to show internal directories.
Click to hide internal directories.