基于CLD模式的GoWeb开发脚手架

已于 2024-06-10 22:21:00 修改
阅读量1.7k 收藏 29
点赞数 64
分类专栏： Go语言 文章标签： golang go web idea
于 2024-06-10 19:51:12 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_73933965/article/details/139581128
版权

文章目录

前言

本文将围绕Go语言在Web开发中最常用的CLD模式展开论述，并提供相关代码和架构作为模版，有助于理解和套用

在讲CLD之前，让我们先来了解一下MVC架构

MVC架构

什么是MVC架构

MVC是一种十分流行的web开发思想，核心在于把一个大型项目拆分成三个独立的部分。

MVC显而易见，代表的是以下三个单词

  1. Model(模型) ：数据管理和数据库设计，实现项目的核心逻辑和功能
  2. View(视图) ：图形化界面设计
  3. Controller(控制器) ：模型和视图的交互，接受请求和发送请求
MVC架构的好处

通过MVC架构可以对项目进行结构化处理

  1. 增加了程序的可读性，层次分明
  2. 使得项目更易于维护
  3. 更方便拓展和更改，每个部分都是独立的，互不影响和干扰
  4. 避免重复性工作，每一部分都是共享的，支持多次调用
CLD模式的引入

随着计算机的日益发展，前端的工作越来越复杂，大多数开发工作也开始使用前后端分离的模式，传统的MVC架构已经变得没那么优秀，已不适用于当今的开发工作，慢慢逐渐引申出来CLD模式。

CLD模式

什么是CLD模式

CLD模式是将MVC的V(视图)单独抽离出来，然后将C(控制器)保留，将M(模型)拆分成L和D

所谓CLD，就是

  1. Controller(控制器) ：负责交互型工作（处理路由、参数校验、请求转发）
  2. Logic/Service(逻辑/服务) ：负责业务逻辑功能实现
  3. DAO/Repository(数据存储) ：负责数据设计和操作管理

划分为这三层之后，我们还需要支持各种的协议，因此我们还需要一个单独的

  • protocol(协议处理) ：负责各种交互协议的处理

每一层都是相互独立的，互不干扰互不影响，保留了MVC架构的优点，也顺应时代发展，成为GoWeb开发最常用的模式架构

具体代码实现

CLD模式是一种思想，可具体该怎么运用到开发中去呢？

代码参考李文周老师的样例，大家可以去李文周的博客学习

确定项目流程

一个GoWeb初始化开发需要以下几个步骤

引用我Go语言的启蒙老师的一句话：遇事不决写注释

  1. 加载配置
  2. 初始化日志
  3. 初始化MySQL连接
  4. 初始化Redis连接
  5. 注册路由
  6. 启动服务(优雅关机)

确定好这些步骤之后，我们针对每一个步骤进行完善

项目最终目录预览

较为通用的脚手架提前看

一. 加载配置文件
  1. 在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
  1. 在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
}
  1. “main.go” 补充
//1.加载配置文件
if err := settings.Init(); err != nil {
		fmt.Println("Init settings failed,err:", err)
		return
	}
二. 初始化日志
  1. 在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()
	}
}
  1. “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连接
  1. 在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()
}
  1. “main.go” 补充
//3.初始化MySQL连接
if err := mysql.Init(); err != nil {
	fmt.Println("Init mysql failed,err:", err)
	return
}
defer mysql.Close()
四. 初始化redis连接
  1. 在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()
}
  1. “main.go” 补充
//4.初始化Redis连接
if err := redis.Init(); err != nil {
	fmt.Println("Init redis failed,err:", err)
	return
}
defer redis.Close()
五. 注册路由
  1. 在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
}
  1. “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开发脚手架，主要是学习思想，具体应用还得根据实际来设计

希望这篇文章能给你们带来帮助

