mhttp

Documentation

Index

• Constants
• func WithRequest(ctx context.Context, r *Request) context.Context
• type DefaultResponse
• type GroupHandler
• type HandlerFunc
• type HandlerMeta
• type MetaHandler
• type MiddlewareFunc
  • func MiddlewareLog() MiddlewareFunc
  • func MiddlewareResponse() MiddlewareFunc
• type OpenAPIInfo
• type Request
  • func RequestFromCtx(ctx context.Context) *Request
  • func (r *Request) GetHandlerResponse() interface{}
  • func (r *Request) GetServerName() string
  • func (r *Request) Logger() *mlog.Logger
  • func (r *Request) SetHandlerResponse(response interface{})
• type RouterGroup
  • func (g *RouterGroup) Bind(objects ...interface{}) *RouterGroup
  • func (g *RouterGroup) Middleware(handlers ...gin.HandlerFunc) *RouterGroup
• type Server
  • func New() *Server
  • func (s *Server) Bind(object interface{})
  • func (s *Server) BindHandler(method, path string, handler HandlerFunc)
  • func (s *Server) GenerateOpenAPI(info OpenAPIInfo) ([]byte, error)
  • func (s *Server) GetAddress() string
  • func (s *Server) GetIdleTimeout() time.Duration
  • func (s *Server) GetMaxHeaderBytes() int
  • func (s *Server) GetReadTimeout() time.Duration
  • func (s *Server) GetServerName() string
  • func (s *Server) GetServerRoot() string
  • func (s *Server) GetWriteTimeout() time.Duration
  • func (s *Server) Group(prefix string, handlers ...interface{}) *RouterGroup
  • func (s *Server) Logger() *mlog.Logger
  • func (s *Server) Run() error
  • func (s *Server) SetAddress(addr string)
  • func (s *Server) SetMaxHeaderBytes(size int)
  • func (s *Server) SetServerName(name string)
  • func (s *Server) SetServerRoot(root string)
  • func (s *Server) SetTimeouts(read, write, idle time.Duration)
  • func (s *Server) Use(middleware ...MiddlewareFunc)
• type ServerConfig
  • func NewConfig() ServerConfig

Constants

const (
	DefaultServerName = "default"
)

Functions

func WithRequest

func WithRequest(ctx context.Context, r *Request) context.Context

WithRequest 将 Request 对象存储到上下文中

Types

type DefaultResponse

type DefaultResponse struct {
	Code    int         `json:"code"`    // 业务码
	Message string      `json:"message"` // 提示信息
	Data    interface{} `json:"data"`    // 业务数据
}

DefaultResponse 标准响应结构

type GroupHandler

type GroupHandler func(group *RouterGroup)

GroupHandler 定义路由组处理函数类型

type HandlerFunc

type HandlerFunc func(*Request)

HandlerFunc 定义基础处理函数类型

type HandlerMeta

type HandlerMeta struct {
	Path        string
	Method      string
	Summary     string
	Description string
	Request     interface{}
	Response    interface{}
	Handler     gin.HandlerFunc
	Middleware  []gin.HandlerFunc
	Tags        []string
}

HandlerMeta 处理器元数据

type MetaHandler

type MetaHandler interface {
	Meta() *HandlerMeta
	Handle(*Request) (interface{}, error)
}

MetaHandler 元数据处理器接口

type MiddlewareFunc

type MiddlewareFunc func(*Request)

MiddlewareFunc 定义中间件函数类型

func MiddlewareLog

func MiddlewareLog() MiddlewareFunc

MiddlewareLog 日志中间件

func MiddlewareResponse

func MiddlewareResponse() MiddlewareFunc

MiddlewareResponse 标准响应中间件

type OpenAPIInfo

type OpenAPIInfo struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Version     string `json:"version"`
}

OpenAPIInfo OpenAPI 基本信息

type Request

type Request struct {
	*gin.Context
	Server *Server // 服务器实例
	// contains filtered or unexported fields
}

Request 请求封装

func RequestFromCtx

func RequestFromCtx(ctx context.Context) *Request

