《Go语言四十二章经》第三十六章 net/http包

作者:李骁

在Go中,搭建一个http server简单到令人难以置信。只需要引入net/http包,写几行代码,一个http服务器就可以正常运行并接受访问请求。

下面就是Go最简单的http服务器:

  1. package main
  2. import (
  3. "fmt"
  4. "net/http"
  5. )
  6. func myfunc(w http.ResponseWriter, r *http.Request) {
  7. fmt.Fprintf(w, "hi")
  8. }
  9. func main() {
  10. http.HandleFunc("/", myfunc)
  11. http.ListenAndServe(":8080", nil)
  12. }

访问 http://localhost:8080/ , 我们可以看到网页输出”hi” !

下面我们通过分析net/http的源代码,来深入理解这个包的实现原理。在net/http源代码中,我们可以深深体会到Go语言的接口设计哲学,这个包主要有4个文件,分别是:

client.go

server.go

request.go

response.go

我们知道有http Request 请求和 http Response 响应,以及client和server,我们先从这四个方面讲讲net/http包:

36.1 Request

http Request请求是由客户端发出的消息, 用来使服务器执行动作.发出的消息包括起始行, Headers, Body。

在net/http包中,request.go文件定义了结构:

  1. type Request struct
  2. 代表客户端给服务器端发送的一个请求或者是服务端收到的一个请求,但是服务器端和客户端使用Request时语义区别很大。
  3. // 利用指定的method, url以及可选的body返回一个新的请求.如果body参数实现了
  4. // io.Closer接口,Request返回值的Body 字段会被设置为body,并会被Client
  5. // 类型的Do、Post和PostForm方法以及Transport.RoundTrip方法关闭。
  6. func NewRequest(method, urlStr string, body io.Reader) (*Request, error)
  7. // 从b中读取和解析一个请求.
  8. func ReadRequest(b *bufio.Reader) (req *Request, err error)
  9. // 给request添加cookie, AddCookie向请求中添加一个cookie.按照RFC 6265
  10. // section 5.4的规则, AddCookie不会添加超过一个Cookie头字段.
  11. // 这表示所有的cookie都写在同一行, 用分号分隔(cookie内部用逗号分隔属性)
  12. func (r *Request) AddCookie(c *Cookie)
  13. // 返回request中指定名name的cookie,如果没有发现,返回ErrNoCookie
  14. func (r *Request) Cookie(name string) (*Cookie, error)
  15. // 返回该请求的所有cookies
  16. func (r *Request) Cookies() []*Cookie
  17. // 利用提供的用户名和密码给http基本权限提供具有一定权限的header。
  18. // 当使用http基本授权时,用户名和密码是不加密的
  19. func (r *Request) SetBasicAuth(username, password string)
  20. // 如果在request中发送,该函数返回客户端的user-Agent
  21. func (r *Request) UserAgent() string
  22. // 对于指定格式的key,FormFile返回符合条件的第一个文件,如果有必要的话,
  23. // 该函数会调用ParseMultipartForm和ParseForm。
  24. func (r *Request) FormFile(key string) (multipart.File, *multipart.FileHeader, error)
  25. // 返回key获取的队列中第一个值。在查询过程中post和put中的主题参数优先级
  26. // 高于url中的value。为了访问相同key的多个值,调用ParseForm然后直接
  27. // 检查RequestForm。
  28. func (r *Request) FormValue(key string) string
  29. // 如果这是一个有多部分组成的post请求,该函数将会返回一个MIME 多部分reader,
  30. // 否则的话将会返回一个nil和error。使用本函数代替ParseMultipartForm
  31. // 可以将请求body当做流stream来处理。
  32. func (r *Request) MultipartReader() (*multipart.Reader, error)
  33. // 解析URL中的查询字符串,并将解析结果更新到r.Form字段。对于POST或PUT
  34. // 请求,ParseForm还会将body当作表单解析,并将结果既更新到r.PostForm也
  35. // 更新到r.Form。解析结果中,POST或PUT请求主体要优先于URL查询字符串
  36. // (同名变量,主体的值在查询字符串的值前面)。如果请求的主体的大小没有被
  37. // MaxBytesReader函数设定限制,其大小默认限制为开头10MB。
  38. // ParseMultipartForm会自动调用ParseForm。重复调用本方法是无意义的。
  39. func (r *Request) ParseForm() error
  40. // ParseMultipartForm将请求的主体作为multipart/form-data解析。
  41. // 请求的整个主体都会被解析,得到的文件记录最多 maxMemery字节保存在内存,
  42. // 其余部分保存在硬盘的temp文件里。如果必要,ParseMultipartForm会
  43. // 自行调用 ParseForm。重复调用本方法是无意义的。
  44. func (r *Request) ParseMultipartForm(maxMemory int64) error
  45. // 返回post或者put请求body指定元素的第一个值,其中url中的参数被忽略。
  46. func (r *Request) PostFormValue(key string) string
  47. // 检测在request中使用的http协议是否至少是major.minor
  48. func (r *Request) ProtoAtLeast(majorminor int) bool
  49. // 如果request中有refer,那么refer返回相应的url。Referer在request
  50. // 中是拼错的,这个错误从http初期就已经存在了。该值也可以从Headermap中
  51. // 利用Header["Referer"]获取;在使用过程中利用Referer这个方法而
  52. // 不是map的形式的好处是在编译过程中可以检查方法的错误,而无法检查map中
  53. // key的错误。
  54. func (r *Request) Referer() string
  55. // Write方法以有线格式将HTTP/1.1请求写入w(用于将请求写入下层TCPConn等)
  56. // 。本方法会考虑请求的如下字段:Host URL Method (defaults to "GET")
  57. // Header ContentLength TransferEncoding Body如果存在Body,
  58. // ContentLength字段<= 0且TransferEncoding字段未显式设置为
  59. // ["identity"],Write方法会显式添加”Transfer-Encoding: chunked”
  60. // 到请求的头域。Body字段会在发送完请求后关闭。
  61. func (r *Request) Write(w io.Writer) error
  62. // 该函数与Write方法类似,但是该方法写的request是按照http代理的格式去写。
  63. // 尤其是,按照RFC 2616 Section 5.1.2,WriteProxy会使用绝对URI
  64. // (包括协议和主机名)来初始化请求的第1行(Request-URI行)。无论何种情况,
  65. // WriteProxy都会使用r.Host或r.URL.Host设置Host头。
  66. func (r *Request) WriteProxy(w io.Writer) error

