脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot gRPC服务

手把手教你写一个SpringBoot+gRPC服务

 更新时间：2023年12月01日 17:01:25   作者：酸奶小肥阳  
本文将在本地环境下搭建gRPC客户端和服务端,并成功建立通讯发送消息的方式,从而帮助大家深入了解gRPC在Spring Boot项目中的应用,有需要的小伙伴可以参考下

请注意，本文不会对gRPC基础概念进行解释，而是着重介绍服务的搭建过程。如果你是零基础的伙伴，请先自行学习gRPC的基础知识。接下来，让我们在本地环境下搭建gRPC客户端和服务端，并成功建立通讯发送消息的方式，来学习gRPC在Spring Boot项目中的应用。

客户端（发送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目录下创建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文件编写后，执行mvn install命令。你会在target/generated-sources/protobuf路径下看到gRPC编译生成的Java代码。这些生成的代码是实现gRPC在不同语言间进行RPC通讯的基础。

3、编写客户端代码

创建一个HelloWorldClient类，实例化stub对象，并发送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

接下来，让我们继续开发服务端的代码。

服务端（处理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) {
        // 获取客户端发送的请求消息
        String name = request.getName();
        // 构建响应消息
        HelloReply response = HelloReply.newBuilder()
        .setMessage("Hello, " + name + "!")
        .build();
        log.info("[grpc server]: response: {}", response);

        // 发送响应消息
        responseObserver.onNext(response);
        // 通知客户端响应已经完成
        responseObserver.onCompleted();
    }
}

4、配置端口号，启动服务

可通过此配置修改rpc的端口号（默认6565）

grpc:
  # grpc server port
  port: 6565
server:
  port: 8081

服务启动后，可以在日志中看到端口信息

可以选择使用通过客户端发送请求来测试服务，或者使用postman等工具发送rpc接口。至此，一个简单且完整的SpringBoot gRPC客户端与服务端开发完成！

以上就是手把手教你写一个SpringBoot+gRPC服务的详细内容，更多关于SpringBoot gRPC服务的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Java 中使用Spring Security的实例详解

    Java 中使用Spring Security的实例详解

    Spring Security是一款强大的安全框架，可以帮助用户保护Web应用程序和REST API的安全性，这篇文章主要介绍了Java 中如何使用Spring Security,需要的朋友可以参考下
    2023-06-06
  • Java redisTemplate阻塞式处理消息队列

    Java redisTemplate阻塞式处理消息队列

    用redis中的List可以实现队列，这样可以用来做消息处理和任务调度的队列。因此，本文将主要为大家介绍如何利用redisTemplate处理消息队列，感兴趣的小伙伴可以了解一下
    2021-12-12
  • 详解java中各类锁的机制

    详解java中各类锁的机制

    这篇文章为大家总结了java中常见的锁（互斥锁、读写锁、公平锁与非公平锁等）的机制以及如何使用，文中示例代码讲解详细，需要的可以学习一下
    2021-12-12
  • Java中的BlockingQueue接口源码解析

    Java中的BlockingQueue接口源码解析

    这篇文章主要介绍了Java中的BlockingQueue接口源码解析,BlockingQueue接口表示阻塞队列,是Java并发包中阻塞队列的接口定义规范,阻塞队列意味着对于该队列的操作是线程安全的,当多个线程存放元素进入队列或者从队列中取出元素都是线程安全的,需要的朋友可以参考下
    2023-11-11
  • 详解spring cloud中使用Ribbon实现客户端的软负载均衡

    详解spring cloud中使用Ribbon实现客户端的软负载均衡

    这篇文章主要介绍了详解spring cloud中使用Ribbon实现客户端的软负载均衡，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • Java中public关键字用法详细讲解

    Java中public关键字用法详细讲解

    这篇文章主要给大家介绍了关于Java中public关键字用法的相关资料,public关键字是和访问权限相关的，它所修饰的方法对所有类都是可以访问的,需要的朋友可以参考下
    2023-09-09
  • IDEA2020.2创建springboot项目卡死在reading maven project的问题

    IDEA2020.2创建springboot项目卡死在reading maven project的问题

    这篇文章主要介绍了关于2020.2IDEA用spring Initializr创建maven的springboot项目卡死在reading maven project的问题描述及解决方法，感兴趣的朋友跟随小编一起看看吧
    2020-09-09
  • Effective Java (异常处理)

    Effective Java (异常处理)

    Effective Java (异常处理)，需要的朋友可以参考一下
    2013-02-02
  • mybatis-plus如何修改日志只打印SQL语句不打印查询结果

    mybatis-plus如何修改日志只打印SQL语句不打印查询结果

    这篇文章主要介绍了mybatis-plus如何修改日志只打印SQL语句不打印查询结果问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • JAVA中使用JSON进行数据传递示例

    JAVA中使用JSON进行数据传递示例

    本篇文章主要介绍了JAVA中使用JSON进行数据传递示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01

最新评论