Merge pull request '优化升级gin框架的二次包装' (#19) from feature/upgrade_gin into master
Reviewed-on: #19
This commit was merged in pull request #19.
This commit is contained in:
@@ -10,15 +10,7 @@ package define
|
|||||||
import "github.com/gin-gonic/gin"
|
import "github.com/gin-gonic/gin"
|
||||||
|
|
||||||
// IsBlackIP 是否是黑名单IP
|
// IsBlackIP 是否是黑名单IP
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:25 2022/6/25
|
|
||||||
type IsBlackIP func(ctx *gin.Context, clientIP string) bool
|
type IsBlackIP func(ctx *gin.Context, clientIP string) bool
|
||||||
|
|
||||||
// IsWhiteIP 是否白名单IP
|
// IsWhiteIP 是否白名单IP
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:27 2022/6/25
|
|
||||||
type IsWhiteIP func(ctx *gin.Context, clientIP string) bool
|
type IsWhiteIP func(ctx *gin.Context, clientIP string) bool
|
||||||
|
|||||||
@@ -20,10 +20,6 @@ var (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// HttpHandleConfig 请求处理配置
|
// HttpHandleConfig 请求处理配置
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 20:41 2022/6/25
|
|
||||||
type HttpHandleConfig struct {
|
type HttpHandleConfig struct {
|
||||||
RecordRequestDataField string
|
RecordRequestDataField string
|
||||||
RecordResponseDataField string
|
RecordResponseDataField string
|
||||||
@@ -43,19 +39,11 @@ type HttpHandleConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ConvertDefaultConfig 覆盖默认配置
|
// ConvertDefaultConfig 覆盖默认配置
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 20:41 2022/6/25
|
|
||||||
func ConvertDefaultConfig(cfg *HttpHandleConfig) {
|
func ConvertDefaultConfig(cfg *HttpHandleConfig) {
|
||||||
inputHttpHandleConfig = cfg
|
inputHttpHandleConfig = cfg
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetHttpHandleConfig 获取http配置
|
// GetHttpHandleConfig 获取http配置
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 16:55 2024/7/23
|
|
||||||
func GetHttpHandleConfig() *HttpHandleConfig {
|
func GetHttpHandleConfig() *HttpHandleConfig {
|
||||||
return &HttpHandleConfig{
|
return &HttpHandleConfig{
|
||||||
EnableExtensionOutput: inputHttpHandleConfig.EnableExtensionOutput,
|
EnableExtensionOutput: inputHttpHandleConfig.EnableExtensionOutput,
|
||||||
@@ -129,8 +117,8 @@ func GetHttpHandleConfig() *HttpHandleConfig {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type LogicAfterResponse struct {
|
type LogicAfterResponse struct {
|
||||||
SuccessHookFuncList []func(ctx *gin.Context) `json:"-"` // 请求最后需要执行的成功hook函数
|
SuccessHookFuncList []func(ctx *gin.Context) `json:"-"` // 请求最后需要执行的成功 hook函数
|
||||||
FailureHookFuncList []func(ctx *gin.Context) `json:"-"` // 请求最后需要执行的失败hook函数
|
FailureHookFuncList []func(ctx *gin.Context) `json:"-"` // 请求最后需要执行的失败 hook函数
|
||||||
Lock *sync.RWMutex `json:"-"` // 逻辑锁
|
Lock *sync.RWMutex `json:"-"` // 逻辑锁
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -151,3 +139,13 @@ type ResponseOption struct {
|
|||||||
Extension map[string]any `json:"extension"` // 扩展数据
|
Extension map[string]any `json:"extension"` // 扩展数据
|
||||||
XmlName string `json:"xml_name"` // 以xml文件格式响应数据时, Xml文件名(根节点)
|
XmlName string `json:"xml_name"` // 以xml文件格式响应数据时, Xml文件名(根节点)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type SseData struct {
|
||||||
|
ID string `json:"id"` // 响应数据 ID
|
||||||
|
Object string `json:"object"` // 响应数据对象类型
|
||||||
|
Created int64 `json:"created"` // 创建时间, 秒级时间戳
|
||||||
|
Choices []map[string]any `json:"choices"` // choice 列表
|
||||||
|
EventType string `json:"event_type"` // 事件类型
|
||||||
|
}
|
||||||
|
|
||||||
|
const SseMsgFormat = "id:%v\nevent:%v\ndata:%v\n\n"
|
||||||
|
|||||||
2
go.mod
2
go.mod
@@ -6,7 +6,7 @@ toolchain go1.24.2
|
|||||||
|
|
||||||
require (
|
require (
|
||||||
git.zhangdeman.cn/zhangdeman/api-doc v1.0.3-0.20251013152001-868ee8955623
|
git.zhangdeman.cn/zhangdeman/api-doc v1.0.3-0.20251013152001-868ee8955623
|
||||||
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251217031322-9e8b61fd5156
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251226093912-de8914503463
|
||||||
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8
|
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8
|
||||||
git.zhangdeman.cn/zhangdeman/exception v0.0.0-20250510123912-a0d52fc093ab
|
git.zhangdeman.cn/zhangdeman/exception v0.0.0-20250510123912-a0d52fc093ab
|
||||||
git.zhangdeman.cn/zhangdeman/graceful v0.0.0-20250529070945-92833db6f3a4
|
git.zhangdeman.cn/zhangdeman/graceful v0.0.0-20250529070945-92833db6f3a4
|
||||||
|
|||||||
4
go.sum
4
go.sum
@@ -6,6 +6,10 @@ git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251101092813-3dd9fb807f1c h1:H0Tlh7
|
|||||||
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251101092813-3dd9fb807f1c/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251101092813-3dd9fb807f1c/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
||||||
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251217031322-9e8b61fd5156 h1:VaaejWXKShnuySe0o2twIBMkWc8bJ+Fw654KLKjoXW8=
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251217031322-9e8b61fd5156 h1:VaaejWXKShnuySe0o2twIBMkWc8bJ+Fw654KLKjoXW8=
|
||||||
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251217031322-9e8b61fd5156/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251217031322-9e8b61fd5156/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
||||||
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251226040044-6bc8da22219a h1:p85je5ExTyUsd2jR+Lq2rSJneAPM3MkuUhFHH+TfhEM=
|
||||||
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251226040044-6bc8da22219a/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
||||||
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251226093912-de8914503463 h1:IEUkYzFIWoxQwoJ1c16mDrBuYUgQzYCQ7YHkWXsb5uo=
|
||||||
|
git.zhangdeman.cn/zhangdeman/consts v0.0.0-20251226093912-de8914503463/go.mod h1:5p8CEKGBxi7qPtTXDI3HDmqKAfIm5i/aBWdrbkbdNjc=
|
||||||
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8 h1:Pw981jG3hH9ZHrB3s1xPpsZafgX3USuMAjnGi2GEP9Y=
|
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8 h1:Pw981jG3hH9ZHrB3s1xPpsZafgX3USuMAjnGi2GEP9Y=
|
||||||
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8/go.mod h1:xtCw3om5DRrG30EfQd/lfQPXgptfK7l9oBSt4Kdhjok=
|
git.zhangdeman.cn/zhangdeman/dynamic-struct v0.0.0-20251013092857-dcf591d4e8a8/go.mod h1:xtCw3om5DRrG30EfQd/lfQPXgptfK7l9oBSt4Kdhjok=
|
||||||
git.zhangdeman.cn/zhangdeman/easylock v0.0.0-20230731062340-983985c12eda h1:bMD6r9gjRy7cO+T4zRQVYAesgIblBdTnhzT1vN5wjvI=
|
git.zhangdeman.cn/zhangdeman/easylock v0.0.0-20230731062340-983985c12eda h1:bMD6r9gjRy7cO+T4zRQVYAesgIblBdTnhzT1vN5wjvI=
|
||||||
|
|||||||
@@ -7,12 +7,33 @@
|
|||||||
// Date : 2025-10-30 16:54
|
// Date : 2025-10-30 16:54
|
||||||
package logger
|
package logger
|
||||||
|
|
||||||
import "go.uber.org/zap"
|
import (
|
||||||
|
"go.uber.org/zap"
|
||||||
|
"go.uber.org/zap/zapcore"
|
||||||
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
Instance = zap.NewNop()
|
Instance *zap.Logger
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// 日志实例初始化默认输出到标准输出
|
||||||
|
func init() {
|
||||||
|
cfg := zap.NewProductionConfig()
|
||||||
|
cfg.OutputPaths = []string{"stdout"}
|
||||||
|
cfg.ErrorOutputPaths = []string{"stderr"}
|
||||||
|
cfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
|
||||||
|
logger, err := cfg.Build()
|
||||||
|
if err != nil {
|
||||||
|
panic("init logger error: " + err.Error())
|
||||||
|
}
|
||||||
|
Instance = logger.Sugar().Desugar()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disable 禁用日志
|
||||||
|
func Disable() {
|
||||||
|
Instance = zap.NewNop()
|
||||||
|
}
|
||||||
|
|
||||||
// SetInstance 设置日志实例
|
// SetInstance 设置日志实例
|
||||||
func SetInstance(l *zap.Logger) {
|
func SetInstance(l *zap.Logger) {
|
||||||
if nil == l {
|
if nil == l {
|
||||||
@@ -26,6 +47,10 @@ const (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
CodeInjectCommonParam = "inject-common-param"
|
CodeInjectCommonParam = "inject-common-param"
|
||||||
CodeLogicHook = "logic-hook"
|
CodeLogicHook = "logic-hook"
|
||||||
|
CodeParamValidateFailure = "param-validate-failure"
|
||||||
|
CodeLogicErrorWrapper = "logic-error-wrapper"
|
||||||
|
CodeLogicSseInitError = "sse-init-error"
|
||||||
|
CodeLogicSseClosedError = "sse-closed-error"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -16,10 +16,6 @@ import (
|
|||||||
type HookFunc func(ctx *gin.Context, requestData []byte, responseData map[string]interface{}, cost int64)
|
type HookFunc func(ctx *gin.Context, requestData []byte, responseData map[string]interface{}, cost int64)
|
||||||
|
|
||||||
// HookAfterResponseMiddleware 请求最终处理完成之后执行的中间件
|
// HookAfterResponseMiddleware 请求最终处理完成之后执行的中间件
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 11:55 2024/7/26
|
|
||||||
func HookAfterResponseMiddleware(hookFunc HookFunc) gin.HandlerFunc {
|
func HookAfterResponseMiddleware(hookFunc HookFunc) gin.HandlerFunc {
|
||||||
handleConfig := define.GetHttpHandleConfig()
|
handleConfig := define.GetHttpHandleConfig()
|
||||||
return func(ctx *gin.Context) {
|
return func(ctx *gin.Context) {
|
||||||
@@ -32,7 +28,7 @@ func HookAfterResponseMiddleware(hookFunc HookFunc) gin.HandlerFunc {
|
|||||||
ctx,
|
ctx,
|
||||||
[]byte(ctx.GetString(handleConfig.RecordRequestDataField)),
|
[]byte(ctx.GetString(handleConfig.RecordRequestDataField)),
|
||||||
ctx.GetStringMap(handleConfig.RecordResponseDataField),
|
ctx.GetStringMap(handleConfig.RecordResponseDataField),
|
||||||
request.WrapperHandle.GetCtxIntData(ctx, handleConfig.StartRequestTimeField, 0)-request.WrapperHandle.GetCtxIntData(ctx, handleConfig.StartRequestTimeField, 0),
|
request.WrapperHandle.GetCtxIntData(ctx, handleConfig.FinishRequestTimeField, 0)-request.WrapperHandle.GetCtxIntData(ctx, handleConfig.StartRequestTimeField, 0),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -21,10 +21,6 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// InitRequest 初始化请求
|
// InitRequest 初始化请求
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:08 2022/6/25
|
|
||||||
func InitRequest() gin.HandlerFunc {
|
func InitRequest() gin.HandlerFunc {
|
||||||
return func(ctx *gin.Context) {
|
return func(ctx *gin.Context) {
|
||||||
httpHandleConfig := define.GetHttpHandleConfig()
|
httpHandleConfig := define.GetHttpHandleConfig()
|
||||||
@@ -38,10 +34,6 @@ func InitRequest() gin.HandlerFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// getRequestID 生成 request id
|
// getRequestID 生成 request id
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:12 2022/6/25
|
|
||||||
func getRequestID(ctx *gin.Context) string {
|
func getRequestID(ctx *gin.Context) string {
|
||||||
return fmt.Sprintf(
|
return fmt.Sprintf(
|
||||||
"%v-%v-%v-%v",
|
"%v-%v-%v-%v",
|
||||||
@@ -53,10 +45,6 @@ func getRequestID(ctx *gin.Context) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// getTraceID 生成 trace id
|
// getTraceID 生成 trace id
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:12 2022/6/25
|
|
||||||
func getTraceID(ctx *gin.Context, requestID string) string {
|
func getTraceID(ctx *gin.Context, requestID string) string {
|
||||||
traceID := ctx.GetHeader("X-Forward-Trace-Id")
|
traceID := ctx.GetHeader("X-Forward-Trace-Id")
|
||||||
if len(traceID) > 0 {
|
if len(traceID) > 0 {
|
||||||
|
|||||||
@@ -15,10 +15,6 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// ValidateBlackIPMiddleware 验证黑名单IP的中间件
|
// ValidateBlackIPMiddleware 验证黑名单IP的中间件
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:24 2022/6/25
|
|
||||||
func ValidateBlackIPMiddleware(code interface{}, httpCode int, validateFunc define.IsBlackIP) gin.HandlerFunc {
|
func ValidateBlackIPMiddleware(code interface{}, httpCode int, validateFunc define.IsBlackIP) gin.HandlerFunc {
|
||||||
return func(ctx *gin.Context) {
|
return func(ctx *gin.Context) {
|
||||||
if nil == validateFunc {
|
if nil == validateFunc {
|
||||||
@@ -40,10 +36,6 @@ func ValidateBlackIPMiddleware(code interface{}, httpCode int, validateFunc defi
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ValidateWhiteIPMiddleware 是否白名单IP
|
// ValidateWhiteIPMiddleware 是否白名单IP
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 23:33 2022/6/25
|
|
||||||
func ValidateWhiteIPMiddleware(code interface{}, httpCode int, validateFunc define.IsWhiteIP) gin.HandlerFunc {
|
func ValidateWhiteIPMiddleware(code interface{}, httpCode int, validateFunc define.IsWhiteIP) gin.HandlerFunc {
|
||||||
return func(ctx *gin.Context) {
|
return func(ctx *gin.Context) {
|
||||||
if nil == validateFunc {
|
if nil == validateFunc {
|
||||||
|
|||||||
@@ -10,11 +10,13 @@ package request
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
"errors"
|
||||||
"github.com/mcuadros/go-defaults"
|
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"git.zhangdeman.cn/zhangdeman/wrapper/op_array"
|
||||||
|
"github.com/mcuadros/go-defaults"
|
||||||
|
|
||||||
"github.com/go-playground/validator/v10"
|
"github.com/go-playground/validator/v10"
|
||||||
|
|
||||||
"git.zhangdeman.cn/zhangdeman/gin/define"
|
"git.zhangdeman.cn/zhangdeman/gin/define"
|
||||||
@@ -44,11 +46,9 @@ func (f *form) Parse(ctx *gin.Context, receiver interface{}) error {
|
|||||||
// 因为请求体被读一遍之后就没了,重新赋值 requestBody
|
// 因为请求体被读一遍之后就没了,重新赋值 requestBody
|
||||||
ctx.Request.Body = io.NopCloser(bytes.NewReader(requestBody))
|
ctx.Request.Body = io.NopCloser(bytes.NewReader(requestBody))
|
||||||
method := strings.ToUpper(ctx.Request.Method)
|
method := strings.ToUpper(ctx.Request.Method)
|
||||||
if method == http.MethodGet ||
|
if op_array.ArrayType([]string{
|
||||||
method == http.MethodPatch ||
|
http.MethodGet, http.MethodPatch, http.MethodTrace, http.MethodConnect, http.MethodOptions,
|
||||||
method == http.MethodTrace ||
|
}).Has(method) >= 0 {
|
||||||
method == http.MethodConnect ||
|
|
||||||
method == http.MethodOptions {
|
|
||||||
if err := ctx.ShouldBindQuery(receiver); nil != err {
|
if err := ctx.ShouldBindQuery(receiver); nil != err {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,14 +49,17 @@ func (s *server) injectCommonParam(ctx *gin.Context, formValue any) error {
|
|||||||
} else {
|
} else {
|
||||||
reflectType = reflectFormValue.Type()
|
reflectType = reflectFormValue.Type()
|
||||||
}
|
}
|
||||||
|
if reflectType.Kind() == reflect.Ptr {
|
||||||
|
reflectType = reflectType.Elem()
|
||||||
|
}
|
||||||
|
|
||||||
fieldTable := map[string]bool{}
|
fieldTable := map[string]bool{}
|
||||||
fieldNum := reflectType.Elem().NumField()
|
fieldNum := reflectType.NumField()
|
||||||
for i := 0; i < fieldNum; i++ {
|
for i := 0; i < fieldNum; i++ {
|
||||||
if reflectType.Elem().Field(i).Anonymous && // 是匿名字段, 再做一次解析
|
if reflectType.Field(i).Anonymous && // 是匿名字段, 再做一次解析
|
||||||
((reflectType.Elem().Field(i).Type.Kind() == reflect.Ptr && reflectType.Elem().Field(i).Type.Kind() == reflect.Struct) || // 结构体指针
|
((reflectType.Field(i).Type.Kind() == reflect.Ptr && reflectType.Field(i).Type.Kind() == reflect.Struct) || // 结构体指针
|
||||||
reflectType.Elem().Field(i).Type.Kind() == reflect.Struct) { // 结构体
|
reflectType.Field(i).Type.Kind() == reflect.Struct) { // 结构体
|
||||||
anonymousFieldType := reflectType.Elem().Field(i).Type
|
anonymousFieldType := reflectType.Field(i).Type
|
||||||
if anonymousFieldType.Kind() == reflect.Ptr {
|
if anonymousFieldType.Kind() == reflect.Ptr {
|
||||||
anonymousFieldType = anonymousFieldType.Elem()
|
anonymousFieldType = anonymousFieldType.Elem()
|
||||||
}
|
}
|
||||||
@@ -65,7 +68,7 @@ func (s *server) injectCommonParam(ctx *gin.Context, formValue any) error {
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// 提取全部结构体字段
|
// 提取全部结构体字段
|
||||||
fieldTable[reflectType.Elem().Field(i).Name] = true
|
fieldTable[reflectType.Field(i).Name] = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for fieldName, getParamFunc := range s.commonParam {
|
for fieldName, getParamFunc := range s.commonParam {
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
// Package router ...
|
|
||||||
//
|
|
||||||
// Description : router ...
|
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 2025-02-07 17:41
|
|
||||||
package router
|
|
||||||
|
|
||||||
import "strings"
|
|
||||||
|
|
||||||
var defaultValidateErrTag = "err"
|
|
||||||
|
|
||||||
// SetValidateErrTag 设置验证失败时, 获取错误信息的tag字段
|
|
||||||
func SetValidateErrTag(tagName string) {
|
|
||||||
tagName = strings.TrimSpace(tagName)
|
|
||||||
if tagName == "" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
defaultValidateErrTag = tagName
|
|
||||||
}
|
|
||||||
@@ -10,6 +10,9 @@ package router
|
|||||||
import (
|
import (
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"git.zhangdeman.cn/zhangdeman/gin/logger"
|
||||||
|
"git.zhangdeman.cn/zhangdeman/util"
|
||||||
)
|
)
|
||||||
|
|
||||||
// controller 解析controller有哪些方法要注册为接口
|
// controller 解析controller有哪些方法要注册为接口
|
||||||
@@ -47,49 +50,65 @@ func (c controller) Parse(inputController any) map[string]UriConfig {
|
|||||||
return parseRes
|
return parseRes
|
||||||
}
|
}
|
||||||
|
|
||||||
// methodConfig 解析方法配置, 要求函数格式, 两个参数, 两个返回值, 格式 : func(ctx *gin.Context, formData anyStruct[组合Meta]) (anyStruct|map[response], error)
|
// preCheckMethod 预检查方法是否可以注册为接口
|
||||||
//
|
func (c controller) preCheckMethod(reflectMethod reflect.Method) (bool, reflect.Type, reflect.StructField) {
|
||||||
// 参数 : 方法反射结果
|
var (
|
||||||
//
|
metaField reflect.StructField
|
||||||
// 返回值 : 第一个 -> 解析出的接口配置 第二个 -> 是否要注册为接口
|
metaFieldExist bool
|
||||||
//
|
)
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 16:05 2025/1/27
|
|
||||||
func (c controller) methodConfig(reflectMethod reflect.Method) (cfg UriConfig, needRegister bool) {
|
|
||||||
methodType := reflectMethod.Type
|
methodType := reflectMethod.Type
|
||||||
// num0: 函数声明
|
// num0: 函数声明
|
||||||
// num1: 第一个参数
|
// num1: 第一个参数
|
||||||
// num2: 第二个参数
|
// num2: 第二个参数
|
||||||
if methodType.NumIn() != 3 {
|
if methodType.NumIn() != 3 {
|
||||||
needRegister = false
|
return false, nil, metaField
|
||||||
return
|
|
||||||
}
|
}
|
||||||
// 第一个参数必须是 *gin.Context 或者 *define.Context
|
// 第一个参数必须是 *gin.Context 或者 *define.Context
|
||||||
paramOne := methodType.In(1).String()
|
paramOne := methodType.In(1).String()
|
||||||
if paramOne != GinContextType {
|
if paramOne != GinContextType {
|
||||||
needRegister = false
|
return false, nil, metaField
|
||||||
return
|
|
||||||
}
|
}
|
||||||
// 解析第二个参数是组合Meta的form表单
|
|
||||||
|
// 解析第二个参数是组合 Meta 的form表单
|
||||||
formType := methodType.In(2)
|
formType := methodType.In(2)
|
||||||
cfg.FormDataType = formType
|
|
||||||
if formType.Kind() == reflect.Ptr {
|
if formType.Kind() == reflect.Ptr {
|
||||||
formType = methodType.In(2).Elem()
|
formType = formType.Elem()
|
||||||
}
|
}
|
||||||
metaField, metaFieldExist := formType.FieldByName(FieldNameMeta)
|
|
||||||
if !metaFieldExist {
|
if metaField, metaFieldExist = formType.FieldByName(FieldNameMeta); !metaFieldExist {
|
||||||
needRegister = false
|
return false, nil, metaField
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
return true, formType, metaField
|
||||||
|
}
|
||||||
|
|
||||||
|
// methodConfig 解析方法配置, 要求函数格式, 两个参数, 两个返回值, 格式 : func(ctx *gin.Context, formData anyStruct[组合Meta]) (anyStruct|map[response], error)
|
||||||
|
//
|
||||||
|
// 参数 : 方法反射结果
|
||||||
|
//
|
||||||
|
// 返回值 : 第一个 -> 解析出的接口配置 第二个 -> 是否要注册为接口
|
||||||
|
func (c controller) methodConfig(reflectMethod reflect.Method) (UriConfig, bool) {
|
||||||
|
var (
|
||||||
|
needRegister bool
|
||||||
|
metaField reflect.StructField
|
||||||
|
cfg UriConfig
|
||||||
|
)
|
||||||
|
|
||||||
|
methodType := reflectMethod.Type
|
||||||
|
// num0: 函数声明
|
||||||
|
// num1: 第一个参数
|
||||||
|
// num2: 第二个参数
|
||||||
|
if needRegister, cfg.FormDataType, metaField = c.preCheckMethod(reflectMethod); !needRegister {
|
||||||
|
logger.Instance.Info("接口方法不符合要求, 不注册为接口, 方法名: " + reflectMethod.Name + ", 方法签名: " + methodType.String())
|
||||||
|
return UriConfig{}, false
|
||||||
|
}
|
||||||
|
|
||||||
cfg.ResultDataType = methodType.Out(0)
|
cfg.ResultDataType = methodType.Out(0)
|
||||||
if cfg.ResultDataType == nil {
|
|
||||||
}
|
|
||||||
if methodType.Out(1).Kind().String() != ErrorType {
|
if methodType.Out(1).Kind().String() != ErrorType {
|
||||||
// 判断是否是实现 error接口的方法
|
// 判断是否是实现 error接口的方法
|
||||||
outputErrParse := false
|
outputErrParse := false
|
||||||
for j := 0; j < methodType.Out(1).NumMethod(); j++ {
|
for j := 0; j < methodType.Out(1).NumMethod(); j++ {
|
||||||
if methodType.Out(1).Method(j).Name == ErrorInterfaceFuncName && // 实现Error方法
|
if methodType.Out(1).Method(j).Name == ErrorInterfaceFuncName && // 实现 Error 方法
|
||||||
methodType.Out(1).Method(j).Type.NumIn() == 0 && // 没有任何参数
|
methodType.Out(1).Method(j).Type.NumIn() == 0 && // 没有任何参数
|
||||||
methodType.Out(1).Method(j).Type.NumOut() == 1 && // 一个返回值
|
methodType.Out(1).Method(j).Type.NumOut() == 1 && // 一个返回值
|
||||||
methodType.Out(1).Method(j).Type.Out(0).Kind().String() == reflect.String.String() {
|
methodType.Out(1).Method(j).Type.Out(0).Kind().String() == reflect.String.String() {
|
||||||
@@ -99,51 +118,48 @@ func (c controller) methodConfig(reflectMethod reflect.Method) (cfg UriConfig, n
|
|||||||
}
|
}
|
||||||
if !outputErrParse {
|
if !outputErrParse {
|
||||||
needRegister = false
|
needRegister = false
|
||||||
return
|
return cfg, needRegister
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// 解析meta信息
|
c.setUriMeta(metaField, &cfg)
|
||||||
cfg.Path = metaField.Tag.Get(TagNamePath)
|
|
||||||
cfg.RequestMethod = metaField.Tag.Get(TagNameMethod)
|
|
||||||
cfg.Desc = metaField.Tag.Get(TagNameDesc)
|
|
||||||
cfg.TagList = strings.Split(metaField.Tag.Get(TagNameUriTag), ",")
|
|
||||||
// 解析第一个返回值, 要求必须是结构体或者是map
|
|
||||||
outputStrictModel := metaField.Tag.Get(TagNameOutputStrict)
|
|
||||||
hookSync := strings.ToLower(metaField.Tag.Get(TagNameHookSync))
|
|
||||||
cfg.HookSync = hookSync == "1" || hookSync == "true" // 同步执行判断
|
|
||||||
cfg.OutputStrict = outputStrictModel == "1" || outputStrictModel == "true"
|
|
||||||
if cfg.OutputStrict {
|
if cfg.OutputStrict {
|
||||||
// 开启输出严格模式校验
|
// 开启输出严格模式校验
|
||||||
if methodType.Out(0).Kind() != reflect.Struct && methodType.Out(0).Kind() != reflect.Map {
|
if methodType.Out(0).Kind() != reflect.Struct && methodType.Out(0).Kind() != reflect.Map {
|
||||||
panic(cfg.Path + " : 接口配置输出严格校验, 输出数据类型必须为 struct 或 *struct 或 map, 实际返回数据类型 : " + methodType.Out(0).Kind().String())
|
panic(cfg.Path + " : 接口配置输出严格校验, 输出数据类型必须为 struct 或 *struct 或 map, 实际返回数据类型 : " + methodType.Out(0).Kind().String())
|
||||||
return
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// 解析参数配置
|
// 解析参数配置
|
||||||
//cfg.ParamList = c.parseParamConfig(formType)
|
//cfg.ParamList = c.parseParamConfig(formType)
|
||||||
cfg.ApiLogicFunc = reflectMethod
|
cfg.ApiLogicFunc = reflectMethod
|
||||||
needRegister = true
|
needRegister = true
|
||||||
return
|
return cfg, needRegister
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseParamConfig 解析参数配置
|
// setUriMeta 设置接口的 meta 信息
|
||||||
//
|
func (c controller) setUriMeta(metaField reflect.StructField, cfg *UriConfig) {
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
// 解析 meta 信息
|
||||||
//
|
cfg.Path = metaField.Tag.Get(TagNamePath) // 接口路由
|
||||||
// Date : 14:35 2025/2/7
|
cfg.RequestMethod = strings.Split(strings.ToUpper(metaField.Tag.Get(TagNameMethod)), ",") // 请求方法
|
||||||
func (c controller) parseParamConfig(formDataType reflect.Type) []UriParam {
|
cfg.Desc = metaField.Tag.Get(TagNameDesc) // 接口描述
|
||||||
res := make([]UriParam, 0)
|
cfg.TagList = strings.Split(metaField.Tag.Get(TagNameUriTag), ",") // 接口标签
|
||||||
for i := 0; i < formDataType.NumField(); i++ {
|
// 以下是bool类型的配置解析
|
||||||
structField := formDataType.Field(i)
|
var boolMetaParse = func(tagName string) bool {
|
||||||
if structField.Name == FieldNameMeta {
|
val := strings.ToLower(metaField.Tag.Get(tagName))
|
||||||
// Meta 字段, 忽略
|
return val == "1" || val == "true"
|
||||||
continue
|
}
|
||||||
}
|
cfg.OutputStrict = boolMetaParse(TagNameOutputStrict) // 配置接口数据是否严格要求是对象
|
||||||
jsonTag := structField.Tag.Get("json")
|
cfg.HookSync = boolMetaParse(TagNameHookSync) // 同步执行判断
|
||||||
if jsonTag == "" {
|
cfg.IsWebsocket = boolMetaParse(TagNameIsWebsocket) // 是否是 websocket 接口
|
||||||
jsonTag = structField.Name
|
cfg.IsSse = boolMetaParse(TagNameIsSse) // 是否是 sse 接口
|
||||||
}
|
cfg.NoLogin = boolMetaParse(TagNameNoLogin) // 是否需要登录
|
||||||
|
|
||||||
|
// 最大执行时间
|
||||||
|
cfg.MaxExecTime = uint(0)
|
||||||
|
if tagVal := strings.ToLower(metaField.Tag.Get(TagNameMaxExecTime)); tagVal != "" {
|
||||||
|
if err := util.ConvertAssign(&cfg.MaxExecTime, tagVal); nil != err {
|
||||||
|
panic(cfg.Path + " : 最大执行时间配置错误(配置的值必须是无符号整型), 请检查配置 : " + err.Error())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return res
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,34 +15,38 @@ const (
|
|||||||
PrefixFuncName = "RouterPrefix" // 路由前缀函数名称
|
PrefixFuncName = "RouterPrefix" // 路由前缀函数名称
|
||||||
MiddlewareFuncName = "RouterMiddleware" // 路由中间件函数名称
|
MiddlewareFuncName = "RouterMiddleware" // 路由中间件函数名称
|
||||||
GinContextType = "*gin.Context" // gin context 类型名称
|
GinContextType = "*gin.Context" // gin context 类型名称
|
||||||
ErrorType = "error" // error类型
|
ErrorType = "error" // error 类型
|
||||||
ErrorInterfaceFuncName = "Error" // error接口需要实现的方法名称
|
ErrorInterfaceFuncName = "Error" // error 接口需要实现的方法名称
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
TagNamePath = "path" // 接口的请求路径
|
TagNamePath = "path" // 接口的请求路径
|
||||||
TagNameMethod = "method" // 接口的请求方法
|
TagNameMethod = "method" // 接口的请求方法
|
||||||
TagNameUriTag = "tag" // 接口的tag
|
TagNameUriTag = "tag" // 接口的 tag
|
||||||
TagNameDesc = "desc" // 接口的描述
|
TagNameDesc = "desc" // 接口的描述
|
||||||
|
TagNameIsSse = "is-sse" // 是否 SSE 连接
|
||||||
|
TagNameIsWebsocket = "is-ws" // 是否 websocket 连接
|
||||||
TagNameOutputStrict = "output_strict" // 接口数据是否为严格模式 : 严格模式, 响应数据必须是结构体/map,非严格模式返回任意值
|
TagNameOutputStrict = "output_strict" // 接口数据是否为严格模式 : 严格模式, 响应数据必须是结构体/map,非严格模式返回任意值
|
||||||
TagNameHookSync = "hook-sync" // hook同步执行
|
TagNameHookSync = "hook-sync" // hook 同步执行
|
||||||
|
TagNameNoLogin = "no-login" // 接口是否需要登录(无需登录, 则有token就验证, 无token不验证)
|
||||||
|
TagNameMaxExecTime = "max-exec-time" // 接口最大执行时间, 单位: s, 配置为0则不验证
|
||||||
TagNameBinding = "binding" // gin 内置的验证规则tag
|
TagNameBinding = "binding" // gin 内置的验证规则tag
|
||||||
TagNameValidate = "validate" // validator v10 默认的验证规则tag
|
TagNameValidate = "validate" // validator v10 默认的验证规则tag
|
||||||
TagNameErrMsg = "err" // 验证失败错误信息tag
|
TagNameErrMsg = "err" // 验证失败错误信息 tag
|
||||||
)
|
)
|
||||||
|
|
||||||
// UriConfig 接口配置
|
// UriConfig 接口配置
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 15:41 2024/7/21
|
|
||||||
type UriConfig struct {
|
type UriConfig struct {
|
||||||
Path string `json:"path"` // 接口路由, 必须配置
|
Path string `json:"path"` // 接口路由, 必须配置
|
||||||
RequestMethod string `json:"request_method"` // 接口请求方法, 必须配置
|
RequestMethod []string `json:"request_method"` // 接口请求方法, 必须配置
|
||||||
TagList []string `json:"tag_list"` // 接口分组
|
TagList []string `json:"tag_list"` // 接口分组
|
||||||
Desc string `json:"desc"` // 接口描述
|
Desc string `json:"desc"` // 接口描述
|
||||||
|
IsSse bool `json:"is_sse"` // 是否 SSE 连接
|
||||||
|
IsWebsocket bool `json:"is_ws"` // 是否 websocket 连接
|
||||||
OutputStrict bool `json:"output_strict"` // 接口是否为严格模式 : 不配置,可返回任意类型, 配置, 必须返回结构体或者map
|
OutputStrict bool `json:"output_strict"` // 接口是否为严格模式 : 不配置,可返回任意类型, 配置, 必须返回结构体或者map
|
||||||
|
MaxExecTime uint `json:"max_exec_time"` // 接口最大执行时间, 单位: ms, 配置为0则不验证, 注意, 超时后不会报错, 会打印一条warn日志, 如果配置了报警策略, 也会发送报警信息
|
||||||
HookSync bool `json:"hook_sync"` // 接口主逻辑执行完成之后,hook是否同步执行, 默认异步执行
|
HookSync bool `json:"hook_sync"` // 接口主逻辑执行完成之后,hook是否同步执行, 默认异步执行
|
||||||
|
NoLogin bool `json:"no_login"` // 接口是否需要登录(无需登录, 则有token就验证, 无token不验证)
|
||||||
FormDataType reflect.Type `json:"-"` // 表单数据类型
|
FormDataType reflect.Type `json:"-"` // 表单数据类型
|
||||||
ResultDataType reflect.Type `json:"-"` // 返回值数据类型
|
ResultDataType reflect.Type `json:"-"` // 返回值数据类型
|
||||||
ApiStructValue reflect.Value `json:"-"` // 逻辑函数所属结构体取值
|
ApiStructValue reflect.Value `json:"-"` // 逻辑函数所属结构体取值
|
||||||
|
|||||||
@@ -9,14 +9,22 @@ package router
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
"reflect"
|
"reflect"
|
||||||
"sync"
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
"git.zhangdeman.cn/zhangdeman/consts"
|
"git.zhangdeman.cn/zhangdeman/consts"
|
||||||
"git.zhangdeman.cn/zhangdeman/exception"
|
"git.zhangdeman.cn/zhangdeman/exception"
|
||||||
"git.zhangdeman.cn/zhangdeman/gin/define"
|
"git.zhangdeman.cn/zhangdeman/gin/define"
|
||||||
|
"git.zhangdeman.cn/zhangdeman/gin/logger"
|
||||||
"git.zhangdeman.cn/zhangdeman/gin/request"
|
"git.zhangdeman.cn/zhangdeman/gin/request"
|
||||||
"git.zhangdeman.cn/zhangdeman/gin/response"
|
"git.zhangdeman.cn/zhangdeman/gin/response"
|
||||||
|
"git.zhangdeman.cn/zhangdeman/gin/util"
|
||||||
|
loggerPkg "git.zhangdeman.cn/zhangdeman/logger"
|
||||||
|
"git.zhangdeman.cn/zhangdeman/serialize"
|
||||||
|
"git.zhangdeman.cn/zhangdeman/wrapper/op_string"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/mcuadros/go-defaults"
|
"github.com/mcuadros/go-defaults"
|
||||||
)
|
)
|
||||||
@@ -38,8 +46,15 @@ func (s *server) getFormInitValue(ctx *gin.Context, uriCfg UriConfig) (any, erro
|
|||||||
if err = request.Form.Parse(ctx, formValue); nil != err {
|
if err = request.Form.Parse(ctx, formValue); nil != err {
|
||||||
// 格式化验证错误的信息
|
// 格式化验证错误的信息
|
||||||
err = GetValidateErr(formValue, err)
|
err = GetValidateErr(formValue, err)
|
||||||
|
logger.Instance.Error("参数解析出现异常", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeParamValidateFailure, map[string]any{
|
||||||
|
"err_msg": err.Error(),
|
||||||
|
}).ToFieldList()...)
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 非必传参数设置默认值
|
||||||
|
defaults.SetDefaults(formValue)
|
||||||
|
|
||||||
return formValue, nil
|
return formValue, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -55,7 +70,7 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
)
|
)
|
||||||
|
|
||||||
if formValue, err = s.getFormInitValue(ctx, uriCfg); nil != err {
|
if formValue, err = s.getFormInitValue(ctx, uriCfg); nil != err {
|
||||||
e = exception.NewFromError(400, err)
|
e = exception.NewFromError(http.StatusBadRequest, err)
|
||||||
response.SendWithException(ctx, e, &define.ResponseOption{
|
response.SendWithException(ctx, e, &define.ResponseOption{
|
||||||
ContentType: consts.MimeTypeJson,
|
ContentType: consts.MimeTypeJson,
|
||||||
})
|
})
|
||||||
@@ -63,7 +78,7 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
// 表单数据
|
// 表单数据
|
||||||
inputValue := reflect.ValueOf(formValue)
|
inputValue := reflect.ValueOf(formValue).Elem()
|
||||||
|
|
||||||
// 注入公共参数
|
// 注入公共参数
|
||||||
if err = s.injectCommonParam(ctx, inputValue); nil != err {
|
if err = s.injectCommonParam(ctx, inputValue); nil != err {
|
||||||
@@ -75,12 +90,9 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// 非必传参数设置默认值
|
|
||||||
defaults.SetDefaults(formValue)
|
|
||||||
|
|
||||||
// 默认请求失败
|
// 默认请求失败
|
||||||
ctx.Set(consts.GinRequestSuccess, false)
|
ctx.Set(consts.GinRequestSuccess, false)
|
||||||
// 初始化响应之后logic
|
// 初始化响应之后 logic
|
||||||
logicAfterResponse := &define.LogicAfterResponse{
|
logicAfterResponse := &define.LogicAfterResponse{
|
||||||
SuccessHookFuncList: make([]func(ctx *gin.Context), 0),
|
SuccessHookFuncList: make([]func(ctx *gin.Context), 0),
|
||||||
FailureHookFuncList: make([]func(ctx *gin.Context), 0),
|
FailureHookFuncList: make([]func(ctx *gin.Context), 0),
|
||||||
@@ -88,11 +100,7 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
}
|
}
|
||||||
// 此处暴露出去,是为了使用方可以获取到对应数据
|
// 此处暴露出去,是为了使用方可以获取到对应数据
|
||||||
ctx.Set(consts.GinLogicAfterResponseKey, logicAfterResponse)
|
ctx.Set(consts.GinLogicAfterResponseKey, logicAfterResponse)
|
||||||
defer s.hook(ctx, uriCfg) // 执行Logic之后的相关逻辑
|
defer s.hook(ctx, uriCfg) // 执行 Logic 之后的相关逻辑
|
||||||
// 执行逻辑
|
|
||||||
if uriCfg.FormDataType.Kind() != reflect.Ptr {
|
|
||||||
inputValue = inputValue.Elem()
|
|
||||||
}
|
|
||||||
|
|
||||||
firstParam = reflect.ValueOf(ctx)
|
firstParam = reflect.ValueOf(ctx)
|
||||||
resList := uriCfg.ApiLogicFunc.Func.Call([]reflect.Value{uriCfg.ApiStructValue, firstParam, inputValue})
|
resList := uriCfg.ApiLogicFunc.Func.Call([]reflect.Value{uriCfg.ApiStructValue, firstParam, inputValue})
|
||||||
@@ -105,9 +113,12 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
// 请求失败
|
// 请求失败
|
||||||
if ok = errors.As(resList[1].Interface().(error), &e); ok {
|
if ok = errors.As(resList[1].Interface().(error), &e); ok {
|
||||||
// 本身就是exception.IException
|
// 本身就是exception.IException
|
||||||
|
logger.Instance.Debug("请求结果err类型为 exception.IException, 无需特殊处理", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
} else if err, ok = resList[1].Interface().(error); ok {
|
} else if err, ok = resList[1].Interface().(error); ok {
|
||||||
|
logger.Instance.Debug("请求结果err类型为 error, 包装为 exception.IException", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
e = exception.NewFromError(-1, err)
|
e = exception.NewFromError(-1, err)
|
||||||
} else {
|
} else {
|
||||||
|
logger.Instance.Debug("请求结果err类型 既不是 error 也不是 exception.IException, 包装为 exception.IException", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
e = exception.NewWithCodeAndData(-1, map[string]any{
|
e = exception.NewWithCodeAndData(-1, map[string]any{
|
||||||
"err": resList[1].Interface(),
|
"err": resList[1].Interface(),
|
||||||
})
|
})
|
||||||
@@ -115,6 +126,146 @@ func (s *server) RequestHandler(uriCfg UriConfig) gin.HandlerFunc {
|
|||||||
response.SendWithException(ctx, e, &define.ResponseOption{
|
response.SendWithException(ctx, e, &define.ResponseOption{
|
||||||
ContentType: consts.MimeTypeJson,
|
ContentType: consts.MimeTypeJson,
|
||||||
})
|
})
|
||||||
return
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SseHandler sse连接请求
|
||||||
|
func (s *server) SseHandler(uriCfg UriConfig) gin.HandlerFunc {
|
||||||
|
return func(ctx *gin.Context) {
|
||||||
|
var (
|
||||||
|
err error
|
||||||
|
ok bool
|
||||||
|
e exception.IException
|
||||||
|
formValue any
|
||||||
|
firstParam reflect.Value
|
||||||
|
)
|
||||||
|
|
||||||
|
if formValue, err = s.getFormInitValue(ctx, uriCfg); nil != err {
|
||||||
|
e = exception.NewFromError(http.StatusBadRequest, err)
|
||||||
|
response.SendWithException(ctx, e, &define.ResponseOption{
|
||||||
|
ContentType: consts.MimeTypeJson,
|
||||||
|
})
|
||||||
|
ctx.Abort()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 表单数据
|
||||||
|
inputValue := reflect.ValueOf(formValue).Elem()
|
||||||
|
|
||||||
|
// 注入公共参数
|
||||||
|
if err = s.injectCommonParam(ctx, inputValue); nil != err {
|
||||||
|
e = exception.NewFromError(500, err)
|
||||||
|
response.SendWithException(ctx, e, &define.ResponseOption{
|
||||||
|
ContentType: consts.MimeTypeJson,
|
||||||
|
})
|
||||||
|
ctx.Abort()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.Set(consts.GinRequestSuccess, false)
|
||||||
|
// 初始化响应之后 logic
|
||||||
|
logicAfterResponse := &define.LogicAfterResponse{
|
||||||
|
SuccessHookFuncList: make([]func(ctx *gin.Context), 0),
|
||||||
|
FailureHookFuncList: make([]func(ctx *gin.Context), 0),
|
||||||
|
Lock: &sync.RWMutex{},
|
||||||
|
}
|
||||||
|
// 此处暴露出去,是为了使用方可以获取到对应数据
|
||||||
|
ctx.Set(consts.GinLogicAfterResponseKey, logicAfterResponse)
|
||||||
|
defer s.hook(ctx, uriCfg) // 执行 Logic 之后的相关逻辑
|
||||||
|
|
||||||
|
ctx.Writer.Header().Set(consts.HeaderKeyContentType.String(), "text/event-stream")
|
||||||
|
ctx.Writer.Header().Set(consts.HeaderKeyCacheControl.String(), "no-cache")
|
||||||
|
ctx.Writer.Header().Set(consts.HeaderKeyConnection.String(), "keep-alive")
|
||||||
|
ctx.Writer.Header().Set(consts.HeaderKeyXAccelBuffering.String(), "no")
|
||||||
|
flusher, _ := ctx.Writer.(http.Flusher)
|
||||||
|
// 发送连接就绪消息
|
||||||
|
if _, err = fmt.Fprintf(ctx.Writer, define.SseMsgFormat, -1, "system", serialize.JSON.MarshalForStringIgnoreError(define.SseData{
|
||||||
|
ID: op_string.Random(8, ""),
|
||||||
|
Object: "system",
|
||||||
|
Created: time.Now().Unix(),
|
||||||
|
Choices: []map[string]any{},
|
||||||
|
EventType: "connected",
|
||||||
|
})); nil != err {
|
||||||
|
// 无法推送数据, 等价于结束, 如有必要, 让客户端发起重连
|
||||||
|
logger.Instance.Error("SSE 连接建立成功后, 发送链接成功消息出现异常", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicSseInitError, map[string]any{
|
||||||
|
"err_msg": err.Error(),
|
||||||
|
}).ToFieldList()...)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
flusher.Flush()
|
||||||
|
defer func() {
|
||||||
|
// 发送连接关闭消息
|
||||||
|
if _, err = fmt.Fprintf(ctx.Writer, define.SseMsgFormat, -3, "system", serialize.JSON.MarshalForStringIgnoreError(define.SseData{
|
||||||
|
ID: op_string.Random(8, ""),
|
||||||
|
Object: "system",
|
||||||
|
Created: time.Now().Unix(),
|
||||||
|
Choices: []map[string]any{},
|
||||||
|
EventType: "closed",
|
||||||
|
})); nil != err {
|
||||||
|
// 无法推送数据, 等价于结束, 如有必要, 让客户端发起重连
|
||||||
|
logger.Instance.Error("SSE 连接断开前, 发送链接断开消息出现异常", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicSseClosedError, map[string]any{
|
||||||
|
"err_msg": err.Error(),
|
||||||
|
}).ToFieldList()...)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
flusher.Flush()
|
||||||
|
}()
|
||||||
|
firstParam = reflect.ValueOf(ctx)
|
||||||
|
resList := uriCfg.ApiLogicFunc.Func.Call([]reflect.Value{uriCfg.ApiStructValue, firstParam, inputValue})
|
||||||
|
if resList[1].IsNil() {
|
||||||
|
// 请求成功, 更新标识
|
||||||
|
ctx.Set(consts.GinRequestSuccess, true)
|
||||||
|
response.SuccessWithExtension(ctx, resList[0].Interface(), &define.ResponseOption{ContentType: consts.MimeTypeJson})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
// 请求失败
|
||||||
|
if ok = errors.As(resList[1].Interface().(error), &e); ok {
|
||||||
|
// 本身就是exception.IException
|
||||||
|
logger.Instance.Debug("请求结果err类型为 exception.IException, 无需特殊处理", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
|
} else if err, ok = resList[1].Interface().(error); ok {
|
||||||
|
logger.Instance.Debug("请求结果err类型为 error, 包装为 exception.IException", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
|
e = exception.NewFromError(-1, err)
|
||||||
|
} else {
|
||||||
|
logger.Instance.Debug("请求结果err类型 既不是 error 也不是 exception.IException, 包装为 exception.IException", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicErrorWrapper, map[string]any{}).ToFieldList()...)
|
||||||
|
e = exception.NewWithCodeAndData(-1, map[string]any{
|
||||||
|
"err": resList[1].Interface(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if nil != e {
|
||||||
|
// 异常终止
|
||||||
|
if _, err = fmt.Fprintf(ctx.Writer, define.SseMsgFormat, -3, "system", serialize.JSON.MarshalForStringIgnoreError(define.SseData{
|
||||||
|
ID: op_string.Random(8, ""),
|
||||||
|
Object: "system",
|
||||||
|
Created: time.Now().Unix(),
|
||||||
|
Choices: []map[string]any{
|
||||||
|
{
|
||||||
|
"err_msg": e.Message(),
|
||||||
|
"err_code": e.Code(),
|
||||||
|
"err_data": e.Data(),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
EventType: "failure",
|
||||||
|
})); nil != err {
|
||||||
|
// 无法推送数据, 等价于结束, 如有必要, 让客户端发起重连
|
||||||
|
logger.Instance.Error("SSE 业务处理完成, 发送业务处理失败消息出现异常", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicSseClosedError, map[string]any{
|
||||||
|
"err_msg": err.Error(),
|
||||||
|
}).ToFieldList()...)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// 正常终止
|
||||||
|
if _, err = fmt.Fprintf(ctx.Writer, define.SseMsgFormat, -3, "system", serialize.JSON.MarshalForStringIgnoreError(define.SseData{
|
||||||
|
ID: op_string.Random(8, ""),
|
||||||
|
Object: "system",
|
||||||
|
Created: time.Now().Unix(),
|
||||||
|
Choices: []map[string]any{},
|
||||||
|
EventType: "success",
|
||||||
|
})); nil != err {
|
||||||
|
// 无法推送数据, 等价于结束, 如有必要, 让客户端发起重连
|
||||||
|
logger.Instance.Error("SSE 业务处理完成, 发送业务处理成功消息出现异常", loggerPkg.NewLogData(util.GinCtxToContext(ctx), logger.RecordType, logger.CodeLogicSseClosedError, map[string]any{
|
||||||
|
"err_msg": err.Error(),
|
||||||
|
}).ToFieldList()...)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,19 +18,23 @@ import (
|
|||||||
|
|
||||||
// hook 执行hook逻辑
|
// hook 执行hook逻辑
|
||||||
func (s *server) hook(ctx *gin.Context, uriCfg UriConfig) {
|
func (s *server) hook(ctx *gin.Context, uriCfg UriConfig) {
|
||||||
responseAfter, exist := ctx.Get(consts.GinLogicAfterResponseKey)
|
var (
|
||||||
|
exists bool
|
||||||
|
isSuccess any
|
||||||
|
responseAfter any
|
||||||
|
)
|
||||||
|
|
||||||
innerContext := util.GinCtxToContext(ctx)
|
innerContext := util.GinCtxToContext(ctx)
|
||||||
if !exist || nil != responseAfter {
|
if responseAfter, exists = ctx.Get(consts.GinLogicAfterResponseKey); !exists || nil != responseAfter {
|
||||||
// 未配置
|
// 未配置
|
||||||
logger.Instance.Debug("未配置Logic执行后的hook逻辑", pkgLogger.NewLogData(innerContext, logger.RecordType, logger.CodeLogicHook, map[string]any{
|
logger.Instance.Debug("未配置 Logic 执行后的 hook 逻辑", pkgLogger.NewLogData(innerContext, logger.RecordType, logger.CodeLogicHook, map[string]any{
|
||||||
"uri": uriCfg.Path,
|
"uri": uriCfg.Path,
|
||||||
"logic_after_response_key": consts.GinLogicAfterResponseKey,
|
"logic_after_response_key": consts.GinLogicAfterResponseKey,
|
||||||
}).ToFieldList()...)
|
}).ToFieldList()...)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
isSuccess, exist := ctx.Get(consts.GinRequestSuccess)
|
|
||||||
success := false
|
success := false
|
||||||
if nil != isSuccess && (isSuccess == "1" || isSuccess == "true" || isSuccess.(bool)) {
|
if isSuccess, exists = ctx.Get(consts.GinRequestSuccess); exists && nil != isSuccess && (isSuccess == "1" || isSuccess == "true" || isSuccess.(bool)) {
|
||||||
success = true
|
success = true
|
||||||
}
|
}
|
||||||
hookInstance := responseAfter.(*define.LogicAfterResponse)
|
hookInstance := responseAfter.(*define.LogicAfterResponse)
|
||||||
@@ -47,14 +51,12 @@ func (s *server) hookAfter(ctx *gin.Context, uriCfg UriConfig, hookInstance *def
|
|||||||
innerContext := util.GinCtxToContext(ctx)
|
innerContext := util.GinCtxToContext(ctx)
|
||||||
defer func() {
|
defer func() {
|
||||||
if err := recover(); err != nil {
|
if err := recover(); err != nil {
|
||||||
logger.Instance.Error("hook执行异常", pkgLogger.NewLogData(innerContext, logger.RecordType, logger.CodeLogicHook, map[string]any{
|
logger.Instance.Error("hook 执行异常", pkgLogger.NewLogData(innerContext, logger.RecordType, logger.CodeLogicHook, map[string]any{
|
||||||
"uri": uriCfg.Path,
|
"uri": uriCfg.Path,
|
||||||
"logic_after_response_key": consts.GinLogicAfterResponseKey,
|
"logic_after_response_key": consts.GinLogicAfterResponseKey,
|
||||||
"error": err.(error).Error(),
|
"error": err.(error).Error(),
|
||||||
"logic_success": success,
|
"logic_success": success,
|
||||||
}).ToFieldList()...)
|
}).ToFieldList()...)
|
||||||
} else {
|
|
||||||
|
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
if success {
|
if success {
|
||||||
|
|||||||
@@ -18,18 +18,14 @@ import (
|
|||||||
type SetServerOptionFunc func(so *serverOption)
|
type SetServerOptionFunc func(so *serverOption)
|
||||||
|
|
||||||
// serverOption 获取server实例的选项
|
// serverOption 获取server实例的选项
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:28 2025/2/18
|
|
||||||
type serverOption struct {
|
type serverOption struct {
|
||||||
swaggerUiTheme string // swagger 主题
|
swaggerUiTheme string // swagger 主题
|
||||||
swaggerBaseUri string // swagger基础path
|
swaggerBaseUri string // swagger 基础path
|
||||||
globalMiddlewareList []gin.HandlerFunc // 全局中间件列表
|
globalMiddlewareList []gin.HandlerFunc // 全局中间件列表
|
||||||
disableSwaggerDoc bool // 禁用swagger文档, 特定环境不想展示文档, 可通过次方式禁用
|
disableSwaggerDoc bool // 禁用swagger文档, 特定环境不想展示文档, 可通过次方式禁用
|
||||||
serverInfo *apiDocDefine.Info // 服务器信息
|
serverInfo *apiDocDefine.Info // 服务器信息
|
||||||
serverList []*apiDocDefine.ServerItem // 服务器环境列表
|
serverList []*apiDocDefine.ServerItem // 服务器环境列表
|
||||||
enablePprof bool // 启用pprof
|
enablePprof bool // 启用 pprof
|
||||||
enableCors bool // 启动跨域支持
|
enableCors bool // 启动跨域支持
|
||||||
disableInitRequest bool // 禁用初始化请求
|
disableInitRequest bool // 禁用初始化请求
|
||||||
loggerCfg *middleware.AccessConfig // 日志配置
|
loggerCfg *middleware.AccessConfig // 日志配置
|
||||||
@@ -60,10 +56,6 @@ func WithInitContextData(formatFunc func(ctx *gin.Context) map[string]any) SetSe
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithSwaggerUITheme 设置swaggerUI主题
|
// WithSwaggerUITheme 设置swaggerUI主题
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:29 2025/2/18
|
|
||||||
func WithSwaggerUITheme(uiTheme string) SetServerOptionFunc {
|
func WithSwaggerUITheme(uiTheme string) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
uiTheme = strings.TrimSpace(uiTheme)
|
uiTheme = strings.TrimSpace(uiTheme)
|
||||||
@@ -75,10 +67,6 @@ func WithSwaggerUITheme(uiTheme string) SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithGlobalMiddlewareList 设置全局中间件
|
// WithGlobalMiddlewareList 设置全局中间件
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:33 2025/2/18
|
|
||||||
func WithGlobalMiddlewareList(middlewareList ...gin.HandlerFunc) SetServerOptionFunc {
|
func WithGlobalMiddlewareList(middlewareList ...gin.HandlerFunc) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
so.globalMiddlewareList = middlewareList
|
so.globalMiddlewareList = middlewareList
|
||||||
@@ -86,10 +74,6 @@ func WithGlobalMiddlewareList(middlewareList ...gin.HandlerFunc) SetServerOption
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithSwaggerBaseUri ...
|
// WithSwaggerBaseUri ...
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 18:05 2025/2/18
|
|
||||||
func WithSwaggerBaseUri(baseUri string) SetServerOptionFunc {
|
func WithSwaggerBaseUri(baseUri string) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
baseUri = strings.TrimSpace(baseUri)
|
baseUri = strings.TrimSpace(baseUri)
|
||||||
@@ -102,10 +86,6 @@ func WithSwaggerBaseUri(baseUri string) SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithDisableSwaggerDoc 禁用swagger文档
|
// WithDisableSwaggerDoc 禁用swagger文档
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:35 2025/2/18
|
|
||||||
func WithDisableSwaggerDoc() SetServerOptionFunc {
|
func WithDisableSwaggerDoc() SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
so.disableSwaggerDoc = true
|
so.disableSwaggerDoc = true
|
||||||
@@ -113,10 +93,6 @@ func WithDisableSwaggerDoc() SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithServerInfo 设置serverInfo
|
// WithServerInfo 设置serverInfo
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:51 2025/2/18
|
|
||||||
func WithServerInfo(serverInfo *apiDocDefine.Info) SetServerOptionFunc {
|
func WithServerInfo(serverInfo *apiDocDefine.Info) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
if nil == serverInfo {
|
if nil == serverInfo {
|
||||||
@@ -127,10 +103,6 @@ func WithServerInfo(serverInfo *apiDocDefine.Info) SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithServerList 设置服务器列表
|
// WithServerList 设置服务器列表
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:52 2025/2/18
|
|
||||||
func WithServerList(serverList []*apiDocDefine.ServerItem) SetServerOptionFunc {
|
func WithServerList(serverList []*apiDocDefine.ServerItem) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
if len(serverList) == 0 {
|
if len(serverList) == 0 {
|
||||||
@@ -141,10 +113,6 @@ func WithServerList(serverList []*apiDocDefine.ServerItem) SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithPprofEnable 启用pprof
|
// WithPprofEnable 启用pprof
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 15:10 2025/2/21
|
|
||||||
func WithPprofEnable() SetServerOptionFunc {
|
func WithPprofEnable() SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
so.enablePprof = true
|
so.enablePprof = true
|
||||||
@@ -152,10 +120,6 @@ func WithPprofEnable() SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithEnableCors 启用全局跨域
|
// WithEnableCors 启用全局跨域
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 14:56 2025/2/22
|
|
||||||
func WithEnableCors() SetServerOptionFunc {
|
func WithEnableCors() SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
so.enableCors = true
|
so.enableCors = true
|
||||||
@@ -163,10 +127,6 @@ func WithEnableCors() SetServerOptionFunc {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithLoggerCfg ...
|
// WithLoggerCfg ...
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 15:25 2025/2/22
|
|
||||||
func WithLoggerCfg(loggerCfg *middleware.AccessConfig) SetServerOptionFunc {
|
func WithLoggerCfg(loggerCfg *middleware.AccessConfig) SetServerOptionFunc {
|
||||||
return func(so *serverOption) {
|
return func(so *serverOption) {
|
||||||
if nil != loggerCfg || nil != loggerCfg.Logger {
|
if nil != loggerCfg || nil != loggerCfg.Logger {
|
||||||
|
|||||||
@@ -77,10 +77,6 @@ func NewServer(port int, optionList ...SetServerOptionFunc) *server {
|
|||||||
if !option.disableInitRequest { // 启用了初始化请求
|
if !option.disableInitRequest { // 启用了初始化请求
|
||||||
globalMiddlewareList = append(globalMiddlewareList, middleware.InitRequest()) // 初始化请求
|
globalMiddlewareList = append(globalMiddlewareList, middleware.InitRequest()) // 初始化请求
|
||||||
}
|
}
|
||||||
// CustomContext 必须在第一个, 并且进行初始化
|
|
||||||
globalMiddlewareList = append(
|
|
||||||
globalMiddlewareList,
|
|
||||||
)
|
|
||||||
if nil != option.loggerCfg {
|
if nil != option.loggerCfg {
|
||||||
// 请求日志记录中间件
|
// 请求日志记录中间件
|
||||||
globalMiddlewareList = append(globalMiddlewareList, middleware.LogRequest(option.loggerCfg))
|
globalMiddlewareList = append(globalMiddlewareList, middleware.LogRequest(option.loggerCfg))
|
||||||
@@ -135,10 +131,6 @@ type server struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Start 启动服务
|
// Start 启动服务
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 18:31 2025/2/7
|
|
||||||
func (s *server) Start() {
|
func (s *server) Start() {
|
||||||
// 注册文档
|
// 注册文档
|
||||||
s.uiInstance.RegisterHandler(s.router, s.option.swaggerBaseUri)
|
s.uiInstance.RegisterHandler(s.router, s.option.swaggerBaseUri)
|
||||||
@@ -153,28 +145,16 @@ func (s *server) Start() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Router 对外访问路由实例, 不建议直接用
|
// Router 对外访问路由实例, 不建议直接用
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 17:35 2025/2/18
|
|
||||||
func (s *server) Router() *gin.Engine {
|
func (s *server) Router() *gin.Engine {
|
||||||
return s.router
|
return s.router
|
||||||
}
|
}
|
||||||
|
|
||||||
// Handler404 注册404的处理方法
|
// Handler404 注册404的处理方法
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 16:01 2025/2/22
|
|
||||||
func (s *server) Handler404(f gin.HandlerFunc) {
|
func (s *server) Handler404(f gin.HandlerFunc) {
|
||||||
s.router.NoRoute(f)
|
s.router.NoRoute(f)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetCustomRouter 自定义路由处理
|
// SetCustomRouter 自定义路由处理
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 16:09 2025/2/22
|
|
||||||
func (s *server) SetCustomRouter(f func(r *gin.Engine)) {
|
func (s *server) SetCustomRouter(f func(r *gin.Engine)) {
|
||||||
if nil == f {
|
if nil == f {
|
||||||
return
|
return
|
||||||
@@ -183,10 +163,6 @@ func (s *server) SetCustomRouter(f func(r *gin.Engine)) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Group 注册接口路由
|
// Group 注册接口路由
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 19:35 2025/1/27
|
|
||||||
func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, cList ...any) {
|
func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, cList ...any) {
|
||||||
g := s.router.Group(routerPrefix)
|
g := s.router.Group(routerPrefix)
|
||||||
g.Use(middlewareList...)
|
g.Use(middlewareList...)
|
||||||
@@ -195,27 +171,29 @@ func (s *server) Group(routerPrefix string, middlewareList []gin.HandlerFunc, cL
|
|||||||
urlTable := cParser.Parse(c)
|
urlTable := cParser.Parse(c)
|
||||||
for _, itemUriCfg := range urlTable {
|
for _, itemUriCfg := range urlTable {
|
||||||
_ = s.uiInstance.DocInstance().AddApiFromInAndOut(routerPrefix, itemUriCfg.FormDataType, itemUriCfg.ResultDataType)
|
_ = s.uiInstance.DocInstance().AddApiFromInAndOut(routerPrefix, itemUriCfg.FormDataType, itemUriCfg.ResultDataType)
|
||||||
method := strings.ToUpper(itemUriCfg.RequestMethod)
|
|
||||||
handleFunc := s.RequestHandler(itemUriCfg)
|
handleFunc := s.RequestHandler(itemUriCfg)
|
||||||
switch method {
|
// 一个接口支持注册多种请求方法
|
||||||
case http.MethodGet:
|
for _, method := range itemUriCfg.RequestMethod {
|
||||||
g.GET(itemUriCfg.Path, handleFunc)
|
switch method {
|
||||||
case http.MethodHead:
|
case http.MethodGet:
|
||||||
g.HEAD(itemUriCfg.Path, handleFunc)
|
g.GET(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodPost:
|
case http.MethodHead:
|
||||||
g.POST(itemUriCfg.Path, handleFunc)
|
g.HEAD(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodPut:
|
case http.MethodPost:
|
||||||
g.PUT(itemUriCfg.Path, handleFunc)
|
g.POST(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodPatch:
|
case http.MethodPut:
|
||||||
g.PATCH(itemUriCfg.Path, handleFunc)
|
g.PUT(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodDelete:
|
case http.MethodPatch:
|
||||||
g.DELETE(itemUriCfg.Path, handleFunc)
|
g.PATCH(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodOptions:
|
case http.MethodDelete:
|
||||||
g.OPTIONS(itemUriCfg.Path, handleFunc)
|
g.DELETE(itemUriCfg.Path, handleFunc)
|
||||||
case http.MethodTrace:
|
case http.MethodOptions:
|
||||||
panic(`method Trace is not supported`)
|
g.OPTIONS(itemUriCfg.Path, handleFunc)
|
||||||
default:
|
case http.MethodTrace:
|
||||||
panic("method " + itemUriCfg.RequestMethod + " is not support")
|
panic(`method Trace is not supported`)
|
||||||
|
default:
|
||||||
|
panic("method " + method + " is not support")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,16 +10,24 @@ package router
|
|||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/go-playground/validator/v10"
|
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/go-playground/validator/v10"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var defaultValidateErrTag = "err"
|
||||||
|
|
||||||
|
// SetValidateErrTag 设置验证失败时, 获取错误信息的tag字段
|
||||||
|
func SetValidateErrTag(tagName string) {
|
||||||
|
tagName = strings.TrimSpace(tagName)
|
||||||
|
if tagName == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defaultValidateErrTag = tagName
|
||||||
|
}
|
||||||
|
|
||||||
// GetValidateErr 格式化错误信息
|
// GetValidateErr 格式化错误信息
|
||||||
//
|
|
||||||
// Author : go_developer@163.com<白茶清欢>
|
|
||||||
//
|
|
||||||
// Date : 22:19 2025/1/15
|
|
||||||
func GetValidateErr(obj any, rawErr error) error {
|
func GetValidateErr(obj any, rawErr error) error {
|
||||||
if nil == rawErr {
|
if nil == rawErr {
|
||||||
return nil
|
return nil
|
||||||
|
|||||||
Reference in New Issue
Block a user