feat: 优化控制台输出 + 修复请求BUG
This commit is contained in:
@@ -80,7 +80,10 @@ func (s *server) injectCommonParam(ctx *gin.Context, formValue any) error {
|
||||
}).ToFieldList()...)
|
||||
continue
|
||||
}
|
||||
fieldValue := reflectFormValue.Elem().FieldByName(fieldName)
|
||||
if reflectFormValue.Type().Kind() == reflect.Ptr {
|
||||
reflectFormValue = reflectFormValue.Elem()
|
||||
}
|
||||
fieldValue := reflectFormValue.FieldByName(fieldName)
|
||||
if !fieldValue.IsZero() {
|
||||
// 表单次数不为空, 说明从参数中传递, 不做覆盖填充
|
||||
logger.Instance.Debug("指定字段已赋值, 不做重新覆盖填充处理, 跳过", pkgLogger.NewLogData(innerCtx, logger.RecordType, logger.CodeInjectCommonParam, map[string]any{
|
||||
|
||||
@@ -47,7 +47,7 @@ func (c controllerParser) Parse(inputController any) map[string]UriConfig {
|
||||
}
|
||||
|
||||
// preCheckMethod 预检查方法是否可以注册为接口
|
||||
func (c controllerParser) preCheckMethod(reflectMethod reflect.Method) (bool, reflect.Type, reflect.StructField) {
|
||||
func (c controllerParser) preCheckMethod(reflectMethod reflect.Method, config *UriConfig) (bool, reflect.Type, reflect.StructField) {
|
||||
var (
|
||||
metaField reflect.StructField
|
||||
metaFieldExist bool
|
||||
@@ -69,6 +69,7 @@ func (c controllerParser) preCheckMethod(reflectMethod reflect.Method) (bool, re
|
||||
// 解析第二个参数是组合 Meta 的form表单
|
||||
formType := methodType.In(2)
|
||||
if formType.Kind() == reflect.Ptr {
|
||||
config.ParamIsPtr = true
|
||||
formType = formType.Elem()
|
||||
}
|
||||
|
||||
@@ -94,7 +95,7 @@ func (c controllerParser) methodConfig(reflectMethod reflect.Method) (UriConfig,
|
||||
// num0: 函数声明
|
||||
// num1: 第一个参数
|
||||
// num2: 第二个参数
|
||||
if needRegister, cfg.FormDataType, metaField = c.preCheckMethod(reflectMethod); !needRegister {
|
||||
if needRegister, cfg.FormDataType, metaField = c.preCheckMethod(reflectMethod, &cfg); !needRegister {
|
||||
logger.Instance.Info("接口方法不符合要求, 不注册为接口, 方法名: " + reflectMethod.Name + ", 方法签名: " + methodType.String())
|
||||
return UriConfig{}, false
|
||||
}
|
||||
|
||||
@@ -47,6 +47,7 @@ type UriConfig struct {
|
||||
MaxExecTime uint `json:"max_exec_time"` // 接口最大执行时间, 单位: ms, 配置为0则不验证, 注意, 超时后不会报错, 会打印一条warn日志, 如果配置了报警策略, 也会发送报警信息
|
||||
HookSync bool `json:"hook_sync"` // 接口主逻辑执行完成之后,hook是否同步执行, 默认异步执行
|
||||
NoLogin bool `json:"no_login"` // 接口是否需要登录(无需登录, 则有token就验证, 无token不验证)
|
||||
ParamIsPtr bool `json:"param_is_ptr"` // 参数是否指针类型
|
||||
FormDataType reflect.Type `json:"-"` // 表单数据类型
|
||||
ResultDataType reflect.Type `json:"-"` // 返回值数据类型
|
||||
ApiStructValue reflect.Value `json:"-"` // 逻辑函数所属结构体取值
|
||||
|
||||
@@ -78,7 +78,10 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
||||
return
|
||||
}
|
||||
// 表单数据
|
||||
inputValue := reflect.ValueOf(formValue).Elem()
|
||||
inputValue := reflect.ValueOf(formValue)
|
||||
if !uriCfg.ParamIsPtr {
|
||||
inputValue = inputValue.Elem()
|
||||
}
|
||||
|
||||
// 注入公共参数
|
||||
if err = s.injectCommonParam(ctx, inputValue); nil != err {
|
||||
|
||||
143
router/server.go
143
router/server.go
@@ -10,10 +10,15 @@ package router
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"os"
|
||||
"reflect"
|
||||
"runtime"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"git.zhangdeman.cn/zhangdeman/graceful"
|
||||
"github.com/jedib0t/go-pretty/v6/table"
|
||||
"github.com/jedib0t/go-pretty/v6/text"
|
||||
|
||||
apiDoc "git.zhangdeman.cn/zhangdeman/api-doc"
|
||||
"git.zhangdeman.cn/zhangdeman/consts"
|
||||
@@ -69,7 +74,41 @@ func NewServer(port int, optionList ...SetServerOptionFunc) *server {
|
||||
if port < 80 {
|
||||
panic("port should be greater than 80")
|
||||
}
|
||||
gin.SetMode(gin.ReleaseMode)
|
||||
option := newServerOption(port, optionList...)
|
||||
|
||||
s := &server{
|
||||
router: gin.Default(),
|
||||
uiInstance: apiDoc.NewSwaggerUI(option.serverInfo, option.serverList, apiDocEnum.SwaggerUITheme(option.swaggerUiTheme)),
|
||||
port: port,
|
||||
option: option,
|
||||
lock: &sync.RWMutex{},
|
||||
commonParam: map[string]GetCommonParam{},
|
||||
consoleOutput: [][]any{},
|
||||
globalMiddlewareDescList: []string{},
|
||||
}
|
||||
globalMiddlewareList := s.getGlobalMiddlewareList(option)
|
||||
// 注册全局中间件
|
||||
s.router.Use(globalMiddlewareList...)
|
||||
// 启用pprof, 注册相关路由
|
||||
if option.enablePprof {
|
||||
pprof.Register(s.router)
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
type server struct {
|
||||
router *gin.Engine
|
||||
port int
|
||||
uiInstance *apiDoc.SwaggerUI
|
||||
option *serverOption
|
||||
commonParam map[string]GetCommonParam // 结构体字段名, 注意, 不是TAG
|
||||
lock *sync.RWMutex
|
||||
consoleOutput [][]any // 控制台输出的提示信息
|
||||
globalMiddlewareDescList []string // 全局中间件描述列表
|
||||
}
|
||||
|
||||
func (s *server) getGlobalMiddlewareList(option *serverOption) []gin.HandlerFunc {
|
||||
globalMiddlewareList := make([]gin.HandlerFunc, 0)
|
||||
if nil != option.initContextData {
|
||||
globalMiddlewareList = append(globalMiddlewareList, option.initContextData) // 初始化一些全局的变量
|
||||
@@ -102,32 +141,8 @@ func NewServer(port int, optionList ...SetServerOptionFunc) *server {
|
||||
// 自定义全局中间件追加
|
||||
globalMiddlewareList = append(globalMiddlewareList, option.globalMiddlewareList...)
|
||||
}
|
||||
r := gin.Default()
|
||||
|
||||
// 注册全局中间件
|
||||
r.Use(globalMiddlewareList...)
|
||||
|
||||
// 启用pprof, 注册相关路由
|
||||
if option.enablePprof {
|
||||
pprof.Register(r)
|
||||
}
|
||||
return &server{
|
||||
router: r,
|
||||
uiInstance: apiDoc.NewSwaggerUI(option.serverInfo, option.serverList, apiDocEnum.SwaggerUITheme(option.swaggerUiTheme)),
|
||||
port: port,
|
||||
option: option,
|
||||
lock: &sync.RWMutex{},
|
||||
commonParam: map[string]GetCommonParam{},
|
||||
}
|
||||
}
|
||||
|
||||
type server struct {
|
||||
router *gin.Engine
|
||||
port int
|
||||
uiInstance *apiDoc.SwaggerUI
|
||||
option *serverOption
|
||||
commonParam map[string]GetCommonParam // 结构体字段名, 注意, 不是TAG
|
||||
lock *sync.RWMutex
|
||||
s.globalMiddlewareDescList = s.getMiddlewareDescList(globalMiddlewareList)
|
||||
return globalMiddlewareList
|
||||
}
|
||||
|
||||
// Start 启动服务
|
||||
@@ -138,6 +153,7 @@ func (s *server) Start() {
|
||||
defer func() {
|
||||
_ = gracefulServer.Close()
|
||||
}()
|
||||
s.TableOutput(nil, nil) // 控制台打印路由表格
|
||||
if err := gracefulServer.ListenAndServe(); err != nil {
|
||||
if strings.Contains(err.Error(), "use of closed network connection") {
|
||||
fmt.Println("接收到退出指令, 服务平滑关闭")
|
||||
@@ -170,9 +186,21 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, co
|
||||
routerGroup := s.router.Group(routerPrefix)
|
||||
routerGroup.Use(middlewareList...)
|
||||
parser := controllerParser{}
|
||||
middlewareDescList := append([]string{}, s.globalMiddlewareDescList...)
|
||||
middlewareDescList = append(middlewareDescList, s.getMiddlewareDescList(middlewareList)...)
|
||||
for _, itemController := range controllerList {
|
||||
urlTable := parser.Parse(itemController)
|
||||
for _, itemUriCfg := range urlTable {
|
||||
// 设置代理请求函数描述
|
||||
apiMiddlewareList := append([]string{}, middlewareDescList...)
|
||||
if itemUriCfg.IsSse {
|
||||
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(reflect.ValueOf(s.SseHandler).Pointer()).Name())
|
||||
} else {
|
||||
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(reflect.ValueOf(s.RequestHandler).Pointer()).Name())
|
||||
}
|
||||
// 设置 logic 函数描述
|
||||
apiMiddlewareList = append(apiMiddlewareList, runtime.FuncForPC(itemUriCfg.ApiLogicFunc.Func.Pointer()).Name())
|
||||
|
||||
_ = s.uiInstance.DocInstance().AddApiFromInAndOut(routerPrefix, itemUriCfg.FormDataType, itemUriCfg.ResultDataType)
|
||||
// 普通 HTTP 请求
|
||||
handleFunc := s.RequestHandler(itemUriCfg)
|
||||
@@ -182,6 +210,14 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, co
|
||||
}
|
||||
// 一个接口支持注册多种请求方法
|
||||
for _, method := range itemUriCfg.RequestMethod {
|
||||
if len(routerPrefix) > 0 {
|
||||
routerPrefix = "/" + strings.TrimSuffix(strings.TrimPrefix(routerPrefix, "/"), "/")
|
||||
}
|
||||
s.consoleOutput = append(s.consoleOutput, []any{
|
||||
routerPrefix + "/" + strings.TrimPrefix(itemUriCfg.Path, "/"),
|
||||
strings.ToUpper(method),
|
||||
strings.Join(apiMiddlewareList, "\n"),
|
||||
})
|
||||
s.registerRouter(routerGroup, method, itemUriCfg, handleFunc)
|
||||
}
|
||||
}
|
||||
@@ -211,3 +247,58 @@ func (s *server) registerRouter(routerGroup *gin.RouterGroup, method string, ite
|
||||
panic("method " + method + " is not support")
|
||||
}
|
||||
}
|
||||
|
||||
// getMiddlewareDescList 获取中间件路径的描述列表
|
||||
func (s *server) getMiddlewareDescList(middlewareList []gin.HandlerFunc) []string {
|
||||
middlewareDescList := []string{}
|
||||
for _, itemMiddleware := range middlewareList {
|
||||
middlewareValue := reflect.ValueOf(itemMiddleware)
|
||||
// 获取函数的指针
|
||||
funcPointer := middlewareValue.Pointer()
|
||||
// 通过 runtime 获取函数信息
|
||||
funcInfo := runtime.FuncForPC(funcPointer)
|
||||
// 获取完整的函数名称(包含包路径)
|
||||
fullName := funcInfo.Name()
|
||||
middlewareDescList = append(middlewareDescList, fullName)
|
||||
}
|
||||
return middlewareDescList
|
||||
}
|
||||
|
||||
// TableOutput 表格输出
|
||||
func (s *server) TableOutput(header []any, footer []any) {
|
||||
// 帮助函数
|
||||
anySlice2TableRow := func(input []any) table.Row {
|
||||
tableRowData := make(table.Row, 0, len(input))
|
||||
for _, d := range input {
|
||||
tableRowData = append(tableRowData, d)
|
||||
}
|
||||
return tableRowData
|
||||
}
|
||||
// 实例化一个表格
|
||||
t := table.NewWriter()
|
||||
t.SetColumnConfigs([]table.ColumnConfig{
|
||||
{
|
||||
Number: 1,
|
||||
AutoMerge: false,
|
||||
VAlign: text.VAlignMiddle,
|
||||
},
|
||||
{
|
||||
Number: 2,
|
||||
AutoMerge: false,
|
||||
VAlign: text.VAlignMiddle,
|
||||
},
|
||||
})
|
||||
// 标准输出
|
||||
t.SetOutputMirror(os.Stdout)
|
||||
if len(header) > 0 {
|
||||
t.AppendHeader(anySlice2TableRow(header))
|
||||
}
|
||||
for _, row := range s.consoleOutput {
|
||||
t.AppendRow(anySlice2TableRow(row))
|
||||
t.AppendSeparator()
|
||||
}
|
||||
if len(footer) > 0 {
|
||||
t.AppendFooter(anySlice2TableRow(footer))
|
||||
}
|
||||
t.Render()
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user