项目源码

teleport：https://github.com/henrylee2cn/teleport

背景

大家在进行业务开发时，是否是否遇到过下列问题，并且无法在Go语言开源生态中找到一套完整的解决方案？

• 高性能、可靠地通信？
• 开发效率不高？
• 无法自定义应用层协议？
• 想要动态协商Body编码类型（如JSON、protobuf等）？
• 不能以简洁的RPC方式进行业务开发？
• 没有灵活的插件扩展机制？
• 不支持服务端向客户端主动推送消息？
• 特殊场景时需要连接管理，如多种连接类型、会话管理？
• 使用了非HTTP协议框架，但不能很好的兼容HTTP协议，无法方便地与第三方对接？

我对于常见的一些相关开源项目做了一次粗略调查，发现迄今为止，除今天我要分享的这款 teleport 框架外（确切讲还包括由teleport扩展而来的微服务框架 tp-micro），貌似并没有另外一款Go语言的开源框架能够同时解决上述问题：

概述

teleport 就是在上述需求背景下被创造出来，成为一个通用、高效、灵活的Socket框架。

它可以用于Peer-Peer对等通信、RPC、长连接网关、微服务、推送服务，游戏服务等领域。

其主要特性如下：

TODO：尚未提供多语言客户端版本

架构

设计原则

• 面向接口设计，保证代码稳定，提供灵活定制

• 抽象核心模型，保持最简化

• 分层设计，自下而上逐层封装，利于稳定和维护

• 充分利用协程，且保证可控、可复用

架构示意图

teleport_module_diagram.png

注：“tp” 是 teleport 的包名，因此它代指 “teleport”。

简单的性能对比图

env.png

mean_latency.png

p99_latency.png

throughput.png

为兼容HTTP做准备

兼容 HTTP 最好的办法就是在设计应用层协议之初就考虑到进去。因此，teleport 对应用层协议报文的属性做了如下抽象：

• Size 整个报文的长度
• Transfer-Filter-Pipeline 报文数据过滤处理管道
• Header
  • Seq 消息序号（因为是异步通信）
  • Mtype 消息类型（如PULL、REPLY、PUSH）
  • URI 资源标识符（对照常见RPC框架中的method，但可以更好地兼容HTTP）
  • Meta 元信息（如错误信息、内容协商信息等，对照HTTP Header）
• Body
  • BodyCodec 消息正文的编码类型（如JSON、Protobuf）
  • Body 消息正文

从下图 teleport 报文属性与 HTTP 报文对比中，不难发现它们有共通之处。

tp_data_message.png

如何实现DIY应用层协议？

应用层协议是指建立在 TCP 协议之上的报文协议。我们希望开发者自己定制该协议，这样更具备灵活性，比如protobuf、thrift等。

首先要做的第一件事是：

抽象出一个 Message 对象，为应用层协议接口提供字节流序列化与反序列化模板。

Step1: 抽象 Message 对象

在 teleport/socket 包中抽象出 Message 结构体（上面已经介绍过了）

Step2: 抽象 Proto 协议接口

提供 Proto 协议接口，对 Message 对象进行序列化与反序列化，从而支持开发者的自定义实现自己的协议格式，其接口声明如下：

type Proto interface {
    Version() (byte, string)
    Pack(*Message) error
    Unpack(*Message) error
}

解释：

• Version ：实现该协议接口的版本号

• Pack ：按照接口实现的规则，将 Message 的属性序列化为字节流

• Unpack ：按照接口实现的规则，将字节流反序列化进一个 Message 对象

目前框架已经提供三种协议：Raw、JSON、Protobuf。

其中以Raw为示例，展示如下：

# raw protocol format(Big Endian):

{4 bytes message length}
{1 byte protocol version}
{1 byte transfer pipe length}
{transfer pipe IDs}
# The following is handled data by transfer pipe
{2 bytes sequence length}
{sequence}
{1 byte message type} # e.g. CALL:1; REPLY:2; PUSH:3
{2 bytes URI length}
{URI}
{2 bytes metadata length}
{metadata(urlencoded)}
{1 byte body codec id}
{body}

如何实现 Body 编码协商？

在实际业务场景中，报文的类型是多种多样的，所以 teleport 使用 Codec 接口对消息正文（Message Body）进行编解码。

type Codec interface {
    Id() byte
    Name() string
    Marshal(v interface{}) ([]byte, error)
    Unmarshal(data []byte, v interface{}) error
}

解释：

• Id ：编解码器的唯一识别码
• Name ：编解码器的名称，同样要求全局唯一，主要是便于开发者记忆和可视化
• Marshal ：编码
• Unmarshal ：解码

开发者可以将自定义的新编解码器注入 teleport/codec 包，从而在整个项目中使用。

框架已经提供的编解码器实现：JSON、Protobuf、Form（urlencoded）、Plain（raw text）

