译注: 这篇文章的内容非常基础,也非常容易理解。
原文地址,感觉是最能清晰的讲述了 net/http
包的用法的一篇,故翻译一下共享之。
Go 语言中处理 HTTP 请求主要跟两个东西相关: ServeMux
和 Handler
。
ServrMux
本质上是一个 HTTP 请求路由器(或者叫多路复用器,Multiplexor)。它把收到的请求与一组预先定义的 URL 路径列表做对比,然后在匹配到路径的时候调用关联的处理器(Handler)。
处理器(Handler)负责输出HTTP响应的头和正文。任何满足了
http.Handler
接口 的对象都可作为一个处理器。通俗的说,对象只要有个如下签名的 ServeHTTP
方法即可:
ServeHTTP(http.ResponseWriter, *http.Request)
Go 语言的 HTTP 包自带了几个函数用作常用处理器,比如
FileServer
,
NotFoundHandler
和
RedirectHandler
。我们从一个简单具体的例子开始:
$ mkdir handler-example
$ cd handler-example
$ touch main.go
//File: main.go package main import ( "log" "net/http" ) func main() { mux := http.NewServeMux() rh := http.RedirectHandler("http://example.org", 307) mux.Handle("/foo", rh) log.Println("Listening...") http.ListenAndServe(":3000", mux) }
快速地过一下代码:
-
在
main
函数中我们只用了http.NewServeMux
函数来创建一个空的ServeMux
。 -
然后我们使用
http.RedirectHandler
函数创建了一个新的处理器,这个处理器会对收到的所有请求,都执行307重定向操作到http://example.org
。 -
接下来我们使用
ServeMux.Handle
函数将处理器注册到新创建的ServeMux
,所以它在 URL 路径/foo
上收到所有的请求都交给这个处理器。 -
最后我们创建了一个新的服务器,并通过
http.ListenAndServe
函数监听所有进入的请求,通过传递刚才创建的ServeMux
来为请求去匹配对应处理器。
继续,运行一下这个程序:
$ go run main.go Listening...
然后在浏览器中访问 http://localhost:3000/foo
,你应该能发现请求已经成功的重定向了。
明察秋毫的你应该能注意到一些有意思的事情: ListenAndServer
的函数签名是 ListenAndServe(addr string, handler Handler)
,但是第二个参数我们传递的是个
ServeMux
。
我们之所以能这么做,是因为 ServeMux
也有 ServeHTTP
方法,因此它也是个合法的处理器。
For me it simplifies things to think of a ServeMux as just being a special kind of handler, which instead of providing a response itself passes the request on to a second handler. This isn't as much of a leap as it first sounds – chaining handlers together is fairly commonplace in Go.
对我来说,将 ServerMux
作为一个特殊的处理器是一种简化。我们不用在第二个 handler上传递请求对象类来提供响应。这乍一听起来不是什么明显的飞跃 - 在 Go 中将
Handler
链在一起是非常普遍的。
自定义处理器(Custom Handlers)
让我们创建一个自定义的处理器,功能是将以特定格式输出当前的本地时间:
type timeHandler struct { format string } func (th *timeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(th.format) w.Write([]byte("The time is: " + tm)) }
这个例子里代码本身并不是重点。
真正的重点是我们有一个对象(本例中就是个 timerHandler
结构体,但是也可以是一个字符串、一个函数或者任意的东西),我们在这个对象上实现了一个
ServeHTTP(http.ResponseWriter, *http.Request)
签名的方法,这就是我们创建一个处理器所需的全部东西。
我们把这个集成到具体的示例里:
//File: main.go
package main
import (
"log"
"net/http"
"time"
)
type timeHandler struct {
format string
}
func (th *timeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
tm := time.Now().Format(th.format)
w.Write([]byte("The time is: " + tm))
}
func main() {
mux := http.NewServeMux()
th := &timeHandler{format: time.RFC1123}
mux.Handle("/time", th)
log.Println("Listening...")
http.ListenAndServe(":3000", mux)
}
main
函数中,我们像初始化一个常规的结构体一样,初始化了 timeHandler
,用 &
符号获得了其地址。随后,像之前的例子一样,我们使用
mux.Handle
函数来将其注册到 ServerMux
。
现在当我们运行这个应用, ServerMux
将会将任何对 /time
的请求直接交给 timeHandler.ServeHTTP
方法处理。
注意我们可以在多个路由中轻松的复用 timeHandler
:
有疑问加站长微信联系(非本文作者)