mux

type Context interface {

	// ClientIP 返回可靠的客户端IP
	ClientIP() string

	// ShouldBindXML 反序列化 querystring
	// tag: `xml:"xxx"` (注：不要写成 query)
	ShouldBindXML(obj interface{}) *errno.Errno

	// ShouldBindQuery 反序列化 querystring
	// tag: `form:"xxx"` (注：不要写成 query)
	ShouldBindQuery(obj interface{}) *errno.Errno

	// ShouldBindPostForm 反序列化 postform (querystring会被忽略)
	// tag: `form:"xxx"`
	ShouldBindPostForm(obj interface{}) *errno.Errno

	// ShouldBindForm 同时反序列化 querystring 和 postform;
	// 当 querystring 和 postform 存在相同字段时，postform 优先使用。
	// tag: `form:"xxx"`
	ShouldBindForm(obj interface{}) *errno.Errno

	// ShouldBindJSON 反序列化 postjson
	// tag: `json:"xxx"`
	ShouldBindJSON(obj interface{}) *errno.Errno

	// ShouldBindURI 反序列化 path 参数(如路由路径为 /user/:name)
	// tag: `uri:"xxx"`
	ShouldBindURI(obj interface{}) *errno.Errno

	// Redirect 重定向
	Redirect(code int, location string)

	// Trace 获取 Trace 对象
	Trace() Trace

	// Payload 正确返回
	Payload(payload interface{})

	// FilePayload 文件流返回
	FilePayload(fileName string, FileContent []byte)

	// HTML 返回界面
	HTML(name string, obj interface{})

	// XML 返回XML响应
	XML(obj interface{})

	// String 返回String响应
	String(format string, values ...interface{})

	// AbortWithError 错误返回
	AbortWithError(err *errno.Errno)

	// Header 获取 Header 对象
	Header() http.Header
	// GetHeader 获取 Header
	GetHeader(key string) string
	// SetHeader 设置 Header
	SetHeader(key, value string)

	// SetCookie 设置response cookie
	SetCookie(name, value string)
	// Cookie 获取request cookie
	Cookie(name string) (string, error)

	// IsAdmin 是否管理员
	IsAdmin() bool

	// RoleType 角色类型
	RoleType() int32

	// TenantID 租户ID
	TenantID() int64

	// UserID 获取 UserID
	UserID() int64

	// UserName 获取 UserName
	UserName() string

	// Alias 设置路由别名 for metrics uri
	Alias() string

	// RequestInputParams 获取所有参数
	RequestInputParams() url.Values
	// RequestPostFormParams  获取 PostForm 参数
	RequestPostFormParams() url.Values
	FormFile(name string) (*multipart.FileHeader, error)
	// Request 获取 Request 对象
	Request() *http.Request
	// RawData 获取 Request.Body
	RawData() []byte
	// Method 获取 Request.Method
	Method() string
	// Host 获取 Request.Host
	Host() string
	// Path 获取 请求的路径 Request.URL.Path (不附带 querystring)
	Path() string
	// URI 获取 unescape 后的 Request.URL.RequestURI()
	URI() string

	// RequestContext (包装 Trace + Logger) 获取一个用来向别的服务发起请求的 context (当client关闭后，会自动canceled).
	// 可以传一个数字进来, 作为timeout的值, 单位是秒. 注意只能传0个或一个, 不要传多了
	RequestContext(timeout ...int) *StdContext

	// ResponseWriter 获取 ResponseWriter 对象
	ResponseWriter() gin.ResponseWriter

	// GinContext 获取gin的ctx
	GinContext() *gin.Context
	// contains filtered or unexported methods
}

type HandlerFunc func(c Context)

type IMux interface {
	http.Handler
	GetEngine() *gin.Engine
	Group(relativePath string, handlers ...HandlerFunc) RouterGroup
}

type IRoutes interface {
	Any(string, ...HandlerFunc)
	GET(string, ...HandlerFunc)
	POST(string, ...HandlerFunc)
	DELETE(string, ...HandlerFunc)
	PATCH(string, ...HandlerFunc)
	PUT(string, ...HandlerFunc)
	OPTIONS(string, ...HandlerFunc)
	HEAD(string, ...HandlerFunc)
}

type Mux struct {
	Engine *gin.Engine
}

type OnPanicNotify func(ctx Context, err interface{}, stackInfo string)

type Option struct {
	DisablePProf      bool
	DisableSwagger    bool
	DisablePrometheus bool
	PanicNotify       OnPanicNotify
	RecordMetrics     RecordMetrics
	EnableCors        bool
	EnableRate        bool
}

type OptionHandler func(*Option)

type RecordMetrics func(method, uri string, success bool, httpCode, businessCode int, costSeconds float64, traceID string)

type Resource struct {
	Logger              *zap.Logger
	ProjectListen       string
	Env                 string
	HeaderLoginToken    string
	HeaderSignToken     string
	HeaderSignTokenDate string
}

type RouterGroup interface {
	Group(string, ...HandlerFunc) RouterGroup
	IRoutes
}

type SpecialContextResource struct {
	UserID   int64
	UserName string
	TenantID int64
	IsAdmin  bool
	RoleType int32
}

type StdContext struct {
	Cancel stdctx.CancelFunc
	stdctx.Context
	Trace
	*zap.Logger
}

type Trace = trace.T