ginmiddleware

Documentation

Overview

Package ginmiddleware 基于gin的web框架封装

Index

• func BasicAuth(accountpairs ...string) gin.HandlerFunc
• func Blacklist(excludePath ...string) gin.HandlerFunc
• func CFConnectingIP() gin.HandlerFunc
• func CheckRequired(params ...string) gin.HandlerFunc
• func CheckSecurityCode(codeType string, codeRange int) gin.HandlerFunc
• func Clearlog(c *gin.Context)
• func Delay() gin.HandlerFunc
• func GetSocketTimeout() time.Duration
• func HideParams(params ...string) gin.HandlerFunc
• func ListenAndServe(port int, h *gin.Engine) error
• func ListenAndServeTLS(port int, h *gin.Engine, certfile, keyfile string, clientca ...string) error
• func ListenAndServeWithOption(opt *ServiceOption)
• func LiteEngine(logfile string, logDays int, hosts ...string) *gin.Engine
• func LogToWriter(w io.Writer, skippath ...string) gin.HandlerFunc
• func LoggerWithRolling(logdir, filename string, maxdays int, skippath ...string) gin.HandlerFunc
• func Page403(c *gin.Context)
• func Page404(c *gin.Context)
• func Page404Big(c *gin.Context)
• func Page404Rand(c *gin.Context)
• func Page405(c *gin.Context)
• func PageAbort(c *gin.Context)
• func PageDefault(c *gin.Context)
• func PageDev(c *gin.Context)
• func PageEmpty(c *gin.Context)
• func RateLimit(r, b int) gin.HandlerFunc
• func ReadCacheJSON(mydb db.SQLInterface) gin.HandlerFunc
• func ReadCachePB2(mydb db.SQLInterface) gin.HandlerFunc
• func ReadParams() gin.HandlerFunc
• func Recovery() gin.HandlerFunc
• func TLSRedirect() gin.HandlerFunc
• func XForwardedIP() gin.HandlerFunc
• type ServiceOption

Functions

func BasicAuth

func BasicAuth(accountpairs ...string) gin.HandlerFunc

BasicAuth 返回basicauth信息

使用`username:password`格式提交

func Blacklist

func Blacklist(excludePath ...string) gin.HandlerFunc

Blacklist IP黑名单

func CFConnectingIP

func CFConnectingIP() gin.HandlerFunc

CFConnectingIP get cf ip

func CheckRequired

func CheckRequired(params ...string) gin.HandlerFunc

CheckRequired 检查必填参数

func CheckSecurityCode

func CheckSecurityCode(codeType string, codeRange int) gin.HandlerFunc

CheckSecurityCode 校验安全码 codeType: 安全码更新周期，h: 每小时更新，m: 每分钟更新 codeRange: 安全码容错范围（分钟）

func Clearlog

func Clearlog(c *gin.Context)

Clearlog 日志清理

func Delay

func Delay() gin.HandlerFunc

Delay 性能延迟

func GetSocketTimeout

func GetSocketTimeout() time.Duration

GetSocketTimeout 获取超时时间

func HideParams

func HideParams(params ...string) gin.HandlerFunc

HideParams 隐藏敏感参数值

func ListenAndServe

func ListenAndServe(port int, h *gin.Engine) error

ListenAndServe 启用监听 port：端口号 h： http.hander, like gin.New()

func ListenAndServeTLS

func ListenAndServeTLS(port int, h *gin.Engine, certfile, keyfile string, clientca ...string) error

ListenAndServeTLS 启用TLS监听 port：端口号 h： http.hander, like gin.New() certfile： cert file path keyfile： key file path clientca: 客户端根证书用于验证客户端合法性

func ListenAndServeWithOption

func ListenAndServeWithOption(opt *ServiceOption)

ListenAndServeWithOption 启动服务

func LiteEngine

func LiteEngine(logfile string, logDays int, hosts ...string) *gin.Engine

LiteEngine 轻量化基础引擎

func LogToWriter

func LogToWriter(w io.Writer, skippath ...string) gin.HandlerFunc

LogToWriter LogToWriter

func LoggerWithRolling

func LoggerWithRolling(logdir, filename string, maxdays int, skippath ...string) gin.HandlerFunc

LoggerWithRolling 滚动日志 logdir: 日志存放目录。 filename：日志文件名。 maxdays：日志文件最大保存天数。

func Page403

func Page403(c *gin.Context)

Page403 Page403

func Page404

func Page404(c *gin.Context)

Page404 Page404

func Page404Big

func Page404Big(c *gin.Context)

Page404Big Page404

func Page404Rand

func Page404Rand(c *gin.Context)

func Page405

func Page405(c *gin.Context)

Page405 Page405

func PageAbort

func PageAbort(c *gin.Context)

PageAbort PPageEmptyage403

func PageDefault

func PageDefault(c *gin.Context)

PageDefault 健康检查

func PageDev

func PageDev(c *gin.Context)

PageDev PageDev

func PageEmpty

func PageEmpty(c *gin.Context)

PageEmpty PPageEmptyage403

func RateLimit

func RateLimit(r, b int) gin.HandlerFunc

RateLimit 限流器，基于uber-go

r: 每秒可访问次数,1-100
b: 缓冲区大小

func ReadCacheJSON

func ReadCacheJSON(mydb db.SQLInterface) gin.HandlerFunc

ReadCacheJSON 读取数据库缓存

func ReadCachePB2

func ReadCachePB2(mydb db.SQLInterface) gin.HandlerFunc

ReadCachePB2 读取数据库缓存

func ReadParams

func ReadParams() gin.HandlerFunc

ReadParams 读取请求的参数，保存到c.Params

func Recovery

func Recovery() gin.HandlerFunc

Recovery 错误恢复

func TLSRedirect

func TLSRedirect() gin.HandlerFunc

TLSRedirect tls重定向

func XForwardedIP

func XForwardedIP() gin.HandlerFunc

XForwardedIP 替换realip

Types

type ServiceOption

type ServiceOption struct {
	EngineFunc   func() *gin.Engine
	Engine       *gin.Engine
	Hosts        []string
	CertFile     string
	KeyFile      string
	LogFile      string
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
	IdleTimeout  time.Duration
	HTTPPort     string
	HTTPSPort    string
	LogDays      int
	Debug        bool
}

ServiceOption 通用化http框架