xgin

Documentation

Index

• Constants
• func AccessLogMiddleware(opt *AccessLogMwOption) gin.HandlerFunc
• func OutermostRecover() gin.HandlerFunc
• func SemicolonMiddleware() gin.HandlerFunc
• func ServerRecover() gin.HandlerFunc
• func StatusText(code int) string
• type AccessLogMwOption
  • func NewDefaultAccessLogOptions() *AccessLogMwOption
• type Method
• type MiddlewaresOption
• type Option
  • func DefaultOption() *Option
  • func (option *Option) Address() string
• type Server
  • func Default() *Server
  • func New(option *Option, logger xlog.Logger, metrics metrics.Provider, ...) *Server
  • func (s *Server) AddRoute(method Method, path string, handlers ...gin.HandlerFunc) *Server
  • func (s *Server) AddRouteWithMethods(methods []Method, path string, handlers ...gin.HandlerFunc) *Server
  • func (server *Server) Initialize() error
  • func (server *Server) Serve() error
  • func (server *Server) Shutdown() error
• type TLSOption

Constants

const (
	StatusContinue           = 100 // RFC 7231, 6.2.1
	StatusSwitchingProtocols = 101 // RFC 7231, 6.2.2
	StatusProcessing         = 102 // RFC 2518, 10.1
	StatusEarlyHints         = 103 // RFC 8297

	StatusOK                   = 200 // RFC 7231, 6.3.1
	StatusCreated              = 201 // RFC 7231, 6.3.2
	StatusAccepted             = 202 // RFC 7231, 6.3.3
	StatusNonAuthoritativeInfo = 203 // RFC 7231, 6.3.4
	StatusNoContent            = 204 // RFC 7231, 6.3.5
	StatusResetContent         = 205 // RFC 7231, 6.3.6
	StatusPartialContent       = 206 // RFC 7233, 4.1
	StatusMultiStatus          = 207 // RFC 4918, 11.1
	StatusAlreadyReported      = 208 // RFC 5842, 7.1
	StatusIMUsed               = 226 // RFC 3229, 10.4.1

	StatusMultipleChoices  = 300 // RFC 7231, 6.4.1
	StatusMovedPermanently = 301 // RFC 7231, 6.4.2
	StatusFound            = 302 // RFC 7231, 6.4.3
	StatusSeeOther         = 303 // RFC 7231, 6.4.4
	StatusNotModified      = 304 // RFC 7232, 4.1
	StatusUseProxy         = 305 // RFC 7231, 6.4.5

	StatusTemporaryRedirect = 307 // RFC 7231, 6.4.7
	StatusPermanentRedirect = 308 // RFC 7538, 3

	StatusBadRequest                   = 400 // RFC 7231, 6.5.1
	StatusUnauthorized                 = 401 // RFC 7235, 3.1
	StatusPaymentRequired              = 402 // RFC 7231, 6.5.2
	StatusForbidden                    = 403 // RFC 7231, 6.5.3
	StatusNotFound                     = 404 // RFC 7231, 6.5.4
	StatusMethodNotAllowed             = 405 // RFC 7231, 6.5.5
	StatusNotAcceptable                = 406 // RFC 7231, 6.5.6
	StatusProxyAuthRequired            = 407 // RFC 7235, 3.2
	StatusRequestTimeout               = 408 // RFC 7231, 6.5.7
	StatusConflict                     = 409 // RFC 7231, 6.5.8
	StatusGone                         = 410 // RFC 7231, 6.5.9
	StatusLengthRequired               = 411 // RFC 7231, 6.5.10
	StatusPreconditionFailed           = 412 // RFC 7232, 4.2
	StatusRequestEntityTooLarge        = 413 // RFC 7231, 6.5.11
	StatusRequestURITooLong            = 414 // RFC 7231, 6.5.12
	StatusUnsupportedMediaType         = 415 // RFC 7231, 6.5.13
	StatusRequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4
	StatusExpectationFailed            = 417 // RFC 7231, 6.5.14
	StatusTeapot                       = 418 // RFC 7168, 2.3.3
	StatusMisdirectedRequest           = 421 // RFC 7540, 9.1.2
	StatusUnprocessableEntity          = 422 // RFC 4918, 11.2
	StatusLocked                       = 423 // RFC 4918, 11.3
	StatusFailedDependency             = 424 // RFC 4918, 11.4
	StatusTooEarly                     = 425 // RFC 8470, 5.2.
	StatusUpgradeRequired              = 426 // RFC 7231, 6.5.15
	StatusPreconditionRequired         = 428 // RFC 6585, 3
	StatusTooManyRequests              = 429 // RFC 6585, 4
	StatusRequestHeaderFieldsTooLarge  = 431 // RFC 6585, 5
	StatusUnavailableForLegalReasons   = 451 // RFC 7725, 3

	StatusInternalServerError           = 500 // RFC 7231, 6.6.1
	StatusNotImplemented                = 501 // RFC 7231, 6.6.2
	StatusBadGateway                    = 502 // RFC 7231, 6.6.3
	StatusServiceUnavailable            = 503 // RFC 7231, 6.6.4
	StatusGatewayTimeout                = 504 // RFC 7231, 6.6.5
	StatusHTTPVersionNotSupported       = 505 // RFC 7231, 6.6.6
	StatusVariantAlsoNegotiates         = 506 // RFC 2295, 8.1
	StatusInsufficientStorage           = 507 // RFC 4918, 11.5
	StatusLoopDetected                  = 508 // RFC 5842, 7.2
	StatusNotExtended                   = 510 // RFC 2774, 7
	StatusNetworkAuthenticationRequired = 511 // RFC 6585, 6
)

