深入理解GeeRPC框架：第五天实现HTTP协议支持-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00986/article/details/148376026

深入理解GeeRPC框架：第五天实现HTTP协议支持

7days-golang 7 days golang programs from scratch (web framework Gee, distributed cache GeeCache, object relational mapping ORM framework GeeORM, rpc framework GeeRPC etc) 7天用Go动手写/从零实现系列项目地址: https://gitcode.com/gh_mirrors/7d/7days-golang

前言

在构建RPC框架时，支持多种传输协议是非常重要的功能。本文将深入探讨如何在GeeRPC框架中实现HTTP协议支持，并构建一个简单的DEBUG页面来监控服务状态。通过本文，你将了解到RPC框架如何与HTTP协议协同工作，以及如何扩展框架功能以提供更好的开发体验。

HTTP协议在RPC中的应用

为什么需要支持HTTP协议？

在分布式系统中，RPC框架通常需要支持多种通信协议。HTTP作为一种广泛使用的应用层协议，具有以下优势：

通用性强：几乎所有网络环境都允许HTTP流量通过
易于调试：可以直接使用浏览器或curl等工具测试
网络环境友好：HTTP/HTTPS端口通常不会被限制

HTTP CONNECT方法的作用

HTTP CONNECT方法在RPC框架中扮演着关键角色，它允许客户端通过HTTP中间节点建立隧道连接。当RPC客户端需要与服务端通信时：

客户端发送CONNECT请求建立连接
服务端响应200状态码确认连接建立
之后的所有通信都通过这个连接进行

这种机制使得RPC通信可以在各种网络环境下工作，同时保持原有的RPC协议格式。

服务端HTTP支持实现

核心接口实现

GeeRPC通过实现http.Handler接口来支持HTTP协议：

func (server *Server) ServeHTTP(w http.ResponseWriter, req *http.Request) {
    if req.Method != "CONNECT" {
        w.Header().Set("Content-Type", "text/plain; charset=utf-8")
        w.WriteHeader(http.StatusMethodNotAllowed)
        _, _ = io.WriteString(w, "405 must CONNECT\n")
        return
    }
    conn, _, err := w.(http.Hijacker).Hijack()
    if err != nil {
        log.Print("rpc hijacking ", req.RemoteAddr, ": ", err.Error())
        return
    }
    _, _ = io.WriteString(conn, "HTTP/1.0 "+connected+"\n\n")
    server.ServeConn(conn)
}

关键点解析：

只接受CONNECT方法请求
使用Hijack获取底层连接
返回成功响应后转为处理RPC请求

路由注册

框架提供了便捷的方法来注册HTTP处理器：

func (server *Server) HandleHTTP() {
    http.Handle(defaultRPCPath, server)
    http.Handle(defaultDebugPath, debugHTTP{server})
    log.Println("rpc server debug path:", defaultDebugPath)
}

这里注册了两个路径：

/_geerpc_：处理RPC请求
/debug/geerpc：提供DEBUG页面

客户端HTTP支持实现

HTTP客户端创建

客户端需要实现通过HTTP建立连接的逻辑：

func NewHTTPClient(conn net.Conn, opt *Option) (*Client, error) {
    _, _ = io.WriteString(conn, fmt.Sprintf("CONNECT %s HTTP/1.0\n\n", defaultRPCPath))
    
    resp, err := http.ReadResponse(bufio.NewReader(conn), &http.Request{Method: "CONNECT"})
    if err == nil && resp.Status == connected {
        return NewClient(conn, opt)
    }
    // 错误处理...
}

流程说明：

发送CONNECT请求
验证响应状态码
成功则创建RPC客户端

统一拨号接口

为简化使用，框架提供了XDial方法支持多种协议：

func XDial(rpcAddr string, opts ...*Option) (*Client, error) {
    parts := strings.Split(rpcAddr, "@")
    // 参数验证...
    switch protocol {
    case "http":
        return DialHTTP("tcp", addr, opts...)
    default:
        return Dial(protocol, addr, opts...)
    }
}

这样用户可以通过统一的方式使用不同协议：

http@localhost:9999
tcp@localhost:9999
unix@/tmp/geerpc.sock

DEBUG页面实现

页面模板

使用HTML模板展示服务信息：

const debugText = `<html>
    <body>
    <title>GeeRPC Services</title>
    {{range .}}
    <hr>
    Service {{.Name}}
    <hr>
        <table>
        <th align=center>Method</th><th align=center>Calls</th>
        {{range $name, $mtype := .Method}}
            <tr>
            <td align=left font=fixed>{{$name}}({{$mtype.ArgType}}, {{$mtype.ReplyType}}) error</td>
            <td align=center>{{$mtype.NumCalls}}</td>
            </tr>
        {{end}}
        </table>
    {{end}}
    </body>
    </html>`

数据收集与渲染

通过debugHTTP类型实现服务信息的收集和渲染：

func (server debugHTTP) ServeHTTP(w http.ResponseWriter, req *http.Request) {
    var services []debugService
    server.serviceMap.Range(func(namei, svci interface{}) bool {
        svc := svci.(*service)
        services = append(services, debugService{
            Name:   namei.(string),
            Method: svc.method,
        })
        return true
    })
    debug.Execute(w, services)
}

实际应用示例

服务端设置

func startServer(addrCh chan string) {
    var foo Foo
    l, _ := net.Listen("tcp", ":9999")
    _ = geerpc.Register(&foo)
    geerpc.HandleHTTP()
    addrCh <- l.Addr().String()
    _ = http.Serve(l, nil)
}

客户端调用

func call(addrCh chan string) {
    client, _ := geerpc.DialHTTP("tcp", <-addrCh)
    defer func() { _ = client.Close() }()

    // 并发调用示例
    var wg sync.WaitGroup
    for i := 0; i < 5; i++ {
        wg.Add(1)
        go func(i int) {
            defer wg.Done()
            args := &Args{Num1: i, Num2: i * i}
            var reply int
            client.Call(context.Background(), "Foo.Sum", args, &reply)
            log.Printf("%d + %d = %d", args.Num1, args.Num2, reply)
        }(i)
    }
    wg.Wait()
}