gin

README

gin

gin logger extension

快速使用

日志扩展使用

import (
	"errors"
	"net/http"

	"github.com/gin-gonic/gin"
	ginEx "github.com/illidaris/gin"
	"github.com/illidaris/logger"
)

func main() {
    // init log core
    logger.OnlyConsole()
    // init gin
    router := gin.New()
    router.Use(ginEx.LoggerHandler())
    router.Use(ginEx.RecoverHandler())
    router.GET("/test", func(c *gin.Context) {
    c.String(http.StatusOK, "success")
    })
    router.GET("/error", func(c *gin.Context) {
    panic(errors.New("this is an error"))
    })
    ginEx.GracefulRun(context.Background(),router,":8080",time.Second*5)
}

Documentation

Index

• func BaseGracefulRunWithAop(ctx context.Context, srv *http.Server, addr string, timeout time.Duration, ...)
• func CORSMiddleware() gin.HandlerFunc
• func GracefulRun(ctx context.Context, e http.Handler, addr string, timeout time.Duration)
• func GracefulRunWithAop(ctx context.Context, e http.Handler, addr string, timeout time.Duration, ...)
• func LoggerHandler() gin.HandlerFunc
• func ParamMiddleware(opts ...ParamMiddlewareOption) gin.HandlerFunc
• func RecoverHandler() gin.HandlerFunc
• func WithTrace(c *gin.Context, birth time.Time) *gin.Context
• type HTTPMetaData
• type ParamMiddlewareOption
  • func WithRequestContentLengthMax(max uint64) ParamMiddlewareOption
  • func WithResponseContentLengthMax(max uint64) ParamMiddlewareOption

Examples

• LoggerHandler
• RecoverHandler

Functions

func BaseGracefulRunWithAop

func BaseGracefulRunWithAop(ctx context.Context, srv *http.Server, addr string, timeout time.Duration, before func(port int), after func())

func CORSMiddleware

func CORSMiddleware() gin.HandlerFunc

CORSMiddleware 防跨域

func GracefulRun

func GracefulRun(ctx context.Context, e http.Handler, addr string, timeout time.Duration)

func GracefulRunWithAop

func GracefulRunWithAop(ctx context.Context, e http.Handler, addr string, timeout time.Duration, before func(port int), after func())

func LoggerHandler

func LoggerHandler() gin.HandlerFunc

LoggerHandler record log

Example

router.Use(LoggerHandler())

func ParamMiddleware

func ParamMiddleware(opts ...ParamMiddlewareOption) gin.HandlerFunc

ParamMiddleware 出参入参记录中间件

func RecoverHandler

func RecoverHandler() gin.HandlerFunc

RecoverHandler recover from panic

Example

router.Use(RecoverHandler())

func WithTrace

func WithTrace(c *gin.Context, birth time.Time) *gin.Context

WithTrace add trace log context

Types

type HTTPMetaData

type HTTPMetaData core.MetaData

const (
	HTTPStatusCode  HTTPMetaData = "statusCode"
	HTTPContentType HTTPMetaData = "contentType"
	HTTPMethod      HTTPMetaData = "httpMethod"
	HTTPPath        HTTPMetaData = "httpPath"
	HTTPQuery       HTTPMetaData = "httpQuery"
	HTTPClientIP    HTTPMetaData = "httpClientIp"
	HTTPUserAgent   HTTPMetaData = "httpUserAgent"
)

type ParamMiddlewareOption

type ParamMiddlewareOption func(opt *paramMiddlewareOptions)

func WithRequestContentLengthMax

func WithRequestContentLengthMax(max uint64) ParamMiddlewareOption

func WithResponseContentLengthMax

func WithResponseContentLengthMax(max uint64) ParamMiddlewareOption