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.pswp.cn/web/40980.shtml
繁體地址,請注明出處:http://hk.pswp.cn/web/40980.shtml
英文地址,請注明出處:http://en.pswp.cn/web/40980.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

計算云服務1

前言 一直以來&#xff0c;計算資源都是整個企業業務系統發展所需的大動脈&#xff0c;沒有計算資源&#xff0c;企業業務就無法正常運行。在云計算的時代里&#xff0c;計算服務也是云服務中的第一大類服務&#xff0c;計算資源的重要性由此可見。本章&#xff0c;我們將帶領…

C++之do-while陳述

回圈是用來進行進行重復性的工作&#xff0c;典型的回圈會進行下列三項基本任務 1.控制變數初始設定2. 回圈結束條件測試3. 調整控制變數的值 關鍵字(keyword) do與while構成C 中回圈的一種&#xff0c;常用于后測式的回圈&#xff0c;意思是回圈會先進行第一輪&#xff0c;然后…

017-GeoGebra基礎篇-微積分函數求解圓弧面積問題

基礎篇慢慢的走進尾聲&#xff0c;今天給大家帶來一個小項目&#xff0c;是關于高中數學微積分部分的展示&#xff0c;這個項目主要包含了函數的介紹、函數與圖形繪制的區別、區域函數圖像的繪制、積分函數的應用、動態文本的調用、嵌套滑動條的應用等等&#xff0c;以及其他常…

基于Transformer神經網絡的鋰離子電池剩余使用壽命估計MATLAB實現【NASA電池數據集】

Transformer神經網絡 基于Transformer神經網絡的鋰離子電池剩余使用壽命估計是一種先進的方法&#xff0c;它利用了Transformer模型在處理序列數據方面的優勢。 Transformer能夠有效地捕捉時間序列中的長程依賴關系和非線性模式&#xff0c;相比傳統的基于循環神經網絡&…

Github:git提交代碼到github

創建 GitHub 倉庫 a. 登錄到您的 GitHub 賬戶。 b. 點擊右上角的 "" 圖標&#xff0c;選擇 "New repository"。 c. 填寫倉庫名稱&#xff08;例如 "Mitemer"&#xff09;。 d. 添加項目描述&#xff08;可選&#xff09;。 e. 選擇倉庫為 &…

第一天(點亮led燈+led燈閃爍)——Arduino uno R3 學習之旅

? 常識: 一般智能手機的額定工作電流大約為200mA Arduino Uno板上I/0(輸入/輸出)引腳最大輸出電流為40 mA Uno板控制器總的輸出電流為200 mA 點亮LED燈 發光二極管介紹 發光二極管(Light Emitting Diode&#xff0c;簡稱LED)是一種能夠將電能轉化為光能的固態的半導體器件…

【論文解讀】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】表的操作{創建/查看/修改/刪除}

文章目錄 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的觀點

引言 在人工智能&#xff08;AI&#xff09;領域&#xff0c;微軟AI公司的CEO Mustafa Suleyman最近在阿斯彭思想節上的訪談引起了廣泛關注。與CNBC記者Andrew Ross Sorkin的對話中&#xff0c;Suleyman不僅分享了他對OpenAI人事變動的看法&#xff0c;還深入探討了AI行業的現…

FRP反向隧道代理打CFS三層

目錄 攻擊機 查看服務端frps.ini配置文件 開啟服務端frps 蟻劍打目標機 上傳客戶端frp到目標機 ?frpc.ini文件配置成 客戶端打開代理frpc vps顯示成功客戶端frpc打開 訪問成功192.168.22.22的第二層內網主機 省去前面漏洞利用的rce過程&#xff0c;直接蟻劍開搞隧道…

五、保存數據到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表的增刪改查&#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 查詢字段為表達式…

中介子方程四十七

XXFXXaXnXaXXαXLXyXXWXuXeXKXXiXyXΣXXΣXXVXuXhXXWXηXWXXhXuXVXXΣXXΣXyXiXXKXeXuXWXXyXLXαXXaXnXaXXFXXaXnXaXXαXLXyXXWXuXeXKXXiXyXΣXXΣXXVXuXhXXWXηXWXXhXuXVXXΣXXΣXyXiXXKXeXuXWXXyXLXαXXaXnXaXXFXXuXXWXXuXXdXXrXXαXXuXpXXKXηXiXXnXXyXηXuXXrXXaXnXXαXLXy…

采用Java語言+開發工具 Idea+ scode數字化產科管理平臺源碼,產科管理新模式

采用Java語言開發工具 Idea scode數字化產科管理平臺源碼&#xff0c;產科管理新模式 數字化產科管理系統是現代醫療信息化建設的重要組成部分&#xff0c;它利用現代信息技術手段&#xff0c;對孕產婦的孕期管理、分娩過程及產后康復等各個環節進行數字化、智能化管理&#xf…

使用LoFTR模型進行圖像配準、重疊區提取

LoFTR模型源自2021年CVPR提出的一篇論文LoFTR: Detector-Free Local Feature Matching with Transformers&#xff0c;其基于pytorch實現圖像配準&#xff0c;與基于superpointsuperglue的方法不同&#xff0c; 是一個端到端的圖像配準方法。與LoFTR官方庫相關的有loftr2onnx庫…

面試專區|【52道微服務架構高頻題整理(附答案背誦版)】

簡述什么是微服務&#xff1f; 微服務是一種軟件架構風格&#xff0c;它將應用程序拆分成一系列小型、獨立的服務&#xff0c;每個服務都運行在其自己的進程中&#xff0c;通過輕量級通信機制進行通信。每個服務都具有明確的業務能力&#xff0c;并且可以獨立開發、測試、部署…

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…

墨烯的C語言技術棧-C語言基礎-007

七.字符串 由雙引號引起的一串字符稱為字符串字面值,或者簡稱字符串 字符串的結束標志是"\0" int main() { //#qWer$ //char 字符類型 //a; //char ch "w"; //字符串 //C語言中沒有字符串類型 "abcdefg"; char arr1[] "abc…

柯橋職場英語學習商務英語口語生活英語培訓生活口語學習

辣妹用英語怎么說&#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

SpringBoot集成Redis 總體概述jedis-lettuce-RedisTemplate三者的聯系 本地Java連接Redis常見問題&#xff0c;注意 bind配置請注釋掉? 保護模式設置為no? Linux系統的防火墻設置? redis服務器的IP地址和密碼是否正確? 忘記寫訪問redis的服務端口號和auth密碼集成Jedis …