36.2 Response

指对于一个http请求的响应response,HTTP响应包括起始行, Headers, Body。

  1. // 注意是在response.go中定义的,而在server.go有一个
  2. // type response struct ,注意大小写。这个结构是体现在server端的功能。
  3. type Response struct
  4. // ReadResponse从r读取并返回一个HTTP 回复。req参数是可选的,指定该回复
  5. // 对应的请求(即是对该请求的回复)。如果是nil,将假设请 求是GET请求。
  6. // 客户端必须在结束resp.Body的读取后关闭它。读取完毕并关闭后,客户端可以
  7. // 检查resp.Trailer字段获取回复的 trailer的键值对。
  8. func ReadResponse(r *bufio.Reader, req *Request) (*Response, error)
  9. // 解析cookie并返回在header中利用set-Cookie设定的cookie值。
  10. func (r *Response) Cookies() []*Cookie
  11. // 返回response中Location的header值的url。如果该值存在的话,则对于
  12. // 请求问题可以解决相对重定向的问题,如果该值为nil,则返回ErrNOLocation。
  13. func (r *Response) Location() (*url.URLerror)
  14. // 判定在response中使用的http协议是否至少是major.minor的形式。
  15. func (r *Response) ProtoAtLeast(major, minor int) bool
  16. // 将response中信息按照线性格式写入w中。
  17. func (r *Response) Write(w io.Writer) error

