middleware

README

middleware

middleware 是实现 http.Handler 接口的中间件，提供了大部分实用的功能。

• auth 基本的验证处理；
• compress 对内容进行压缩；
• errorhandler 处理各类状态码下的输出；
• header 输出指定的报头；
• health 接口状态的监测；
• host 匹配指定的域名；
• ratelimit x-rate-limit 的相关实现；
• recovery 对 Panic 的处理；
• version 匹配从 Accept 报头中的版本号信息；
• debugger 用于输出测试的中间件；

安装

go get github.com/issue9/middleware/v3

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package middleware 包含了一系列 http.Handler 接口的中间件

Index

• func Handler(h http.Handler, middleware ...Middleware) http.Handler
• func HandlerFunc(h func(w http.ResponseWriter, r *http.Request), middleware ...Middleware) http.Handler
• type Manager
  • func NewManager(next http.Handler) *Manager
  • func (mgr *Manager) After(m Middleware) *Manager
  • func (mgr *Manager) Before(m Middleware) *Manager
  • func (mgr *Manager) Reset() *Manager
  • func (mgr *Manager) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Middleware

Functions

func Handler

func Handler(h http.Handler, middleware ...Middleware) http.Handler

Handler 按顺序将所有的中间件应用于 h

func HandlerFunc

func HandlerFunc(h func(w http.ResponseWriter, r *http.Request), middleware ...Middleware) http.Handler

HandlerFunc 按顺序将所有的中间件应用于 h

Types

type Manager

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

Manager 中间件管理

func NewManager

func NewManager(next http.Handler) *Manager

NewManager 声明新的 Manager 实例

func (*Manager) After

func (mgr *Manager) After(m Middleware) *Manager

After 添加中间件到尾部

func (*Manager) Before

func (mgr *Manager) Before(m Middleware) *Manager

Before 添加中间件到顶部

func (*Manager) Reset

func (mgr *Manager) Reset() *Manager

Reset 清除中间件

func (*Manager) ServeHTTP

func (mgr *Manager) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Middleware

type Middleware func(http.Handler) http.Handler

Middleware 将一个 http.Handler 封装成另一个 http.Handler