README
¶
Cago
Cago 一个快速开发的集成式框架.使用模块化的开发模式,每一个组件都可以单独的调用.
Cago 只对社区工具进行集成,大大减少迁移难度和学习成本,我们不生产代码,我们只是方案的搬运工.
使用 go 的struct来声明 API 和 swagger 文档,可以通过脚手架来帮助你生成相关内容.
快速开始
你可以通过简单示例来快速的了解 Cago 的使用。你也可以复制这个示例来创建你的项目。
完整文档入口见 Cago 文档导航。
脚手架
你可以安装脚手架来帮助你生成代码。
CI/CD
代码检查
仓库通过 make lint 运行固定版本的 golangci-lint，并内置 Cago 框架结构检查器
cagolint。除了常规 Go 静态检查外，它还会检查 API 路由元数据、
Controller handler 签名、Service/Repository 命名和分层依赖。支持安全修复的规则可以通过
make lint-fix 自动处理。
CI 会在每次 push 和 pull request 时执行相同的 lint harness。规则列表、配置和开发方式见
tools/cagolint/README.md。
cago 提供了gitlab-ci、golanglint-ci和
Kubernetes helm的 CI/CD 配置文件,可以快速帮你实现 CI/CD.
当本地调试时也可以使用docker-compose.yaml启动调试环境.
可以使用etcd作为配置中心，也支持文件作为配置启动。
组件
大多数组件都是基于社区工具进行封装，方便使用。
目录结构
Cago使用三层架构，并混合了DDD的思想，推荐使用下面的目录结构。你也可以根据自己的需求来调整目录结构。
cmd/app/main.go项目的入口configsconfig.yaml配置文件...其他配置文件，也可以写配置读取方法，其它包调用：configs.GetConfig().XXX
docs文档目录，包括 swagger api 文档、设计文档等deploy部署资源文件internal内部包apiAPI 请求结构体example/example.goapi请求与返回结构router.go路由定义
controller控制器目录，API请求会调用控制器，做一些数据处理校验逻辑model数据模型entity数据库实体模型，推荐使用充血模型xxx.go一些数据模型的定义
pkg项目内通用的模块code错误码定义utils工具包
repository数据库操作service服务接口task任务模块crontab定时任务queue消息队列handler消息队列处理器message消息定义xxx.go消息队列定义
task.go任务定义
migrations数据库迁移文件pkg公共的模块，可以被其它项目引用.golangci.ymlgolangci-lint 配置文件Makefile项目的 Makefile 文件
AI
SKILL
本项目提供了 AI 编程助手的 Skill 支持，详见 Skill 文档。
开发工具
cago：从 API、Service 或数据库结构生成项目代码和 Swagger 文档。cagolint：检查 Cago 项目的分层、路由元数据和命名约定，已集成到make lint。tools/skill：供 AI 编程助手读取的框架知识，不是可执行程序，也不参与 Go 构建。
参考项目
- GoFrame
- GoMicro
Who use Cago？
License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Cago ¶
type Cago struct {
// contains filtered or unexported fields
}
func New ¶
New create a new cago instance ctx 可以管理整个应用的生命周期，当ctx.Done()时，会传递到每一个组件，安全退出 cfg 配置文件，每一个组件都可以使用，通过 configs.NewConfig 去构建 应用启动时，会调用每一个组件的 Component.Start 方法，启动组件 应用停止时，会调用每一个组件的 Component.CloseHandle 方法，关闭组件 推荐链式调用的方式去使用 cago.New(ctx, cfg).Registry(component.Core()).RegistryCancel(mux.HTTP(api.Router)).Start()
func (*Cago) RegistryCancel ¶
func (r *Cago) RegistryCancel(component ComponentCancel) *Cago
RegistryCancel 注册cancel组件，cancel组件可以停止整个应用
type CloseHandle ¶
type CloseHandle func()
type Component ¶
type Component interface {
// Start 启动组件 会传入框架的context和配置文件
Start(ctx context.Context, cfg *configs.Config) error
// CloseHandle 关闭处理 当应用停止时，会调用该方法，停止组件
CloseHandle()
}
Component 组件接口
type ComponentCancel ¶
type ComponentCancel interface {
Component
// StartCancel 启动组件，会传入框架的context和配置文件，以及cancel方法
// 可以通过cancel方法停止整个应用
StartCancel(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error
}
ComponentCancel 带cancel方法的组件 可以停止整个应用
type FuncComponent ¶
FuncComponent 函数式组件 适用于简单的组件 当你的组件不需要释放资源时，你可以只写一个函数，然后通过 FuncComponent 转换成组件 例如：
cago.FuncComponent(func(ctx context.Context, cfg *configs.Config) error {
return nil
})
func (FuncComponent) CloseHandle ¶
func (f FuncComponent) CloseHandle()
type FuncComponentCancel ¶
type FuncComponentCancel func(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error
FuncComponentCancel 函数式带cancel方法的组件 适用于简单的组件，与 FuncComponent 的区别是多了一个cancel方法
func (FuncComponentCancel) CloseHandle ¶
func (f FuncComponentCancel) CloseHandle()
func (FuncComponentCancel) StartCancel ¶
func (f FuncComponentCancel) StartCancel(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cago
command
|
|
|
database
|
|
|
examples
|
|
|
simple/cmd/app
command
|
|
|
simple/docs
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag at 2024-04-12 17:50:02.541948 +0800 CST m=+0.060448417
|
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag at 2024-04-12 17:50:02.541948 +0800 CST m=+0.060448417 |
|
simple/internal/repository/user_repo/mock
Package mock_user_repo is a generated GoMock package.
|
Package mock_user_repo is a generated GoMock package. |
|
internal
|
|
|
pkg
|
|
|
utils/testutils
一些用于测试的工具函数
|
一些用于测试的工具函数 |
|
server
|
|