Go 语言的 http 包工作模式
SunLazar
8年前
<h2><strong>一切的基础：ServeMux 和 Handler</strong></h2> <p>Go 语言中处理 HTTP 请求主要跟两个东西相关： ServeMux 和 Handler 。</p> <p><a href="/misc/goto?guid=4959714382910705509" rel="nofollow,noindex">ServrMux </a> 本质上是一个 HTTP 请求路由器（或者叫多路复用器，Multiplexor）。它把收到的请求与一组预先定义的 URL 路径列表做对比，然后在匹配到路径的时候调用关联的处理器（Handler）。</p> <p>处理器（Handler）负责输出HTTP响应的头和正文。任何满足了 <a href="/misc/goto?guid=4959619040247649716" rel="nofollow,noindex"> http.Handler 接口 </a> 的对象都可作为一个处理器。通俗的说，对象只要有个如下签名的 ServeHTTP 方法即可：</p> <pre> <code class="language-go">ServeHTTP(http.ResponseWriter, *http.Request)</code></pre> <p>Go 语言的 HTTP 包自带了几个函数用作常用处理器，比如 <a href="/misc/goto?guid=4959714383035399417" rel="nofollow,noindex"> FileServer </a> ， <a href="/misc/goto?guid=4959714383119716271" rel="nofollow,noindex"> NotFoundHandler </a> 和 <a href="/misc/goto?guid=4959714383206821600" rel="nofollow,noindex"> RedirectHandler </a> 。我们从一个简单具体的例子开始：</p> <pre> <code class="language-go">$ mkdir handler-example $ cd handler-example $ touch main.go</code></pre> <pre> <code class="language-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) }</code></pre> <p>快速地过一下代码：</p> <ul> <li> <p>在 main 函数中我们只用了 <a href="/misc/goto?guid=4959714383283582583" rel="nofollow,noindex"> http.NewServeMux </a> 函数来创建一个空的 ServeMux 。</p> </li> <li> <p>然后我们使用 <a href="/misc/goto?guid=4959714383206821600" rel="nofollow,noindex"> http.RedirectHandler </a> 函数创建了一个新的处理器，这个处理器会对收到的所有请求，都执行307重定向操作到 http://example.org 。</p> </li> <li> <p>接下来我们使用 <a href="/misc/goto?guid=4959714383381253930" rel="nofollow,noindex"> ServeMux.Handle </a> 函数将处理器注册到新创建的 ServeMux ，所以它在 URL 路径 /foo 上收到所有的请求都交给这个处理器。</p> </li> <li> <p>最后我们创建了一个新的服务器，并通过 <a href="/misc/goto?guid=4959714383463831482" rel="nofollow,noindex"> http.ListenAndServe </a> 函数监听所有进入的请求，通过传递刚才创建的 ServeMux 来为请求去匹配对应处理器。</p> </li> </ul> <p>继续，运行一下这个程序:</p> <pre> <code class="language-go">$ go run main.go Listening...</code></pre> <p>然后在浏览器中访问 http://localhost:3000/foo ，你应该能发现请求已经成功的重定向了。</p> <p>明察秋毫的你应该能注意到一些有意思的事情： ListenAndServer 的函数签名是 ListenAndServe(addr string, handler Handler) ，但是第二个参数我们传递的是个 ServeMux 。</p> <p>我们之所以能这么做，是因为 ServeMux 也有 ServeHTTP 方法，因此它也是个合法的处理器。</p> <p>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.</p> <p>对我来说，将 ServerMux 作为一个特殊的处理器是一种简化。我们不用在第二个 handler上传递请求对象类来提供响应。这乍一听起来不是什么明显的飞跃 - 在 Go 中将 Handler 链在一起是非常普遍的。</p> <h2><strong>自定义处理器（Custom Handlers）</strong></h2> <p>让我们创建一个自定义的处理器，功能是将以特定格式输出当前的本地时间：</p> <pre> <code class="language-go">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)) }</code></pre> <p>这个例子里代码本身并不是重点。</p> <p>真正的重点是我们有一个对象（本例中就是个 timerHandler 结构体，但是也可以是一个字符串、一个函数或者任意的东西），我们在这个对象上实现了一个 ServeHTTP(http.ResponseWriter, *http.Request) 签名的方法，这就是我们创建一个处理器所需的全部东西。</p> <p>我们把这个集成到具体的示例里：</p> <pre> <code class="language-go">//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) }</code></pre> <p>main 函数中，我们像初始化一个常规的结构体一样，初始化了 timeHandler ，用 & 符号获得了其地址。随后，像之前的例子一样，我们使用 mux.Handle 函数来将其注册到 ServerMux 。</p> <p>现在当我们运行这个应用， ServerMux 将会将任何对 /time 的请求直接交给 timeHandler.ServeHTTP 方法处理。</p> <p>访问一下这个地址看一下效果： <a href="/misc/goto?guid=4959714383544058981" rel="nofollow,noindex">http://localhost:3000/time</a> 。</p> <p>注意我们可以在多个路由中轻松的复用 timeHandler ：</p> <pre> <code class="language-go">func main() { mux := http.NewServeMux() th1123 := &timeHandler{format: time.RFC1123} mux.Handle("/time/rfc1123", th1123) th3339 := &timeHandler{format: time.RFC3339} mux.Handle("/time/rfc3339", th3339) log.Println("Listening...") http.ListenAndServe(":3000", mux) }</code></pre> <h2><strong>将函数作为处理器</strong></h2> <p>对于简单的情况（比如上面的例子），定义个新的有 ServerHTTP 方法的自定义类型有些累赘。我们看一下另外一种方式，我们借助 <a href="/misc/goto?guid=4959714383644054588" rel="nofollow,noindex"> http.HandleerFunc </a> 类型来强制一个常规函数满足成为 Handler 接口的条件。</p> <p>任何有 func(http.ResponseWriter, *http.Request) 签名的函数都能转化为一个 HandlerFunc 类型。这很有用，因为 HandlerFunc 对象内置了 ServeHTTP 方法，后者可以聪明又方便的调用我们最初提供的函数内容。</p> <p>如果你听起来还有些困惑，可以尝试看一下[相关的源代码] <a href="/misc/goto?guid=4959714383715163071" rel="nofollow,noindex">http://golang.org/src/pkg/net...</a> 。你将会看到让一个函数对象满足 Handler 接口是非常简洁优雅的。</p> <p>让我们使用这个技术重新实现一遍 timeHandler 应用：</p> <pre> <code class="language-go">//File: main.go package main import ( "log" "net/http" "time" ) func timeHandler(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(time.RFC1123) w.Write([]byte("The time is: " + tm)) } func main() { mux := http.NewServeMux() // Convert the timeHandler function to a HandlerFunc type th := http.HandlerFunc(timeHandler) // And add it to the ServeMux mux.Handle("/time", th) log.Println("Listening...") http.ListenAndServe(":3000", mux) }</code></pre> <p>实际上，将一个函数转换成 HandlerFunc 后注册到 ServeMux 是很普遍的用法，所以 Go 语言为此提供了个便捷方式： <a href="/misc/goto?guid=4959714383801339923" rel="nofollow,noindex"> ServerMux.HandlerFunc </a> 方法。</p> <p>我们使用便捷方式重写 main() 函数看起来是这样的：</p> <pre> <code class="language-go">func main() { mux := http.NewServeMux() mux.HandleFunc("/time", timeHandler) log.Println("Listening...") http.ListenAndServe(":3000", mux) }</code></pre> <p>绝大多数情况下这种用函数当处理器的方式工作的很好。但是当事情开始变得更复杂的时候，就会有些产生一些限制了。</p> <p>你可能已经注意到了，跟之前的方式不同，我们不得不将时间格式硬编码到 timeHandler 的方法中。如果我们想从 main() 函数中传递一些信息或者变量给处理器该怎么办？</p> <p>一个优雅的方式是将我们处理器放到一个闭包中，将我们要使用的变量带进去：</p> <pre> <code class="language-go">//File: main.go package main import ( "log" "net/http" "time" ) func timeHandler(format string) http.Handler { fn := func(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(format) w.Write([]byte("The time is: " + tm)) } return http.HandlerFunc(fn) } func main() { mux := http.NewServeMux() th := timeHandler(time.RFC1123) mux.Handle("/time", th) log.Println("Listening...") http.ListenAndServe(":3000", mux) }</code></pre> <p>timeHandler 函数现在有了个更巧妙的身份。除了把一个函数封装成 Handler(像我们之前做到那样)，我们现在使用它来返回一个处理器。这种机制有两个关键点：</p> <p>首先是创建了一个 fn ，这是个匿名函数，将 format 变量封装到一个闭包里。闭包的本质让处理器在任何情况下，都可以在本地范围内访问到 format 变量。</p> <p>其次我们的闭包函数满足 func(http.ResponseWriter, *http.Request) 签名。如果你记得之前我们说的，这意味我们可以将它转换成一个 HandlerFunc 类型（满足了 http.Handler 接口）。我们的 timeHandler 函数随后转换后的 HandlerFunc 返回。</p> <p>在上面的例子中我们已经可以传递一个简单的字符串给处理器。但是在实际的应用中可以使用这种方法传递数据库连接、模板组，或者其他应用级的上下文。使用全局变量也是个不错的选择，还能得到额外的好处就是编写更优雅的自包含的处理器以便测试。</p> <p>你也可能见过相同的写法，像这样：</p> <pre> <code class="language-go">func timeHandler(format string) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(format) w.Write([]byte("The time is: " + tm)) }) }</code></pre> <p>或者在返回时，使用一个到 HandlerFunc 类型的隐式转换：</p> <pre> <code class="language-go">func timeHandler(format string) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(format) w.Write([]byte("The time is: " + tm)) } }</code></pre> <h2><strong>更便利的 DefaultServeMux</strong></h2> <p>你可能已经在很多地方看到过 DefaultServeMux , 从最简单的 Hello World 例子，到 go 语言的源代码中。</p> <p>It took me a long time to realise it isn't anything special. The DefaultServeMux is just a plain ol' ServeMux like we've already been using, which gets instantiated by default when the HTTP package is used. Here's the relevant line from the Go source:</p> <p>我花了很长时间才意识到 DefaultServerMux 并没有什么的特殊的地方。 DefaultServerMux 就是我们之前用到的 ServerMux ，只是它随着 net/httpp 包初始化的时候被自动初始化了而已。Go 源代码中的相关行如下：</p> <pre> <code class="language-go">var DefaultServeMux = NewServeMux()</code></pre> <p>net/http 包提供了一组快捷方式来配合 DefaultServeMux ： <a href="/misc/goto?guid=4959714383879350964" rel="nofollow,noindex"> http.Handle </a> 和 <a href="/misc/goto?guid=4959714383964103410" rel="nofollow,noindex"> http.HandleFunc </a> 。这些函数与我们之前看过的类似的名称的函数功能一样，唯一的不同是他们将处理器注册到 DefaultServerMux ，而之前我们是注册到自己创建的 ServeMux 。</p> <p>此外， ListenAndServe 在没有提供其他的处理器的情况下（也就是第二个参数设成了 nil ），内部会使用 DefaultServeMux 。</p> <p>因此，作为最后一个步骤，我们使用 DefaultServeMux 来改写我们的 timeHandler 应用：</p> <pre> <code class="language-go">//File: main.go package main import ( "log" "net/http" "time" ) func timeHandler(format string) http.Handler { fn := func(w http.ResponseWriter, r *http.Request) { tm := time.Now().Format(format) w.Write([]byte("The time is: " + tm)) } return http.HandlerFunc(fn) } func main() { // Note that we skip creating the ServeMux... var format string = time.RFC1123 th := timeHandler(format) // We use http.Handle instead of mux.Handle... http.Handle("/time", th) log.Println("Listening...") // And pass nil as the handler to ListenAndServe. http.ListenAndServe(":3000", nil) }</code></pre> <p> </p> <p>来自：https://segmentfault.com/a/1190000006812688</p> <p> </p>