GRPC使用之HelloWorld

使用grpc的好处是提供高效的序列化能力，能够跨语言进行调用。这一节我们来学习grpc的入门应用，整篇文章分成3部分:

  1. 接口定义，使用grpc的IDL，创建proto文件，编译/生成grpc文件
  2. 服务端开发，处理客户端请求，并返回响应
  3. 客户端开发，发送请求，并接收服务端响应

根据上面的拆分，我们将grpc的项目拆分为3个工程，分别是:

  1. demo-grpc-proto，用于存放.proto文件，生成jar包供其他工程使用
  2. demo-grpc-server，引用proto，创建grpc的server
  3. demo-grpc-client，引用proto，调用grpc的server端

1. 接口定义

1. 初始化项目

先通过mvn archetype:generate从quickstart生成一个极简的Maven项目

mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DgroupId=org.keyniu -DartifactId=DemoGrpcProto -Dversion=0.1 -Dpackage=org.keyniu -DinteractiveMode=false

引入grpc的Maven依赖以及打包插件，插件略复杂，主要的目的是为了将grpc生成的代码直接打包进当前工程的jar，暂时忽略具体含义即可。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>org.keyniu.proto</groupId><artifactId>demo-grpc-proto</artifactId><version>1.0-SNAPSHOT</version><packaging>jar</packaging><name>DemoGrpcProto</name><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><maven.compiler.source>1.8</maven.compiler.source><maven.compiler.target>1.8</maven.compiler.target></properties><dependencies><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>3.8.1</version><scope>test</scope></dependency><dependency><groupId>io.grpc</groupId><artifactId>grpc-netty-shaded</artifactId><version>1.64.0</version><scope>runtime</scope></dependency><dependency><groupId>io.grpc</groupId><artifactId>grpc-protobuf</artifactId><version>1.64.0</version></dependency><dependency><groupId>io.grpc</groupId><artifactId>grpc-stub</artifactId><version>1.64.0</version></dependency><dependency> <!-- necessary for Java 9+ --><groupId>org.apache.tomcat</groupId><artifactId>annotations-api</artifactId><version>6.0.53</version><scope>provided</scope></dependency></dependencies><build><sourceDirectory>${basedir}/src/main/java</sourceDirectory><testSourceDirectory>${basedir}/src/test/java</testSourceDirectory><extensions><extension><groupId>kr.motd.maven</groupId><artifactId>os-maven-plugin</artifactId><version>1.7.1</version></extension></extensions><plugins><plugin><groupId>org.xolstice.maven.plugins</groupId><artifactId>protobuf-maven-plugin</artifactId><version>0.6.1</version><configuration><protocArtifact>com.google.protobuf:protoc:3.25.1:exe:${os.detected.classifier}</protocArtifact><pluginId>grpc-java</pluginId><pluginArtifact>io.grpc:protoc-gen-grpc-java:1.64.0:exe:${os.detected.classifier}</pluginArtifact></configuration><executions><execution><goals><goal>compile</goal><goal>compile-custom</goal></goals></execution></executions></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.8.1</version><configuration><source>${maven.compiler.source}</source><target>${maven.compiler.target}</target><generatedSourcesDirectory>${project.build.directory}/generated-sources/protobuf/grpc-java</generatedSourcesDirectory><generatedSourcesDirectory>${project.build.directory}/generated-sources/protobuf/java</generatedSourcesDirectory></configuration></plugin><plugin><artifactId>maven-jar-plugin</artifactId><version>3.2.0</version><configuration><archive><addMavenDescriptor>false</addMavenDescriptor></archive></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-source-plugin</artifactId><version>3.2.1</version><executions><execution><id>attach-sources</id><goals><goal>jar-no-fork</goal></goals></execution></executions></plugin></plugins></build>
</project>

2. 编辑proto文件

proto文件定义了grpc的接口、出参、入参，这里我们定义了4个接口，分别是对应grpc basic tutorial的4种模式:

  1. 基本调用
  2. Server端Streaming
  3. Client端Streaming
  4. 双向Streaming
    文件名是helloworld.proto，路径是 src/main/proto/helloworld.proto，文件内容:
syntax = "proto3";option java_multiple_files = true;
option java_package = "org.keyniu.grpc.generate";
//option java_outer_classname = "HelloWorldProto";
//option objc_class_prefix = "HLW";// The greeting service definition.
service Greeter {rpc sayHello (HelloRequest) returns (HelloReply) {}rpc sayHelloClientStream (stream HelloRequest) returns (HelloReply) {}rpc sayHelloServerStream (HelloRequest) returns (stream HelloReply) {}rpc sayHelloBiStream (stream HelloRequest) returns (stream HelloReply) {}
}// The request message containing the user's name.
message HelloRequest {string name = 1;
}// The response message containing the greetings
message HelloReply {string message = 1;
}

3. 编译proto文件

通过Maven命令，生成grpc的请求/响应对象，以及grpc调用对象

mvn protobuf:compile protobuf:compile-custom

生成的文件结构如下在这里插入图片描述

4. 打包代码

protobuff-maven-plugin生成的代码默认在target/generated-source/protobuff/java下，该代码不会打包到当前工程的jar中，解决方案有两种

1. 换生成目录

可以将生成代码的目录放到src/main/java下，这样我们在package的时候就会包含这部分代码。通过pom.xml指定生成目录

<plugin>  <groupId>org.xolstice.maven.plugins</groupId>  <artifactId>protobuf-maven-plugin</artifactId>  <version>0.6.1</version>  <configuration>  <protocArtifact>com.google.protobuf:protoc:3.25.1:exe:${os.detected.classifier}</protocArtifact>  <pluginId>grpc-java</pluginId>  <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.64.0:exe:${os.detected.classifier}</pluginArtifact>  <outputDirectory>src/main/java</outputDirectory>  </configuration>  <executions>  <execution>  <goals>  <goal>compile</goal>  <goal>compile-custom</goal>  </goals>  </execution>  </executions>  
</plugin>
2. 改编译插件

直接将代码生成到src/main/java下的问题是生成的代码和手动编辑的代码冲突，而且我们无法分辨哪些是生成的，哪些自己编辑的。前面我们给出的完整配置，目的就是打包的时候将generated-source种protobuff的代码包含在jar中

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.8.1</version><configuration><source>${maven.compiler.source}</source><target>${maven.compiler.target}</target><generatedSourcesDirectory>${project.build.directory}/generated-sources/protobuf/grpc-java</generatedSourcesDirectory><generatedSourcesDirectory>${project.build.directory}/generated-sources/protobuf/java</generatedSourcesDirectory></configuration>
</plugin>

正常的执行mvn clean package就能完成打包，打包后的文件结构如下图所示
在这里插入图片描述

2. 服务端

1. 初始化项目

通过achetype:generate生成一个最简单的项目

mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DgroupId=org.keyniu.server-DartifactId=demo-grpc-server -Dversion=0.1 -Dpackage=org.keyniu.server-DinteractiveMode=false

之前我们创建了接口定义的项目demo-grpc-proto，在demo-grpc-server要引入它的依赖

<dependency><groupId>org.keyniu.proto</groupId><artifactId>demo-grpc-proto</artifactId><version>1.0-SNAPSHOT</version>
</dependency>

2. 实现Server

proto生成的时候，根据我们定义的service名称(例子中是Greeter)， 自动生成了一个GreeterGrpc类
在这里插入图片描述

要实现service Greeter服务端的逻辑，需要继承Greeter.GreeterImplBase类，下面我们来看一下每个方法的具体实现

