ICode9
精准搜索请尝试： 精确搜索
首页
编程语言>
数据库
系统相关
互联网
其他分享
Python
Java
JavaScript
android
PHP
首页 > 其他分享> 文章详细

Spring Boot 集成 GRPC

2022-06-19 11:35:41  阅读：139  来源： 互联网

标签：SpringBoot GRPC Spring Boot HelloWorld server Grpc grpc


Spring Boot 集成 GRPC

http://www.demodashi.com/demo/14110.html

概述

SpringBoot框架中集成Grpc服务

详细

一.背景

Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。

Grpc 由 google 开发，是一款语言中立、平台中立、开源的远程过程调用(RPC)系统。

​ 项目定位是电商平台和WMS系统中间的插件服务，wms采用.net语言开发，电商平台采用java开发，所以出现了多语言间的数据交换，开始考虑使用json协议，方便快捷，但是考虑到效率和系统发展的问题，考虑使用RPC框架，斟酌之后敲定为GRPC。

​ 但是，我们拓展服务使用的SpringBoot，Grpc和SpringBoot集成的文章不是很多，大部分都是采用github上*-springboot.grpc.starter的项目，看了一下，并不是很感兴趣，所以自己根据官网的demo，尝试与SpringBoot集成，所以在这和大家分享下

二. 准备工作

开发环境

Spring Boot 2.0.5.RELEASE
Grpc 1.15.0
Inteliji Idea 2018.3

项目截图

三.实现过程

1. 配置SpringBoot项目

  • Pom文件增加

    1. <parent>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-parent</artifactId>
    4. <version>2.0.5.RELEASE</version>
    5. </parent>
    7. <dependencies>
    8. <dependency>
    9. <groupId>org.springframework.boot</groupId>
    10. <artifactId>spring-boot-starter-web</artifactId>
    11. </dependency>
    12. <dependency>
    13. <groupId>org.springframework.boot</groupId>
    14. <artifactId>spring-boot-starter-test</artifactId>
    15. </dependency>
    16. </dependencies>
  • 编写启动类
  1. publicstaticvoid main(String[] args){
  2. // 启动SpringBoot web
  3. SpringApplication.run(Launcher.class, args);
  4. }
2. 增加GRPC支持和GRPC代码生成工具，集成GrpcServer端
  • 增加POM文件
  1. <dependency>
  2. <groupId>io.grpc</groupId>
  3. <artifactId>grpc-netty-shaded</artifactId>
  4. <version>1.15.0</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>io.grpc</groupId>
  8. <artifactId>grpc-protobuf</artifactId>
  9. <version>1.15.0</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>io.grpc</groupId>
  13. <artifactId>grpc-stub</artifactId>
  14. <version>1.15.0</version>
  15. </dependency>
  • 增加maven工具
  1. <build>
  2. <extensions>
  3. <extension>
  4. <groupId>kr.motd.maven</groupId>
  5. <artifactId>os-maven-plugin</artifactId>
  6. <version>1.5.0.Final</version>
  7. </extension>
  8. </extensions>
  9. <plugins>
  10. <plugin>
  11. <groupId>org.xolstice.maven.plugins</groupId>
  12. <artifactId>protobuf-maven-plugin</artifactId>
  13. <version>0.5.1</version>
  14. <configuration>
  15. <protocArtifact>com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}</protocArtifact>
  16. <pluginId>grpc-java</pluginId>
  17. <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.15.0:exe:${os.detected.classifier}</pluginArtifact>
  18. </configuration>
  19. <executions>
  20. <execution>
  21. <goals>
  22. <goal>compile</goal>
  23. <goal>compile-custom</goal>
  24. </goals>
  25. </execution>
  26. </executions>
  27. </plugin>
  28. </plugins>
  29. </build>
  • 编写Server端实现类
  2. publicclassHelloWorldServiceextendsHelloWorldServiceGrpc.HelloWorldServiceImplBase{
  4. @Override
  5. publicvoid welcome(HelloWorld.NameRequest request,StreamObserver<HelloWorld.EchoResponse> responseObserver){
  6. HelloWorld.EchoResponseOrBuilder echoResponseOrBuilder =HelloWorld.EchoResponse.newBuilder();
  7. ((HelloWorld.EchoResponse.Builder) echoResponseOrBuilder).setMergename("welcome "+ request.getName());
  8. responseObserver.onNext(((HelloWorld.EchoResponse.Builder) echoResponseOrBuilder).build());
  9. responseObserver.onCompleted();
  10. }
  11. }
  • 增加Grpc启动器
  1. @Component("grpcLauncher")
  2. publicclassGrpcLauncher{
  4. privateLogger logger =LoggerFactory.getLogger(Launcher.class);
  7. /**
  8. * 定义Grpc Server
  9. */
  10. privateServer server;
  13. @Value("${grpc.server.port}")
  14. privateInteger grpcServerPort;
  15. /**
  16. * GRPC 服务启动方法
  17. * @param grpcServiceBeanMap
  18. */
  19. publicvoid grpcStart(Map<String,Object> grpcServiceBeanMap){
  20. try{
  21. SelfSignedCertificate ssc =newSelfSignedCertificate();
  22. ServerBuilder serverBuilder =ServerBuilder.forPort(grpcServerPort).useTransportSecurity(ssc.certificate(), ssc.privateKey());
  23. for(Object bean : grpcServiceBeanMap.values()){
  24. serverBuilder.addService((BindableService) bean);
  25. logger.info(bean.getClass().getSimpleName()+" is regist in Spring Boot");
  26. }
  27. server = serverBuilder.build().start();
  28. logger.info("grpc server is started at "+ grpcServerPort);
  29. server.awaitTermination();
  30. Runtime.getRuntime().addShutdownHook(newThread(()->{grpcStop();}));
  31. }catch(IOException e){
  32. e.printStackTrace();
  33. }catch(InterruptedException e){
  34. e.printStackTrace();
  35. }
  36. }
  38. /**
  39. * GRPC 服务Stop方法
  40. */
  41. privatevoid grpcStop(){
  42. if(server !=null){
  43. server.shutdownNow();
  44. }
  45. }
  46. }
  • 添加自定义注解用于扫描Grpc服务
  1. /**
  2. * 自定义注解，用于获取Spring扫描到的类
  3. */
  4. @Target({ElementType.TYPE})
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. @Component
  8. public@interfaceGrpcService{
  9. }
  • 在SpringBoot中增加Grpc启动器，并将Spring管理的类，添加到Grpc服务中
  1. /**
  2. * Spring Boot 启动器
  3. */
  4. @SpringBootApplication
  5. publicclassLauncher{
  7. publicstaticvoid main(String[] args){
  8. // 启动SpringBoot web
  9. ConfigurableApplicationContext configurableApplicationContext =SpringApplication.run(Launcher.class, args);
  10. Map<String,Object> grpcServiceBeanMap = configurableApplicationContext.getBeansWithAnnotation(GrpcService.class);
  11. GrpcLauncher grpcLauncher = configurableApplicationContext.getBean("grpcLauncher",GrpcLauncher.class);
  12. grpcLauncher.grpcStart(grpcServiceBeanMap);
  13. }
  14. }