36.3 client

  1. // Client具有Do,Get,Head,Post以及PostForm等方法。 其中Do方法可以对
  2. // Request进行一系列的设定,而其他的对request设定较少。如果Client使用默认的
  3. // Client,则其中的Get,Head,Post以及PostForm方法相当于默认的http.Get,
  4. // http.Post, http.Head以及http.PostForm函数。
  5. type Client struct
  6. // 利用GET方法对一个指定的URL进行请求,如果response是如下重定向中的一个
  7. // 代码,则Get之后将会调用重定向内容,最多10次重定向。
  8. // 301 (永久重定向,告诉客户端以后应该从新地址访问)
  9. // 302 (暂时性重定向,作为HTTP1.0的标准,PHP的默认Location重定向用到
  10. // 也是302),注:303和307其实是对302的细化。
  11. // 303 (对于Post请求,它表示请求已经被处理,客户端可以接着使用GET方法去
  12. // 请求Location里的URl)
  13. // 307 (临时重定向,对于Post请求,表示请求还没有被处理,客户端应该向
  14. // Location里的URL重新发起Post请求)
  15. func Get(url string) (resp *Response, err error)
  16. // 该函数功能见net中Head方法功能。该方法与默认的defaultClient中
  17. // Head方法一致。
  18. func Head(url string) (resp *Response, err error)
  19. // 该方法与默认的defaultClient中Post方法一致。
  20. func Post(url string, bodyType string, body io.Reader) (resp *Response, err error)
  21. // 该方法与默认的defaultClient中PostForm方法一致。
  22. func PostForm(url string, data url.Values) (resp *Response, err error)
  23. // Do发送http请求并且返回一个http响应, 遵守client的策略, 如重定向,
  24. // cookies以及auth等.错误经常是由于策略引起的, 当err是nil时, resp
  25. // 总会包含一个非nil的resp.body.当调用者读完resp.body之后应该关闭它,
  26. // 如果resp.body没有关闭, 则Client底层RoundTripper将无法重用存在的
  27. // TCP连接去服务接下来的请求, 如果resp.body非nil, 则必须对其进行关闭.
  28. // 通常来说, 经常使用Get, Post, 或者PostForm来替代Do.
  29. func (c *Client) Do(req *Request) (resp *Response, err error)
  30. // 利用get方法请求指定的url.Get请求指定的页面信息,并返回实体主体。
  31. func (c *Client) Get(url string) (resp *Response, err error)
  32. // 利用head方法请求指定的url,Head只返回页面的首部。
  33. func (c *Client) Head(url string) (resp *Response, err error)
  34. // post方法请求指定的URl, 如果body也是一个io.Closer, 则在请求之后关闭它
  35. func (c *Client) Post(url string, bodyType string, body io.Reader) (resp *Response, err error)
  36. // 利用post方法请求指定的url, 利用data的key和value作为请求体.
  37. func (c *Client) PostForm(url string, data url.Values) (resp *Response, err error)

