代码拉取完成，页面将自动刷新
-27a5ea.svg?style=flat-square){kind=icon}
eRPC 是一个高效、可扩展且简单易用的 RPC 框架。
适用于 RPC、微服务、点对点长连接、IM 和游戏等领域。
go vesion ≥ 1.11
install
GO111MODULE=on go get -u -v -insecure github.com/andeya/erpc/v7
import "github.com/andeya/erpc/v7"
Header 和 Body 两部分组成Header 包含与 HTTP header 格式相同的 metadataBody 支持类似 Content Type 的自定义编解码器，已经实现的：
rawproto - 默认的高性能二进制协议jsonproto - JSON 消息协议pbproto - Ptotobuf 消息协议thriftproto - Thrift 消息协议httproto - HTTP 消息协议tcptcp4tcp6unixunixpacketkcpquic自测
一个服务端与一个客户端进程，在同一台机器上运行
CPU: Intel Xeon E312xx (Sandy Bridge) 16 cores 2.53GHz
Memory: 16G
OS: Linux 2.6.32-696.16.1.el6.centos.plus.x86_64, CentOS 6.4
Go: 1.9.2
信息大小: 581 bytes
信息编码：protobuf
发送 1000000 条信息
erpc
| 并发client | 平均值(ms) | 中位数(ms) | 最大值(ms) | 最小值(ms) | 吞吐率(TPS) |
|---|---|---|---|---|---|
| 100 | 1 | 0 | 16 | 0 | 75505 |
| 500 | 9 | 11 | 97 | 0 | 52192 |
| 1000 | 19 | 24 | 187 | 0 | 50040 |
| 2000 | 39 | 54 | 409 | 0 | 42551 |
| 5000 | 96 | 128 | 1148 | 0 | 46367 |
| 并发client | 平均值(ms) | 中位数(ms) | 最大值(ms) | 最小值(ms) | 吞吐率(TPS) |
|---|---|---|---|---|---|
| 100 | 0 | 0 | 14 | 0 | 225682 |
| 500 | 2 | 1 | 24 | 0 | 212630 |
| 1000 | 4 | 3 | 51 | 0 | 180733 |
| 2000 | 8 | 6 | 64 | 0 | 183351 |
| 5000 | 21 | 18 | 651 | 0 | 133886 |
对比测试
| Environment | Throughputs | Mean Latency | P99 Latency |
|---|---|---|---|
 |
 |
 |
 |