泰勒霉霉霉
关注
  • 64
    点赞
  • 踩
  • 29
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
go web 项目开发脚手架
01-08
# web 项目开发脚手架 ## 项目分层模式 ### MVC - Model：模型代表一个存取数据的对象。它也可以带有逻辑，在数据变化时更新控制器。 - View：视图代表模型包含的数据的可视化。 - Controller：控制器作用于模型...
Go语言网络层脚手架.rar
06-20
Go语言在Web开发领域中的一种快速开发脚手架的构建方法。该脚手架以gin作为Web框架，结合gorm处理RESTful API和MySQL数据库操作，使用go-redis作为缓存解决方案，zap负责日志记录，而配置管理则采用viper。下面是对...
CLD.rar_cld
09-14
【CLD.rar_cld】是一个压缩包文件，其中包含了与C语言编程相关的源代码，用于在ms51系列单片机上实现一个完整的电子时钟功能。ms51单片机是8051系列的一种，由Intel公司推出，被广泛应用在各种嵌入式系统中。这个...
CLD 考试范围.pdf
09-11
Labview的CLD考试范围，帮助大家更好的了解考试信息以及考试的范围，针对重点进行复习，希望大家都考的很满意。
CLD-16.rar_cld
07-15
Certification LabVIEW Development认证练习
golang闭包中变量获取
ezreal_pan的博客
09-05 786
闭包的本质是一个语法糖，其本质是获取外部变量在其内部使用。文中case2和case3并未涉及闭包，只是作为对比案例。case4这个案例有点不能理解，汇编看着太吃力了。case4和case5留待后续再研究。
go切片的深入学习以及context库的使用
qq_63728673的博客
09-07 1062
1.如果期望容量大于当前容量的两倍就会使用期望容量；2.如果当前切片的长度小于 1024 就会将容量翻倍；3.如果当前切片的长度大于 1024 就会每次增加 25% 的容量，直到新容量大于期望容量；
golang入门
m0_51866860的博客
09-06 461
学习视频：PATH。
【Go - 变长参数】
qq_38428433的博客
09-07 396
在函数定义中，变长参数必须是参数列表中的最后一个参数，并且其类型前面要加上...。// b 是一个 int 类型的切片。
深入掌握 Go 语言中的数值类型与循环技巧
一个被知识诅咒的人
09-05 680
本文深入介绍了 Go 语言中的数值数据类型，包括有符号与无符号整数、浮点数和复数，帮助开发者理解不同数据类型的特性与使用场景。此外，还详解了 Go 中 for 循环的灵活应用，包括传统的迭代循环、while 和 do...while 循环的模拟，展示了 range 关键字在遍历数组和切片中的强大功能。通过丰富的代码示例，本文帮助读者更好地掌握 Go 语言中数值处理和循环控制的核心技巧。
Go语言概述
最新发布
对我来说痴心绝对的博客
09-09 331
1）从语言层面支持并发，实现简单2）goroutine，轻量级线程，可实现大并发处理，高效利用多核3）垃圾回收机制，内存自动回收，不需要开发人员管理4）5）吸收了管道通信机制，形成Go语言特有的管道channel，通过管道channel，可以实现不同的goroute之间的相互通信。6）函数返回多个值。
golang 数据库使用注意事项
Fly_Sky
09-05 444
// 使用参数化查询，避免特殊符号引起的问题 func InsertTactics(pgHandle *pgx.Conn, params Params) error { // 使用 pgx.Exec 方法执行参数化查询 _, err := pgHandle.Exec(context.Background(), tbTacticsInsert, params.Plat, params.Tactics, params.Tname, params.Detail) return err }
Go语言变量的声明
u011290064的博客
09-06 500
Go语言是静态类型语言，因此变量（variable）是有明确类型的，编译器也会检查变量类型的正确性。在数学概念中，变量表示没有固定值且可改变的数。但从计算机系统实现角度来看，变量是一段或多段用来存储数据的内存。其中，var 是声明变量的关键字，name 是变量名，type 是变量的类型。需要注意的是，Go语言和许多编程语言不同，它在声明变量时将变量的类型放在变量的名称之后。int* a, b;。其中只有 a 是指针而 b 不是。如果你想要这两个变量都是指针，则需要将它们分开书写。
2024最新技术！使用Golang Beego开发的社区老人健康管理系统，Vue前端交互流畅，大数据分析助力健康趋势预测
卫星：biyesheji88的博客
09-06 1033
亲爱的同学们，本文为大家介绍了基于Golang Beego和Vue技术的社区老人健康管理系统，希望能为大家在毕业设计选题和实施过程中提供有益的参考。如果您对这个课题感兴趣，或者有任何疑问和建议，欢迎在评论区留言交流。让我们一起为社区老人健康管理事业贡献一份力量，共创美好未来！👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java实战项目Python实战项目微信小程序|安卓实战项目大数据实战项目PHP|C#.NET|Golang实战项目🍅 主页获取源码联系🍅。
Golang path/filepath包详解：高效路径操作与实战案例
walkskyer的博客
09-09 822
我们可以根据需要添加各种自定义过滤条件，例如根据文件名、创建时间等进行过滤。= nil {在这个示例中，Walk函数仅打印文件名包含字符串"example"的文件。我们可以根据不同的需求添加自定义的过滤条件。例如，根据文件名、修改时间或其他文件属性进行过滤。
掌握Go语言的流程控制：构建逻辑与决策的基石
王中阳的博客
09-06 683
Go语言以其简洁明了的语法和强大的内置控制结构，为开发者提供了构建高效且逻辑清晰的程序的强大工具。Go的流程控制机制，从基本的条件判断到复杂的循环处理，是编写各类程序的基础。
怎么用golang实现一个简易版c++的FIFO队列？
GoppViper的博客
09-04 466
消息队列（Message Queue）是一种在不同应用程序或组件之间进行异步通信的中间件技术。它主要用于解耦系统中的各个组件，使得它们可以独立地运行和扩展，同时提高系统的可靠性和性能。消息队列的工作原理是，发送者将消息发送到队列中，接收者从队列中获取消息进行处理。发送者和接收者不需要直接相互通信，它们只需要与消息队列进行交互。这样可以避免发送者和接收者之间的直接依赖，提高系统的灵活性和可维护性。异步通信：发送者不需要等待接收者处理完消息后再进行下一步操作，可以立即返回继续执行其他任务。
golang学习笔记02——gin框架及基本原理
GoppViper的博客
09-04 1536
gin框架是golang中比较常见的web框架，截止到目前(2023-03-21)，github上已经累计了67.3K的star数，这足以表明其优秀。作为一名想要知其然亦想知其所以然的程序员，希望通过学习gin框架的实现原理来提高自己的技术能力，也希望通过分享来帮助想要进行学习的同学。框架源码地址: https://github.com/gin-gonic/gin。
cld repmovsb
06-12
"cld" 是 x86 汇编语言中的一条指令，用于将方向标志位 (Direction Flag) 置为清零状态，表示字符串操作时按照从低地址往高地址的方向进行。 "repmovsb" 也是 x86 汇编语言中的一条指令，用于在内存中复制字符串。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值