Do方法可以灵活的对request进行配置,然后进行请求。利用http.Client以及http.NewRequest可以模拟请求。下面模拟request中带有cookie的请求,通过http.Client的DO方法发送这个请求。也就是说配置http.NewRequest,我们通过http.Client的Do方法来发送任何http请求。示例如下:

  • 模拟请求:
  1. package main
  2. import (
  3. "fmt"
  4. "io/ioutil"
  5. "net/http"
  6. "strconv"
  7. )
  8. func main() {
  9. client := &http.Client{}
  10. request, err := http.NewRequest("GET", "http://www.baidu.com", nil)
  11. if err != nil {
  12. fmt.Println(err)
  13. }
  14. cookie := &http.Cookie{Name: "userId", Value: strconv.Itoa(12345)}
  15. //request中添加cookie
  16. request.AddCookie(cookie)
  17. //设置request的header
  18. request.Header.Set("Accept", "text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8")
  19. request.Header.Set("Accept-Charset", "GBK, utf-8;q=0.7, *;q=0.3")
  20. request.Header.Set("Accept-Encoding", "gzip, deflate, sdch")
  21. request.Header.Set("Accept-Language", "zh-CN, zh;q=0.8")
  22. request.Header.Set("Cache-Control", "max-age=0")
  23. request.Header.Set("Connection", "keep-alive")
  24. response, err := client.Do(request)
  25. if err != nil {
  26. fmt.Println(err)
  27. return
  28. }
  29. defer response.Body.Close()
  30. fmt.Println(response.StatusCode)
  31. if response.StatusCode == 200 {
  32. r, err := ioutil.ReadAll(response.Body)
  33. if err != nil {
  34. fmt.Println(err)
  35. }
  36. fmt.Println(string(r))
  37. }
  38. }
  • 发送一个http Get请求:
  1. package main
  2. import (
  3. "fmt"
  4. "io/ioutil"
  5. "net/http"
  6. )
  7. func main() {
  8. response, err := http.Get("http://www.baidu.com")
  9. if err != nil {
  10. }
  11. //程序在使用完回复后必须关闭回复的主体。
  12. defer response.Body.Close()
  13. body, _ := ioutil.ReadAll(response.Body)
  14. fmt.Println(string(body))
  15. }

使用http POST方法可以直接使用http.Post 或 http.PostForm

  • http.Post请求:
  1. package main
  2. import (
  3. "net/http"
  4. "strings"
  5. "fmt"
  6. "io/ioutil"
  7. )
  8. func main() {
  9. resp, err := http.Post("http://www.xxx.com/loginRegister/login.do",
  10. "application/x-www-form-urlencoded",
  11. strings.NewReader("mobile=xxxxxxxxxx&isRemberPwd=1"))
  12. if err != nil {
  13. fmt.Println(err)
  14. return
  15. }
  16. defer resp.Body.Close()
  17. body, err := ioutil.ReadAll(resp.Body)
  18. if err != nil {
  19. fmt.Println(err)
  20. return
  21. }
  22. fmt.Println(string(body))
  23. }
  • http.PostForm请求:
  1. package main
  2. import (
  3. "net/http"
  4. "fmt"
  5. "io/ioutil"
  6. "net/url"
  7. )
  8. func main() {
  9. postParam := url.Values{
  10. "mobile": {"xxxxxx"},
  11. "isRemberPwd": {"1"},
  12. }
  13. resp, err := http.PostForm("http://www.xxx.com/loginRegister/login.do", postParam)
  14. if err != nil {
  15. fmt.Println(err)
  16. return
  17. }
  18. defer resp.Body.Close()
  19. body, err := ioutil.ReadAll(resp.Body)
  20. if err != nil {
  21. fmt.Println(err)
  22. return
  23. }
  24. fmt.Println(string(body))
  25. }

上面列举了几种客户端发送http.request请求的方式:

1.http.Client与http.NewRequest模拟HTTP请求,方法可以是Get 、Post 、 PostForm

2.http.Get 方式请求

3.http.Post 方式请求

4.http.PostForm 方式请求

一共这四种HTTP请求方式,这几种方式都和http.Client封装的函数(方法)有密切关系。