public class GreeterServer extends GreeterGrpc.GreeterImplBase {public void sayHello(HelloRequest request, StreamObserver<HelloReply> observer) {super.sayHello(request, observer);}public StreamObserver<HelloRequest> sayHelloClientStream(StreamObserver<HelloReply> responseObserver) {return super.sayHelloClientStream(responseObserver);}public void sayHelloServerStream(HelloRequest request, StreamObserver<HelloReply> responseObserver) {super.sayHelloServerStream(request, responseObserver);}public StreamObserver<HelloRequest> sayHelloBiStream(StreamObserver<HelloReply> responseObserver) {return super.sayHelloBiStream(responseObserver);}
}
1. 基本调用

基本调用的实现逻辑清晰，通过处理入参HelloRequest，生成响应HelloReply，StreamObserver.onNext返回响应，onCompleted通知框架grpc调用结束。

    public void sayHello(HelloRequest request, StreamObserver<HelloReply> observer) {String message = "hello " + request.getName();observer.onNext(HelloReply.newBuilder().setMessage(message).build());observer.onCompleted();}
2. Server端Streaming

Server端Streaming和基本调用类似，只是多个响应时要多次调用onNext，onCompleted同样是在grpc请求完整结束之后调用

    public void sayHelloServerStream(HelloRequest request, StreamObserver<HelloReply> observer) {String name = request.getName();for(char c : name.toCharArray()) {String message = "hello " + String.valueOf(c);observer.onNext(HelloReply.newBuilder().setMessage(message).build());}observer.onCompleted();}
3. Client端Streaming

Client端Streaming是通过返回一个StreamObserver回调对象给框架实现的，每收到一个请求框架就回调返回对象的onNext方法，客户端发送参数结束之后会调用onCompleted方法，详细的流程看代码会更清晰。

    public StreamObserver<HelloRequest> sayHelloClientStream(StreamObserver<HelloReply> observer) {return new StreamObserver<HelloRequest>() {private List<String> names = new ArrayList<String>();public void onNext(HelloRequest request) {names.add(request.getName());}public void onError(Throwable t) {t.printStackTrace();}public void onCompleted() {String message = "hello " + String.join(",", names);observer.onNext(HelloReply.newBuilder().setMessage(message).build());observer.onCompleted();}};}
4. 双向Streaming

我们已经看到过Client和Server端各自的Streaming实现了，双向Streaming其实就是两者的结合，应该说StreamObserver的抽象还是很实用的。

    public StreamObserver<HelloRequest> sayHelloBiStream(StreamObserver<HelloReply> observer) {return new StreamObserver<HelloRequest>() {public void onNext(HelloRequest request) {String message = "hello " + request.getName();observer.onNext(HelloReply.newBuilder().setMessage(message).build());}public void onError(Throwable t) {t.printStackTrace();}public void onCompleted() {observer.onCompleted();}};}

3. 启动服务

通过ServerBuilder创建服务，将我们的GreeterServer作为服务注册

public class Main {public static void main(String[] args) throws IOException {Server server = ServerBuilder.forPort(2333).addService(new GreeterServer()).build();server.start();System.out.println("server started....");}
}

启动后发现server started服务就算启动完成了。
在这里插入图片描述

3. 客户端

首先是创建和grpc服务的Channel，通过ManagedChannel创建，后续的调用都是通Stub完成的，支持的Stub有两种

  1. BlockingStub，同步调用
  2. async Stub，异步调用
ManagedChannel channel = ManagedChannelBuilder.forAddress("127.0.0.1", 2333).usePlaintext().build();
GreeterGrpc.GreeterBlockingStub stub = GreeterGrpc.newBlockingStub(channel);
GreeterGrpc.GreeterStub async = GreeterGrpc.newStub(channel);

如果不是Client端不是Stream，都可以通过BlockingStub实现，我们来分别看一下

1. 基本调用

HelloRequest request = HelloRequest.newBuilder().setName("randy").build();
HelloReply reply = stub.sayHello(request);
System.out.println(reply.getMessage());

2. Server端Streaming

直接响应一个Iterator，Iterator中是服务器的多个响应值

Iterator<HelloReply> replies = stub.sayHelloServerStream(request);
while (replies.hasNext()) {HelloReply aReply = replies.next();System.out.println(aReply.getMessage());
}

3. Client端Streaming

