middleware

README

middleware

web中间件

Documentation

Index

• Constants
• Variables
• func EchoAsync() echo.MiddlewareFunc
• func EchoAuth() echo.MiddlewareFunc
• func EchoAuthWithConfig(authConfig *AuthConfig) echo.MiddlewareFunc
• func EchoCache(cacheMaxEntryNum ...int) echo.MiddlewareFunc
• func EchoLogger() echo.MiddlewareFunc
• func EchoLoggerWitchConfig(loggerConfig *LoggerConfig) echo.MiddlewareFunc
• type AuthConfig
  • func NewAuthConfig(signature func(url.Values, string) string, secretKey string) *AuthConfig
• type CacheKeyAlgorithm
• type CacheKeyFunc
  • func (self CacheKeyFunc) GenCacheKey(ctx echo.Context) string
• type LoggerConfig
• type Stats
  • func NewStats() *Stats
  • func (s *Stats) Handle(c echo.Context) error
  • func (s *Stats) Process() echo.MiddlewareFunc

Constants

const HeaderKey = "X-Request-Id"

Variables

var CacheKeyAlgorithmMap = make(map[string]CacheKeyAlgorithm)

var DefaultAuthConfig = &AuthConfig{}

var DefaultLoggerConfig = &LoggerConfig{}

var LruCache = nosql.DefaultLRUCache

Functions

func EchoAsync

func EchoAsync() echo.MiddlewareFunc

EchoAsync 用于 echo 框架的异步处理中间件

func EchoAuth

func EchoAuth() echo.MiddlewareFunc

func EchoAuthWithConfig

func EchoAuthWithConfig(authConfig *AuthConfig) echo.MiddlewareFunc

EchoAuth 用于 echo 框架的签名校验中间件

func EchoCache

func EchoCache(cacheMaxEntryNum ...int) echo.MiddlewareFunc

EchoCache 用于 echo 框架的缓存中间件。支持自定义 cache 数量

func EchoLogger

func EchoLogger() echo.MiddlewareFunc

func EchoLoggerWitchConfig

func EchoLoggerWitchConfig(loggerConfig *LoggerConfig) echo.MiddlewareFunc

EchoLoggerWitchConfig 用于 echo 框架的日志中间件

Types

type AuthConfig

type AuthConfig struct {
	// contains filtered or unexported fields
}

func NewAuthConfig

func NewAuthConfig(signature func(url.Values, string) string, secretKey string) *AuthConfig

type CacheKeyAlgorithm

type CacheKeyAlgorithm interface {
	GenCacheKey(echo.Context) string
}

type CacheKeyFunc

type CacheKeyFunc func(echo.Context) string

func (CacheKeyFunc) GenCacheKey

func (self CacheKeyFunc) GenCacheKey(ctx echo.Context) string

type LoggerConfig

type LoggerConfig struct {
	// 是否输出 POST 参数，默认不输出
	OutputPost bool
	// 当 OutputPost 为 true 时，排除这些 path，避免包含敏感信息输出
	Excludes map[string]struct{}
}

type Stats

type Stats struct {
	Uptime       time.Time      `json:"uptime"`
	RequestCount uint64         `json:"request_count"`
	Statuses     map[string]int `json:"statuses"`
	// contains filtered or unexported fields
}

func NewStats

func NewStats() *Stats

func (*Stats) Handle

func (s *Stats) Handle(c echo.Context) error

Handle is the endpoint to get stats.

func (*Stats) Process

func (s *Stats) Process() echo.MiddlewareFunc