brpc/docs/cn/http_derivatives.md
2022-12-14 20:13:26 +08:00

1.8 KiB
Raw Permalink Blame History

English version

http/h2协议的基本用法见http_clienthttp_service

下文中的小节名均为可填入ChannelOptions.protocol中的协议名。冒号后的内容是协议参数用于动态选择衍生行为但基本协议仍然是http/1.x或http/2故这些协议在服务端只会被显示为http或h2/h2c。

http:json, h2:json

如果pb request不为空则会被转为json并作为http/h2请求的body此时Controller.request_attachment()必须为空否则报错。

如果pb response不为空则会以json解析http/h2回复的body并转填至pb response的对应字段。

http/1.x默认是这个行为所以"http"和"http:json"等价。

http:proto, h2:proto

如果pb request不为空则会把pb序列化结果作为http/h2请求的body此时Controller.request_attachment()必须为空否则报错。

如果pb response不为空则会以pb序列化格式解析http/h2回复的body并填至pb response。

http/2默认是这个行为所以"h2"和"h2:proto"等价。

h2:grpc

gRPC的默认协议,具体格式可阅读gRPC over HTTP2

使用brpc的客户端把ChannelOptions.protocol设置为"h2:grpc"一般就能连通gRPC。

使用brpc的服务端一般无需修改代码即可自动被gRPC客户端访问。

gRPC默认序列化是pb二进制格式所以"h2:grpc"和"h2:grpc+proto"等价。

TODO: gRPC其他配置

h2:grpc+json

这个协议相比h2:grpc就是用json序列化结果代替pb序列化结果。gRPC未必直接支持这个格式如grpc-go用户可参考这里注册相应的codec后才支持。