ServeHTTP 是如何工作的?

How does ServeHTTP work?

我正在学习 Golang 的 Web 开发(初学者)我遇到了一些我玩过的代码但我不太确定它为什么有效,我查看了库源代码和文档但我只有一个模糊的想法它仍然没有点击。请注意以下代码:

package main

import (
    "fmt"
    "net/http"
)

type foo int

func (m foo) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Some text")
}

func main() {
    var bar foo
    http.ListenAndServe(":8080", bar)
}

根据我的理解,添加 ServeHTTP(w http.ResponseWriter, r *http.Request) 作为函数方法,调用 处理程序interface(如果我没说错的话)现在 foo 也是 类型的 handler。我也明白 http.ListenAndServe 接受类型处理程序的输入,所以这就是我的变量 bar 发挥作用的地方。当我 运行 代码并在我的浏览器上转到 localhost:8080 时,我得到 "Some Text" 出现。

编辑: 实现接口 是不调用的正确术语。

问题:

这究竟是如何工作的?如何访问 ServeHTTP 函数?

我尝试查看库的源代码,但无法准确指出 ServeHTTP 的工作原理。我发现这两段代码(不确定这是否适用)让我觉得它正在实现一个功能但需要澄清:

// The HandlerFunc type is an adapter to allow the use of
// ordinary functions as HTTP handlers. If f is a function
// with the appropriate signature, HandlerFunc(f) is a
// Handler that calls f.
type HandlerFunc func(ResponseWriter, *Request)

// ServeHTTP calls f(w, r).
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
    f(w, r)
}

我从未见过像上面这样带有 HandlerFunc 的类型声明,它在类型名称后有一个函数。我还看到了方法是如何声明的,但不确定上面的代码中发生了什么。

在此代码中为

键入声明
type foo int

正在实现 Handler 接口。我们可以创建结构或任何类型来实现 ServeHTTP 方法。喜欢

type Foo struct{}
func (m foo) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Some text")
}

用于实现 Handler 接口或任何其他接口需要在此处的 foo 类型上实现接口中声明的所有方法。

HandlerFunc 正在实现 Handler 接口的 ServeHttp 方法,因此可以作为处理程序传递给 http.ListenAndServe。它可用于创建围绕 ServeHttp 的中间件。

有关 HanlderFunc 的更多信息,请在终端中使用 go doc

godoc net/http HanlderFunc

net/http中的相关类型是

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

接口类型。任何实现此接口的具体类型都可用于服务 HTTP 请求。您的 barfoo 类型并且 foo 实现了 Handler 接口。如果内置 HTTP 服务器必须处理请求,它将调用您的栏的 ServeHTTP 方法。

Go 的 HTTP 服务器接受一个要监听的地址和一个处理程序。在内部,它创建一个 TCP 侦听器来接受给定地址上的连接,并且每当有请求进入时,它:

  1. 将原始 HTTP 请求(路径、headers 等)解析为 http.Request
  2. 创建一个 http.ResponseWriter 用于发送响应
  3. 通过调用其 ServeHTTP 方法调用处理程序,传入 RequestResponseWriter

处理程序可以是满足 Handler 接口的任何东西,您的 foo 类型就是这样:

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

标准库还包括一些方便的功能,例如 HandlerFunc(允许您传递任何 func(ResponseWriter, *Request) 并将其用作 Handler)和 ServeMux,这允许您注册许多 Handler 并根据传入的请求路径选择哪个处理哪个请求。

这究竟是如何工作的?如何访问 ServeHTTP 函数?

要回答这个问题,我们需要看看 http.ListenAndServe 是如何工作的:

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

这里我们用给定的地址和处理程序创建了一个服务器并调用了 ListenAndServer 方法所以让我们看看那里:

func (srv *Server) ListenAndServe() error {
    addr := srv.Addr
    if addr == "" {
        addr = ":http"
    }
    ln, err := net.Listen("tcp", addr)
    if err != nil {
        return err
    }
    return srv.Serve(tcpKeepAliveListener{ln.(*net.TCPListener)})
}

此方法刚开始侦听给定地址并使用我们新创建的侦听器调用服务器方法,所以让我们沿着那里的线索:

func (srv *Server) Serve(l net.Listener) error {
    defer l.Close()

    ...

    for {
        rw, e := l.Accept()

        ...

        c := srv.newConn(rw)
        c.setState(c.rwc, StateNew) // before Serve can return
        go c.serve(ctx)
    }
}

从 Serve 方法我们可以看出,这是我们接受新连接并开始在它自己的 goroutine 中处理它的地方。

// Serve a new connection.
func (c *conn) serve(ctx context.Context) {
    ...
    for {
        w, err := c.readRequest(ctx)
        ...
        serverHandler{c.server}.ServeHTTP(w, w.req)
        ...
    }
}

在这里,我们最终调用了 ServeHTTP 方法,但正如我们所见,这还不是我们对该函数的实现,而是标准库中的一些东西,所以让我们看一下 serverHandler 结构包含的内容:

// serverHandler delegates to either the server's Handler or
// DefaultServeMux and also handles "OPTIONS *" requests.
type serverHandler struct {
    srv *Server
}

func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request) {
    handler := sh.srv.Handler
    if handler == nil {
        handler = DefaultServeMux
    }
    if req.RequestURI == "*" && req.Method == "OPTIONS" {
        handler = globalOptionsHandler{}
    }
    handler.ServeHTTP(rw, req)
}

终于到了。如果我们没有提供任何处理程序,则将使用 DefaultServeMux,但由于我们提供了来自 foo get 的 foo 处理程序 ServeHTTP。

就是这样。所有这些都可以从server.go

中找到

我建议任何想了解 http.Handler
的人阅读这些博文 A Recap of Request Handling in Go
Making and Using HTTP Middleware