Go HTTP请求处理——net/http包

Go 语言中处理 HTTP 请求主要跟两个东西相关：ServeMux 和 Handler。

一、ServeMux 和 Handler

        ServrMux 本质上是一个 HTTP 请求路由器（或者叫多路复用器，Multiplexor），它把收到的请求与一组预先定义的 URL 路径列表做对比，然后在匹配到路径的时候调用关联的处理器（Handler）。

        Handler（处理器）负责输出HTTP响应的头和正文，任何满足了http.Handler接口的对象都可作为一个处理器。通俗的说，对象只要有个如下签名的ServeHTTP方法即可：

ServeHTTP(http.ResponseWriter, *http.Request)

     Go语言的HTTP 包自带了几个函数用作常用处理器，比如FileServer，NotFoundHandler 和 RedirectHandler。我们从一个简单具体的例子开始：

//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 方法，因此它也是个合法的 Handler。

       对我来说，将 ServerMux 用作一个特殊的Handler是一种简化。它不是自己输出响应而是将请求传递给注册到它的其他 Handler。这乍一听起来不是什么明显的飞跃，但在 Go 中将 Handler 链在一起是非常普遍的用法。

二、DefaultServeMux

        DefaultServeMux 是一种ServeMux，它会随着 net/http 包初始化被自动初始化。net/http 包提供了一组快捷函数（http.Handle 和 http.HandleFunc）来配合 DefaultServeMux，这些函数将处理器注册到 DefaultServerMux。当ListenAndServe在没有提供其他的处理器的情况下（也就是第二个参数设成了 nil），内部会使用 DefaultServeMux。

        下面是一个 DefaultServeMux 例子：

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() {
  // Note that we skip creating the ServeMux...
  th := http.HandlerFunc(timeHandler)

  // 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)
}

        这个例子里使用了DefaultServeMux，而没有显示声明ServeMux。在代码中我们有一个对象（本例中就是个timerHandler函数，但是也可以是一个字符串、一个结构体或者任意的东西），我们在这个函数内实现了一个 ServeHTTP(http.ResponseWriter, *http.Request) 签名的方法，这就是我们创建一个处理器所需的全部东西。

        任何有 func(http.ResponseWriter, *http.Request) 签名的函数都能转化为一个 HandlerFunc 类型。这很有用，因为 HandlerFunc 对象内置了 ServeHTTP 方法，后者可以聪明又方便的调用我们最初提供的函数内容。

        如果你听起来还有些困惑，可以尝试看一下[相关的源代码]，你将会看到让一个函数对象满足 Handler 接口是非常简洁优雅的。

三、显式使用ServeMux

      实际上，将一个函数转换成 HandlerFunc 后注册到 ServeMux 是很普遍的用法。当显式的使用ServeMux时， Go 语言有个更加方便的ServerMux.HandlerFunc函数。

        我们使用便捷方式重写 main() 函数看起来是这样的：

func main() {
  mux := http.NewServeMux()

  mux.HandleFunc("/time", timeHandler)

  log.Println("Listening...")
  http.ListenAndServe(":3000", mux)
}

        绝大多数情况下这种用函数当处理器的方式工作的很好。但是当事情开始变得更复杂的时候，就会有些产生一些限制了。

        你可能已经注意到了，跟之前的方式不同，我们不得不将时间格式硬编码到 timeHandler 的方法中。如果我们想从 main() 函数中传递一些信息或者变量给处理器该怎么办？

        一个优雅的方式是将我们处理器放到一个闭包中，将我们要使用的变量带进去：

//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)
}

        timeHandler 函数现在有了个更巧妙的身份。除了把一个函数封装成 Handler(像我们之前做到那样)，我们现在使用它来返回一个处理器。这种机制有两个关键点：

        （1）首先是创建了一个fn，这是个匿名函数，将 format 变量封装到一个闭包里。闭包的本质让处理器在任何情况下，都可以在本地范围内访问到 format 变量。

        （2）其次我们的闭包函数满足 func(http.ResponseWriter, *http.Request) 签名。如果你记得之前我们说的，这意味我们可以将它转换成一个HandlerFunc类型（满足了http.Handler接口）。我们的timeHandler 函数随后转换后的 HandlerFunc 返回。

        在上面的例子中我们已经可以传递一个简单的字符串给处理器。但是在实际的应用中可以使用这种方法传递数据库连接、模板组，或者其他应用级的上下文。使用全局变量也是个不错的选择，还能得到额外的好处就是编写更优雅的自包含的处理器以便测试。

        你也可能见过相同的写法，像这样：

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))
  })
}

        或者在返回时，使用一个到 HandlerFunc 类型的隐式转换：

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))
  }
}

四、自定义Handler

        让我们创建一个自定义的处理器，功能是将以特定格式输出当前的本地时间：

//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 方法处理。

        访问一下这个地址看一下效果：http://localhost:3000/time

        注意我们可以在多个路由中轻松的复用 timeHandler：

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)
}

 

---