java版gRPC实战之二：服务发布和调用

短命女 2023-01-13 10:07 147阅读 0赞

### 欢迎访问我的GitHub ###

> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 《java版gRPC实战》全系列链接 ###

1.  [用proto生成代码][proto]
2.  [服务发布和调用][Link 1]
3.  [服务端流][Link 2]
4.  [客户端流][Link 3]
5.  [双向流][Link 4]
6.  [客户端动态获取服务端地址][Link 5]
7.  [基于eureka的注册发现][eureka]

### 本篇概览 ###

*  本文是《java版gRPC实战》系列的第二篇，前文[《用proto生成代码》][proto]将父工程、依赖库版本、helloworld.proto对应的java代码都准备好了，今天的任务是实战gRPC服务的开发和调用，实现的效果如下图：  
    ![在这里插入图片描述][20210418095224876.jpg]
 *  本篇的具体操作如下：

1.  开发名为local-server的springboot应用，提供helloworld.proto中定义的gRPC服务；
2.  开发名为local-client的springboot应用，调用local-server提供的gRPP服务；
3.  验证gRPC服务能不能正常调用；

### 源码下载 ###

*  本篇实战中的完整源码可在GitHub下载到，地址和链接信息如下表所示(https://github.com/zq2599/blog\_demos)：

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">链接</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">项目主页</td> 
   <td align="left">https://github.com/zq2599/blog_demos</td> 
   <td align="left">该项目在GitHub上的主页</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(https)</td> 
   <td align="left">https://github.com/zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，https协议</td> 
  </tr> 
  <tr> 
   <td align="left">git仓库地址(ssh)</td> 
   <td align="left">git@github.com:zq2599/blog_demos.git</td> 
   <td align="left">该项目源码的仓库地址，ssh协议</td> 
  </tr> 
 </tbody> 
</table>

*  这个git项目中有多个文件夹，《java版gRPC实战》系列的源码在grpc-tutorials文件夹下，如下图红框所示：  
    ![在这里插入图片描述][2021041720563940.png]
 *  grpc-tutorials文件夹下有多个目录，本篇文章对应的代码在local-server和local-client中，如下图红框：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]

### 开发gRPC服务端 ###

*  首先要开发的是gRPC服务端，回顾前文中helloworld.proto中定义的服务和接口，如下所示，名为Simple的服务对外提供名为SayHello接口，这就是咱们接下来的任务，创建一个springboot应用，该应用以gRPC的方式提供SayHello接口给其他应用远程调用：

service Simple { 
        // 接口定义
        rpc SayHello (HelloRequest) returns (HelloReply) { 
        }
    }

*  基于springboot框架开发一个普通的gRPC服务端应用，一共需要五个步骤，如下图所示，接下来我们按照下图序号的顺序来开发：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]
 *  首先是在父工程grpc-turtorials下面新建名为local-server的模块，其build.gradle内容如下：

// 使用springboot插件
    plugins { 
        id 'org.springframework.boot'
    }
    
    dependencies { 
        implementation 'org.projectlombok:lombok'
        implementation 'org.springframework.boot:spring-boot-starter'
        // 作为gRPC服务提供方，需要用到此库
        implementation 'net.devh:grpc-server-spring-boot-starter'
        // 依赖自动生成源码的工程
        implementation project(':grpc-lib')
    }

*  这是个springboot应用，配置文件内容如下：

spring:
      application:
        name: local-server
    # gRPC有关的配置，这里只需要配置服务端口号
    grpc:
      server:
        port: 9898

*  新建拦截类LogGrpcInterceptor.java，每当gRPC请求到来后该类会先执行，这里是将方法名字在日志中打印出来，您可以对请求响应做更详细的处理：

package com.bolingcavalry.grpctutorials;
    
    import io.grpc.Metadata;
    import io.grpc.ServerCall;
    import io.grpc.ServerCallHandler;
    import io.grpc.ServerInterceptor;
    import lombok.extern.slf4j.Slf4j;
    
    @Slf4j
    public class LogGrpcInterceptor implements ServerInterceptor { 
        @Override
        public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> serverCall, Metadata metadata,
                                                                     ServerCallHandler<ReqT, RespT> serverCallHandler) { 
            log.info(serverCall.getMethodDescriptor().getFullMethodName());
            return serverCallHandler.startCall(serverCall, metadata);
        }
    }

