文章目录
前言
本文将围绕Go语言在Web开发中最常用的CLD模式展开论述,并提供相关代码和架构作为模版,有助于理解和套用
在讲CLD之前,让我们先来了解一下MVC架构
MVC架构
什么是MVC架构
MVC是一种十分流行的web开发思想,核心在于把一个大型项目拆分成三个独立的部分。
MVC显而易见,代表的是以下三个单词
- Model(模型) :数据管理和数据库设计,实现项目的核心逻辑和功能
- View(视图) :图形化界面设计
- Controller(控制器) :模型和视图的交互,接受请求和发送请求
MVC架构的好处
通过MVC架构可以对项目进行结构化处理
- 增加了程序的可读性,层次分明
- 使得项目更易于维护
- 更方便拓展和更改,每个部分都是独立的,互不影响和干扰
- 避免重复性工作,每一部分都是共享的,支持多次调用
CLD模式的引入
随着计算机的日益发展,前端的工作越来越复杂,大多数开发工作也开始使用前后端分离的模式,传统的MVC架构已经变得没那么优秀,已不适用于当今的开发工作,慢慢逐渐引申出来CLD模式。
CLD模式
什么是CLD模式
CLD模式是将MVC的V(视图)单独抽离出来,然后将C(控制器)保留,将M(模型)拆分成L和D
所谓CLD,就是
- Controller(控制器) :负责交互型工作(处理路由、参数校验、请求转发)
- Logic/Service(逻辑/服务) :负责业务逻辑功能实现
- DAO/Repository(数据存储) :负责数据设计和操作管理
划分为这三层之后,我们还需要支持各种的协议,因此我们还需要一个单独的
- protocol(协议处理) :负责各种交互协议的处理
每一层都是相互独立的,互不干扰互不影响,保留了MVC架构的优点,也顺应时代发展,成为GoWeb开发最常用的模式架构
具体代码实现
CLD模式是一种思想,可具体该怎么运用到开发中去呢?
代码参考李文周老师的样例,大家可以去李文周的博客学习
确定项目流程
一个GoWeb初始化开发需要以下几个步骤
引用我Go语言的启蒙老师的一句话:遇事不决写注释
- 加载配置
- 初始化日志
- 初始化MySQL连接
- 初始化Redis连接
- 注册路由
- 启动服务(优雅关机)
确定好这些步骤之后,我们针对每一个步骤进行完善
项目最终目录预览
一. 加载配置文件
- 在conf目录下新建 “config.yaml” 文件
app:
name: "web_app"
mode: "dev" 开发者模式
port: 8081 端口号
log:
level: "debug" 日志级别
filename: "web_app.log" 日志文件
max_size: 200
max_age: 30
max_backups: 7
mysql:
host: "127.0.0.1"
port: 13306 端口号
user: "数据库用户"
password: "数据库密码"
dbname: "数据库名称"
max_open_conns: 200
max_idle_conns: 50
redis:
host: "127.0.0.1"
post: 16379 端口号
password: "" 无密码
db: 0
pool_size: 100
- 在settings目录下,新建 “settings.go” 文件
package settings
import (
"fmt"
"github.com/fsnotify/fsnotify"
"github.com/spf13/viper"
)
func Init() error {
viper.SetConfigFile("./conf/config.yaml") // 指定配置文件路径
err := viper.ReadInConfig() // 读取配置信息
if err != nil { // 读取配置信息失败
fmt.Printf("viper.ReadInConfig file: %s \n", err)
return err
}
// 监控配置文件变化
viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
fmt.Println("配置文件修改了...")
})
return nil
}
- “main.go” 补充
//1.加载配置文件
if err := settings.Init(); err != nil {
fmt.Println("Init settings failed,err:", err)
return
}
二. 初始化日志
- 在logger目录下新建 “logger.go” 文件
package logger
import (
"net"
"net/http"
"net/http/httputil"
"os"
"runtime/debug"
"strings"
"time"
"github.com/spf13/viper"
"github.com/gin-gonic/gin"
"gopkg.in/natefinch/lumberjack.v2"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// Init 初始化Logger
func Init() (err error) {
writeSyncer := getLogWriter(
viper.GetString("log.filename"),
viper.GetInt("log.max_size"),
viper.GetInt("log.max_backup"),
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()
}
}
- “main.go” 补充
//2.初始化日志
if err := logger.Init(); err != nil {
fmt.Println("Init logger failed,err:", err)
return
}
defer zap.L().Sync()
zap.L().Debug("logger init success...")
三. 初始化MySQL连接
- 在dao目录下新建mysql目录,新建 **“mysql.go”**文件
package mysql
import (
"fmt"
"go.uber.org/zap"
"github.com/spf13/viper"
_ "github.com/go-sql-driver/mysql" // 不要忘了导入数据库驱动
"github.com/jmoiron/sqlx"
)
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 DB failed", zap.Error(err))
return
}
db.SetMaxOpenConns(viper.GetInt("mysql.max_open_conns"))
db.SetMaxIdleConns(viper.GetInt("mysql.max_idle_conns"))
return
}
func Close() {
_ = db.Close()
}
- “main.go” 补充
//3.初始化MySQL连接
if err := mysql.Init(); err != nil {
fmt.Println("Init mysql failed,err:", err)
return
}
defer mysql.Close()
四. 初始化redis连接
- 在dao目录下新建redis目录,新建 “redis.go” 文件
package redis
import (
"fmt"
"github.com/redis/go-redis/v9"
"github.com/spf13/viper"
)
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"),
DB: viper.GetInt("redis.db"),
PoolSize: viper.GetInt("redis.pool_size"),
})
return nil
}
func Close() {
_ = rdb.Close()
}
- “main.go” 补充
//4.初始化Redis连接
if err := redis.Init(); err != nil {
fmt.Println("Init redis failed,err:", err)
return
}
defer redis.Close()
五. 注册路由
- 在routes目录下新建 “routes.go” 文件
package routes
import (
"jwt/logger"
"net/http"
"github.com/gin-gonic/gin"
)
func SetUp() *gin.Engine {
r := gin.New()
r.Use(logger.GinLogger(), logger.GinRecovery(true))
r.GET("/", func(c *gin.Context) {
c.JSON(http.StatusOK, "ok")
})
return r
}
- “main.go” 补充
//5.注册路由
r := routes.SetUp()
六. 启动服务(优雅关机)
“main.go” 补充
//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) // 创建一个接收信号的通道
// kill 默认会发送 syscall.SIGTERM 信号
// kill -2 发送 syscall.SIGINT 信号,我们常用的Ctrl+C就是触发系统SIGINT信号
// kill -9 发送 syscall.SIGKILL 信号,但是不能被捕获,所以不需要添加它
// signal.Notify把收到的 syscall.SIGINT或syscall.SIGTERM 信号转发给quit
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")
补充
controllers :控制目录
logic :逻辑目录
pkg :存放第三方库
models :存放模型
这只是一个较为通用的GoWeb开发脚手架,主要是学习思想,具体应用还得根据实际来设计
希望这篇文章能给你们带来帮助