middleware

Documentation

Index

• func CasbinHandler() gin.HandlerFunc
• func Cors() gin.HandlerFunc
• func CorsByRules() gin.HandlerFunc
• func DefaultCheckOrMark(key string, expire int, limit int) (err error)
• func DefaultGenerationKey(c *gin.Context) string
• func DefaultLimit() gin.HandlerFunc
• func DefaultLogger() gin.HandlerFunc
• func ErrorToEmail() gin.HandlerFunc
• func GinRecovery(stack bool) gin.HandlerFunc
• func JWTAuth() gin.HandlerFunc
• func LoadTls() gin.HandlerFunc
• func OperationRecord() gin.HandlerFunc
• func SetLimitWithTime(key string, limit int, expiration time.Duration) error
• type LimitConfig
  • func (l LimitConfig) LimitWithTime() gin.HandlerFunc
• type LogLayout
• type Logger
  • func (l Logger) SetLoggerMiddleware() gin.HandlerFunc

Functions

func CasbinHandler

func CasbinHandler() gin.HandlerFunc

CasbinHandler 拦截器

func Cors

func Cors() gin.HandlerFunc

Cors 直接放行所有跨域请求并放行所有 OPTIONS 方法

func CorsByRules

func CorsByRules() gin.HandlerFunc

CorsByRules 按照配置处理跨域请求

func DefaultCheckOrMark

func DefaultCheckOrMark(key string, expire int, limit int) (err error)

func DefaultGenerationKey

func DefaultGenerationKey(c *gin.Context) string

DefaultGenerationKey 默认生成key

func DefaultLimit

func DefaultLimit() gin.HandlerFunc

func DefaultLogger

func DefaultLogger() gin.HandlerFunc

func ErrorToEmail

func ErrorToEmail() gin.HandlerFunc

func GinRecovery

func GinRecovery(stack bool) gin.HandlerFunc

GinRecovery recover掉项目可能出现的panic，并使用zap记录相关日志

func JWTAuth

func JWTAuth() gin.HandlerFunc

func LoadTls

func LoadTls() gin.HandlerFunc

func OperationRecord

func OperationRecord() gin.HandlerFunc

func SetLimitWithTime

func SetLimitWithTime(key string, limit int, expiration time.Duration) error

SetLimitWithTime 设置访问次数

Types

type LimitConfig

type LimitConfig struct {
	// GenerationKey 根据业务生成key 下面CheckOrMark查询生成
	GenerationKey func(c *gin.Context) string
	// 检查函数,用户可修改具体逻辑,更加灵活
	CheckOrMark func(key string, expire int, limit int) error
	// Expire key 过期时间
	Expire int
	// Limit 周期时间
	Limit int
}

func (LimitConfig) LimitWithTime

func (l LimitConfig) LimitWithTime() gin.HandlerFunc

type LogLayout

type LogLayout struct {
	Time      time.Time
	Metadata  map[string]interface{} // 存储自定义原数据
	Path      string                 // 访问路径
	Query     string                 // 携带query
	Body      string                 // 携带body数据
	IP        string                 // ip地址
	UserAgent string                 // 代理
	Error     string                 // 错误
	Cost      time.Duration          // 花费时间
	Source    string                 // 来源
}

LogLayout 日志layout

type Logger

type Logger struct {
	// Filter 用户自定义过滤
	Filter func(c *gin.Context) bool
	// FilterKeyword 关键字过滤(key)
	FilterKeyword func(layout *LogLayout) bool
	// AuthProcess 鉴权处理
	AuthProcess func(c *gin.Context, layout *LogLayout)
	// 日志处理
	Print func(LogLayout)
	// Source 服务唯一标识
	Source string
}

func (Logger) SetLoggerMiddleware

func (l Logger) SetLoggerMiddleware() gin.HandlerFunc