*  为了让LogGrpcInterceptor可以在gRPC请求到来时被执行，需要做相应的配置，如下所示，在普通的bean的配置中添加注解即可：

package com.bolingcavalry.grpctutorials;
    
    import io.grpc.ServerInterceptor;
    import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration(proxyBeanMethods = false)
    public class GlobalInterceptorConfiguration { 
        @GrpcGlobalServerInterceptor
        ServerInterceptor logServerInterceptor() { 
            return new LogGrpcInterceptor();
        }
    }

*  应用启动类很简单：

package com.bolingcavalry.grpctutorials;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class LocalServerApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(LocalServerApplication.class, args);
        }
    }

*  接下来是最重要的service类，gRPC服务在此处对外暴露出去，完整代码如下，有几处要注意的地方稍后提到：

package com.bolingcavalry.grpctutorials;
    
    import com.bolingcavalry.grpctutorials.lib.HelloReply;
    import com.bolingcavalry.grpctutorials.lib.SimpleGrpc;
    import net.devh.boot.grpc.server.service.GrpcService;
    import java.util.Date;
    
    @GrpcService
    public class GrpcServerService extends SimpleGrpc.SimpleImplBase { 
    
        @Override
        public void sayHello(com.bolingcavalry.grpctutorials.lib.HelloRequest request,
                             io.grpc.stub.StreamObserver<com.bolingcavalry.grpctutorials.lib.HelloReply> responseObserver) { 
            HelloReply reply = HelloReply.newBuilder().setMessage("Hello " + request.getName() + ", " + new Date()).build();
            responseObserver.onNext(reply);
            responseObserver.onCompleted();
        }
    }

*  上述GrpcServerService.java中有几处需要注意：

1.  是使用@GrpcService注解，再继承SimpleImplBase，这样就可以借助grpc-server-spring-boot-starter库将sayHello暴露为gRPC服务；
2.  SimpleImplBase是前文中根据proto自动生成的java代码，在grpc-lib模块中；
3.  sayHello方法中处理完毕业务逻辑后，调用HelloReply.onNext方法填入返回内容；
4.  调用HelloReply.onCompleted方法表示本次gRPC服务完成；

*  至此，gRPC服务端编码就完成了，咱们接着开始客户端开发；

### 调用gRPC ###

*  在父工程grpc-turtorials下面新建名为local-client的模块，其build.gradle内容如下，注意要使用spingboot插件、依赖grpc-client-spring-boot-starter库：

plugins { 
        id 'org.springframework.boot'
    }
    
    dependencies { 
        implementation 'org.projectlombok:lombok'
        implementation 'org.springframework.boot:spring-boot-starter'
        implementation 'org.springframework.boot:spring-boot-starter-web'
        implementation 'net.devh:grpc-client-spring-boot-starter'
        implementation project(':grpc-lib')
    }

*  应用配置文件grpc-tutorials/local-client/src/main/resources/application.yml，注意address的值就是gRPC服务端的信息，我这里local-server和local-client在同一台电脑上运行，请您根据自己情况来设置：

server:
      port: 8080
    spring:
      application:
        name: local-grpc-client
    
    grpc:
      client:
        # gRPC配置的名字，GrpcClient注解会用到
        local-grpc-server:
          # gRPC服务端地址
          address: 'static://127.0.0.1:9898'
          enableKeepAlive: true
          keepAliveWithoutCalls: true
          negotiationType: plaintext

\-接下来要创建下图展示的类，按序号顺序创建：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]

*  首先是拦截类LogGrpcInterceptor，与服务端的拦截类差不多，不过实现的接口不同：

package com.bolingcavalry.grpctutorials;
    
    import io.grpc.*;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class LogGrpcInterceptor implements ClientInterceptor { 
    
        private static final Logger log = LoggerFactory.getLogger(LogGrpcInterceptor.class);
    
        @Override
        public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(MethodDescriptor<ReqT, RespT> method,
                CallOptions callOptions, Channel next) { 
            log.info(method.getFullMethodName());
            return next.newCall(method, callOptions);
        }
    }

*  为了让拦截类能够正常工作，即发起gRPC请求的时候被执行，需要新增一个配置类：

