erpc

README

erpc

一个简易、优雅的 rpc 框架

安装

go get github.com/edte/erpc

抽象

客户端                  服务端
client     <---->       server

     ----   request  --- >
     <---   response ---


一次 request+response = context

而每次发送的 request 或 response 都分为 header、body

主要目录

• client: 客户端实现
• server: 服务端实现
• center：注册中心实现
• codec: 编码方式实现
• protocol: 网络协议设计
• transport: 底层网络支撑，包括连接池，连接事务等

使用

过程

1. 创建服务传输协议（默认 pb），可使用 webhook 自动部署到 github
2. 部署注册中心 center
3. 部署服务模块 server
4. 部署客户端模块 client

例子

go run ./demo/center/center.go
go run ./demo/server/server.go
go run ./demo/client/client.go

快速开始

center

func main() {
	erpc.ListenCenter()
}

server

func handleHello(c *transport.Context) {
	rsp := c.Response.(*demo.HelloResponse)

	rsp.Msg = "hello world"
	fmt.Println(rsp.Msg)
}

func main() {
	erpc.Handle("demo.hello", handleHello, &demo.HelloRequest{}, &demo.HelloResponse{})
	erpc.Listen(":8877")
}

client

func main() {
    req := demo.HelloRequest{}
    rsp := demo.HelloResponse{}
    
    ctx, _ := context.WithTimeout(context.Background(), time.Second*5)
    
    if err := erpc.Call(ctx, "demo.hello", &req, &rsp); err != nil {
    	panic(fmt.Sprintf("call demo.hello failed, error:%s", err))
    }

    fmt.Println(rsp.Msg)
}

todo

• 客户端实现
• 服务端实现
• 注册中心实现
• 支持多种编码方式
• 网络协议设计
• 增加超时处理
• 心跳检测功能
• 支持多种负载均衡算法
• 实现连接池
• 实现链路追踪日志管理
• 自定义序列化协议实现
• 熔断机制
• 自定义网络模型
• 协程池实现
• 把负载均衡从 center 拆分出来单独作为一个新的服务
• center 支持路由功能
• center 支持多机房部署

现有问题

1. server 死循环 client 断开之后，server 之前 accept 的那个协程会一直轮询，考虑优化掉(方案1：解码编码处优化，方案2：线程池优化，考虑关闭 client 后就自动) sever 就关闭该协程

2. 注册中心地址 怎么知道注册中心地址，这是一个问题，也就是说，server 向 center 请求其他 server 的地址，前提是知道 center 的地址在哪，这个要看怎么实现，不可能 ip 写死到代码中，因为 center 也是一个集群，本项目暂时吧 center 作为基础服务，每个 server 部署的机器上都有一个 center，所以固定 center 的监听端口，然后 server 请求时向这个默认端口请求即可。 但是问题也有很多，比如每台机器上都部署 center 这种方式好吗？并且，center 之间的同步怎么做？（考虑加 redis 缓存？感觉不太好，还是一般的分布式同步算法？待重新设计）

Documentation

Index

• Variables
• func Call(ctx context.Context, addr string, req interface{}, rsp interface{}) (err error)
• func Handle(partten string, handler server.HandlerFunc, req interface{}, rsp interface{})
• func Listen(addr string)
• func ListenCenter()

Variables

var (
	DefaultClient = client.NewClient()
)

Functions

func Call

func Call(ctx context.Context, addr string, req interface{}, rsp interface{}) (err error)

func Handle

func Handle(partten string, handler server.HandlerFunc, req interface{}, rsp interface{})

func Listen

func Listen(addr string)

func ListenCenter

func ListenCenter()