RequestFromCtx 从上下文中获取 Request 对象

func (*Request) GetHandlerResponse

func (r *Request) GetHandlerResponse() interface{}

GetHandlerResponse 获取处理函数响应

func (*Request) GetServerName

func (r *Request) GetServerName() string

GetServerName 获取服务器名称

func (*Request) Logger

func (r *Request) Logger() *mlog.Logger

Logger 获取日志实例

func (*Request) SetHandlerResponse

func (r *Request) SetHandlerResponse(response interface{})

SetHandlerResponse 设置处理函数响应

type RouterGroup

type RouterGroup struct {
	*gin.RouterGroup
	// contains filtered or unexported fields
}

RouterGroup 路由组

func (*RouterGroup) Bind

func (g *RouterGroup) Bind(objects ...interface{}) *RouterGroup

Bind 绑定控制器到路由组

func (*RouterGroup) Middleware

func (g *RouterGroup) Middleware(handlers ...gin.HandlerFunc) *RouterGroup

Middleware 为路由组添加中间件

type Server

type Server struct {
	*gin.Engine
	// contains filtered or unexported fields
}

Server HTTP 服务结构

func New

func New() *Server

New 创建新的 HTTP 服务实例

func (*Server) Bind

func (s *Server) Bind(object interface{})

Bind 绑定对象到路由

func (*Server) BindHandler

func (s *Server) BindHandler(method, path string, handler HandlerFunc)

BindHandler 绑定简单处理函数

func (*Server) GenerateOpenAPI

func (s *Server) GenerateOpenAPI(info OpenAPIInfo) ([]byte, error)

GenerateOpenAPI 生成 OpenAPI 文档

func (*Server) GetAddress

func (s *Server) GetAddress() string

GetAddress 获取服务器监听地址

func (*Server) GetIdleTimeout

func (s *Server) GetIdleTimeout() time.Duration

GetIdleTimeout 获取空闲超时时间

func (*Server) GetMaxHeaderBytes

func (s *Server) GetMaxHeaderBytes() int

GetMaxHeaderBytes 获取最大请求头大小

func (*Server) GetReadTimeout

func (s *Server) GetReadTimeout() time.Duration

GetReadTimeout 获取读取超时时间

func (*Server) GetServerName

func (s *Server) GetServerName() string

GetServeName 获取服务名称

func (*Server) GetServerRoot

func (s *Server) GetServerRoot() string

GetServerRoot 获取服务根目录

func (*Server) GetWriteTimeout

func (s *Server) GetWriteTimeout() time.Duration

GetWriteTimeout 获取写入超时时间

func (*Server) Group

func (s *Server) Group(prefix string, handlers ...interface{}) *RouterGroup

Group 创建路由组

func (*Server) Logger

func (s *Server) Logger() *mlog.Logger

Logger 获取日志实例

func (*Server) Run

func (s *Server) Run() error

Run 启动 HTTP 服务

func (*Server) SetAddress

func (s *Server) SetAddress(addr string)

SetAddress 设置服务器监听地址

func (*Server) SetMaxHeaderBytes

func (s *Server) SetMaxHeaderBytes(size int)

SetMaxHeaderBytes 设置最大请求头大小

func (*Server) SetServerName

func (s *Server) SetServerName(name string)

SetServeName 设置服务名称

func (*Server) SetServerRoot

func (s *Server) SetServerRoot(root string)

SetServerRoot 设置服务根目录

func (*Server) SetTimeouts

func (s *Server) SetTimeouts(read, write, idle time.Duration)

SetTimeouts 设置超时配置

func (*Server) Use

func (s *Server) Use(middleware ...MiddlewareFunc)

Use 添加全局中间件

type ServerConfig

type ServerConfig struct {
	Address    string
	ServerName string
	ServerRoot string
	Logger     *mlog.Logger

	ReadTimeout    time.Duration
	WriteTimeout   time.Duration
	IdleTimeout    time.Duration
	MaxHeaderBytes int
}

ServerConfig 服务器配置

func NewConfig

func NewConfig() ServerConfig