HTTP status codes as registered with IANA. See: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Functions

func AccessLogMiddleware

func AccessLogMiddleware(opt *AccessLogMwOption) gin.HandlerFunc

func OutermostRecover

func OutermostRecover() gin.HandlerFunc

func SemicolonMiddleware

func SemicolonMiddleware() gin.HandlerFunc

func ServerRecover

func ServerRecover() gin.HandlerFunc

func StatusText

func StatusText(code int) string

StatusText returns a text for the HTTP status code. It returns the empty string if the code is unknown.

Types

type AccessLogMwOption

type AccessLogMwOption struct {
	Enabled    bool
	Pattern    string
	Path       string
	FileName   string
	NoFile     bool
	MaxAge     int  // 保留旧文件的最大天数，默认7天
	MaxBackups int  // 保留旧文件的最大个数，默认7个
	MaxSize    int  // 在进行切割之前，日志文件的最大大小（以MB为单位）默认1024
	Compress   bool // 是否压缩/归档旧文件
}

func NewDefaultAccessLogOptions

func NewDefaultAccessLogOptions() *AccessLogMwOption

type Method

type Method string

const (
	GET     Method = http.MethodGet
	HEAD    Method = http.MethodHead
	POST    Method = http.MethodPost
	PUT     Method = http.MethodPut
	PATCH   Method = http.MethodPatch
	DELETE  Method = http.MethodDelete
	CONNECT Method = http.MethodConnect
	OPTIONS Method = http.MethodOptions
	TRACE   Method = http.MethodTrace
)

type MiddlewaresOption

type MiddlewaresOption struct {
	AccessLog *AccessLogMwOption
}

type Option

type Option struct {
	Host           string
	Port           int
	Mode           string
	EnabledMetric  bool
	EnableTracer   bool
	ServiceAddress string
	MetricsPath    string
	TLS            *TLSOption

	ShutdownTimeout time.Duration
	Middlewares     *MiddlewaresOption
}

func DefaultOption

func DefaultOption() *Option

func (*Option) Address

func (option *Option) Address() string

type Server

type Server struct {
	*gin.Engine
	*http.Server

	Logger  xlog.Logger
	Metrics metrics.Provider
	Tracer  tracer.Provider
	// contains filtered or unexported fields
}

func Default

func Default() *Server

func New

func New(option *Option, logger xlog.Logger, metrics metrics.Provider, tracer tracer.Provider) *Server

func (*Server) AddRoute

func (s *Server) AddRoute(method Method, path string, handlers ...gin.HandlerFunc) *Server

func (*Server) AddRouteWithMethods

func (s *Server) AddRouteWithMethods(methods []Method, path string, handlers ...gin.HandlerFunc) *Server

func (*Server) Initialize

func (server *Server) Initialize() error

func (*Server) Serve

func (server *Server) Serve() error

func (*Server) Shutdown

func (server *Server) Shutdown() error

type TLSOption

type TLSOption struct {
	Enable bool
	Cert   string
	Key    string
}