magicCommon

功能特性

基础工具 (Foundation)

框架组件 (Framework)

其他模块

快速开始

安装

go get github.com/muidea/magicCommon

使用示例

package main
import (
 "fmt"
 
 cd "github.com/muidea/magicCommon/def"
 "github.com/muidea/magicCommon/foundation/dao"
 "github.com/muidea/magicCommon/foundation/log"
)
func main() {
 // 初始化日志
 log.Infof("Starting application...")
 
 // 创建数据库连接
 db, err := dao.Fetch("user", "password", "localhost:3306", "testdb")
 if err != nil {
 log.Errorf("Failed to connect to database: %v", err)
 return
 }
 defer db.Release()
 
 // 执行查询
 err = db.Query("SELECT 1")
 if err != nil {
 log.Errorf("Query failed: %v", err)
 return
 }
 
 log.Infof("Application started successfully")
}

开发指南

Framework 生命周期

err := application.Startup(ctx, service.DefaultService())
if err != nil {
 return err
}
defer application.Shutdown(ctx)
err = application.Run(ctx)

opts := application.Options{
 ConfigDir: "./config",
 ServiceName: "example-service",
 EventHubQueueSize: 1024,
 BackgroundQueueSize: 1024,
}
err := application.StartupWithOptions(ctx, service.DefaultService(), opts)

type localService struct{}
func (s *localService) Startup(ctx context.Context) error { return nil }
func (s *localService) Run(ctx context.Context) error { return nil }
func (s *localService) Shutdown(ctx context.Context) error { return nil }
svc := service.AdaptLifecycle("local", &localService{})
err := application.Startup(ctx, svc)

err := initiator.RegisterE(plugin)
module.MustRegister(plugin)

环境要求

本地开发

# 克隆项目
git clone https://github.com/muidea/magicCommon.git
cd magicCommon
# 安装依赖
go mod tidy
go mod download
# 运行完整验证
make all
# 运行测试
make test
# 代码质量检查
make lint

测试数据库

# 启动 MySQL
docker run -d --name mysql-test \
 -e MYSQL_DATABASE=testdb \
 -e MYSQL_ROOT_PASSWORD=rootkit \
 -p 3306:3306 \
 mysql:5.7
# 启动 PostgreSQL
docker run -d --name postgres-test \
 -e POSTGRES_USER=postgres \
 -e POSTGRES_PASSWORD=rootkit \
 -e POSTGRES_DB=testdb \
 -p 5432:5432 \
 postgres:17.2-alpine

CI/CD 流程

提交代码前

# 运行完整验证
make all
# 或分步运行
make build # 构建项目
make test # 运行测试 
make lint # 代码质量检查
make vet # 静态分析
make fmt-check # 代码格式检查

CI 流程

发布流程

项目结构

magicCommon/
├── def/ # 通用定义和错误类型
├── foundation/ # 基础工具
│ ├── cache/ # 缓存系统
│ ├── dao/ # 数据访问层
│ ├── log/ # 日志系统
│ ├── net/ # 网络工具
│ ├── os/ # 系统工具
│ ├── path/ # 路径工具
│ ├── pool/ # 连接池
│ ├── signal/ # 信号处理
│ ├── system/ # 系统工具
│ └── util/ # 工具函数
├── framework/ # 框架组件
│ ├── application/ # 应用框架
│ ├── configuration/ # 配置管理
│ ├── plugin/ # 插件系统
│ └── service/ # 服务框架
├── event/ # 事件系统
├── execute/ # 并发执行器
├── monitoring/ # 监控系统
├── session/ # 会话管理
├── task/ # 任务调度
└── test/ # 测试工具

核心基础设施文档

代码规范

导入顺序

错误处理

测试规范

贡献指南

提交信息规范

许可证

联系方式

致谢