package com.bolingcavalry.grpctutorials;
    
    import io.grpc.ClientInterceptor;
    import net.devh.boot.grpc.client.interceptor.GrpcGlobalClientInterceptor;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.Ordered;
    import org.springframework.core.annotation.Order;
    
    @Order(Ordered.LOWEST_PRECEDENCE)
    @Configuration(proxyBeanMethods = false)
    public class GlobalClientInterceptorConfiguration { 
    
        @GrpcGlobalClientInterceptor
        ClientInterceptor logClientInterceptor() { 
            return new LogGrpcInterceptor();
        }
    }

*  启动类：

package com.bolingcavalry.grpctutorials;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class LocalGrpcClientApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(LocalGrpcClientApplication.class, args);
        }
    }

*  接下来是最重要的服务类GrpcClientService，有几处要注意的地方稍后会提到：

package com.bolingcavalry.grpctutorials;
    
    import com.bolingcavalry.grpctutorials.lib.HelloReply;
    import com.bolingcavalry.grpctutorials.lib.HelloRequest;
    import com.bolingcavalry.grpctutorials.lib.SimpleGrpc;
    import io.grpc.StatusRuntimeException;
    import net.devh.boot.grpc.client.inject.GrpcClient;
    import org.springframework.stereotype.Service;
    
    @Service
    public class GrpcClientService { 
    
        @GrpcClient("local-grpc-server")
        private SimpleGrpc.SimpleBlockingStub simpleStub;
    
        public String sendMessage(final String name) { 
            try { 
                final HelloReply response = this.simpleStub.sayHello(HelloRequest.newBuilder().setName(name).build());
                return response.getMessage();
            } catch (final StatusRuntimeException e) { 
                return "FAILED with " + e.getStatus().getCode().name();
            }
        }
    }

*  上述GrpcClientService类有几处要注意的地方：

1.  用@Service将GrpcClientService注册为spring的普通bean实例；
2.  用@GrpcClient修饰SimpleBlockingStub，这样就可以通过grpc-client-spring-boot-starter库发起gRPC调用，被调用的服务端信息来自名为local-grpc-server的配置；
3.  SimpleBlockingStub来自前文中根据helloworld.proto生成的java代码；
4.  SimpleBlockingStub.sayHello方法会远程调用local-server应用的gRPC服务；

*  为了验证gRPC服务调用能否成功，再新增个web接口，接口内部会调用GrpcClientService.sendMessage，这样咱们通过浏览器就能验证gRPC服务是否调用成功了：

package com.bolingcavalry.grpctutorials;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class GrpcClientController { 
    
        @Autowired
        private GrpcClientService grpcClientService;
    
        @RequestMapping("/")
        public String printMessage(@RequestParam(defaultValue = "will") String name) { 
            return grpcClientService.sendMessage(name);
        }
    }

*  编码完成，接下来将两个服务都启动，验证gRPC服务是否正常；

### 验证gRPC服务 ###

1.  local-server和local-client都是普通的springboot应用，可以在IDEA中启动，点击下图红框位置，在弹出菜单中选择Run 'LocalServerApplication’即可启动local-server：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]
2.  local-server启动后，控制台会提示gRPC server已启动，正在监听9898端口，如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]
3.  local-client后，在浏览器输入http://localhost:8080/?name=Tom，可以看到响应的内容正是来自local-server的GrpcServerService.java：  
    ![在这里插入图片描述][20210418161514705.png]
4.  从web端到gRPC服务端的关键节点信息如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 5]

*  可以看到local-server的拦截日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 6]
 *  还有local-client的拦截日志：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 7]
 *  至此，最简单的java版gRPC服务发布和调用验证通过，本篇的任务也就完成了，接下来的文章，咱们会继续深入学习java版gRPC的相关技术；

### 你不孤单，欣宸原创一路相伴 ###

1.  [Java系列][Java]
2.  [Spring系列][Spring]
3.  [Docker系列][Docker]
4.  [kubernetes系列][kubernetes]
5.  [数据库+中间件系列][Link 6]
6.  [DevOps系列][DevOps]

### 欢迎关注公众号：程序员欣宸 ###