在自由支持各种编解码类型后，我就可以模仿 HTTP 协议头的 Content-Type 实现一下协商功能了。

在 Request/Response 的通信场景下，按以下步骤进行 Body 编码类型协商：

• Step1：请求端将当前 Body 的编码类型设置到 Message 的 BodyCodec 属性

• Step2：在请求端希望收到请求Body不同的编码类型时（在web开发中很常见），就可以在 Message 对象的 Meta 元信息中设置 X-Accept-Body-Codec 来指定响应的编码类型

• Step3：响应端根据请求的 BodyCodec 属性解码 Body，执行业务逻辑

• Step4：响应端在发现有 X-Accept-Body-Codec 元信息时，使用该元信息指定类型编码响应 Body，否则默认使用与请求相同的编码类型。当然，响应端的开发者也可以明确指定编码类型，这样就会忽略前面的规则，强制使用该指定的编码类型。

在上述 Step2 中，请求端设置 Message 对象的 X-Accept-Body-Codec Meta 元信息的一段代码片段：

session.Call("/a/b", arg, result, tp.WithAcceptBodyCodec(codec.ID_PROTOBUF))

其中，tp.WithAcceptBodyCodec 是一种修饰函数的用法，这类函数可以实现灵活地配置策略，一些相关定义如下。在 teleport/socket 包中：

type MessageSetting func(*Message)

func WithAddMeta(key, value string) MessageSetting {
    return func(m *Message) {
        m.meta.Add(key, value)
    }
}

在 teleport 包中：

const MetaAcceptBodyCodec = "X-Accept-Body-Codec"

func WithAcceptBodyCodec(bodyCodec byte) MessageSetting {
    if bodyCodec == codec.NilCodecId {
        return func(*Message) {}
    }
    return socket.WithAddMeta(MetaAcceptBodyCodec, strconv.FormatUint(uint64(bodyCodec), 10))
}
...
type Session interface {
    Call(uri string, arg interface{}, result interface{}, setting ...socket.MessageSetting) CallCmd
}

说明：Call 其实类似于 net/http 中的 func (c *Client) Do(req *Request) (*Response, error) 是根据请求参数 Message 进行请求的。

在该场景中为什么选择使用修饰函数？为什么不直接传入 Message 结构体（先将其字段公开）？

• Message 的字段很多，有的必填，有的选填；例如必填参数 uri、arg 都是它的字段（arg对应body字段），meta、context 等为选填；通过上述这种“必填参数+修饰函数不定参”的方法声明，可以从语法层面明确使用规范（如换成使用结构体，只能使用约定，然后在运行时检查）
• 修饰函数的方式可以封装更加复杂的配置逻辑，比如设置两个关联参数的情况，某个字段需要写多行代码进行初始化的情况
• 修饰函数的使用更加灵活，具有很强的封装性，比如可以提供常用的修饰函数包，可以多个修饰函数嵌套组合成一个新的修饰函数等等
• 特意将 Message 的字段声明为私有，同时在当前包内提供一些基础修饰函数，可以大大提高配置的可控性与安全性，同时也避免了开发者学习一些配置约定的成本

概括一下修饰函数的使用场景：

• 配置项很多且一些配置间存在联动性
• 配置项的结构体本身属于内部逻辑的一部分，如果外部传入后再对其进行修改，会对内部造成执行bug的情况
• 若仅仅是简单的配置，建议使用结构体，更加简单直接，比如 mysql 的配置等

如何管理连接？

一般常见的 Go 语言 RPC 框架都没有重视对连接的管理，甚至是没有连接管理功能。那么，是不是就说明连接管理功能不重要？可有可无？其实不然，这只是与 RPC 框架的定位有关：

实现远程过程调用，并不强调连接，甚至是刻意屏蔽掉底层连接！

那么，什么场景下，我们需要使用连接管理？

• 服务端主动推送消息给指定（一批）连接的客户端
• 服务端主动请求客户端，并获得客户端的响应
• 增加会话管理，将每条连接命名为用户ID，并绑定用户信息
• 获取文件描述符，对连接性能进行调优
• 异步主动断开指定（一批）连接
• 与第三方框架/组件对接

下面我们来了解一下 teleport 是如何实现连接管理的。

Step1：封装 Socket 模块

首先，我们以分层的原则对来自net标准包的 net.Conn 进行封装得到 Socket 接口。它作为整个框架的底层通信接口，向上层提供应用层消息通信和连接管理的基础功能。

该接口涉及五个组件：

• 来自标准包的 net.Conn 接口
• 抽象的应用层协议接口 Proto
• 对字节流处理的接口管道 XferPipe
• 抽象出来的 Message 结构体
• 用于编解码 Message 中 Body 数据的接口 Codec

常用接口方法如下：

