一个go最简单的http服务器程序

package main
 
import (
    "fmt"
    "net/http"
)
 
func indexhandler(w http.responsewriter, r *http.request) {
    fmt.fprintln(w, "hello world")
}
 
func main() {
    http.handlefunc("/", indexhandler)
    http.listenandserve("127.0.0.0:8000", nil)
}

http

   除去细节,理解http构建的网络应用只要关注两个端–客户端(client)和服务端(server),两个端的交互来自client的request,以及server端的response。所谓的http服务器,主要在于如何接受client的request,并向client返回response。

   接收request的过程中,最重要的莫过于路由(router),即实现一个multiplexer器。go中既可以使用内置的mutilplexer–defaultservemux,也可以自定义。multiplexer路由的目的就是为了找到处理器函数(hander),后者将对request进行处理,同时构建response。

  简单总结就是这个流程:

  因此,理解go中的http服务,,最重要的就是要理解multiplexer和hander,golang中的multiplexer基于servermux结构,同时也实现了handler接口。

  ·hander函数:具有func(w http.responsewriter, r *http.requests)签名的函数

  ·handler处理器(函数):经过handerfunc结构包装的handler函数,它实现了servehttp接口方法的函数。调用handler处理器的servehttp方法时,即调用handler函数本身。

  ·handler对象:实现了hander接口servehttp方法的结构。

   golang的http处理流程可以用下面一张图表示,后面内容是针对图进行说明:

handler

   golang没有继承,类多态的方法可以通过接口实现。所谓接口则是定义声明了函数签名,任何结构只要实现了与接口函数签名相同的方法,就等同于实现了接口。go的http服务都是基于handler进行处理的。

type handler interface {
    servehttp(responsewriter, *request)
}

    任何结构体,只要实现了servehttp方法,这个结构就可以称之为handler对象。servemux会使用handler并调用其servehttp方法处理请求并返回响应。

servemux

   了解了handler之后,再看servemux。servemux源码很简单:

type servemux struct {
    mu    sync.rwmutex
    m     map[string]muxentry
    hosts bool 
}
 
type muxentry struct {
    explicit bool
    h        handler
    pattern  string
}

   servemux结构中最重要的字段为m,这是一个map,key是一些url模式,value是一个muxentry结构,后者里定义存储了具体的url模式和handler。 

   当然,所谓的servemux也实现了servehttp接口,也算是一个handler,不过servemux的servehttp方法不是用来处理request和respone,而是用来找到路由注册的handler。

server

   除了servemux和handler,还有一个结构server需要了解。从http.listenandserve的源码可以看出,它创建了一个server对象,并调用server对象的listenandserve方法:

func listenandserve(addr string, handler handler) error {
    server := &server{addr: addr, handler: handler}
    return server.listenandserve()
}

   查看server的结构如下:

type server struct {
    addr         string        
    handler      handler       
    readtimeout  time.duration 
    writetimeout time.duration 
    tlsconfig    *tls.config   
 
    maxheaderbytes int
 
    tlsnextproto map[string]func(*server, *tls.conn, handler)
 
    connstate func(net.conn, connstate)
    errorlog *log.logger
    disablekeepalives int32     nextprotoonce     sync.once 
    nextprotoerr      error     
}

   server结构存储了服务器处理请求常见的字段。其中handler字段也保留hander接口。如果server接口没有提供handler结构对象,那么会使用defaultservemux做multiplexer。

创建http服务

    创建一个http服务,大致需要经历两个过程,首先需要注册路由,即提供url模式和handler函数的映射,其次就是实例化一个server对象,并开启对客户端的监听。

http.handlefunc("/", indexhandler)
http.listenandserve("127.0.0.1:8000", nil)
 
或者:
 
server := &server{addr: addr, handler: handler}
 
server.listenandserve()

http注册路由

    net/http包暴露的注册路由的api很简单,http.handlefunc选取了defaultservemux作为multiplexer:

func handlefunc(pattern string, handler func(responsewriter, *request)) {
    defaultservemux.handlefunc(pattern, handler)
}

   实际上,defaultservemux是servemux的一个实例。当然http包也提供了newservemux方法创建一个servemux实例,默认则创建一个defaultservemux:

// newservemux allocates and returns a new servemux.
func newservemux() *servemux {
    return new(servemux)
}
 
// defaultservemux is the default servemux used by serve.
var defaultservemux = &defaultservemux
 
var defaultservemux servemux

   注意,go创建实例的过程中,也可以使用指针方式,即

   type server struct{}
   server := server{}

   和下面的一样都可以创建server的实例

 var defaultserver server
  var server = &defalutserver

   因此defaultservemux的handlefunc(pattern,handler)方法实际是定义在servemux下的:

func (mux *servemux) handlefunc(pattern string, handler func(responsewriter, *request)) {
    mux.handle(pattern, handlerfunc(handler))
}

   上述代码中,handlerfunc是一个函数类型。同时实现了handler接口的servehttp方法。使用handlerfunc类型包装一下路由定义的indexhandler函数,其目的就是为了让这个函数也实现servehttp方法,即转变成一个handler处理器(函数)。

type handlerfunc func(responsewriter, *request)
 
func (f handlerfunc) servehttp(w responsewriter, r *request) {
    f(w, r)
}

   一旦这样做了,就意味着我们的indexhandler函数也有了servehttp方法。
   此外,servemux的handle方法,将会对pattern和handler函数做一个map映射:

func (mux *servemux) handle(pattern string, handler handler) {
    mux.mu.lock()
    defer mux.mu.unlock()
 
    if pattern == "" {
        panic("http: invalid pattern " + pattern)
    }
    if handler == nil {
        panic("http: nil handler")
    }
    if mux.m[pattern].explicit {
        panic("http: multiple registrations for " + pattern)
    }
 
    if mux.m == nil {
        mux.m = make(map[string]muxentry)
    }
    mux.m[pattern] = muxentry{explicit: true, h: handler, pattern: pattern}
 
    if pattern[0] != '/' {
        mux.hosts = true
    }
 
    n := len(pattern)
    if n > 0 && pattern[n-1] == '/' && !mux.m[pattern[0:n-1]].explicit {
 
        path := pattern
        if pattern[0] != '/' {
            path = pattern[strings.index(pattern, "/"):]
        }
        url := &url.url{path: path}
        mux.m[pattern[0:n-1]] = muxentry{h: redirecthandler(url.string(), statusmovedpermanently), pattern: pattern}
    }
}

   由此可见,handle函数的主要目的在于把handler和pattern模式绑定到map[string]muxentry的map上,其中muxentry保存了更多pattern和handler的信息。server的m字段就是map[string]muxentry这样一个map。
   此时,pattern和handler的路由注册完成。

开启监听

    注册好路由之后,启动web服务还需要开启服务器监听。http的listenandserver方法中可以看到创建了一个server对象,并调用了server对象的同名方法:

func listenandserve(addr string, handler handler) error {
    server := &server{addr: addr, handler: handler}
    return server.listenandserve()
}
 
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)})
}

   server的listenandserver方法中,会初始化监听地址addr,同时调用listen方法设置监听。最后将监听的tcp对象传入serve方法:

func (srv *server) serve(l net.listener) error {
    defer l.close()
    ...
 
    basectx := context.background()
    ctx := context.withvalue(basectx, servercontextkey, srv)
    ctx = context.withvalue(ctx, localaddrcontextkey, l.addr())
    for {
        rw, e := l.accept()
        ...
        c := srv.newconn(rw)
        c.setstate(c.rwc, statenew) // before serve can return
        go c.serve(ctx)
    }
}

处理请求

   监听开启之后,一旦客户端请求到底,go就开启一个协程处理请求,主要逻辑都在server方法之中。

   serve方法比较长,其主要职能就是,创建一个上下文对象,然后调用listener的accept方法用来获取连接数据并使用newconn方法创建连接对象。最后使用goroutein协程的方式处理连接请求。因此每一个连接都开启了一个协程,请求的上下文都不同,同时又保证了go的高并发。serve也是一个长长的方法:

