【译】在GO中如何拼接HTTP处理程序

你好,今天我想分享一下,在GO语言中拼接HTTP处理器.

在使用 GO 之前, 我使用 Nodejs + ExpressJS 去编写HTTP服务器应用. 这个框架提供了很简单的方法去使用中间件和拼接很多路由节点,因此,不必指定全部路由URL来为其添加处理程序.

图1

这个想法是通过分割你的路由和处理每一个部分,拼接到处理器,每个处理程序只负责一部分. 它理解起来非常简单且非常容易使用和维护,所以首先我尝试在 GO 中做一些类似的事情.

开箱既用, GO 提供了一个很棒的 http 包, 它包含了很多不同的工具, 当然, 还有 ListenAndServe 方法, 它在给定的端口上启动一个 HTTP 服务器并且通过处理程序处理它, 所以,这个处理器是什么?

1
2
3
type Handler interface {
ServeHTTP(ResponseWriter, *Request)
}

处理器是接口,它有一个方法 - ServeHTTP 去处理传入的请求和编写响应

但是,如果我们想为每一个根路由定义一个处理程序, 例如 /api/, /home, /about 等, 要怎么做?

ServeMux - HTTP请求复用器, 可以帮助你处理这一点. 使用 ServeMux,我们可以指定处理器方法来服务任何给定的路由, 但问题是我们不能做任何嵌套的 ServeMux .

文档中的例子:

1
2
3
4
5
6
7
8
9
10
11
mux := http.NewServeMux()
mux.Handle("/api/", apiHandler{})
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
// The "/" pattern matches everything, so we need to check
// that we're at the root here.
if req.URL.Path != "/" {
http.NotFound(w, req)
return
}
fmt.Fprintf(w, "Welcome to the home page!")
})

我们可以看到, 在这个例子中为 /api/ 路由自定义了一个处理器并且定义了一个处理方法给根路由. 因此任何以 /api/* 开头的路由都将使用 apiHandler 处理器方法. 但是如果我们需要拼接一个 usersHandler 到 apiHandler, 不通过任何的头脑风暴和编码,我们无法做到这点.

为此我写了一个小库 - gosplitter, 它只提供一个公共方法 Match(url string, mux *http.ServeMux, http.Handler|http.HandlerFunc|interface{}) - 他匹配给定的路由部分 和处理器,处理方法或你给定的任何结构!

让我们来看一个例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/**
* 定义一个处理器类型
*/
type APIV1Handler struct {
mux *http.ServeMux
}

type ColorsHandler struct {
mux *http.ServeMux
}

/**
* Start - 绑定父级到子级
*/
func (a *APIV1Handler) Start() {
var colorsHandler = ColorsHandler{
mux: a.mux,
}
gosplitter.Match("/ping", a.mux, a.HandlePing())
gosplitter.Match("/colors", a.mux, colorsHandler)
colorsHandler.Start()
}
func (c *ColorsHandler) Start() {
gosplitter.Match("/black", c.mux, c.HandleBlack())
}
/**
* 简单的HTTP处理器方法
*/
func (a *APIV1Handler) HandlePing() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("pong"))
}
}

func (c *ColorsHandler) HandleBlack() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("#000000"))
}
}

func main() {
var mux = http.NewServeMux()
var apiV1 = APIV1Handler{
mux: mux,
}

/**
* 绑定api处理器到根目录
*/
gosplitter.Match("/api/v1", mux, apiV1)
/**
* 开始api的处理
*/
apiV1.Start()
}

举个例子:

1
2
3
4
5
6
7
8
9
10
/**
* 定义处理器类型
*/
type APIV1Handler struct {
mux *http.ServeMux
}

type ColorsHandler struct {
mux *http.ServeMux
}

这里我们定义了一个我们的处理器,它是一个结构体

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/**
* Start - 绑定api处理器到根目录
*/
func (a *APIV1Handler) Start() {
var colorsHandler = ColorsHandler{
mux: a.mux,
}
gosplitter.Match("/ping", a.mux, a.HandlePing())
gosplitter.Match("/colors", a.mux, colorsHandler)
colorsHandler.Start()
}
func (c *ColorsHandler) Start() {
gosplitter.Match("/black", c.mux, c.HandleBlack())
}

添加一个 Start 方法到我们的处理器程序, 去激活处理方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/**
* 简单的HTTP处理器方法
*/
func (a *APIV1Handler) HandlePing() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("pong"))
}
}



func (c *ColorsHandler) HandleBlack() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("#000000"))
}
}

添加 HandlePingHandleBlack 到我们的 APIV1Handler 他响应了 pong#000000

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
func main() {
var mux = http.NewServeMux()
var apiV1 = APIV1Handler{
mux: mux,
}

/**
* 绑定API处理器到根路由
*/
gosplitter.Match("/api/v1", mux, apiV1)
/**
* 启动API处理器
*/
apiV1.Start()
}

我们在main方法中创建了一个新的 ServeMux 然后创建了一个APIV1Handler的实例, 把他绑定到了/api/v1路由,然后启动了它

所以在所有这些简单的操作之后我们拥有了两个工作中的路由: /api/v1/ping/api/v1/colors/black会响应 pong#000000.

使用起来不是很容易么? 我认为是这样, 现在在我的项目中使用这个库来方便的进行路由分割和拼接处理器 :)

感谢阅读, 欢迎提出任何建议和批评!


via: https://medium.com/@cashalot/how-to-chain-http-handlers-in-go-33c96396b397

作者:goncharovnikita
译者:MarlonFan