• WriteMessage(message *Message) error ：写入应用层消息
• ReadMessage(message *Message) error ：读取应用层消息
• SetId(string) 、Id() string ：设置或读取当前连接ID
• Swap() goutil.Map ：存储与当前连接相关的临时数据
• ControlFD(f func(fd uintptr)) error ：操作当前连接的文件描述符

Step2：封装 Session 模块

Session 对象封装了 Socket 接口 ，并负责整个会话相关的事务（相当于引擎）。如：

• 读消息协程
• 创建消息处理的上下文
• 执行路由与操作
• 写入消息
• 打印运行日志
• 连接的ID命名
• 绑定连接相关状态信息（用户资料等）
• 连接生命周期（连接超时）
• 一次请求的生命周期（请求超时）
• 主动断开连接
• 拨号端的断线重连
• 连接断开事件通知

Step3：并发 Map 集中管理 Session

Peer 是 teleport 对通信两端的对等抽象，除了 Listener 与 Dialer 固有的角色差异外，两种角色拥有完全一致的API。Peer 就包含有一个并发 Map 用于保存全部 Session。因此，开发者可以通过 Peer 实现：

• 监听地址端口
• 拨号建立连接
• 获取指定 ID 的 Session 实例
• 向所有 Session 广播消息
• 查看当前连接数
• 平滑关闭全部连接

另外，顺便提一下，teleport是采用非阻塞的通信机制，同时支持同步、异步两种编程方式。这样做有什么好处，或者说阻塞通信与非阻塞通信的区别是什么？

golang 的 socket 是非阻塞式的，也就是说不管是accpet，还是读写都是非阻塞的。但是 golang 本身对 socket 做了一定的处理，让其用起来像阻塞的一样简单。

因此，如果我们当真把它作为阻塞通信机制，通过连接池实现并发通信，是很浪费连接资源的！我们知道，“阻塞通信+连接池”的方式，不仅吞吐量相比较低，而且还有一个无法避免的缺陷：

• 一类请求的慢响应，会很快耗尽整个连接池资源，进而拖慢整个进程的网络通信

• 如果该进程是分布式系统中的一个节点，那么这种慢响应还会很快蔓延着其他通信节点

但是，如果使用非阻塞通信机制，每个请求都不独占连接，而是共享连接。这样：

• 首先我们可以抛弃复杂的独占式连接池了（文件下载服务可能还是会用到另外一种连接池）
• 其次，一类或者一个慢响应都不会对其他请求造成影响，同时也就解决了慢响应蔓延的问题
• 第三，可以最大化利用连接资源，提升吞吐量

微服务系统中，强烈建议使用这种非阻塞通信机制！

如何设计灵活的插件

插件会给框架带来灵活性和扩展性，是一个非常重要的模块。那么，如何设计好它？teleport 从三方面考虑：

• 合适且丰富的插件位置

• 按插件位置量身设计入参和出参

• 一个插件允许包含一个或多个插件位置

  以下是 teleport 的一些插件位置定义：

上面这些函数的入参中，不带有 * 前缀的都是接口。

其中以 Peer、Session、 Ctx 为后缀的入参（接口类型），涉及到一种非常有趣、有用的 interface 用法——限制方法集。

以 Ctx 为例：

ctx.png

实践：轻松组装微服务

tp-micro 是以 teleport + plugin 的方式扩展而来的微服务。虽然目前还有一些功能未开发，但已有两家公司使用。它在完整继承 teleport 特性的同时，增加如下主要模块：

tp-micro_flow_chart.png

聊聊高效开发的一些事儿

实现 RPC 开发范式

实现 RPC 范式的好处是代码书写简单、代码结构清晰明了、对开发者友好。

在此只贴出一个简单代码示例，不展开讨论封装细节。

• server.go

package main

import (
    "fmt"
    "time"

    tp "github.com/henrylee2cn/teleport"
)

func main() {
    // graceful
    go tp.GraceSignal()

    // server peer
    srv := tp.NewPeer(tp.PeerConfig{
        CountTime:   true,
        ListenPort:  9090,
        PrintDetail: true,
    })

    // router
    srv.RouteCall(new(Math))

    // broadcast per 5s
    go func() {
        for {
            time.Sleep(time.Second * 5)
            srv.RangeSession(func(sess tp.Session) bool {
                sess.Push(
                    "/push/status",
                    fmt.Sprintf("this is a broadcast, server time: %v", time.Now()),
                )
                return true
            })
        }
    }()

    // listen and serve
    srv.ListenAndServe()
}

// Math handler
type Math struct {
    tp.CallCtx
}

// Add handles addition request
func (m *Math) Add(arg *[]int) (int, *tp.Rerror) {
    // test query parameter
    tp.Infof("author: %s", m.Query().Get("author"))
    // add
    var r int
    for _, a := range *arg {
        r += a
    }
    // response
    return r, nil
}