最基础的还是http.NewRequest,其他三种方法是在它基础上做了封装而已:

  1. func NewRequest(method, url string, body io.Reader) (*Request, error)
  2. func (c *Client) Get(url string) (resp *Response, err error) {
  3. req, err := NewRequest("GET", url, nil)
  4. ......
  5. func (c *Client) Post(url string, contentType string, body io.Reader) (resp *Response, err error) {
  6. req, err := NewRequest("POST", url, body)
  7. ......

36.4 server

  1. type Handler interface {
  2. ServeHTTP(ResponseWriter, *Request)
  3. }
  4. type Server struct
  5. // 监听TCP网络地址srv.Addr然后调用Serve来处理接下来连接的请求。
  6. // 如果srv.Addr是空的话,则使用“:http”。
  7. func (srv *Server) ListenAndServe() error
  8. // ListenAndServeTLS监听srv.Addr确定的TCP地址,并且会调用Serve
  9. // 方法处理接收到的连接。必须提供证书文件和对应的私钥文 件。如果证书是由
  10. // 权威机构签发的,certFile参数必须是顺序串联的服务端证书和CA证书。
  11. // 如果srv.Addr为空字符串,会使 用”:https”。
  12. func (srv *Server) ListenAndServeTLS(certFile, keyFile string) error
  13. // 接受Listener l的连接,创建一个新的服务协程。该服务协程读取请求然后调用
  14. // srv.Handler来应答。实际上就是实现了对某个端口进行监听,然后创建相应的连接。
  15. func (srv *Server) Serve(l net.Listener) error
  16. // 该函数控制是否http的keep-alives能够使用,默认情况下,keep-alives总是可用的。
  17. // 只有资源非常紧张的环境或者服务端在关闭进程中时,才应该关闭该功能。
  18. func (s *Server) SetKeepAlivesEnabled(v bool)
  19. // 是一个http请求多路复用器,它将每一个请求的URL和
  20. // 一个注册模式的列表进行匹配,然后调用和URL最匹配的模式的处理器进行后续操作。
  21. type ServeMux
  22. // 初始化一个新的ServeMux
  23. func NewServeMux() *ServeMux
  24. // 将handler注册为指定的模式,如果该模式已经有了handler,则会出错panic。
  25. func (mux *ServeMux) Handle(pattern string, handler Handler)
  26. // 将handler注册为指定的模式
  27. func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request))
  28. // 根据指定的r.Method, r.Host以及r.RUL.Path返回一个用来处理给定请求的handler。
  29. // 该函数总是返回一个非nil的 handler,如果path不是一个规范格式,则handler会
  30. // 重定向到其规范path。Handler总是返回匹配该请求的的已注册模式;在内建重定向
  31. // 处理器的情况下,pattern会在重定向后进行匹配。如果没有已注册模式可以应用于该请求,
  32. // 本方法将返回一个内建的”404 page not found”处理器和一个空字符串模式。
  33. func (mux *ServeMux) Handler(r *Request) (h Handler, pattern string)
  34. // 该函数用于将最接近请求url模式的handler分配给指定的请求。
  35. func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request)

server.go中定义的接口:

  1. // A Handler responds to an HTTP request.
  2. // ...
  3. type Handler interface {
  4. ServeHTTP(ResponseWriter, *Request)
  5. }

这个接口应该算是整个net/http中关键了,如果你仔细看这个包的源代码,你很发现很多结构体实现了这个接口的ServeHTTP方法。

注意这个接口的注释:Handler响应HTTP请求。没错,最终我们的http服务是通过实现ServeHTTP(ResponseWriter, *Request)来达到服务端接收客户端请求并响应。

理解 HTTP 构建的网络应用只要关注两个端—-客户端(clinet)和服务端(server),两个端的交互来自 clinet 的 request,以及server端的response。

HTTP服务器,主要在于如何接受 clinet端 的 request,server端向client端返回response。

那这个过程是什么样的呢?有了前面request、response、client、server四个部分作为基础,我们要讲清楚这个过程,还需要回到开始的程序:

  1. func main() {
  2. http.HandleFunc("/", myfunc)
  3. http.ListenAndServe(":8080", nil)
  4. }

两行代码,成功启动了一个http服务器。我们通过net/http 包源代码分析,调用Http.HandleFunc,按顺序做了几件事:

1.Http.HandleFunc调用了DefaultServeMux的HandleFunc

  1. func HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
  2. DefaultServeMux.HandleFunc(pattern, handler)
  3. }

