【SpringBoot 学习】52、SpringBoot 使用 grpc 实现远程服务调用

文章介绍了如何利用gRPC框架和SpringBoot来实现远程服务调用。首先,讨论了gRPC的特性,然后详细说明了如何配置项目依赖,编写protobuf定义文件,生成服务端和客户端代码,并提供了服务端和客户端的具体实现示例。
摘要由CSDN通过智能技术生成

一、SpringBoot 使用 grpc 实现远程服务调用

gRPC 是一个现代的、开源的、高性能的远程过程调用(RPC)框架,可以在任何地方运行。gRPC 使客户端和服务器应用程序能够透明地通信,并简化了连接系统的构建。

为了最大限度地提高可用性,gRPC 支持向用户选择的语言(如果有)添加依赖项的标准方法。在大多数语言中,gRPC 运行时作为用户语言包管理器中可用的包提供。

核心依赖之间的关系:

  • grpc-spring-boot-starter:包含了客户端和服务端
  • grpc-server-spring-boot-starter:只有服务端
  • grpc-client-spring-boot-starter:只有客户端

1、服务端编写

通常情况下,服务端也会是客户端,所以这里引用依赖直接客户端、服务端一起引入

<properties>
        <java.version>1.8</java.version>
        <grpc-spring-boot-starter.version>2.14.0.RELEASE</grpc-spring-boot-starter.version>
        <os-maven-plugin.version>1.6.0</os-maven-plugin.version>
        <protobuf-maven-plugin.version>0.5.1</protobuf-maven-plugin.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-spring-boot-starter</artifactId>
            <version>${grpc-spring-boot-starter.version}</version>
        </dependency>
    </dependencies>

    <build>
        <extensions>
            <!-- os-maven-plugin -->
            <extension>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>${os-maven-plugin.version}</version>
            </extension>
        </extensions>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
            <!-- protobuf-maven-plugin -->
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>${protobuf-maven-plugin.version}</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.11.0:exe:${os.detected.classifier}</pluginArtifact>
                    <outputDirectory>${project.build.sourceDirectory}</outputDirectory>
                    <clearOutputDirectory>false</clearOutputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

然后在创建 src/main/proto 文件夹,并在其中创建 news.proto 文件

syntax = "proto3";
option java_package = "cn.tellsea.grpcservice.proto";

service NewsService {
  rpc Hello (StringRequest) returns (StringResponse) {}
}

message StringRequest {
  string name = 1;
}

message StringResponse {
  string result = 1;
}

然后在 maven 中执行生成代码

执行完成之后,会直接生成可调用的代码

然后编写自己的业务 Service 方法,注意使用@GrpcService 注解标明

import cn.tellsea.grpcservice.proto.News;
import cn.tellsea.grpcservice.proto.NewsServiceGrpc;
import io.grpc.stub.StreamObserver;
import net.devh.boot.grpc.server.service.GrpcService;

/**
 * @author Tellsea
 * @date 2023/1/13
 */
@GrpcService
public class NewsService extends NewsServiceGrpc.NewsServiceImplBase {

    @Override
    public void hello(News.StringRequest request, StreamObserver<News.StringResponse> responseObserver) {
        String name = request.getName();
        News.StringResponse response = News.StringResponse.newBuilder().setResult("Hi:" + name).build();
        responseObserver.onNext(response);
        responseObserver.onCompleted();
    }
}

修改 application.yml 配置文件

server:
  port: 8080
spring:
  application:
    name: spring-boot-grpc-service
grpc:
  server:
    port: 9090

到此服务端准备完毕

2、客户端编写

客户端和服务端一样,把 proto 文件和生成的 java 类一样的处理一遍, pom.xml 中的依赖文件也使用一样的就可以了

文件生成完成之后,修改 application.yml 配置文件

server:
  port: 8081
spring:
  application:
    name: spring-boot-grpc-client
grpc:
  client:
    spring-boot-grpc-service:
      address: 'static://127.0.0.1:9090'
      negotiation-type: plaintext

然后写一个测试控制层的接口,调用测试是有完成

import cn.tellsea.grpcclient.proto.News;
import cn.tellsea.grpcclient.proto.NewsServiceGrpc;
import net.devh.boot.grpc.client.inject.GrpcClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author Tellsea
 * @date 2023/1/13
 */
@RestController
public class NewsController {

    /**
     * 获取调用存根
     */
    @GrpcClient("spring-boot-grpc-service")
    private NewsServiceGrpc.NewsServiceBlockingStub newsServiceBlockingStub;

    @GetMapping("/say")
    public String sayHello(String name) {
        News.StringResponse response = newsServiceBlockingStub.hello(News.StringRequest
                .newBuilder()
                .setName(name)
                .build());
        return response.getResult();
    }
}

