grpc使用,方便自己复习

本文介绍了gRPC这一RPC框架的四种主要调用方式:简单的RPC调用、客户端流式调用、服务端流式调用及双向流式调用,并提供了配置maven插件以支持gRPC的示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

grpc是一个rpc调用框架,使用与thrift相同的设计,通过工具生成响应必要的代码,实现其生成代码的接口,配置grpc服务端与客户端机型工作.

这里就不说proto文件的写法,主要是提醒自己grpc的四种调用方式:

1.rpc

    就是简单的方法调用,返回响应的response.

2.客户端流式

    rpc sendErrorLogMessageRequestStream (stream SendErrorLogRequest) returns (SendMessageResponse) {}

    //客户端可以发送多个消息,服务端返回一次消息

3.服务端式

    rpc sendErrorLogMessageResponseStream (SendErrorLogRequest) returns (stream SendMessageResponse) {}

    //客户端发送一次消息,服务端可以返回多次消息

4.双向流式

    rpc sendErrorLogMessageStream (stream SendErrorLogRequest) returns (stream SendMessageResponse) {}

    //服务端与客户端互相监听

grpc maven插件

    <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.5.0</version>
                <configuration>
                    <!--
                      The version of protoc must match protobuf-java. If you don't depend on
                      protobuf-java directly, you will be transitively depending on the
                      protobuf-java version that grpc depends on.
                    -->
                    <protocArtifact>com.google.protobuf:protoc:3.0.0:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.0.1:exe:${os.detected.classifier}</pluginArtifact>
                    <protoSourceRoot>src/main/resources/helloproto</protoSourceRoot>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

中文文档地址: http://doc.oschina.net/grpc?t=57966

