手把手教你寫一個SpringBoot+gRPC服務
更新時間：2023年12月01日 17:01:25 作者：酸奶小肥陽
本文將在本地環(huán)境下搭建gRPC客戶端和服務端,并成功建立通訊發(fā)送消息的方式,從而幫助大家深入了解gRPC在Spring Boot項目中的應用,有需要的小伙伴可以參考下
請注意，本文不會對gRPC基礎概念進行解釋，而是著重介紹服務的搭建過程。如果你是零基礎的伙伴，請先自行學習gRPC的基礎知識。接下來，讓我們在本地環(huán)境下搭建gRPC客戶端和服務端，并成功建立通訊發(fā)送消息的方式，來學習gRPC在Spring Boot項目中的應用。
客戶端（發(fā)送rpc請求）
1、導入maven依賴
包含rpc所使用的依賴和構建protobuf的插件。完整的<dependencies>和<build>如下：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-netty-shaded</artifactId>
<version>1.59.1</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-protobuf</artifactId>
<version>1.59.1</version>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-stub</artifactId>
<version>1.59.1</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>
<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.24.0:exe:${os.detected.classifier}</protocArtifact>
<pluginId>grpc-java</pluginId>
<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.59.1:exe:${os.detected.classifier}</pluginArtifact>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<goal>compile-custom</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
導入成功后，可以在maven的插件中看到protobuf選項；
2、編寫Proto文件
在main目錄下創(chuàng)建proto軟件包，將編寫好的Proto文件放在該目錄（src/main/proto）下。示例Proto文件內容如下
syntax = "proto3";
option java_multiple_files = true;
option java_package = "com.example.server";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package com.example.server;
service Greeter {
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
string name = 1;
}
message HelloReply {
string message = 1;
}
完成Proto文件編寫后，執(zhí)行mvn install命令。你會在target/generated-sources/protobuf路徑下看到gRPC編譯生成的Java代碼。這些生成的代碼是實現gRPC在不同語言間進行RPC通訊的基礎。
3、編寫客戶端代碼
創(chuàng)建一個HelloWorldClient類，實例化stub對象，并發(fā)送rpc請求的方法；
@Service
public class HelloWorldClient {
private GreeterGrpc.GreeterBlockingStub stub;
@Value("${grpc.hello-world.host}")
private String host;
@Value("${grpc.hello-world.port}")
private Integer port;
@PostConstruct
void init() {
ManagedChannel channel =
ManagedChannelBuilder.forAddress(host, port)
.keepAliveWithoutCalls(true)
.keepAliveTime(60, TimeUnit.SECONDS)
.keepAliveTimeout(3, TimeUnit.SECONDS)
.idleTimeout(60, TimeUnit.SECONDS)
.maxInboundMessageSize(Integer.MAX_VALUE)
.usePlaintext().build();
stub = GreeterGrpc.newBlockingStub(channel);
}
/**
* 說“你好”
*
* @param name 名字
* @return {@link String}
*/
public String sayHello(String name) {
HelloRequest request = HelloRequest.newBuilder().setName(name).build();
HelloReply helloReply = stub.sayHello(request);
return helloReply.getMessage();
}
}
這里我配置的gRPC服務端地址如下，請根據實際情況修改host和port的值。
grpc:
hello-world:
host: 127.0.0.1
port: 6565
接下來，讓我們繼續(xù)開發(fā)服務端的代碼。
服務端（處理rpc請求并返回處理數據）
1、導入maven依賴
與客戶端依賴略有不同，服務端中我們使用了grpc-spring-boot-starter
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-protobuf</artifactId>
<version>1.53.0</version>
</dependency>
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-stub</artifactId>
<version>1.53.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.lognet</groupId>
<artifactId>grpc-spring-boot-starter</artifactId>
<version>2.3.2</version>
</dependency>
</dependencies>
<!-- 添加protobuf-maven-plugin插件 編譯proto文件-->
<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>1.6.2</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.17.3:exe:${os.detected.classifier}</protocArtifact>
<pluginId>grpc-java</pluginId>
<pluginArtifact>io.grpc:protoc-gen-grpc-java:1.42.0:exe:${os.detected.classifier}</pluginArtifact>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<goal>compile-custom</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
2、導入Proto文件
這里的proto文件盡量和客戶端的保持一致，完成和客戶端步驟2同樣的事兒。需要注意的是，在proto文件中，用package聲明生成的Java類的包名，請與服務端實現類的包結構保持一致，這樣才能正常地完成依賴導入和方法重寫；
例如：
3、編寫服務端實現類代碼
@GRpcService：用于標記這個類是一個gRPC服務端的實現類。它告訴Spring Boot框架將這個類注冊為一個gRPC服務端，并自動處理gRPC請求。- 繼承自
GreeterGrpc.GreeterImplBase類，表示它是rpc服務Greeter的實現類，在類中，我們可以重寫rpc接口的實現方法，來處理接收到請求；
/**
* hello service impl
*
* @author yangyang
* @date 2023/11/30
*/
@GRpcService
@Slf4j
public class HelloServiceImpl extends GreeterGrpc.GreeterImplBase {
@Override
public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
// 獲取客戶端發(fā)送的請求消息
String name = request.getName();
// 構建響應消息
HelloReply response = HelloReply.newBuilder()
.setMessage("Hello, " + name + "!")
.build();
log.info("[grpc server]: response: {}", response);
// 發(fā)送響應消息
responseObserver.onNext(response);
// 通知客戶端響應已經完成
responseObserver.onCompleted();
}
}
4、配置端口號，啟動服務
可通過此配置修改rpc的端口號（默認6565）
grpc: # grpc server port port: 6565 server: port: 8081
服務啟動后，可以在日志中看到端口信息
可以選擇使用通過客戶端發(fā)送請求來測試服務，或者使用postman等工具發(fā)送rpc接口。至此，一個簡單且完整的SpringBoot gRPC客戶端與服務端開發(fā)完成！
以上就是手把手教你寫一個SpringBoot+gRPC服務的詳細內容，更多關于SpringBoot gRPC服務的資料請關注腳本之家其它相關文章！
相關文章
Spring Security是一款強大的安全框架，可以幫助用戶保護Web應用程序和REST API的安全性，這篇文章主要介紹了Java 中如何使用Spring Security,需要的朋友可以參考下2023-06-06
用redis中的List可以實現隊列，這樣可以用來做消息處理和任務調度的隊列。因此，本文將主要為大家介紹如何利用redisTemplate處理消息隊列，感興趣的小伙伴可以了解一下2021-12-12
這篇文章為大家總結了java中常見的鎖（互斥鎖、讀寫鎖、公平鎖與非公平鎖等）的機制以及如何使用，文中示例代碼講解詳細，需要的可以學習一下2021-12-12
這篇文章主要介紹了Java中的BlockingQueue接口源碼解析,BlockingQueue接口表示阻塞隊列,是Java并發(fā)包中阻塞隊列的接口定義規(guī)范,阻塞隊列意味著對于該隊列的操作是線程安全的,當多個線程存放元素進入隊列或者從隊列中取出元素都是線程安全的,需要的朋友可以參考下2023-11-11
詳解spring cloud中使用Ribbon實現客戶端的軟負載均衡
這篇文章主要介紹了詳解spring cloud中使用Ribbon實現客戶端的軟負載均衡，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-01-01
這篇文章主要給大家介紹了關于Java中public關鍵字用法的相關資料,public關鍵字是和訪問權限相關的，它所修飾的方法對所有類都是可以訪問的,需要的朋友可以參考下2023-09-09
IDEA2020.2創(chuàng)建springboot項目卡死在reading maven project的問題
這篇文章主要介紹了關于2020.2IDEA用spring Initializr創(chuàng)建maven的springboot項目卡死在reading maven project的問題描述及解決方法，感興趣的朋友跟隨小編一起看看吧2020-09-09
Effective Java (異常處理)，需要的朋友可以參考一下2013-02-02
mybatis-plus如何修改日志只打印SQL語句不打印查詢結果
這篇文章主要介紹了mybatis-plus如何修改日志只打印SQL語句不打印查詢結果問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
本篇文章主要介紹了JAVA中使用JSON進行數據傳遞示例，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-01-01