grpc 介绍与整合springboot

已于 2023-02-14 11:56:10 修改
阅读量445 收藏 1
点赞数
分类专栏： Java 文章标签： spring boot java spring
于 2022-12-09 14:29:49 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/GZ946/article/details/128252265
版权

grpc 介绍与整合springboot

1.grpc介绍

1.1定义

grpc是谷歌的一种高性能、开源的通用型RPC框架；支持多达十几种常用语言，它的原理是通过 IDL（Interface Definition Language）文件定义服务接口的参数和返回值类型，然后通过代码生成程序生成服务端和客户端的具体实现代码，这样在 gRPC 里，客户端应用可以像调用本地对象一样调用另一台服务器上对应的方法。

1.2特点

  • 通信协议采用了 HTTP/2，因为 HTTP/2 提供了连接复用、双向流、服务器推送、请求优先级、首部压缩等机制
  • IDL 使用了ProtoBuf，ProtoBuf 是由 Google 开发的一种数据序列化协议，它的压缩和传输效率极高，语法也简单
  • 多语言支持，能够基于多种语言自动生成对应语言的客户端和服务端的代码。

1.3Protobuf文件

  • syntax
    用来指定protobuf的版本

  • java_multiple_files
    是否多个文件

  • java_package
    生成文件包路径
    在这里插入图片描述

  • java_outer_classname
    文件名
    在这里插入图片描述

  • 方法
    在这里插入图片描述

  • 参数
    在这里插入图片描述

  • 数据类型
    在这里插入图片描述

  • 服务类型
    简单rpc：就是一般的rpc调用，一个请求对象对应一个返回对象
    proto语法：rpc simpleHello(Person) returns (Result) {}
    服务端流式rpc：一个请求对象，服务端可以传回多个结果对象
    proto语法：rpc serverStreamHello(Person) returns (stream Result) {}
    客户端流式rpc：客户端传入多个请求对象，服务端返回一个响应结果
    proto语法：rpc clientStreamHello(stream Person) returns (Result) {}
    双向流式rpc：结合客户端流式rpc和服务端流式rpc，可以传入多个对象，返回多个响应对象
    proto语法：rpc biStreamHello(stream Person) returns (stream Result) {}

  • 常用的调用方式
    1)DialogServiceBlockingStub（阻塞，类似http，一个请求，一个响应）
    2)DialogServiceStub（异步调用）

2.整合springboot

2.1项目结构

在这里插入图片描述

  • springboot_grpc
    父类项目
  • grpc_client
    grpc客户端
  • grpc_server
    grpc 服务端
  • grpc_lib
    公共jar包

2.2pom配置

  • 父pom配置
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.gz</groupId>
    <artifactId>springboot_grpc</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>springboot_grpc</name>
    <properties>
        <java.version>1.8</java.version>
        <grpc-client.version>2.10.1.RELEASE</grpc-client.version>
        <grpc-server.version>2.10.1.RELEASE</grpc-server.version>
    </properties>
    <packaging>pom</packaging>
    <modules>
        <module>grpc_client</module>
        <module>grpc_server</module>
        <module>grpc_lib</module>
    </modules>
    <dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-client-spring-boot-starter</artifactId>
            <version>${grpc-client.version}</version>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-server-spring-boot-starter</artifactId>
            <version>${grpc-server.version}</version>
        </dependency>
    </dependencies>
    </dependencyManagement>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
  • 客户端pom配置
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.gz</groupId>
        <artifactId>springboot_grpc</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <groupId>com.gz</groupId>
    <artifactId>grpc_client</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>grpc_client</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-client-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.gz</groupId>
            <artifactId>grpc_lib</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
  • 服务端pom配置
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.gz</groupId>
        <artifactId>springboot_grpc</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <groupId>com.gz</groupId>
    <artifactId>grpc_server</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>grpc_server</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-server-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.gz</groupId>
            <artifactId>grpc_lib</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
  • 公共lib pom配置
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.gz</groupId>
        <artifactId>springboot_grpc</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <groupId>com.gz</groupId>
    <artifactId>grpc_lib</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <name>grpc_lib</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <dubbo.protobuf.verion>2.7.14</dubbo.protobuf.verion>
        <dubbo.compiler.version>0.0.2</dubbo.compiler.version>
        <grpc.version>1.6.1</grpc.version>
        <protobuf.version>3.3.0</protobuf.version>
        <protobuf.format.version>1.2</protobuf.format.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-server-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-client-spring-boot-starter</artifactId>
        </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.5.0</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
                    <outputDirectory>src/main/java</outputDirectory>
                    <clearOutputDirectory>false</clearOutputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

        </plugins>
    </build>

</project>

2.3proto文件

  • 创建文件
    创建文件夹要和java文件夹同目录
    在这里插入图片描述
    创建proto文件
syntax = "proto3";

option java_multiple_files = false;
option java_package = "com.gz.grpc_lib.protobuf";
option java_outer_classname="HelloServiceProto";

