SpringCloudAlibaba極簡入門整合Grpc代替OpenFeign的詳細過程
前言
他來了他來了,停了快2個月了終于又開始更新文章啦,這次帶來的絕對是干貨?。?!。由于公司項目進行重構(gòu)的時候考慮到,OpenFeign做為服務通信組件在高并發(fā)情況下有一定的性能瓶頸,所以將其替換為更高性能的通信組件Grpc,Grpc也是業(yè)界比較流行的服務通信組件,底層采用HTTP/2進行網(wǎng)絡通信性能上高于基于Http/1.1的OpenFeign。 我將把Grpc的整合過程整理成文字分享給大家,喜歡請三連!??!,你的鼓勵是我堅持下去的動力。
認識Grpc
OpenFeign基于 HTTP/1.1 協(xié)議。主要使用 JSON 或 XML 格式進行數(shù)據(jù)交換,這些格式更加人性化但分裝臃腫效率較低。其主要用于 RESTful API 調(diào)用,支持聲明式的 Web 服務客戶端。
而 gRPC 是一個高性能、開源和通用的 RPC(遠程過程調(diào)用)框架,基于 Protocol Buffers 序列化協(xié)議開發(fā),在內(nèi)部實現(xiàn)上,它采用了 HTTP/2 協(xié)議作為傳輸層協(xié)議的一部分來實現(xiàn)高效的雙向流通信的能力等特性讓它成為很多開發(fā)者熱衷的工具庫之一;gRPC 在處理大量數(shù)據(jù)時表現(xiàn)優(yōu)異,適用于需要快速響應的應用場景,特別是在微服務架構(gòu)中。
gRPC:
- 強調(diào)高效的數(shù)據(jù)傳輸和低延遲通信。如金融交易、在線游戲等對延遲要求極高的場景
- 適合構(gòu)建高性能的分布式系統(tǒng)和服務間通信。在大規(guī)模微服務架構(gòu)中,gRPC 可以顯著提高系統(tǒng)的整體性能。
- 支持流式傳輸,可以實現(xiàn)長連接和實時數(shù)據(jù)推送。
OpenFeign:
- 注重簡化開發(fā)者的代碼編寫工作。
- 更加靈活,可以輕松地集成到現(xiàn)有的 Spring Boot 項目中。
- 適用于輕量級的 RESTful API 調(diào)用。
總結(jié)來說,gRPC 和 OpenFeign 各有優(yōu)勢,選擇哪種技術(shù)取決于具體的業(yè)務需求和技術(shù)棧。如果你需要高性能、低延遲的服務間通信,gRPC 是更好的選擇;如果你希望簡化開發(fā)流程并快速集成 RESTful API,OpenFeign 則更為合適。
案例實戰(zhàn)
1.搭建工程
首先搭建一個SpringBoot父工程,父工程下分別有:grpc-api ,grpc-provider ,grpc-consumer 三個模塊,分別代表:Grpc接口,生產(chǎn)者,消費者。父工程管理的依賴如下
<properties> <maven.compiler.source>21</maven.compiler.source> <maven.compiler.target>21</maven.compiler.target> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <java.version>21</java.version> <skipTests>true</skipTests> <spring-cloud.version>2023.0.1</spring-cloud.version> <spring-cloud-alibaba.version>2023.0.1.0</spring-cloud-alibaba.version> <hutool.version>5.8.28</hutool.version> <lombok.version>1.18.32</lombok.version> </properties> <!--SpringBoot依賴--> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.3.0</version> </parent> <dependencies> <!-- 常用工具類 --> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>${hutool.version}</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>${lombok.version}</version> <scope>provided</scope> </dependency> <!--SpringCloud 2020.* 禁用了bootstrap 而注冊中心等配置文件需要 bootstrap.yml 為名的配置文件--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-bootstrap</artifactId> </dependency> <!--注解配置器--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-alibaba-dependencies</artifactId> <version>${spring-cloud-alibaba.version}</version> <type>pom</type> <scope>import</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
2.API模塊
api模塊需要導入grpc相關(guān)依賴,以及編寫proto文件,我們根據(jù)proto文件自動生成Grpc的API接口文件,需要導入的依賴如下
<dependencies> <!-- https://mvnrepository.com/artifact/net.devh/grpc-server-spring-boot-starter --> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-server-spring-boot-starter</artifactId> <version>3.0.0.RELEASE</version> </dependency> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-client-spring-boot-starter</artifactId> <version>3.0.0.RELEASE</version> </dependency> <dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId> <version>1.3.2</version> </dependency> </dependencies> <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.12.0:exe:${os.detected.classifier}</protocArtifact> <pluginId>grpc-java</pluginId> <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.34.1:exe:${os.detected.classifier}</pluginArtifact> <outputDirectory>${project.basedir}/src/main/java</outputDirectory> <clearOutputDirectory>false</clearOutputDirectory> </configuration> <executions> <execution> <goals> <goal>compile</goal> <goal>compile-custom</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
grpc-server-spring-boot-starter 和 grpc-client-spring-boot-starter 是Grpc的服務端和客戶端的依賴,javax.annotation-api是對Grpc代碼生成注解的支持,不導入該包會報錯。然后導入了os-maven-plugin插件,以及 protobuf-maven-plugin 插件用來根據(jù)proto文件生成API代碼的。
接著我們再API模塊中main目錄下創(chuàng)建一個proto目錄,并創(chuàng)建一個文件User.proto
,內(nèi)容如下
syntax = "proto3"; /** 生產(chǎn)的代碼合并到一個文件 **/ option java_multiple_files = false; /** 生產(chǎn)代碼輸出的包路徑 **/ option java_package = "cn.whale.api.User"; /** API接口 **/ service UserApi { /** Grpc API 接口 **/ rpc getById(GetUserReq) returns (GetUserRep) {} } /** 響應對象 **/ message GetUserReq { /** Long 用戶ID **/ int64 id = 1; } /** 結(jié)果對象 **/ message GetUserRep { /** Long 用戶ID **/ int64 id = 1; /** String 用戶名字 **/ string name = 2; }
該文件是用來定義Grpc Api接口的,具體請看上面的注釋,需要注意的是定義Protobuf 的 message 對象的字段類型可不能使用Java的類型,int64 對應Long
, string 對應 String
具體請看:https://protobuf.com.cn/programming-guides/proto3/#specifying-types
編寫好proto文件后,對api模塊進行compile(IDEA 右側(cè) - api模塊 - lifecycle - compile) ,然后會自動在API模塊中生成Grpc相關(guān)的 API接口。
3.提供者服務
提供者服務首先是需要向Nacos注冊(其他注冊中心也行)的,然后導入api模塊,編寫Grpc的提供者服務,導入如下依賴
<dependencies> <!--grpc api 模塊 --> <dependency> <groupId>cn.whale</groupId> <artifactId>grpc-api</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--nacos服務發(fā)現(xiàn)--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <!--配置管理 --> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> </dependency> <!--grpc服務端依賴,api模塊中引入了,這里其實可以不引--> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-server-spring-boot-starter</artifactId> <version>3.0.0.RELEASE</version> </dependency> </dependencies>
接著對提供者服務進行配置,啟動類正常寫,沒有什么新東西,bootstrap.yml配置如下
server: port: 8081 #tomcat 端口 grpc: server: port: 7071 #Grpc端口 client: #Grpic客戶端配置 GLOBAL: negotiation-type: plaintext #協(xié)議類型,明文傳輸,也可以使用TLS進行加密傳輸,服務內(nèi)部通信使用明文即可 enable-keep-alive: true keep-alive-without-calls: true spring: application: name: grpc-provider #服務名 cloud: nacos: discovery: #服務注冊 server-addr: nacos地址:8848 config: #配置管理 server-addr: ${spring.cloud.nacos.discovery.server-addr} file-extension: yml
接下來編寫提供者服務的Grpc實現(xiàn),創(chuàng)建一個類UserApiImpl
繼承UserApiGrpc
,具體如下
package cn.whale.grpc; import cn.whale.api.User.User; import cn.whale.api.User.UserApiGrpc; import io.grpc.stub.StreamObserver; import net.devh.boot.grpc.server.service.GrpcService; /** * 標記Grpc提供者服務 */ @GrpcService public class UserApiImpl extends UserApiGrpc.UserApiImplBase { /** * 接口方法實現(xiàn) * @param request :請求對象 * @param responseObserver : 消息流對象,用來響應結(jié)果 */ @Override public void getById(User.GetUserReq request, StreamObserver<User.GetUserRep> responseObserver) { long id = request.getId(); //TODO :去數(shù)據(jù)查詢數(shù)據(jù) //封裝結(jié)果數(shù)據(jù) User.GetUserRep userRep = User.GetUserRep.newBuilder().setId(id).setName("zs").build(); //響應結(jié)果 responseObserver.onNext(userRep); responseObserver.onCompleted(); //異常情況 //responseObserver.onError(exception); } }
- @GrpcService :Grpc的服務端注解
- UserApiGrpc.UserApiImplBase :根據(jù)Proto自動生成的API接口
- getById :我們定義的API接口方法,具體請看代碼注釋
到這里提供者就編寫完成了,啟動提供者服務,可以看到Grpc的端口
4.消費者服務
消費者服務也是要做服務注冊,然后引入api模塊,以及Grpc客戶端依賴,具體如下
<dependencies> <dependency> <groupId>cn.whale</groupId> <artifactId>grpc-api</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> </dependency> <dependency> <groupId>net.devh</groupId> <artifactId>grpc-client-spring-boot-starter</artifactId> <version>3.0.0.RELEASE</version> </dependency> </dependencies>
編寫啟動類和創(chuàng)建bootstrap.yml文件
server: port: 8082 grpc: server: port: 7072 client: GLOBAL: negotiation-type: plaintext enable-keep-alive: true keep-alive-without-calls: true spring: application: name: grpc-consumer cloud: nacos: discovery: server-addr: nacos地址:8848 config: server-addr: ${spring.cloud.nacos.discovery.server-addr} file-extension: yml
接著我們編寫一個Conroller來實現(xiàn)和提供者的Grpc通信,代碼如下
@RestController @Slf4j public class BusinessController { //指向提供者的服務名 @GrpcClient(value = "grpc-provider") private UserApiGrpc.UserApiBlockingStub userApiBlockingStub; @GetMapping("/user") public String getUserById(){ User.GetUserRep getUserRep = userApiBlockingStub.getById(User.GetUserReq.newBuilder().setId(1L).build()); log.info("查詢到用戶信息,id = {},name = {}",getUserRep.getId(),getUserRep.getName()); return getUserRep.toString(); } }
- @GrpcClient(value = “grpc-provider”) : 客戶端注解,value指向了注冊中心的提供者服務的名字,底層會自動進行負載均衡
- UserApiGrpc.UserApiBlockingStub : Grpc 同步接口,它也支持異步調(diào)用UserApiGrpc.UserApiFutureStub
到這里消費者就編寫完成了,啟動消費者,通過瀏覽器訪問/user,就可以拿到提供者返回的數(shù)據(jù)了
5.注意事項
最后說幾個注意事項
- Grpc生成的對象只提供了Builder的方式設置值,所以沒辦法通過BeanUtils等工具進行對象之間的自動轉(zhuǎn)換的,需要手動給Proto對象設置值。見生產(chǎn)者 User.GetUserRep
- 如果給Proto對象設置了空值會報錯,所以在給對象設置值的時候建議先判斷空值,然后給一個默認值,比如:String為null,就指定一個“”空字符串
- Grpc是無法返回一個null對象的,所以消費者端到底有沒有拿到一個有效的結(jié)果不能直接用null來判斷,需要取出具體的值來判斷
就寫到這把,剩下的坑大家自己去踩,如果文章對你有幫助請給個好評?。?!
到此這篇關(guān)于SpringCloudAlibaba極簡入門整合Grpc代替OpenFeign的文章就介紹到這了,更多相關(guān)SpringCloudAlibaba整合Grpc內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
k8s部署的java服務添加idea調(diào)試參數(shù)的方法
文章介紹了如何在K8S容器中的Java服務上進行遠程調(diào)試,包括配置Deployment、Service以及本地IDEA的調(diào)試設置,感興趣的朋友跟隨小編一起看看吧2025-02-02arthas?jprofiler做復雜鏈路的調(diào)用分析
這篇文章主要為大家介紹了arthas?jprofiler做復雜鏈路的調(diào)用分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-06-06Java下變量大小寫駝峰、大小寫下劃線、大小寫連線轉(zhuǎn)換
有時候需要處理對象屬性的getter、setter方法,或者將屬性與數(shù)據(jù)表字段進行相互轉(zhuǎn)換,感興趣的可以了解一下2021-06-06Java使用JDBC或MyBatis框架向Oracle中插入XMLType數(shù)據(jù)
XMLType是Oracle支持的一種基于XML格式存儲的數(shù)據(jù)類型,這里我們共同來探究Java使用JDBC或MyBatis框架向Oracle中插入XMLType數(shù)據(jù)的方法:2016-07-07