至此Server端，集成完毕

3. 增加Client端
  • 获取Chanel
  2. @Component
  3. publicclassGrpcClientMananer{
  4. @Value("${grpc.client.host}")
  5. privateString host;
  6. @Value("${grpc.client.port}")
  7. privateInteger port;
  9. publicManagedChannel getChannel(){
  10. NettyChannelBuilder ncb =NettyChannelBuilder.forAddress(host, port).sslContext(SslContextBuilder.forClient()
  11. .sslProvider(OpenSsl.isAlpnSupported()?SslProvider.OPENSSL :SslProvider.JDK)
  12. .ciphers(Http2SecurityUtil.CIPHERS,SupportedCipherSuiteFilter.INSTANCE)
  13. .trustManager(InsecureTrustManagerFactory.INSTANCE)
  14. .applicationProtocolConfig(
  15. newApplicationProtocolConfig(
  16. ApplicationProtocolConfig.Protocol.ALPN,
  17. ApplicationProtocolConfig.SelectorFailureBehavior.NO_ADVERTISE,
  18. ApplicationProtocolConfig.SelectedListenerFailureBehavior.ACCEPT,
  19. ApplicationProtocolNames.HTTP_2,
  20. ApplicationProtocolNames.HTTP_1_1))
  21. .build());
  22. return ncb.build();
  23. }
  24. }
  • 调用方式
  1. @Component
  2. publicclassHelloWorldClient{
  4. @Autowired
  5. privateGrpcClientMananer grpcClientMananer;
  7. publicvoid call(){
  8. ManagedChannel channel = grpcClientMananer.getChannel();
  9. HelloWorld.NameRequestOrBuilder nameRequestOrBuilder =HelloWorld.NameRequest.newBuilder();
  10. ((HelloWorld.NameRequest.Builder) nameRequestOrBuilder).setName("Geek");
  11. HelloWorldServiceGrpc.HelloWorldServiceBlockingStub stub =HelloWorldServiceGrpc.newBlockingStub(channel);
  12. HelloWorld.EchoResponse echoResponse = stub.welcome(((HelloWorld.NameRequest.Builder) nameRequestOrBuilder).build());
  13. System.out.println(echoResponse.getMergename());
  14. }
  16. }
  18. `

四.其他补充

暂没

标签：SpringBoot,GRPC,Spring,Boot,HelloWorld,server,Grpc,grpc
来源： https://www.cnblogs.com/xiondun/p/16390153.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

关于我们 | 联系我们 | 留言反馈

专注分享技术，共同学习，共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有