package main
import (
"fmt"
"time"
"github.com/andeya/erpc/v7"
)
func main() {
defer erpc.FlushLogger()
// graceful
go erpc.GraceSignal()
// server peer
srv := erpc.NewPeer(erpc.PeerConfig{
CountTime: true,
ListenPort: 9090,
PrintDetail: true,
})
// srv.SetTLSConfig(erpc.GenerateTLSConfigForServer())
// router
srv.RouteCall(new(Math))
// broadcast per 5s
go func() {
for {
time.Sleep(time.Second * 5)
srv.RangeSession(func(sess erpc.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 {
erpc.CallCtx
}
// Add handles addition request
func (m *Math) Add(arg *[]int) (int, *erpc.Status) {
// test meta
erpc.Infof("author: %s", m.PeekMeta("author"))
// add
var r int
for _, a := range *arg {
r += a
}
// response
return r, nil
}
package main
import (
"time"
"github.com/andeya/erpc/v7"
)
func main() {
defer erpc.SetLoggerLevel("ERROR")()
cli := erpc.NewPeer(erpc.PeerConfig{})
defer cli.Close()
// cli.SetTLSConfig(&tls.Config{InsecureSkipVerify: true})
cli.RoutePush(new(Push))
sess, stat := cli.Dial(":9090")
if !stat.OK() {
erpc.Fatalf("%v", stat)
}
var result int
stat = sess.Call("/math/add",
[]int{1, 2, 3, 4, 5},
&result,
erpc.WithAddMeta("author", "andeya"),
).Status()
if !stat.OK() {
erpc.Fatalf("%v", stat)
}
erpc.Printf("result: %d", result)
erpc.Printf("Wait 10 seconds to receive the push...")
time.Sleep(time.Second * 10)
}
// Push push handler
type Push struct {
erpc.PushCtx
}
// Push handles '/push/status' message
func (p *Push) Status(arg *string) *erpc.Status {
erpc.Printf("%s", *arg)
return nil
}
NOTE:
SetReadLimit
// Start a server
var peer1 = erpc.NewPeer(erpc.PeerConfig{
ListenPort: 9090, // for server role
})
peer1.Listen()
...
// Start a client
var peer2 = erpc.NewPeer(erpc.PeerConfig{})
var sess, err = peer2.Dial("127.0.0.1:8080")
结构体或方法名称到服务方法名称的默认映射（HTTPServiceMethodMapper）：
AaBb -> /aa_bb
ABcXYz -> /abc_xyz
Aa__Bb -> /aa_bb
aa__bb -> /aa_bb
ABC__XYZ -> /abc_xyz
Aa_Bb -> /aa/bb
aa_bb -> /aa/bb
ABC_XYZ -> /abc/xyz
erpc.SetServiceMethodMapper(erpc.HTTPServiceMethodMapper)
结构体或方法名称到服务方法名称的映射（RPCServiceMethodMapper）：
AaBb -> AaBb
ABcXYz -> ABcXYz
Aa__Bb -> Aa_Bb
aa__bb -> aa_bb
ABC__XYZ -> ABC_XYZ
Aa_Bb -> Aa.Bb
aa_bb -> aa.bb
ABC_XYZ -> ABC.XYZ
erpc.SetServiceMethodMapper(erpc.RPCServiceMethodMapper)
type Aaa struct {
erpc.CallCtx
}
func (x *Aaa) XxZz(arg *<T>) (<T>, *erpc.Status) {
...
return r, nil
}
// register the call route
// HTTP mapping: /aaa/xx_zz
// RPC mapping: Aaa.XxZz
peer.RouteCall(new(Aaa))
// or register the call route
// HTTP mapping: /xx_zz
// RPC mapping: XxZz
peer.RouteCallFunc((*Aaa).XxZz)
func XxZz(ctx erpc.CallCtx, arg *<T>) (<T>, *erpc.Status) {
...
return r, nil
}
// register the call route
// HTTP mapping: /xx_zz
// RPC mapping: XxZz
peer.RouteCallFunc(XxZz)
type Bbb struct {
erpc.PushCtx
}
func (b *Bbb) YyZz(arg *<T>) *erpc.Status {
...
return nil
}
// register the push handler
// HTTP mapping: /bbb/yy_zz
// RPC mapping: Bbb.YyZz
peer.RoutePush(new(Bbb))
// or register the push handler
// HTTP mapping: /yy_zz
// RPC mapping: YyZz
peer.RoutePushFunc((*Bbb).YyZz)
// YyZz register the handler
func YyZz(ctx erpc.PushCtx, arg *<T>) *erpc.Status {
...
return nil
}
// register the push handler
// HTTP mapping: /yy_zz
// RPC mapping: YyZz
peer.RoutePushFunc(YyZz)
func XxxUnknownCall (ctx erpc.UnknownCallCtx) (interface{}, *erpc.Status) {
...
return r, nil
}
// register the unknown pull route: /*
peer.SetUnknownCall(XxxUnknownCall)
func XxxUnknownPush(ctx erpc.UnknownPushCtx) *erpc.Status {
...
return nil
}
// register the unknown push route: /*
peer.SetUnknownPush(XxxUnknownPush)
// NewIgnoreCase Returns a ignoreCase plugin.
func NewIgnoreCase() *ignoreCase {
return &ignoreCase{}
}
type ignoreCase struct{}
var (
_ erpc.PostReadCallHeaderPlugin = new(ignoreCase)
_ erpc.PostReadPushHeaderPlugin = new(ignoreCase)
)
func (i *ignoreCase) Name() string {
return "ignoreCase"
}
func (i *ignoreCase) PostReadCallHeader(ctx erpc.ReadCtx) *erpc.Status {
// Dynamic transformation path is lowercase
ctx.UriObject().Path = strings.ToLower(ctx.UriObject().Path)
return nil
}
func (i *ignoreCase) PostReadPushHeader(ctx erpc.ReadCtx) *erpc.Status {
// Dynamic transformation path is lowercase
ctx.UriObject().Path = strings.ToLower(ctx.UriObject().Path)
return nil
}
// add router group
group := peer.SubRoute("test")
// register to test group
group.RouteCall(new(Aaa), NewIgnoreCase())
peer.RouteCallFunc(XxZz, NewIgnoreCase())
group.RoutePush(new(Bbb))
peer.RoutePushFunc(YyZz)
peer.SetUnknownCall(XxxUnknownCall)
peer.SetUnknownPush(XxxUnknownPush)
type PeerConfig struct {
Network string `yaml:"network" ini:"network" comment:"Network; tcp, tcp4, tcp6, unix, unixpacket, kcp or quic"`
LocalIP string `yaml:"local_ip" ini:"local_ip" comment:"Local IP"`
ListenPort uint16 `yaml:"listen_port" ini:"listen_port" comment:"Listen port; for server role"`
DialTimeout time.Duration `yaml:"dial_timeout" ini:"dial_timeout" comment:"Default maximum duration for dialing; for client role; ns,µs,ms,s,m,h"`
RedialTimes int32 `yaml:"redial_times" ini:"redial_times" comment:"The maximum times of attempts to redial, after the connection has been unexpectedly broken; Unlimited when <0; for client role"`
RedialInterval time.Duration `yaml:"redial_interval" ini:"redial_interval" comment:"Interval of redialing each time, default 100ms; for client role; ns,µs,ms,s,m,h"`
DefaultBodyCodec string `yaml:"default_body_codec" ini:"default_body_codec" comment:"Default body codec type id"`
DefaultSessionAge time.Duration `yaml:"default_session_age" ini:"default_session_age" comment:"Default session max age, if less than or equal to 0, no time limit; ns,µs,ms,s,m,h"`
DefaultContextAge time.Duration `yaml:"default_context_age" ini:"default_context_age" comment:"Default PULL or PUSH context max age, if less than or equal to 0, no time limit; ns,µs,ms,s,m,h"`
SlowCometDuration time.Duration `yaml:"slow_comet_duration" ini:"slow_comet_duration" comment:"Slow operation alarm threshold; ns,µs,ms,s ..."`
PrintDetail bool `yaml:"print_detail" ini:"print_detail" comment:"Is print body and metadata or not"`
CountTime bool `yaml:"count_time" ini:"count_time" comment:"Is count cost time or not"`
}
SetMessageSizeLimit 设置报文大小的上限， 如果 maxSize<=0，上限默认为最大 uint32
func SetMessageSizeLimit(maxMessageSize uint32)
SetSocketKeepAlive 是否允许操作系统的发送TCP的keepalive探测包
func SetSocketKeepAlive(keepalive bool)
SetSocketKeepAlivePeriod 设置操作系统的TCP发送keepalive探测包的频度
func SetSocketKeepAlivePeriod(d time.Duration)
SetSocketNoDelay 是否禁用Nagle算法，禁用后将不在合并较小数据包进行批量发送，默认为禁用
func SetSocketNoDelay(_noDelay bool)
SetSocketReadBuffer 设置操作系统的TCP读缓存区的大小
func SetSocketReadBuffer(bytes int)
SetSocketWriteBuffer 设置操作系统的TCP写缓存区的大小
func SetSocketWriteBuffer(bytes int)
| package | import | description |
|---|---|---|
| json | "github.com/andeya/erpc/v7/codec" |
JSON codec(erpc own) |
| protobuf | "github.com/andeya/erpc/v7/codec" |
Protobuf codec(erpc own) |
| thrift | "github.com/andeya/erpc/v7/codec" |
Form(url encode) codec(erpc own) |
| xml | "github.com/andeya/erpc/v7/codec" |
Form(url encode) codec(erpc own) |
| plain | "github.com/andeya/erpc/v7/codec" |
Plain text codec(erpc own) |
| form | "github.com/andeya/erpc/v7/codec" |
Form(url encode) codec(erpc own) |
| package | import | description |
|---|---|---|
| auth | "github.com/andeya/erpc/v7/plugin/auth" |
An auth plugin for verifying peer at the first time |
| binder | "github.com/andeya/erpc/v7/plugin/binder" |
Parameter Binding Verification for Struct Handler |
| heartbeat | "github.com/andeya/erpc/v7/plugin/heartbeat" |
A generic timing heartbeat plugin |
| proxy | "github.com/andeya/erpc/v7/plugin/proxy" |
A proxy plugin for handling unknown calling or pushing |
| secure | "github.com/andeya/erpc/v7/plugin/secure" |
Encrypting/decrypting the message body |
| overloader | "github.com/andeya/erpc/v7/plugin/overloader" |
A plugin to protect erpc from overload |
| package | import | description |
|---|---|---|
| rawproto | "github.com/andeya/erpc/v7/proto/rawproto |
一个高性能的通信协议（erpc默认） |
| jsonproto | "github.com/andeya/erpc/v7/proto/jsonproto" |
JSON 格式的通信协议 |
| pbproto | "github.com/andeya/erpc/v7/proto/pbproto" |
Protobuf 格式的通信协议 |
| thriftproto | "github.com/andeya/erpc/v7/proto/thriftproto" |
Thrift 格式的通信协议 |
| httproto | "github.com/andeya/erpc/v7/proto/httproto" |
HTTP 格式的通信协议 |
| package | import | description |
|---|---|---|
| gzip | "github.com/andeya/erpc/v7/xfer/gzip" |
Gzip(erpc own) |
| md5 | "github.com/andeya/erpc/v7/xfer/md5" |
Provides a integrity check transfer filter |
| package | import | description |
|---|---|---|
| multiclient | "github.com/andeya/erpc/v7/mixer/multiclient" |
Higher throughput client connection pool when transferring large messages (such as downloading files) |
| websocket | "github.com/andeya/erpc/v7/mixer/websocket" |
Makes the eRPC framework compatible with websocket protocol as specified in RFC 6455 |
| evio | "github.com/andeya/erpc/v7/mixer/evio" |
A fast event-loop networking framework that uses the erpc API layer |
| html | html "github.com/xiaoenai/tp-micro/helper/mod-html" |
HTML render for http client |
| project | description |
|---|---|
| TP-Micro | TP-Micro 是一个基于 eRPC 定制的、简约而强大的微服务框架 |
| Pholcus | Pholcus（幽灵蛛）是一款纯Go语言编写的支持分布式的高并发、重量级爬虫软件，定位于互联网数据采集，为具备一定Go或JS编程基础的人提供一个只需关注规则定制的功能强大的爬虫工具 |
eRPC 项目采用商业应用友好的 Apache2.0 协议发布
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型