• client.go

package main

import (
    "time"

    tp "github.com/henrylee2cn/teleport"
)

func main() {
    // log level
    tp.SetLoggerLevel("ERROR")

    cli := tp.NewPeer(tp.PeerConfig{})
    defer cli.Close()

    cli.RoutePush(new(Push))

    sess, err := cli.Dial(":9090")
    if err != nil {
        tp.Fatalf("%v", err)
    }

    var result int
    rerr := sess.Call("/math/add?author=henrylee2cn",
        []int{1, 2, 3, 4, 5},
        &result,
    ).Rerror()
    if rerr != nil {
        tp.Fatalf("%v", rerr)
    }
    tp.Printf("result: %d", result)

    tp.Printf("wait for 10s...")
    time.Sleep(time.Second * 10)
}

// Push push handler
type Push struct {
    tp.PushCtx
}

// Push handles '/push/status' message
func (p *Push) Status(arg *string) *tp.Rerror {
    tp.Printf("%s", *arg)
    return nil
}

处理错误的姿势

teleport 对于 Handler 的错误返回值，并没有采用 error 接口类型，而是定义了一个 Rerror 结构体：（用法见上面示例代码）

type Rerror struct {
    // Code error code
    Code int32
    // Message the error message displayed to the user (optional)
    Message string
    // Reason the cause of the error for debugging (optional)
    Reason string
}

这样设计有几个好处：

• Code 字段表示错误代号，类似 HTTP 状态码，有利于和 HTTP 协议完美兼容，同时也方便插件和客户端对错误类型快速判断与处理

• Message 字段用于给客户端的错误提示信息，可进行字符串格式的定制

• Reason 字段记录错误发生的原因甚至上下文，助力Debug

• 如果开发者需要与 error 接口交互，Rerror.ToError() error 方法可以实现

可能有人会问：为什么不直接实现 Rerror.Error() error ？因为我是故意的！原因则涉及到 interface 的一个经典的坑：(*Rerror)(nil) !=(error)(nil)。如果开发者不小心写出下面的代码，就掉坑里了：

var err error
err = sess.Call(...).Rerror()
if err != nil { // 此处掉坑里了，必定会进入错误处理逻辑，因为 (*Rerror)(nil) != (error)(nil) 永远成立
    ...
}

推荐：服务端定义一张全局的错误码表，方便于客户端对接以及错误Debug。比如这样的规则：

• 1 ≤ Code ≤ 999：框架错误，包括通信错误，具体可以与 HTTP 状态码保持一致
• 1000 ≤ Code ≤ 9999：基础服务错误
• 1000000 ≤ 999999：业务错误，前四位表示模块或服务，后两位表示当前模块或服务中错误序号

推荐一种很酷的项目结构

这是 tp-micro 中默认的项目组织结构，它有 micro gen 命令由模板自动构建。

├── README.md
├── __tp-micro__gen__.lock
├── __tp-micro__tpl__.go
├── config
│   └── config.yaml
├── config.go
├── internal
│   ├── handler
│   │   ├── call.tmp.go
│   │   └── push.tmp.go
│   └── model
│       ├── init.go
│       ├── mongo_meta.gen.go
│       ├── mysql_device.gen.go
│       ├── mysql_log.gen.go
│       └── mysql_user.gen.go
├── log
│   └── PID
├── main.go
├── router.gen.go
└── sdk
    ├── rerr.go
    ├── rpc.gen.go
    ├── rpc.gen_test.go
    ├── type.gen.go
    └── val.gen.go

该项目结构整体分为两部分。

一部分是对外公开的代码，都位于 sdk 目录下，比如 client 远程调用的函数就在这里。

剩余代码都是不对外公开的，属于 server 进程的部分，其中私有包 internal 下是 server 的主体业务逻辑部分。

这样设计的好处是：

• 外部调用者（一般是客户端）只能导入 sdk 包，其余的包要么在 internal 下被私有化，要么就是 main 包，都无法导入；从而起到了从语法级别隔离代码目的，有效地解决了误用代码、复杂依赖的问题
• 将 sdk 代码与 server 代码放在同一项目中，便于统一管理，减少更新时人为原因造成客户端与服务端接口对不上的情况

脚手架提升开发效率

在 tp-micro 中，提供了一个 micro 工具，介绍两个最常用的命令：

• 命令 micro gen 可以通过模板可以快速生成一个项目（上面提到的项目结构）
  • 其中包括 mysql、mongo、redis 相关的 model 层代码
  • README.md 中会自动写入接口文档等，便于交付给客户端同学
  • 支持覆盖更新部分代码，比如新增接口。
• 命令 micro run 可以自动编译运行指定项目，并在项目代码发生变化时自动进行平滑升级