一个小巧但强大的 RPC 框架
qrpc 提供完整的服务端及客户端功能,并支持以下4种特性使得rpc变得极为容易:
阻塞或非阻塞流式或非流式主动推送双向调用
默认是阻塞模式,也就是同一个长链接的请求是串行处理,类似http/1.1,但是通过微小的改动就可以切换到其他模式。
此外,qrpc还提供了桥接网络的特性,该特性使得多协议支持不费吹灰之力,同样的一套代码可以同时跑在tcp、websocket及任意已有的协议之下,详情参考ws/README.md;以及代码生成功能,使得服务的注册和调用极大地便利化,详情参考codegen demo。
这里是ppt版。
qrpc提供请求->响应以及主动推送两大类的交互能力。
请求->响应又分为「阻塞 或 非阻塞」以及「流式 或 非流式」。
qrpc的请求和响应有相同的结构:帧,即代码中的Frame。
每个帧包括8字节的唯一标识,1字节的flag,3字节的命令,以及不超过可配置上限长度的负荷。
客户端会为每个请求帧自动生成8字节的唯一标识,服务端对应的响应帧会有相同的唯一标识。
通过这种方式,一个长链接可以同时发起多个请求,并且精确地知道每个请求对应的响应结果。
此外,请求和响应都可以由多个帧组成,类似http中的chunked传输模式,这就是前面提到的流式或非流式。
而所有关于是否阻塞、是否流式、是否主动推送的元信息,都包含在头部1字节的flag之中!
具体字段参考frame.md。
server.go:…client.go:package main
import (
"fmt"
"github.com/zhiqiangxu/qrpc"
)
const (
HelloCmd qrpc.Cmd = iota
)
func main() {
// 采用默认配置
conf := qrpc.ConnectionConfig{}
// 建立一个qrpc的长链接
conn, _ := qrpc.NewConnection("0.0.0.0:8080", conf, nil)
// 发起一个命令为HelloCmd的请求帧,flag空,负荷为xu
_, resp, _ := conn.Request(HelloCmd, 0/*no flags*/, []byte("xu"))
// 获取响应
frame, _ := resp.GetFrame()
// 打印响应负荷
fmt.Println("resp is", string(frame.Payload))
}上面的例子中,由于flag为空,所以服务端会采用默认的串行处理模式。
要使用该模式,只需要修改client.go的一行代码:
- _, resp, _ := conn.Request(HelloCmd, 0/*no flags*/, []byte("xu"))
+ _, resp, _ := conn.Request(HelloCmd, qrpc.NBFlag, []byte("xu"))这样服务端便会并行处理这个长链接发来的请求!
类似http中的chunked传输模式,不论请求还是响应,都可以拆成多个帧。
下面按流式请求和流式响应分别介绍。
streamclient.go:…streamserver.go:package main
import (
"github.com/zhiqiangxu/qrpc"
)
const (
HelloCmd qrpc.Cmd = iota
HelloRespCmd
)
func main() {
handler := qrpc.NewServeMux()
handler.HandleFunc(HelloCmd, func(writer qrpc.FrameWriter, request *qrpc.RequestFrame) {
// 首帧的处理类似非流式,只是EndWrite最后才会调用
writer.StartWrite(request.RequestID, HelloRespCmd, 0)
writer.WriteBytes(append([]byte("first frame "), request.Payload...))
// 循环取出流式请求中的剩余帧
for {
continueFrames := PS:扫码请注明来意,比如:学习`qrpc`或者`go`爱好者
## Stargazers暂无开放 Issues,或尚未同步最近议题。