service HelloService {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  rpc SayHelloBothStream (stream SteamRequest) returns (stream SteamReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

message SteamRequest {
  string name = 1;
}
message SteamReply {
  string message = 1;
}
  • 创建grpc
    通过maven 插件创建，点击编译，再点击custom
    在这里插入图片描述
    在这里插入图片描述

2.4服务端

  • application.yml
grpc:
  server:
    port: 9999
spring:
  application:
    name: grpc-server
server:
  port: 8888
  • 服务代码
package com.gz.grpc_server.service.grpc;

import com.gz.grpc_lib.protobuf.HelloServiceGrpc;
import com.gz.grpc_lib.protobuf.HelloServiceProto;
import io.grpc.stub.StreamObserver;
import lombok.extern.slf4j.Slf4j;
import net.devh.boot.grpc.server.service.GrpcService;

/**
 * @author GuoZhong
 * @description
 * @date 2022/12/9 10:34
 */
@GrpcService
@Slf4j
public class UserInfoServiceImpl extends HelloServiceGrpc.HelloServiceImplBase {

	@Override
	public void sayHello(HelloServiceProto.HelloRequest request, StreamObserver<HelloServiceProto.HelloReply> responseObserver) {
		String name = request.getName();
		//构建响应值
		HelloServiceProto.HelloReply.Builder response=HelloServiceProto.HelloReply.newBuilder();
		response.setMessage("hello every one :"+name);
		responseObserver.onNext(response.build());
		responseObserver.onCompleted();
	}

	@Override
	public StreamObserver<HelloServiceProto.SteamRequest> sayHelloBothStream(StreamObserver<HelloServiceProto.SteamReply> responseObserver) {
		return new StreamObserver<HelloServiceProto.SteamRequest>() {
			@Override
			public void onNext(HelloServiceProto.SteamRequest steamRequest) {
            log.info("正在处理");
				responseObserver.onNext(HelloServiceProto.SteamReply.newBuilder()
						.setMessage(steamRequest.getName())
						.build());
			}

			@Override
			public void onError(Throwable throwable) {
				log.info("异常",throwable);
			}

			@Override
			public void onCompleted() {
				log.info("完成");
             responseObserver.onCompleted();
			}
		};
	}
}

2.5客户端

  • application.yml
grpc:
  client:
    grpc-server:
      address: static://localhost:9999
      enableKeepAlive: true
      keepAliveWithoutCalls: true
      negotiationType: plaintext
spring:
  application:
    name: grpc-client
server:
  port: 8891
  • 代码
package com.gz.grpc_client.controller;

import com.gz.grpc_lib.protobuf.HelloServiceGrpc;
import com.gz.grpc_lib.protobuf.HelloServiceProto;
import net.devh.boot.grpc.client.inject.GrpcClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.concurrent.ExecutionException;

/**
 * @author GuoZhong
 * @description
 * @date 2022/12/9 11:03
 */
@RestController
@RequestMapping("/test")
public class HelloController {

	@GrpcClient("grpc-server")
	HelloServiceGrpc.HelloServiceFutureStub helloServiceFutureStub;
	@GrpcClient("grpc-server")
	HelloServiceGrpc.HelloServiceStub  helloServiceStub;

	@GetMapping("hello")
	public String hello(@PathVariable String name) throws ExecutionException, InterruptedException {

		String str=helloServiceFutureStub.sayHello(HelloServiceProto.HelloRequest.newBuilder().setName(name).build()).get().getMessage();
		return str;
	}
	 @GetMapping("moreStream")
    public void moreStream( )  {

         //接受服务端消息
        StreamObserver<DialogServiceProto.MoreInvokeDlgStreamResponse> responseObserver =
                new StreamObserver<DialogServiceProto.MoreInvokeDlgStreamResponse>() {
            @Override
            public void onNext(DialogServiceProto.MoreInvokeDlgStreamResponse moreInvokeDlgStreamReply) {
                log.info("客户接收信息：{}",moreInvokeDlgStreamReply.getMsg());
            }

            @Override
            public void onError(Throwable throwable) {
                log.info("异常", throwable);
            }

            @Override
            public void onCompleted() {
                log.info("完成");
            }
        };

        //发送服务端口消息
        StreamObserver<DialogServiceProto.MoreInvokeDlgStreamRequest> requestObserver = dialogServiceStub
                .moreInvokeDlgStream(responseObserver);

        for(int i=1; i <= 10; i++){
            // 发送一笔数据到服务端
            requestObserver.onNext(DialogServiceProto.MoreInvokeDlgStreamRequest.newBuilder()
                    .setUuid("测试"+i)
                    .build());
            log.info("客户端发送数据:{}","测试"+i);

        }


    }

}
我叫果冻
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
gRPC框架的SpringBoot启动器模块GrpcSpringBootStarter.zip
07-19
Grpc Spring Boot Starter特点使用 Spring Boot 的应用进行自动配置，内嵌 gRPC server支持 Spring Cloud（可以通过 Spring Cloud 进行服务注册并且获取 gRPC server 的信息）支持 Spring Sleuth 进行应用跟踪支持对于 server、client 分别设置全局拦截器或单个的拦截器支持 keepalive示例示例https://github.com/yidongnan/grpc-spring-boot-starter/tree/master/examples 标签：微服务框架
Springboot整合gRPC
热门推荐
额滴神的博客
07-23 2万+
Springboot整合gRPC 概述： gRPC 一开始由 google 开发，是一款语言中立、平台中立、开源的远程过程调用(RPC)系统。 在 gRPC 里客户端应用可以像调用本地对象一样直接调用另一台不同的机器上服务端应用的方法，使得您能够更容易地创建分布式应用和服务。与许多 RPC 系统类似，gRPC 也是基于以下理念：定义一个服务，指定其能够被远程调用的方法（包含参数和返回类型）。在服务...
Springboot之接入gRPC
最新发布
02-18 1061
依次执行protobuf:compile、compile-custom。在src/java同级添加proto文件夹，内部添加proto文件。修改java_package，生成包路径。核心文件 MediaBrokerGrpc。随后生成对应代码文件。
springboot整合gprc 传输对象
carlos 程序员里最丑的
01-19 1万+
一，grpc简介： GRPC是google开源的一个高性能、跨语言的RPC框架，基于HTTP2协议，基于protobuf 3.x，基于Netty 4.x +。GRPC与thrift、avro-rpc等其实在总体原理上并没有太大的区别，简而言之GRPC并没有太多突破性的创新。    对于开发者而言：    1）需要使用protobuf定义接口，即.proto文件    2）然后使用compile工具...
SpringBoot整合grpc
weixin_44504392的博客
12-30 4123
springboot-grpc整合文档
Springboot 集成 GRPC
qq_18244417的博客
06-06 280
springboot 集成 GRPC(https://so.csdn.net/so/search?q=GRPC&spm=1001.2101.3001.7020)，需要做如下准备server 端client 端proto 文件相应的 pom步骤 1.创建 java maven 工程，使用 maven 对 Jar 包进行管理，工程目录如下：步骤 2.在 pom.xml...
springboot 整合grpc
09-04
springboot 整合grpc
grpc springboot demo代码
09-28
grpc springboot demo代码 操作步骤： 1.lzk-demo-grpc install 生成 grpc 依赖包 2.启动 lzk-demo-grpc-server 3.启动 lzk-demo-grpc-client
SpringBoot集成gRPC微服务工程搭建实践的方法
08-26
主要介绍了SpringBoot集成gRPC微服务工程搭建实践的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
grpc+springboot.zip
06-30
初学demo，启动server和client，访问localhost：8080/?num=1222121
SpringBoot-grpc.rar
09-08
SpringBoot-grpc.rar
springboot 集成GRPC
sunrj_niu的博客
10-19 1873
springboot 集成GRPC
使用spring boot集成grpc
jiayoubaobei2的博客
03-12 1043
grpc调用示例
Springboot集成grpc 简单实现
xbcheng_ai的博客
05-22 594
-设置grpc生成代码到指定路径-->--设置grpc生成代码到指定路径-->--生成代码前是否清空目录-->--生成代码前是否清空目录-->proto : 放的是需要生成Java 文件的基础 .proto文件。生成的java 代码复制一份放到 客户端的代码包里。Service grpc 服务端的配置。文件：eventInfo.proto。proto-client 服务配置。
SpringBoot整合高性能微服务框架 gRPC
公众号：微观技术
03-13 1198
Spring Boot 作为主流微服务框架，拥有成熟的社区生态。市场应用广泛，为了方便大家，整理了一个基于spring boot的常用中间件快速集成入门系列手册，涉及RPC、缓存、消息队列、分库分表、注册中心、分布式配置等常用开源组件，大概有几十篇文章，陆续会开放出来，感兴趣同学可以关注&收藏 1、简介 在 gRPC 里，客户端应用可以像调用本地对象一样直接调用另一台不同的机器上服务端应用的方法，使得我们能够更容易地创建分布式应用和服务。 gRPC 基于 HTTP/2 标准设计，带来诸如双.
springboot整合grpc
夜一
07-29 468
一、创建项目 创建模块
springboot 使用 GRPC
正怒月神的博客
01-19 1万+
说明： GRPC是什么？ 首先我们知道 RPC是远程过程调用。 而GRPC是RPC的一种实现。 那么为什么要用GRPC呢？ 因为它支持跨语言的开发，换句话说，大家都用过FeignRPC，尤其在spring cloud中。 然而它只支持java语言，而作为微服务，可能有很多其他的服务不是java开发的。因此需要满足这个需求，就需要一个跨语言的RPC，所以就会考虑使用GRPC 好了，下面进入正题 直接上代码。 我们做一个Service和一个Client 进行交互。 一，Service
springboot整合gRPC
08-11
回答: 在将gRPC整合到Spring Boot中时，首先需要创建一个Spring Boot项目作为父工程，并命名为springboot_grpc。然后，您可以使用proto3版本的协议缓冲与gRPC一起使用，这样可以避免与proto2客户端通信时的兼容性...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

我叫果冻

你的鼓励将是我创作的动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值