> 微信搜索「程序员欣宸」，我是欣宸，期待与您一同畅游Java世界…

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[proto]: https://xinchen.blog.csdn.net/article/details/115049443
[Link 1]: https://xinchen.blog.csdn.net/article/details/115803738
[Link 2]: https://xinchen.blog.csdn.net/article/details/115983001
[Link 3]: https://xinchen.blog.csdn.net/article/details/116097756
[Link 4]: https://xinchen.blog.csdn.net/article/details/116354293
[Link 5]: https://xinchen.blog.csdn.net/article/details/116479078
[eureka]: https://xinchen.blog.csdn.net/article/details/116635441
[20210418095224876.jpg]: /images/20221022/28f9c1c1c7ba485ab97cbdfa58484924.png
[2021041720563940.png]: /images/20221022/20a62728b233427db44b70d337a4345b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]: /images/20221022/94363f37c96f405db06d3078a66b5120.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]: /images/20221022/2e0c6fd0768f4701bcd76c004a306dda.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 2]: /images/20221022/9ce2721e6d8b423eaa1112f023a7422d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 3]: /images/20221022/b6adae714f074e86bc7c8d87fff56621.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 4]: /images/20221022/a46597e18a2c40cb8a47e9233fa72567.png
[20210418161514705.png]: /images/20221022/c8a4e0ec5e004a198029c026bdfd03b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 5]: /images/20221022/219406435ee444ce97417d31c60f34c5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 6]: /images/20221022/79207f45a6ac45e4b213f1cf3dcd4a57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 7]: /images/20221022/e3f4760c4d794e4486a1e0019a53818d.png
[Java]: https://xinchen.blog.csdn.net/article/details/105068742
[Spring]: https://xinchen.blog.csdn.net/article/details/105086498
[Docker]: https://xinchen.blog.csdn.net/article/details/105086732
[kubernetes]: https://xinchen.blog.csdn.net/article/details/105086794
[Link 6]: https://xinchen.blog.csdn.net/article/details/105086850
[DevOps]: https://xinchen.blog.csdn.net/article/details/105086920

发表评论取消回复

表情：

评论列表（有 0 条评论，147人围观）

还没有评论，来说两句吧...

相关阅读

相关 java版gRPC实战之七：基于eureka的注册发现

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

ゝ一纸荒年。/ 2023年01月20日 01:56/ 0 赞/ 7 阅读

相关 java版gRPC实战之六：客户端动态获取服务端地址

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

川长思鸟来/ 2023年01月19日 01:56/ 0 赞/ 9 阅读

相关 java版gRPC实战之四：客户端流

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

绝地灬酷狼/ 2023年01月16日 06:48/ 0 赞/ 151 阅读

相关 java版gRPC实战之三：服务端流

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

落日映苍穹つ/ 2023年01月15日 08:10/ 0 赞/ 157 阅读

相关 java版gRPC实战之二：服务发布和调用

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

短命女/ 2023年01月13日 10:07/ 0 赞/ 148 阅读

相关 java版gRPC实战之五：双向流

欢迎访问我的GitHub > 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_g

Bertha 。/ 2022年10月21日 14:57/ 0 赞/ 234 阅读

相关 java版gRPC实战之五：双向流

本篇概览本文是《java版gRPC实战》系列的第五篇，目标是掌握双向流类型的服务，即请求参数是流的形式，响应的内容也是流的形式；先来看看官方资料对双向流式

谁践踏了优雅/ 2022年09月11日 13:29/ 0 赞/ 228 阅读

相关 java版gRPC实战之七：基于eureka的注册发现

关于eureka 前面咱们在开发客户端应用时，所需的服务端地址都是按如下步骤设置的：在application.yml中配置，如下图： ![在这里插入图片描述]

女爷i/ 2022年08月28日 13:47/ 0 赞/ 237 阅读

相关 java版gRPC实战之六：客户端动态获取服务端地址

客户端为什么要动态获取服务端地址本文是《java版gRPC实战》系列的第六篇，前面咱们在开发客户端应用时，所需的服务端地址都是按如下步骤设置的：在applic

电玩女神/ 2022年08月28日 13:43/ 0 赞/ 375 阅读

相关 GRPC服务-跨平台调用

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ub

女爷i/ 2022年04月25日 03:00/ 0 赞/ 277 阅读