func (c *conn) serve(ctx context.context) {
    c.remoteaddr = c.rwc.remoteaddr().string()
    defer func() {
        if err := recover(); err != nil {
            const size = 64 << 10
            buf := make([]byte, size)
            buf = buf[:runtime.stack(buf, false)]
            c.server.logf("http: panic serving %v: %v\n%s", c.remoteaddr, err, buf)
        }
        if !c.hijacked() {
            c.close()
            c.setstate(c.rwc, stateclosed)
        }
    }()
 
    ...
 
    for {
        w, err := c.readrequest(ctx)
        if c.r.remain != c.server.initialreadlimitsize() {
            // if we read any bytes off the wire, we're active.
            c.setstate(c.rwc, stateactive)
        }
        ...
        
        }
        
        ...
    
        serverhandler{c.server}.servehttp(w, w.req)
        w.cancelctx()
        if c.hijacked() {
            return
        }
        w.finishrequest()
        if !w.shouldreuseconnection() {
            if w.requestbodylimithit || w.closedrequestbodyearly() {
                c.closewriteandwait()
            }
            return
        }
        c.setstate(c.rwc, stateidle)
    }
}

   尽管serve很长,里面的结构和逻辑还是很清晰的,使用defer定义了函数退出时,连接关闭相关的处理。然后就是读取连接的网络数据,并处理读取完毕时候的状态。接下来就是调用serverhandler{c.server}.servehttp(w,w.req)方法处理请求了。最后就是请求处理完毕的逻辑。serverhandler是一个重要的结构,它仅有一个字段,即server结构,同时它也实现了hander接口方法servehttp,同时它也实现了handler接口方法servehttp,并在该接口方法中做了一个重要的事情,初始化multiplexer路由多路复用器。如果server对象没有制定handler,则使用默认的defaultservemux作为路由multiplexer。并调用初始化handler的servehttp方法。

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的servehttp方法其实也是定义在servemux结构中的,相关代码如下:

func (mux *servemux) (w responsewriter, r request) {
    if r.requesturi == "" {
        if r.protoatleast(1, 1) {
            w.header().set("connection", "close")
        }
        w.writeheader(statusbadrequest)
        return
    }
    h, _ := mux.handler(r)
    h.servehttp(w, r)
}
 
func (mux *servemux) handler(r *request) (h handler, pattern string) {
    if r.method != "connect" {
        if p := cleanpath(r.url.path); p != r.url.path {
            _, pattern = mux.handler(r.host, p)
            url := *r.url
            url.path = p
            return redirecthandler(url.string(), statusmovedpermanently), pattern
        }
    }
    return mux.handler(r.host, r.url.path)
}
 
func (mux *servemux) handler(host, path string) (h handler, pattern string) {
    mux.mu.rlock()
    defer mux.mu.runlock()
 
    // host-specific pattern takes precedence over generic ones
    if mux.hosts {
        h, pattern = mux.match(host + path)
    }
    if h == nil {
        h, pattern = mux.match(path)
    }
    if h == nil {
        h, pattern = notfoundhandler(), ""
    }
    return
}
 
func (mux *servemux) match(path string) (h handler, pattern string) {
    var n = 0
    for k, v := range mux.m {
        if !pathmatch(k, path) {
        continue
    }
    if h == nil || len(k) > n {
        n = len(k)
        h = v.h
        pattern = v.pattern
        }
    }
    return
}

   mux的servehttp方法通过调用其handler方法寻找注册到路由上的handler函数,并调用该函数的servehttp方法。 

   mux的handler方法对url简单的处理,然后调用handler方法,后者会创建一个锁,同时调用match方法返回一个handler和pattern。
   在match方法中,mux的m字段是map[string]muxentry,后者存储了pattern和handler处理器函数,因此通过迭代m寻找出注册路由的pattern模式与实际url匹配的handler函数并返回。
   返回的结构一直传递到mux的servehttp方法,接下来调用handler函数的servehttp方法,即indexhandler函数,然后把reponse写到http.requestwirter对象返回给客户端。

   上述函数运行结束即serverhandler{c.server}.servehttp(w, w.req)运行结束。接下来就是对请求处理完毕之后上希望和连接断开的相关逻辑。

   至此,golang中一个完整的http服务介绍完毕,包括注册路由,开启监听,处理连接,路由处理函数。

参考:

https://www.yuque.com/docs/share/24a1bd1c-e32d-4268-9115-bf03f53677d3

到此这篇关于golang构建http服务的实现步骤的文章就介绍到这了,更多相关golang构建http服务内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!