cago

package module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2024 License: MIT Imports: 11 Imported by: 3

README

[TOC]

Cago

Cago 一个快速开发的集成式框架.使用模块化的开发模式,每一个组件都可以单独的调用.

Cago 只对社区工具进行集成,大大减少迁移难度和学习成本,我们不生产代码,我们只是方案的搬运工.

使用 go 的struct来声明 API 和 swagger 文档,可以通过脚手架来帮助你生成相关内容.

快速开始

简单示例

脚手架

脚手架文档

CI/CD

部署资源

cago 提供了gitlab-ci、golanglint-ci和 Kubernetes的 CI/CD 配置文件,可以快速帮你实现 CI/CD.

当本地调试时也可以使用docker compose up -d启动调试环境.

默认使用etcd作为配置中心,同时也支持文件作为配置启动.

组件

参考项目

  • GoFrame
  • GoMicro

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Version 

func Version() string

Types

type Cago 

type Cago struct {
	// contains filtered or unexported fields
}

func New 

func New(ctx context.Context, cfg *configs.Config) *Cago

New 初始化cago

func (*Cago) DisableLogger 

func (r *Cago) DisableLogger() *Cago

DisableLogger 禁用框架日志

func (*Cago) Registry 

func (r *Cago) Registry(component Component) *Cago

Registry 注册组件

func (*Cago) RegistryCancel 

func (r *Cago) RegistryCancel(component ComponentCancel) *Cago

RegistryCancel 注册cancel组件

func (*Cago) Start 

func (r *Cago) Start() error

Start 启动框架,在此之前组件已全部启动,此处只做停止等待

type CloseHandle 

type CloseHandle func()

type Component 

type Component interface {
	Start(ctx context.Context, cfg *configs.Config) error
	CloseHandle()
}

type ComponentCancel 

type ComponentCancel interface {
	Component
	StartCancel(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error
}

type FuncComponent 

type FuncComponent func(ctx context.Context, cfg *configs.Config) error

func (FuncComponent) CloseHandle 

func (f FuncComponent) CloseHandle()

func (FuncComponent) Start 

func (f FuncComponent) Start(ctx context.Context, cfg *configs.Config) error

type FuncComponentCancel 

type FuncComponentCancel func(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error

func (FuncComponentCancel) CloseHandle 

func (f FuncComponentCancel) CloseHandle()

func (FuncComponentCancel) Start 

func (f FuncComponentCancel) Start(ctx context.Context, cfg *configs.Config) error

func (FuncComponentCancel) StartCancel 

func (f FuncComponentCancel) StartCancel(ctx context.Context, cancel context.CancelFunc, cfg *configs.Config) error

Source Files

View all Source files

Directories

Path Synopsis
cmd
cago
etcd
file
memory
source
database
cache
cache/cache
cache/memory
cache/redis
db
db/clickhouse
db/model
elasticsearch
migrate/mongomigrate
mongo
redis
examples
simple/cmd/app
simple/docs
Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag at 2024-01-05 15:41:56.648995 +0800 CST m=+0.085785210
 Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT This file was generated by swaggo/swag at 2024-01-05 15:41:56.648995 +0800 CST m=+0.085785210
simple/internal/api
simple/internal/api/example
simple/internal/api/user
simple/internal/controller/example_ctr
simple/internal/controller/user_ctr
simple/internal/model
simple/internal/model/entity/user_entity
simple/internal/pkg/code
simple/internal/repository/user_repo
simple/internal/service/example_svc
simple/internal/service/user_svc
simple/internal/task/consumer
simple/internal/task/consumer/subscribe
simple/internal/task/producer
simple/migrations
internal
cmd
cmd/gen
cmd/gen/utils
permission
permission/storage
sessions
sessions/cache
token_auth
pkg
broker
broker/broker
broker/event_bus
broker/nsq
component
consts
errs
gogo
i18n
limit
logger
logger/loki
opentelemetry/metric
opentelemetry/trace
oss
oss/minio
oss/oss
swagger
sync
utils
utils/httputils
utils/muxutils
utils/validator
utils/wrap
server
cron
grpc
mux
mux/muxclient
mux/muxtest

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.