feat: 增加接口流量配置中间件

This commit is contained in:
2026-01-04 15:28:11 +08:00
parent 3788d2b4b6
commit ded502746c
13 changed files with 215 additions and 79 deletions

View File

@@ -16,6 +16,7 @@ import (
"strings"
"sync"
"git.zhangdeman.cn/zhangdeman/gin/define"
"git.zhangdeman.cn/zhangdeman/graceful"
"github.com/jedib0t/go-pretty/v6/table"
"github.com/jedib0t/go-pretty/v6/text"
@@ -90,11 +91,13 @@ func NewServer(port int, optionList ...SetServerOptionFunc) *server {
lock: &sync.RWMutex{},
commonParam: map[string]GetCommonParam{},
consoleOutput: [][]any{},
globalMiddlewareList: []gin.HandlerFunc{},
globalMiddlewareDescList: []string{},
uriTable: map[string]define.UriConfig{},
}
globalMiddlewareList := s.getGlobalMiddlewareList(option)
s.getGlobalMiddlewareList(option)
// 注册全局中间件
s.router.Use(globalMiddlewareList...)
s.router.Use(s.globalMiddlewareList...)
// 启用pprof, 注册相关路由
if option.enablePprof {
pprof.Register(s.router)
@@ -109,27 +112,30 @@ type server struct {
option *serverOption
commonParam map[string]GetCommonParam // 结构体字段名, 注意, 不是TAG
lock *sync.RWMutex
consoleOutput [][]any // 控制台输出的提示信息
globalMiddlewareDescList []string // 全局中间件描述列表
consoleOutput [][]any // 控制台输出的提示信息
globalMiddlewareList []gin.HandlerFunc // 全局中间件列表
globalMiddlewareDescList []string // 全局中间件描述列表
uriTable map[string]define.UriConfig // uri配置表
}
func (s *server) getGlobalMiddlewareList(option *serverOption) []gin.HandlerFunc {
globalMiddlewareList := make([]gin.HandlerFunc, 0)
func (s *server) getGlobalMiddlewareList(option *serverOption) {
// 全局 panic 捕获
globalMiddlewareList = append(globalMiddlewareList, middleware.CustomRecover())
s.globalMiddlewareList = append(s.globalMiddlewareList, middleware.CustomRecover())
// 全局流控中间件
s.globalMiddlewareList = append(s.globalMiddlewareList, middleware.RateLimit(s.option.rateLimitInstance, s.uriTable))
if nil != option.initContextData {
globalMiddlewareList = append(globalMiddlewareList, option.initContextData) // 初始化一些全局的变量
s.globalMiddlewareList = append(s.globalMiddlewareList, option.initContextData) // 初始化一些全局的变量
}
if !option.disableInitRequest { // 启用了初始化请求
globalMiddlewareList = append(globalMiddlewareList, middleware.InitRequest) // 初始化请求
s.globalMiddlewareList = append(s.globalMiddlewareList, middleware.InitRequest) // 初始化请求
}
if nil != option.loggerCfg {
// 请求日志记录中间件
globalMiddlewareList = append(globalMiddlewareList, middleware.LogRequest(option.loggerCfg))
s.globalMiddlewareList = append(s.globalMiddlewareList, middleware.LogRequest(option.loggerCfg))
}
if option.enableCors {
// 跨域中间件
globalMiddlewareList = append(globalMiddlewareList, request_cors.New(request_cors.Config{
s.globalMiddlewareList = append(s.globalMiddlewareList, request_cors.New(request_cors.Config{
AllowAllOrigins: true,
AllowOrigins: nil,
AllowOriginFunc: nil,
@@ -146,10 +152,9 @@ func (s *server) getGlobalMiddlewareList(option *serverOption) []gin.HandlerFunc
}
if len(option.globalMiddlewareList) > 0 {
// 自定义全局中间件追加
globalMiddlewareList = append(globalMiddlewareList, option.globalMiddlewareList...)
s.globalMiddlewareList = append(s.globalMiddlewareList, option.globalMiddlewareList...)
}
s.globalMiddlewareDescList = s.getMiddlewareDescList(globalMiddlewareList)
return globalMiddlewareList
s.globalMiddlewareDescList = s.getMiddlewareDescList(s.globalMiddlewareList)
}
// Start 启动服务
@@ -205,7 +210,7 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, co
} else {
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(reflect.ValueOf(s.RequestHandler).Pointer()).Name())
}
// 设置 超时 函数描述
// 设置 超时 函数
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(reflect.ValueOf(middleware.Timeout).Pointer()).Name())
// 设置 logic 函数描述
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(itemUriCfg.ApiLogicFunc.Func.Pointer()).Name())
@@ -222,8 +227,10 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, co
if len(routerPrefix) > 0 {
routerPrefix = "/" + strings.TrimSuffix(strings.TrimPrefix(routerPrefix, "/"), "/")
}
fullUriPath := routerPrefix + "/" + strings.TrimPrefix(itemUriCfg.Path, "/")
s.uriTable[fullUriPath] = itemUriCfg // 注册路由时存储 接口路径 => 接口配置的信息
s.consoleOutput = append(s.consoleOutput, []any{
routerPrefix + "/" + strings.TrimPrefix(itemUriCfg.Path, "/"),
fullUriPath,
strings.ToUpper(method),
strings.Join(apiMiddlewareList, "\n"),
})
@@ -234,7 +241,7 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, co
}
// registerRouter 注册路由
func (s *server) registerRouter(routerGroup *gin.RouterGroup, method string, itemUriCfg UriConfig, handleFunc gin.HandlerFunc) {
func (s *server) registerRouter(routerGroup *gin.RouterGroup, method string, itemUriCfg define.UriConfig, handleFunc gin.HandlerFunc) {
funcList := []gin.HandlerFunc{
middleware.Timeout(itemUriCfg.MaxExecTime), // 超时处理
handleFunc,