<think>嗯,我现在要写一篇关于gRPC使用攻略的介绍。用户需要结构清晰,分步骤解决问题,同时内容真实可靠。首先,我应该先回忆一下自己对gRPC的了解,然后整理出主要的点,确保不遗漏关键内容。 首先,gRPC是什么?它是一个高性能、开源的RPC框架,由Google开发,基于HTTP/2和Protocol Buffers。那RPC又是什么呢?远程过程调用,允许像调用本地函数一样调用远程服务。这点需要解释清楚,因为可能有些读者不熟悉这个概念。 接下来,gRPC的核心特性。比如基于HTTP/2,支持双向流、多路复用;使用Protocol Buffers作为IDL,高效序列化;支持多种编程语言;还有四种通信模式,这个要详细说明。可能用户会关心这些特性带来的好处,比如性能提升,跨语言支持等。 然后是使用步骤。第一步应该是定义服务接口,也就是编写.proto文件。这部分需要详细说明语法,比如如何定义service、rpc方法、消息类型。比如一个简单的例子,定义一个Hello服务,里面有个SayHello的rpc方法,接收HelloRequest,返回HelloResponse。这里要注意语法正确,比如message的结构,字段类型和编号。 第二步是生成代码,使用protoc编译器配合gRPC插件生成对应语言的代码。需要提到常用的语言,比如Go、Java、Python等,以及如何安装protoc工具,生成命令的例子,比如protoc --go_out=. --go-grpc_out=. *.proto。 第三步是实现服务端。需要举一个例子,比如用Go语言实现服务接口,创建gRPC服务器,注册服务,监听端口,启动服务器。代码示例可能对用户有帮助,但要注意不要出错,同时用中文解释每一步的作用。 第四步是实现客户端。同样用例子说明如何创建连接,创建客户端实例,调用远程方法,处理响应。这里要强调客户端如何像调用本地方法一样使用远程服务。 第五步是运行和测试,确保服务端和客户端能正常通信,可以补充测试方法,比如使用grpcurl工具或者编写单元测试。 接下来要讲通信模式,四种类型:简单RPC、服务端流式、客户端流式、双向流式。每种模式的应用场景和示例,比如简单RPC适合一次性请求响应,流式适合大数据传输或实时通信。这部分可能需要用不同的.proto定义来展示,比如在rpc方法中使用stream关键字。 然后是关键技术点:Protocol Buffers的高效序列化,HTTP/2的优势,拦截器的作用,比如认证、日志、监控,还有超时和错误处理的重要性。需要详细说明每个技术点如何应用,比如设置超时时间,处理状态码。 最后是注意事项,比如版本兼容性,.proto文件的维护,性能优化方法,比如连接复用、压缩,以及安全方面的TLS加密和身份验证。 在组织内容时,需要确保结构清晰,分步骤讲解,每个部分有必要的示例和解释。同时,注意使用中文,避免专业术语过于晦涩,必要时进行解释。可能还需要检查是否有遗漏的部分,比如负载均衡、服务发现等高级话题,但根据用户的要求,可能基础攻略不需要深入这些,但可以简要提及扩展方向。 还要注意LaTeX格式的问题,用户提到行内公式用$...$,独立公式用$$...$$,但在这个主题中可能数学公式不多,但如果有涉及性能数据或公式,需要正确应用格式。不过gRPC攻略可能较少涉及数学表达式,所以这部分可能用不上,但需要留意用户可能的隐藏要求。 最后总结一下,确保内容覆盖了gRPC的核心概念、使用步骤、关键技术和注意事项,结构层次分明,帮助用户从零开始使用gRPC,并解决可能遇到的问题。</think>以下是一份结构清晰的gRPC使用攻略,分步骤解析核心用法及注意事项: --- ### 一、gRPC基础概念 1. **定义** gRPC是Google开源的高性能RPC框架,基于**HTTP/2协议**和**Protocol Buffers**(Protobuf)实现,支持跨语言调用。 2. **核心特性** - 多语言支持(如Go、Java、Python等) - 双向流式通信 - 高效的序列化(Protobuf) - 内置负载均衡、重试、超时机制 --- ### 二、使用步骤详解 #### 步骤1:定义服务接口(.proto文件) ```protobuf syntax = "proto3"; service Greeter { rpc SayHello (HelloRequest) returns (HelloResponse) {} } message HelloRequest { string name = 1; } message HelloResponse { string message = 1; } ``` - **关键语法** - `service`定义服务,`rpc`定义方法 - `message`定义请求/响应结构 - 字段编号(如`=1`)需唯一且不可重复 #### 步骤2:生成代码 安装编译器`protoc`和对应语言插件(以Go为例): ```bash protoc --go_out=. --go-grpc_out=. *.proto ``` 生成代码包含: - 客户端存根(Stub) - 服务端接口 #### 步骤3:实现服务端 ```go type server struct { pb.UnimplementedGreeterServer } func (s *server) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloResponse, error) { return &pb.HelloResponse{Message: "Hello " + req.Name}, nil } // 启动服务 lis, _ := net.Listen("tcp", ":50051") s := grpc.NewServer() pb.RegisterGreeterServer(s, &server{}) s.Serve(lis) ``` #### 步骤4:实现客户端 ```go conn, _ := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials())) client := pb.NewGreeterClient(conn) resp, _ := client.SayHello(context.Background(), &pb.HelloRequest{Name: "World"}) fmt.Println(resp.Message) // 输出:Hello World ``` #### 步骤5:运行与测试 - 启动服务端:`go run server.go` - 运行客户端验证结果 - 推荐工具:`grpcurl`(命令行测试)、BloomRPC(GUI工具) --- ### 三、4种通信模式 1. **简单RPC(Unary)** 一请求一响应,示例见上文。 2. **服务端流式(Server Streaming)** ```protobuf rpc StreamData (Request) returns (stream Response) {} ``` 3. **客户端流式(Client Streaming)** ```protobuf rpc UploadData (stream Request) returns (Response) {} ``` 4. **双向流式(Bidirectional Streaming)** ```protobuf rpc Chat (stream Message) returns (stream Message) {} ``` --- ### 四、关键技术点 1. **Protocol Buffers优化** - 使用`repeated`定义数组 - 通过`oneof`实现联合类型 2. **HTTP/2优势** - 多路复用降低延迟 - 头部压缩减少带宽占用 3. **拦截器(Interceptor)** - 客户端拦截器:实现认证、日志 - 服务端拦截器:限流、监控 4. **错误处理** - 使用`status`包返回错误码: ```go return nil, status.Error(codes.NotFound, "data not found") ``` --- ### 五、注意事项 1. **版本兼容性** 确保`protoc`编译器与gRPC库版本匹配。 2. **性能优化** - 复用gRPC连接(避免频繁创建) - 启用压缩:`grpc.UseCompressor("gzip")` 3. **安全配置** - 服务端启用TLS: ```go creds := credentials.NewServerTLSFromCert(cert) s := grpc.NewServer(grpc.Creds(creds)) ``` --- ### 六、扩展场景 - **服务发现**:集成Consul/Etcd - **负载均衡**:客户端权重轮询 - **网关代理**:搭配gRPC-Gateway暴露HTTP接口 --- 通过以上步骤和技巧,可快速掌握gRPC的核心用法。建议从简单RPC入手,逐步尝试流式通信和高级特性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值