2.DefaultServeMux.HandleFunc调用了DefaultServeMux的Handle,DefaultServeMux是一个ServeMux 指针变量。而ServeMux 是Go中Multiplexer(多路复用器),通过Handle匹配pattern 和我们定义的handler。

  1. var DefaultServeMux = &defaultServeMux
  2. var defaultServeMux ServeMux
  3. func (mux *ServeMux) HandleFunc(pattern string, handler func(ResponseWriter, *Request)) {
  4. mux.Handle(pattern, HandlerFunc(handler))
  5. }

注意:
上面的方法命名Handle,HandleFunc和HandlerFunc,Handler(接口),他们很相似,容易混淆。记住Handle和HandleFunc和pattern 匹配有关,也即往DefaultServeMux的map[string]muxEntry中增加对应的handler和路由规则。

接着我们看看myfunc的声明和定义:

  1. func myfunc(w http.ResponseWriter, r *http.Request) {
  2. fmt.Fprintf(w, "hi")
  3. }

而type HandlerFunc func(ResponseWriter, *Request) 是一个函数类型。而我们定义的myfunc的函数签名刚好符合这个函数类型。

所以http.HandleFunc(“/“, myfunc),实际上是mux.Handle(“/“, HandlerFunc(myfunc))。

HandlerFunc(myfunc) 让myfunc成为了HandlerFunc类型,我们称myfunc为handler。而HandlerFunc类型是具有ServeHTTP方法的,有了ServeHTTP方法也就是实现了Handler接口。

现在ServeMux和Handler都和我们的myfunc联系上了,接下来和结构体server有关了。

从http.ListenAndServe的源码可以看出,它创建了一个server对象,并调用server对象的ListenAndServe方法:

  1. func ListenAndServe(addr string, handler Handler) error {
  2. server := &Server{Addr: addr, Handler: handler}
  3. return server.ListenAndServe()
  4. }

而我们HTTP服务器中第二行代码:

  1. http.ListenAndServe(":8080", nil)

创建了一个server对象,并调用server对象的ListenAndServe方法,这里没有直接传递Handler,而是默认使用DefautServeMux作为multiplexer,myfunc是存在于handler和路由规则中的。

Server的ListenAndServe方法中,会初始化监听地址Addr,同时调用Listen方法设置监听。

  1. for {
  2. rw, e := l.Accept()
  3. ...
  4. c := srv.newConn(rw)
  5. c.setState(c.rwc, StateNew)
  6. go c.serve(ctx)
  7. }

监听开启之后,一旦客户端请求过来,Go就开启一个协程go c.serve(ctx)处理请求,主要逻辑都在serve方法之中。

func (c *conn) serve(ctx context.Context),这个方法很长,里面主要的一句:serverHandler{c.server}.ServeHTTP(w, w.req)。其中w由w, err := c.readRequest(ctx)得到,因为有传递context。

还是来看源代码:

  1. type serverHandler struct {
  2. srv *Server
  3. }
  4. func (sh serverHandler) ServeHTTP(rw ResponseWriter, req Request) {
  5. handler := sh.srv.Handler
  6. if handler == nil {
  7. handler = DefaultServeMux
  8. }
  9. if req.RequestURI == "" && req.Method == "OPTIONS" {
  10. handler = globalOptionsHandler{}
  11. }
  12. handler.ServeHTTP(rw, req)
  13. }

从http.ListenAndServe(“:8080”, nil)开始,handler是nil,所以最后实际ServeHTTP方法是DefaultServeMux.ServeHTTP(rw, req)。

  1. func (mux *ServeMux) ServeHTTP(w ResponseWriter, r *Request) {
  2. if r.RequestURI == "*" {
  3. if r.ProtoAtLeast(1, 1) {
  4. w.Header().Set("Connection", "close")
  5. }
  6. w.WriteHeader(StatusBadRequest)
  7. return
  8. }
  9. h, _ := mux.Handler(r)
  10. h.ServeHTTP(w, r)
  11. }