当然了,我这里测试肯定是没问题的,OK,到此结束

  • 2
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
### 回答1: Spring Boot 是一个用于构建基于Java的微服务的开发框架。它提供了一种快速开发、简化配置的方式,使得开发者能够更容易地构建和部署应用程序。 Spring Boot MVC 是 Spring Boot 中用于构建Web应用程序的一部分。它基于 Spring MVC 框架,提供了简化的配置和开发方式,使得开发者能够更高效地构建和维护Web应用。 gRPC是一种高性能、开源的远程过程调用(RPC)框架,由Google开发并开源。它使用Protocol Buffers作为接口定义语言(IDL),可以跨语言地进行通信。与传统的HTTP+JSON通信相比,gRPC提供了更快、更轻量级、更高效的跨网络通信方式。 Spring Boot可以集成gRPC实现基于gRPC远程过程调用。集成gRPC的步骤如下: 1. 在Spring Boot项目中添加gRPC的依赖,例如在pom.xml中添加相关依赖。 2. 使用Protocol Buffers编写接口定义文件(.proto文件),定义服务和消息格式。 3. 使用gRPC编译器生成相应的Java代码。 4. 编写服务实现类,实现生成的接口。 5. 在Spring Boot中配置gRPC服务端和客户端的相关信息。 6. 启动Spring Boot应用程序。 通过上述步骤,就可以在Spring Boot实现基于gRPC远程过程调用。通过gRPC服务端和客户端可以直接调用对方提供的方法,以实现跨网络的通信。gRPC使用Protocol Buffers进行序列化和反序列化,提供了高效的通信方式。同时,通过Spring Boot的集成,开发者可以更方便地进行开发和部署。总之,Spring Boot MVC gRPC实现可以为开发者提供快速、高效地构建基于gRPC的微服务应用的能力。 ### 回答2: Spring Boot是一个用于构建独立的、生产级别的Spring应用程序的框架。它简化了Spring应用程序的配置和部署过程,并提供了大量的开箱即用的功能。而MVC(Model-View-Controller)是一种常用的软件设计模式,用于将应用程序的业务逻辑、数据和呈现逻辑分离。 gRPC是一种高性能、开源的远程过程调用(RPC)框架,它使用Protocol Buffers作为接口定义语言。gRPC支持多种语言,包括JavaSpring Boot使用gRPC,可以定义消息类型和服务接口,并生成用于客户端和服务器之间通信的代码。 在Spring Boot使用gRPC实现通常需要以下步骤: 1.定义gRPC服务接口:使用Protocol Buffers定义服务接口和消息类型,并生成相应的代码。 2.实现gRPC服务接口:在Spring Boot应用程序中实现gRPC服务接口中定义的方法。 3.配置gRPC服务器:在Spring Boot应用程序中配置gRPC服务器,指定端口和服务实现类。 4.编写客户端代码:编写客户端代码以使用gRPC调用服务器端提供的服务使用gRPC的好处包括高性能、跨语言支持、自动化的代码生成等。在Spring Boot使用gRPC可以方便地将gRPC集成到现有的Spring应用程序中,并利用Spring Boot提供的便利功能,如自动配置和部署。 总结:Spring Boot MVC和gRPC是两种不同的技术,分别用于构建Web应用程序和实现远程过程调用。在Spring Boot应用程序中使用gRPC实现时,需要通过定义gRPC服务接口、实现服务接口方法、配置和启动gRPC服务器等步骤来集成gRPC。这样可以在Spring Boot应用程序中使用gRPC高性能的远程过程调用功能。 ### 回答3: Spring Boot是一个基于Spring框架的快速开发框架,它简化了Spring的配置和部署过程。而MVC是Spring框架中的一种设计模式,通过它可以将应用程序的不同部分进行解耦,使得每个部分可以独立开发、测试和部署。 gRPC是一个高性能、开源的远程过程调用(RPC)框架,它使用Google Protocol Buffers作为接口定义语言,并支持多种编程语言。通过gRPC,我们可以轻松地定义RPC服务,然后使用自动生成的客户端和服务端代码进行通信。 在Spring Boot中集成MVC和gRPC可以实现两者的优势互补。我们可以使用Spring MVC来处理HTTP请求,同时使用gRPC来处理RPC请求。这样一来,我们就可以使用Spring Boot的自动配置和注解来简化开发,同时利用gRPC的高效性能和跨语言能力。 首先,我们需要在Spring Boot项目中引入gRPC的依赖。然后,我们可以定义gRPC服务接口和实现类,就像定义普通的Java接口和实现类一样。接着,我们可以使用gRPC的注解来定义服务的类型、方法、输入参数和返回值。同时,我们也可以在服务实现类中编写具体的逻辑代码。 在Spring MVC中,我们可以使用@RestController注解来定义HTTP接口,通过调用gRPC服务来处理请求。这样,我们就可以将HTTP请求转发到gRPC服务,从而实现在一个应用中同时支持HTTP和RPC两种协议。 总之,通过Spring Boot集成MVC和gRPC,我们可以在一个应用中同时支持HTTP和RPC协议,并可以充分利用两者的优势。这样,我们就可以更加方便地开发和部署分布式系统,提高系统的性能和可维护性。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

Tellsea

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

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

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

打赏作者

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

抵扣说明:

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

余额充值