Client端Streaming需要接着async stub完成，我们曾经看到过两个StreamObserver，在客户端的时候，客户端的StreamObserver是用来发送数据的，服务端的StreamObserver用来接收服务器数据；在服务端的时候则相反。

StreamObserver<HelloReply> serverObserver = new StreamObserver<HelloReply>() { // 接收服务端响应的回调public void onNext(HelloReply helloReply) {System.out.println(helloReply.getMessage());}public void onError(Throwable t) {t.printStackTrace();}public void onCompleted() {System.out.println("server complete");}
};
StreamObserver<HelloRequest> requestObserver = async.sayHelloClientStream(serverObserver); // 返回客户端StreamObserver
requestObserver.onNext(HelloRequest.newBuilder().setName("randy").build());  // 客户端StreamObserver.onNext用来发送数据
requestObserver.onNext(HelloRequest.newBuilder().setName("zhangsan").build());
requestObserver.onCompleted();

4. 双向Streaming

理解了Client端Streaming，双向Streaming就好理解了，唯一的不同是serverObserver的onNext方法会有多次回调

StreamObserver<HelloReply> serverObserver = new StreamObserver<HelloReply>() { // 接收服务端响应的回调public void onNext(HelloReply helloReply) {System.out.println(helloReply.getMessage());}public void onError(Throwable t) {t.printStackTrace();}public void onCompleted() {System.out.println("server complete");}
};
requestObserver = async.sayHelloBiStream(serverObserver);
requestObserver.onNext(HelloRequest.newBuilder().setName("randy").build());
requestObserver.onNext(HelloRequest.newBuilder().setName("zhangsan").build());
requestObserver.onCompleted();

A. 参考资料

  1. what is grpc
    1. https://grpc.io/docs/what-is-grpc/introduction/
  2. basic tutorial
    1. https://grpc.io/docs/languages/java/basics/
  3. proto buff overview
    1. https://protobuf.dev/overview/
  4. proto3 guide
    1. https://protobuf.dev/programming-guides/proto3/
  5. Java Generated
    1. https://protobuf.dev/reference/java/java-generated/
  6. Github
    1. https://github.com/grpc/grpc-java

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/web/40980.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

计算云服务1

计算云服务1

前言 一直以来&#xff0c;计算资源都是整个企业业务系统发展所需的大动脉&#xff0c;没有计算资源&#xff0c;企业业务就无法正常运行。在云计算的时代里&#xff0c;计算服务也是云服务中的第一大类服务&#xff0c;计算资源的重要性由此可见。本章&#xff0c;我们将带领…
阅读更多...
C++之do-while陈述

C++之do-while陈述

回圈是用来进行进行重复性的工作&#xff0c;典型的回圈会进行下列三项基本任务 1.控制变数初始设定2. 回圈结束条件测试3. 调整控制变数的值 关键字(keyword) do与while构成C 中回圈的一种&#xff0c;常用于后测式的回圈&#xff0c;意思是回圈会先进行第一轮&#xff0c;然后…
阅读更多...
017-GeoGebra基础篇-微积分函数求解圆弧面积问题

017-GeoGebra基础篇-微积分函数求解圆弧面积问题

基础篇慢慢的走进尾声&#xff0c;今天给大家带来一个小项目&#xff0c;是关于高中数学微积分部分的展示&#xff0c;这个项目主要包含了函数的介绍、函数与图形绘制的区别、区域函数图像的绘制、积分函数的应用、动态文本的调用、嵌套滑动条的应用等等&#xff0c;以及其他常…
阅读更多...
基于Transformer神经网络的锂离子电池剩余使用寿命估计MATLAB实现【NASA电池数据集】

基于Transformer神经网络的锂离子电池剩余使用寿命估计MATLAB实现【NASA电池数据集】

Transformer神经网络 基于Transformer神经网络的锂离子电池剩余使用寿命估计是一种先进的方法&#xff0c;它利用了Transformer模型在处理序列数据方面的优势。 Transformer能够有效地捕捉时间序列中的长程依赖关系和非线性模式&#xff0c;相比传统的基于循环神经网络&…
阅读更多...
Github：git提交代码到github