通过func (mux ServeMux) Handler(r Request) (h Handler, pattern string),我们得到Handler h,然后执行h.ServeHTTP(w, r)方法,也就是执行我们的myfunc函数(别忘了myfunc是HandlerFunc类型,而他的ServeHTTP(w, r)方法这里其实就是自己调用自己),把response写到http.ResponseWriter对象返回给客户端,fmt.Fprintf(w, “hi”),我们在客户端会接收到hi 。至此整个HTTP服务执行完成。

总结下,HTTP服务整个过程大概是这样:

  1. Request -> ServeMux(Multiplexer) -> handler-> Response

如果需要自定义 http.Server怎么办呢:

  1. package main
  2. import (
  3. "fmt"
  4. "net/http"
  5. )
  6. func myfunc(w http.ResponseWriter, r *http.Request) {
  7. fmt.Fprintf(w, "hi")
  8. }
  9. func main() {
  10. server := http.Server{
  11. Addr: ":8080",
  12. ReadTimeout: 0,
  13. WriteTimeout: 0,
  14. }
  15. http.HandleFunc("/", myfunc)
  16. server.ListenAndServe()
  17. }

这样服务也能跑起来!

指定Servemux的用法:

  1. package main
  2. import (
  3. "fmt"
  4. "net/http"
  5. )
  6. func myfunc(w http.ResponseWriter, r *http.Request) {
  7. fmt.Fprintf(w, "hi")
  8. }
  9. func main() {
  10. mux := http.NewServeMux()
  11. mux.HandleFunc("/", myfunc)
  12. http.ListenAndServe(":8080", mux)
  13. }

如果既指定Servemux又自定义 http.Server:

  1. package main
  2. import (
  3. "fmt"
  4. "net/http"
  5. )
  6. func myfunc(w http.ResponseWriter, r *http.Request) {
  7. fmt.Fprintf(w, "hi")
  8. }
  9. func main() {
  10. server := http.Server{
  11. Addr: ":8080",
  12. ReadTimeout: 0,
  13. WriteTimeout: 0,
  14. }
  15. mux := http.NewServeMux()
  16. server.Handler = mux
  17. mux.HandleFunc("/", myfunc)
  18. server.ListenAndServe()
  19. }

在前面pprof 包的内容中我们也用了本章开头这段代码,当我们访问http://localhost:8080/debug/pprof/ 时可以看到对应的性能分析报告。
因为我们这样导入 _”net/http/pprof” 包时,在文件 pprof.go 文件中init 函数已经定义好了handler:

  1. func init() {
  2. http.HandleFunc("/debug/pprof/", Index)
  3. http.HandleFunc("/debug/pprof/cmdline", Cmdline)
  4. http.HandleFunc("/debug/pprof/profile", Profile)
  5. http.HandleFunc("/debug/pprof/symbol", Symbol)
  6. http.HandleFunc("/debug/pprof/trace", Trace)
  7. }

所以,我们就可以通过浏览器访问上面地址来看到报告。现在再来看这些代码,我们就明白怎么回事了!

36.5 自定义处理器(Custom Handlers)

自定义的Handler:

标准库http提供了Handler接口,用于开发者实现自己的handler。只要实现接口的ServeHTTP方法即可。

  1. package main
  2. import (
  3. "log"
  4. "net/http"
  5. "time"
  6. )
  7. type timeHandler struct {
  8. format string
  9. }
  10. func (th *timeHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  11. tm := time.Now().Format(th.format)
  12. w.Write([]byte("The time is: " + tm))
  13. }
  14. func main() {
  15. mux := http.NewServeMux()
  16. th := &timeHandler{format: time.RFC1123}
  17. mux.Handle("/time", th)
  18. log.Println("Listening...")
  19. http.ListenAndServe(":3000", mux)
  20. }

