一架梯子,一头程序猿,仰望星空!

golang echo中间件


在echo框架中中间件(Middleware)指的是可以拦截http请求-响应生命周期的特殊函数,在请求-响应生命周期中可以注册多个中间件,每个中间件执行不同的功能,一个中间执行完再轮到下一个中间件执行。

下图是中间件的运行流程: 

中间件的常见应用场景如下:

  • 请求限速
  • api接口签名处理
  • 权限校验
  • 统一错误处理

提示:如果你想拦截所有请求做一些事情都可以开发一个中间件函数去实现。

1.常用中间件

下面介绍echo自带的中间件

1.1. Redirect

重定向中间件支持下面几种重定向机制:

  • http强制跳转至https
    例子:
    访问http://www.tizi365.com 自动跳转到https://www.tizi365.com
e := echo.New()
e.Pre(middleware.HTTPSRedirect())
  • www跳转
    例子:
    访问http://tizi365.com 自动跳转到http://www.tizi365.com
e := echo.New()
e.Pre(middleware.WWWRedirect())
  • https www跳转
    例子:
    访问http://tizi365.com 自动跳转到https://www.tizi365.com
e := echo.New()
e.Pre(middleware.HTTPSWWWRedirect())

1.2. Recover

Recover中间件,主要用于拦截panic错误并且在控制台打印错误日志,避免echo程序直接崩溃。
使用例子:

//初始化echo实例
e := echo.New()

//注册中间件
e.Use(middleware.Recover())

提示:一般echo应用都会注册Recover中间件,避免程序崩溃退出。

1.3. Static

Static中间件主要用于处理js、css之类的静态资源, 具体用法请参考: 处理静态文件。

1.4. Logger

Logger中间件主要用于打印http请求日志。 例子:

//初始化echo实例
e := echo.New()

//注册中间件
e.Use(middleware.Logger())

开启Logger中间件后,访问http请求会打印下面日志:

{"time":"2017-01-12T08:58:07.372015644-08:00","remote_ip":"::1","host":"localhost:1323","method":"GET","uri":"/","status":200,"error":"","latency":14743,"latency_human":"14.743µs","bytes_in":0,"bytes_out":2}

1.5. Rewrite

url重定向中间,我们可以用于将一个url重定向到另外一个url。
例子:

//初始化echo实例
e := echo.New()

e.Pre(middleware.Rewrite(map[string]string{
  "/old":              "/new",   //将/old重定向至/new
  "/api/*":            "/$1",    
  "/js/*":             "/public/javascripts/$1",
  "/users/*/orders/*": "/user/$1/order/$2",
}))

"*"星代表任意字符串,$1 代表引用表达式中第一个星(*)的匹配值, $2代表第二个,以此类推。

1.6. Session

会话中间件,请参考echo session处理章节。

2.自定义中间件

下面以一个简单的统计访问量的例子介绍如何自定义中间件。

package main

import (
	"net/http"
	"github.com/labstack/echo"
)

//记录访问量
var totalRequests  = 0

//中间件函数
func Count(next echo.HandlerFunc) echo.HandlerFunc {
	return func(c echo.Context) error {
		//在这里处理拦截请求的逻辑
		//累计访问量
		totalRequests++
		
		//在响应头中输出访问量
		c.Response().Header().Add("requests", fmt.Sprintf("%d", totalRequests))

		//执行下一个中间件或者执行控制器函数, 然后返回执行结果
		return next(c)
	}
}

func main() {
	//初始化echo实例
	e := echo.New()
	//注册中间件
	e.Use(Count)
	
	e.GET("/", func(c echo.Context) error {
		return c.String(http.StatusOK, "Hello, World!")
	})
	
	e.Logger.Fatal(e.Start(":1323"))
}