Github：git提交代码到github

创建 GitHub 仓库 a. 登录到您的 GitHub 账户。 b. 点击右上角的 "" 图标&#xff0c;选择 "New repository"。 c. 填写仓库名称&#xff08;例如 "Mitemer"&#xff09;。 d. 添加项目描述&#xff08;可选&#xff09;。 e. 选择仓库为 &…
阅读更多...
第一天(点亮led灯+led灯闪烁)——Arduino uno R3 学习之旅

第一天(点亮led灯+led灯闪烁)——Arduino uno R3 学习之旅

​ 常识: 一般智能手机的额定工作电流大约为200mA Arduino Uno板上I/0(输入/输出)引脚最大输出电流为40 mA Uno板控制器总的输出电流为200 mA 点亮LED灯 发光二极管介绍 发光二极管(Light Emitting Diode&#xff0c;简称LED)是一种能够将电能转化为光能的固态的半导体器件…
阅读更多...
【论文解读】LivePortrait：具有拼接和重定向控制的高效肖像动画

【论文解读】LivePortrait：具有拼接和重定向控制的高效肖像动画

&#x1f4dc; 文献卡 英文题目: LivePortrait: Efficient Portrait Animation with Stitching and Retargeting Control;作者: Jianzhu Guo; Dingyun Zhang; Xiaoqiang Liu; Zhizhou Zhong; Yuan Zhang; Pengfei Wan; Di ZhangDOI: 10.48550/arXiv.2407.03168摘要翻译: *旨在…
阅读更多...
【MySQL】表的操作{创建/查看/修改/删除}

【MySQL】表的操作{创建/查看/修改/删除}

文章目录 1.创建表1.1comment&#xff1a;注释信息1.2存储引擎 2.查看表3.修改表3.1add添加列&#xff0c;对原数据无影响3.2drop删除列3.3modify修改列类型3.4change修改列名3.5rename [to]修改表名 4.删除表5.总结 1.创建表 CREATE TABLE table_name (field1 datatype,field…
阅读更多...
AI行业的非零和博弈：解读Mustafa Suleyman的观点

AI行业的非零和博弈：解读Mustafa Suleyman的观点

引言 在人工智能&#xff08;AI&#xff09;领域&#xff0c;微软AI公司的CEO Mustafa Suleyman最近在阿斯彭思想节上的访谈引起了广泛关注。与CNBC记者Andrew Ross Sorkin的对话中&#xff0c;Suleyman不仅分享了他对OpenAI人事变动的看法&#xff0c;还深入探讨了AI行业的现…
阅读更多...
FRP反向隧道代理打CFS三层

FRP反向隧道代理打CFS三层

目录 攻击机 查看服务端frps.ini配置文件 开启服务端frps 蚁剑打目标机 上传客户端frp到目标机 ​frpc.ini文件配置成 客户端打开代理frpc vps显示成功客户端frpc打开 访问成功192.168.22.22的第二层内网主机 省去前面漏洞利用的rce过程&#xff0c;直接蚁剑开搞隧道…
阅读更多...
五、保存数据到Excel、sqlite（爬虫及数据可视化）

五、保存数据到Excel、sqlite（爬虫及数据可视化）

五、保存数据到Excel、sqlite&#xff08;爬虫及数据可视化&#xff09; 1&#xff0c;保存数据到excel1.1 保存九九乘法表到excel&#xff08;1&#xff09;代码testXwlt.py&#xff08;2&#xff09;excel保存结果 1.2 爬取电影详情并保存到excel&#xff08;1&#xff09;代…
阅读更多...
MySQL表的增删改查（CRUD）

MySQL表的增删改查（CRUD）

MySQL表的增删改查&#xff08;CRUD&#xff09; 文章目录 MySQL表的增删改查&#xff08;CRUD&#xff09;1. Create1.1 单行数据 全列插入1.2 多行数据 指定列插入1.3 插入否则更新1.4 替换 2. Retrieve2.1 SELECT 列2.1.1 全列查询2.1.2 指定列查询2.1.3 查询字段为表达式…
阅读更多...
采用Java语言+开发工具 Idea+ scode数字化产科管理平台源码，产科管理新模式

采用Java语言+开发工具 Idea+ scode数字化产科管理平台源码，产科管理新模式

采用Java语言开发工具 Idea scode数字化产科管理平台源码&#xff0c;产科管理新模式 数字化产科管理系统是现代医疗信息化建设的重要组成部分&#xff0c;它利用现代信息技术手段&#xff0c;对孕产妇的孕期管理、分娩过程及产后康复等各个环节进行数字化、智能化管理&#xf…
阅读更多...
使用LoFTR模型进行图像配准、重叠区提取

使用LoFTR模型进行图像配准、重叠区提取

LoFTR模型源自2021年CVPR提出的一篇论文LoFTR: Detector-Free Local Feature Matching with Transformers&#xff0c;其基于pytorch实现图像配准&#xff0c;与基于superpointsuperglue的方法不同&#xff0c; 是一个端到端的图像配准方法。与LoFTR官方库相关的有loftr2onnx库…
阅读更多...
Android在framework层添加自定义服务的流程

Android在framework层添加自定义服务的流程

环境说明 ubuntu16.04android4.1java version “1.6.0_45”GNU Make 3.81gcc version 5.4.0 20160609 (Ubuntu 5.4.0-6ubuntu1~16.04.12) 可能有人会问&#xff0c;现在都2024了怎么还在用android4版本&#xff0c;早都过时了。确实&#xff0c;现在最新的都是Android13、And…
阅读更多...
柯桥职场英语学习商务英语口语生活英语培训生活口语学习

柯桥职场英语学习商务英语口语生活英语培训生活口语学习

辣妹用英语怎么说&#xff1f; 辣妹在英语中通常被翻译为“hot girl”或“spicy girl”&#xff0c;但更常见和直接的是“hot chick”或简单地使用“hot”来形容。 举个例子: Shes a real hot girl with her trendy outfit and confident attitude. 她真是个辣妹&#xff0…
阅读更多...
Redis---10---SpringBoot集成Redis

Redis---10---SpringBoot集成Redis

SpringBoot集成Redis 总体概述jedis-lettuce-RedisTemplate三者的联系 本地Java连接Redis常见问题&#xff0c;注意 bind配置请注释掉​ 保护模式设置为no​ Linux系统的防火墙设置​ redis服务器的IP地址和密码是否正确​ 忘记写访问redis的服务端口号和auth密码集成Jedis …
阅读更多...
Docker：Docker网络

Docker：Docker网络

Docker Network 是 Docker 平台中的一项功能&#xff0c;允许容器相互通信以及与外界通信。它提供了一种在 Docker 环境中创建和管理虚拟网络的方法。Docker 网络使容器能够连接到一个或多个网络&#xff0c;从而使它们能够安全地共享信息和资源。 预备知识 推荐先看视频先有…
阅读更多...
maven项目使用netty,前端是vue2,实现通讯

maven项目使用netty,前端是vue2,实现通讯

引入的java包 <!-- 以下是即时通讯--><!-- Netty core modules --><dependency><groupId>io.netty</groupId><artifactId>netty-all</artifactId><version>4.1.76.Final</version> <!-- 使用最新的稳定版本…
阅读更多...
C++初学者指南-4.诊断---地址检测器

C++初学者指南-4.诊断---地址检测器

C初学者指南-4.诊断—地址检测器 幻灯片 地址检测器&#xff08;ASan&#xff09; 适用编译器g,clang检测内存错误 内存泄露访问已经释放的内存访问不正确的堆栈区域 用额外的指令检测代码 运行时间增加约70%内存使用量大约增加了3倍 示例&#xff1a;检测空指针 使用地址…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023