我们知道,NewServeMux可以创建一个ServeMux实例,ServeMux同时也实现了ServeHTTP方法,因此代码中的mux也是一种handler。把它当成参数传给http.ListenAndServe方法,后者会把mux传给Server实例。因为指定了handler,因此整个http服务就不再是DefaultServeMux,而是mux,无论是在注册路由还是提供请求服务的时候。

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

36.6 将函数作为处理器

  1. package main
  2. import (
  3. "log"
  4. "net/http"
  5. "time"
  6. )
  7. func timeHandler(w http.ResponseWriter, r *http.Request) {
  8. tm := time.Now().Format(time.RFC1123)
  9. w.Write([]byte("The time is: " + tm))
  10. }
  11. func main() {
  12. mux := http.NewServeMux()
  13. // Convert the timeHandler function to a HandlerFunc type
  14. th := http.HandlerFunc(timeHandler)
  15. // And add it to the ServeMux
  16. mux.Handle("/time", th)
  17. log.Println("Listening...")
  18. http.ListenAndServe(":3000", mux)
  19. }

创建新的server:

  1. func index(w http.ResponseWriter, r *http.Request) {
  2. w.Header().Set("Content-Type", "text/html")
  3. html := `<doctype html>
  4. <html>
  5. <head>
  6. <title>Hello World</title>
  7. </head>
  8. <body>
  9. <p>
  10. Welcome
  11. </p>
  12. </body>
  13. </html>`
  14. fmt.Fprintln(w, html)
  15. }
  16. func main(){
  17. http.HandleFunc("/", index)
  18. server := &http.Server{
  19. Addr: ":8000",
  20. ReadTimeout: 60 * time.Second,
  21. WriteTimeout: 60 * time.Second,
  22. }
  23. server.ListenAndServe()
  24. }

36.7 中间件Middleware

所谓中间件,就是连接上下级不同功能的函数或者软件,通常进行一些包裹函数的行为,为被包裹函数提供添加一些功能或行为。前文的HandleFunc就能把签名为 func(w http.ResponseWriter, r *http.Reqeust)的函数包裹成handler。这个函数也算是中间件。

Go的http中间件很简单,只要实现一个函数签名为func(http.Handler) http.Handler的函数即可。http.Handler是一个接口,接口方法我们熟悉的为serveHTTP。返回也是一个handler。因为Go中的函数也可以当成变量传递或者或者返回,因此也可以在中间件函数中传递定义好的函数,只要这个函数是一个handler即可,即实现或者被handlerFunc包裹成为handler处理器。

  1. func index(w http.ResponseWriter, r *http.Request) {
  2. w.Header().Set("Content-Type", "text/html")
  3. html := `<doctype html>
  4. <html>
  5. <head>
  6. <title>Hello World</title>
  7. </head>
  8. <body>
  9. <p>
  10. Welcome
  11. </p>
  12. </body>
  13. </html>`
  14. fmt.Fprintln(w, html)
  15. }
  16. func middlewareHandler(next http.Handler) http.Handler{
  17. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request){
  18. // 执行handler之前的逻辑
  19. next.ServeHTTP(w, r)
  20. // 执行完毕handler后的逻辑
  21. })
  22. }
  23. func loggingHandler(next http.Handler) http.Handler {
  24. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  25. start := time.Now()
  26. log.Printf("Started %s %s", r.Method, r.URL.Path)
  27. next.ServeHTTP(w, r)
  28. log.Printf("Completed %s in %v", r.URL.Path, time.Since(start))
  29. })
  30. }
  31. func main() {
  32. http.Handle("/", loggingHandler(http.HandlerFunc(index)))
  33. http.ListenAndServe(":8000", nil)
  34. }

36.8 静态站点

下面代码通过指定目录,作为静态站点:

  1. package main
  2. import (
  3. "net/http"
  4. )
  5. func main() {
  6. http.Handle("/", http.FileServer(http.Dir("D:/html/static/")))
  7. http.ListenAndServe(":8080", nil)
  8. }