gnet: 轻量级且高性能的 Golang 网络库

原创
2019/09/16 23:32
阅读数 316

项目主页

https://github.com/panjf2000/gnet

欢迎大家围观~~,目前还在持续更新,感兴趣的话可以 star 一下暗中观察哦。

简介

gnet 是一个基于 Event-Loop 事件驱动的高性能和轻量级网络库。这个库直接使用 epoll[1] 和 kqueue[2] 系统调用而非标准 Golang 网络包:net[3] 来构建网络应用,它的工作原理类似两个开源的网络库:libuv[4] 和 libevent[5]

这个项目存在的价值是提供一个在网络包处理方面能和 Redis[6]Haproxy[7] 这两个项目具有相近性能的Go 语言网络服务器框架。

gnet 的亮点在于它是一个高性能、轻量级、非阻塞的纯 Go 实现的传输层(TCP/UDP/Unix-Socket)网络库,开发者可以使用 gnet 来实现自己的应用层网络协议,从而构建出自己的应用层网络应用:比如在 gnet 上实现 HTTP 协议就可以创建出一个 HTTP 服务器 或者 Web 开发框架,实现 Redis 协议就可以创建出自己的 Redis 服务器等等。

gnet 衍生自另一个项目:evio,但是性能更好。

功能

高性能[8] 的基于多线程模型的 Event-Loop 事件驱动内置 Round-Robin 轮询负载均衡算法简洁的 APIs基于 Ring-Buffer 的高效内存利用支持多种网络协议:TCP、UDP、Unix Sockets支持两种事件驱动机制:Linux 里的 epoll 以及 FreeBSD 里的 kqueue支持异步写操作允许多个网络监听地址绑定在一个 Event-Loop 上灵活的事件定时器SO_REUSEPORT 端口重用

核心设计

多线程模型

gnet 重新设计开发了一个新内置的多线程模型:『主从 Reactor 多线程』,这也是 netty 默认的线程模型,下面是这个模型的原理图:

它的运行流程如下面的时序图:

现在我正在 gnet 里开发一个新的多线程模型:『带线程/go程池的主从 Reactors 多线程』,并且很快就能完成,这个模型的架构图如下所示:

它的运行流程如下面的时序图:

通信机制

gnet 的『主从 Reactors 多线程』模型是基于 Golang 里的 Goroutines的,一个 Reactor 挂载在一个 Goroutine 上,所以在 gnet 的这个网络模型里主 Reactor/Goroutine 与从 Reactors/Goroutines 有海量通信的需求,因此 gnet 里必须要有一个能在 Goroutines 之间进行高效率的通信的机制,我没有选择 Golang 里的主流方案:基于 Channel 的 CSP 模型,而是选择了性能更好、基于 Ring-Buffer 的 Disruptor 方案。

所以我最终选择了 go-disruptor[9]:高性能消息分发队列 LMAX Disruptor 的 Golang 实现。

自动扩容的 Ring-Buffer

gnet 利用 Ring-Buffer 来缓存 TCP 流数据以及管理内存使用。

开始使用

安装

$ go get -u github.com/panjf2000/gnet

使用示例

// ======================== Echo Server implemented with gnet ===========================

package main

import (
    "flag"
    "fmt"
    "log"
    "strings"

    "github.com/panjf2000/gnet"
    "github.com/panjf2000/gnet/ringbuffer"
)

func main() {
    var port int
    var loops int
    var udp bool
    var trace bool
    var reuseport bool

    flag.IntVar(&port, "port"5000"server port")
    flag.BoolVar(&udp, "udp"false"listen on udp")
    flag.BoolVar(&reuseport, "reuseport"false"reuseport (SO_REUSEPORT)")
    flag.BoolVar(&trace, "trace"false"print packets to console")
    flag.IntVar(&loops, "loops"0"num loops")
    flag.Parse()

    var events gnet.Events
    events.NumLoops = loops
    events.OnInitComplete = func(srv gnet.Server) (action gnet.Action) {
        log.Printf("echo server started on port %d (loops: %d)", port, srv.NumLoops)
        if reuseport {
            log.Printf("reuseport")
        }
        return
    }
    events.React = func(c gnet.Conn, inBuf *ringbuffer.RingBuffer) (out []byte, action gnet.Action) {
        top, tail := inBuf.PreReadAll()
        out = append(top, tail...)
        inBuf.Reset()

        if trace {
            log.Printf("%s", strings.TrimSpace(string(top)+string(tail)))
        }
        return
    }
    scheme := "tcp"
    if udp {
        scheme = "udp"
    }
    log.Fatal(gnet.Serve(events, fmt.Sprintf("%s://:%d", scheme, port)))
}

I/O 事件

gnet 目前支持的 I/O 事件如下:

OnInitComplete 当 server 初始化完成之后调用。OnOpened 当连接被打开的时候调用。OnClosed 当连接被关闭的时候调用。OnDetached 当主动摘除连接的时候的调用。React 当 server 端接收到从 client 端发送来的数据的时候调用。(你的核心业务代码一般是写在这个方法里)Tick 服务器启动的时候会调用一次,之后就以给定的时间间隔定时调用一次,是一个定时器方法。PreWrite 预先写数据方法,在 server 端写数据回 client 端之前调用。

性能测试

Linux (epoll)

系统参数

Go Version: go1.12.9 linux/amd64OS:         Ubuntu 18.04CPU:        8 Virtual CPUsMemory:     16.0 GiB

Echo Server

HTTP Server

FreeBSD (kqueue)

系统参数

Go Version: go version go1.12.9 darwin/amd64OS:         macOS Mojave 10.14.6CPU:        4 CPUsMemory:     8.0 GiB

Echo Server

HTTP Server

证书

gnet 的源码允许用户在遵循 MIT 开源证书[10] 规则的前提下使用。

待做事项

gnet 还在持续开发的过程中,所以这个仓库的代码和文档会一直持续更新,如果你对 gnet 感兴趣的话,欢迎给这个开源库贡献你的代码~~

References

[1] epoll: https://en.wikipedia.org/wiki/Epoll
[2] kqueue: https://en.wikipedia.org/wiki/Kqueue
[3] net: https://golang.org/pkg/net/
[4] libuv: https://github.com/libuv/libuv
[5] libevent: https://github.com/libevent/libevent
[6] Redis: http://redis.io
[7] Haproxy: http://www.haproxy.org
[8] 高性能: #性能测试
[9] go-disruptor: https://github.com/smartystreets-prototypes/go-disruptor
[10] 开源证书: /https://github.com/panjf2000/gnet/blob/master/LICENSE


本文分享自微信公众号 - 潘建锋(R136a1_Pan)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部