CLD的核心理念是将开发过程中的各种资源(如计算资源、存储资源、数据库等)都移到云端进行管理和调配,使得开发者能够专注于业务逻辑的实现,而不必过多关心底层的基础设施搭建和维护。
CLD分层
1.Controller层:服务的入口,处理外部请求,路由解析、参数校验、请求转发等功能。
2.Logic层:业务逻辑层,承担了业务处理的核心功能。
3.DAO层:数据访问层,主要负责与数据存储进行交互。
|_redis 负责与redis数据库进行交互
|_mysql 负责与mysql数据库进行交互
其他应用层
a、Logger层:日志层负责记录系统运行时的各种信息和事件。
b、Model层:功能实现层,包括各种业务功能的具体实现代码、数据模型的定义和操作等。
c、Setting层:配置层用于存储系统的各种配置信息。
d、Routes层:路由层负责将外部请求映射,定义了系统的各种API接口和路由规则。
基础脚手架目录
1. 初始化脚手架配置main.go
func main() {
//1加载配置
if err := settings.Init(); err != nil {
fmt.Printf("init settings error: %v\n", err)
return
}
//2.初始化日志
if err := logger.Init(); err != nil {
fmt.Printf("init logger error: %v\n", err)
return
}
defer zap.L().Sync()
//3.初始化MySQL
if err := mysql.Init(); err != nil {
fmt.Printf("init mysql error: %v\n", err)
return
}
defer mysql.Close()
//4.初始化Redis
if err := redis.Init(); err != nil {
fmt.Printf("init redis error: %v\n", err)
return
}
defer redis.Close()
//5.注册路由
r := routes.Setup()
//6.启动服务(优雅关机)
srv := &http.Server{
Addr: fmt.Sprintf(":%d", viper.GetInt("app.port")),
Handler: r,
}
go func() {
// 开启一个goroutine启动服务
if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
log.Fatalf("listen: %s\n", err)
}
}()
// 等待中断信号来优雅地关闭服务器,为关闭服务器操作设置一个5秒的超时
quit := make(chan os.Signal, 1) // 创建一个接收信号的通道
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM) // 此处不会阻塞
<-quit // 阻塞在此,当接收到上述两种信号时才会往下执行
zap.L().Info("Shutdown Server ...")
// 创建一个5秒超时的context
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// 5秒内优雅关闭服务(将未处理完的请求处理完再关闭服务),超过5秒就超时退出
if err := srv.Shutdown(ctx); err != nil {
zap.L().Fatal("Server Shutdown: ", zap.Error(err))
}
zap.L().Info("Server exiting")
}
2.setting.go映射配置文件内容
func Init() (err error) {
viper.SetConfigFile("config.yaml") // 配置文件的名称配置此项
viper.AddConfigPath(".") // 还可以在工作目录中查找配置
err = viper.ReadInConfig() // 查找并读取配置文件
if err != nil {
fmt.Printf("viper.ReadInConfig() falling ,err %v\n", err)
return // 处理读取配置文件的错误
}
viper.WatchConfig()
viper.OnConfigChange(func(in fsnotify.Event) {
fmt.Println("配置文件修改了")
})
return
}
3.mysql.go 数据库连接模块
var db *sqlx.DB
func Init() (err error) {
dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=utf8mb4&parseTime=True",
viper.GetString("mysql.user"),
viper.GetString("mysql.password"),
viper.GetString("mysql.host"),
viper.GetInt("mysql.port"),
viper.GetString("mysql.dbname"),
)
// 也可以使用MustConnect连接不成功就panic
db, err = sqlx.Connect("mysql", dsn)
if err != nil {
zap.L().Error("connect failed", zap.Error(err))
//fmt.Printf("connect DB failed, err:%v\n", err)
return
}
db.SetMaxOpenConns(viper.GetInt("mysql.max_open_conns"))
db.SetMaxIdleConns(viper.GetInt("mysql.max_idle_conns"))
return
}
func Close() {
_ = db.Close()
}
4.logger.go 日志记录模块
// InitLogger 初始化Logger
func Init() (err error) {
writeSyncer := getLogWriter(viper.GetString("log.filename"),
viper.GetInt("log.max_size"),
viper.GetInt("log.max_backups"),
viper.GetInt("log.max_age"),
)
encoder := getEncoder()
var l = new(zapcore.Level)
err = l.UnmarshalText([]byte(viper.GetString("log.level")))
if err != nil {
return
}
core := zapcore.NewCore(encoder, writeSyncer, l)
lg := zap.New(core, zap.AddCaller())
zap.ReplaceGlobals(lg) // 替换zap包中全局的logger实例,后续在其他包中只需使用zap.L()调用即可
return
}
func getEncoder() zapcore.Encoder {
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
encoderConfig.TimeKey = "time"
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
encoderConfig.EncodeDuration = zapcore.SecondsDurationEncoder
encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
return zapcore.NewJSONEncoder(encoderConfig)
}
func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {
lumberJackLogger := &lumberjack.Logger{
Filename: filename,
MaxSize: maxSize,
MaxBackups: maxBackup,
MaxAge: maxAge,
}
return zapcore.AddSync(lumberJackLogger)
}
// GinLogger 接收gin框架默认的日志
func GinLogger() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
path := c.Request.URL.Path
query := c.Request.URL.RawQuery
c.Next()
cost := time.Since(start)
zap.L().Info(path,
zap.Int("status", c.Writer.Status()),
zap.String("method", c.Request.Method),
zap.String("path", path),
zap.String("query", query),
zap.String("ip", c.ClientIP()),
zap.String("user-agent", c.Request.UserAgent()),
zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
zap.Duration("cost", cost),
)
}
}
// GinRecovery recover掉项目可能出现的panic,并使用zap记录相关日志
func GinRecovery(stack bool) gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if err := recover(); err != nil {
// Check for a broken connection, as it is not really a
// condition that warrants a panic stack trace.
var brokenPipe bool
if ne, ok := err.(*net.OpError); ok {
if se, ok := ne.Err.(*os.SyscallError); ok {
if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
brokenPipe = true
}
}
}
httpRequest, _ := httputil.DumpRequest(c.Request, false)
if brokenPipe {
zap.L().Error(c.Request.URL.Path,
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
// If the connection is dead, we can't write a status to it.
c.Error(err.(error)) // nolint: errcheck
c.Abort()
return
}
if stack {
zap.L().Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
zap.String("stack", string(debug.Stack())),
)
} else {
zap.L().Error("[Recovery from panic]",
zap.Any("error", err),
zap.String("request", string(httpRequest)),
)
}
c.AbortWithStatus(http.StatusInternalServerError)
}
}()
c.Next()
}
}
5.dao/redis.go连接Redis
// 声明一个全局的rdb变量
var rdb *redis.Client
// 初始化连接
func Init() (err error) {
rdb = redis.NewClient(&redis.Options{
Addr: fmt.Sprintf("%s:%d",
viper.GetString("redis.host"),
viper.GetInt("redis.port")),
Password: viper.GetString("redis.password"), // no password set
DB: viper.GetInt("redis.db"),
PoolSize: viper.GetInt("redis.pool_size"), // use default DB
})
_, err = rdb.Ping().Result()
return
}
func Close() {
_ = rdb.Close()
}
6.routes.go配置路由模块
// 声明一个全局的rdb变量
var rdb *redis.Client
// 初始化连接
func Init() (err error) {
rdb = redis.NewClient(&redis.Options{
Addr: fmt.Sprintf("%s:%d",
viper.GetString("redis.host"),
viper.GetInt("redis.port")),
Password: viper.GetString("redis.password"), // no password set
DB: viper.GetInt("redis.db"),
PoolSize: viper.GetInt("redis.pool_size"), // use default DB
})
_, err = rdb.Ping().Result()
return
}
func Close() {
_ = rdb.Close()
}
通过配置这些文件在终端运行 go build 即可生成app.exe文件。