AI 助理
备案控制台登录注册
开发者社区 开发与运维 文章 正文

SpringBoot集成Dubbo启用gRPC协议

2023-08-17 281 发布于陕西
版权
举报
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 本文记录下SpringBoot集成Dubbo启用gRPC协议，以及与原生 gRPC 在代码编写过程中的区别。

本文记录下SpringBoot集成Dubbo启用gRPC协议，以及与原生 gRPC 在代码编写过程中的区别。

2023.6.30 补充：Dubbo 官方文档开放，为开发者使用提供友好的支持。

前言

Dubbo 在 2.7.5 版本开始支持原生 gRPC 协议，对于计划使用 HTTP/2 通信或者期望 gRPC 协议支持服务治理能力的，都可以考虑接入 Dubbo 体系启用 gRPC 协议。

由于官网给的 代码示例 是基于 spring，现在基本上都是基于SpringBoot开发，所以本文提供一下 SpringBoot 的代码示例。

此外还会简单说明 Dubbo 支持的原生 gRPC 协议与原生 gRPC 协议在代码开发时的区别。

如果对gRPC协议不了解的，后续文章会有更新，请持续关注。

项目结构

根据现在微服务开发的常见方式，先搭建一个项目，结构如下
在这里插入图片描述

这样的项目结构可以将服务的声明和实现隔离开，如果有 client 调用，直接添加api module 的依赖即可。

代码示例

项目结构确定好后需要做三件事

  1. 在项目中需要用到 grpc 和 dubbo 相关依赖，所以在父工程中的 pom.xml 文件添加两者的 BOM。
  2. gRPC 支持的序列化协议为 protobuf，我们在 api module 下添加 gRPC 所需依赖、插件以及 proto IDL文件。
  3. 在 service module 添加相关配置并进行 api service 的实现。

详细代码如下：

父工程

父工程中的 pom.xml 文件添加 grpc 和 dubbo 的 BOM。
pom.xml

<?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>
    <groupId>com.demo</groupId>
    <artifactId>nava</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>nava</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <dubbo.version>3.1.7</dubbo.version>
        <grpc.version>1.44.1</grpc.version>
        <spring-boot.version>2.6.11</spring-boot.version>
    </properties>

    <modules>
        <module>nava-api</module>
        <module>nava-service</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.grpc</groupId>
                <artifactId>grpc-bom</artifactId>
                <version>${grpc.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-bom</artifactId>
                <version>${dubbo.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.demo</groupId>
                <artifactId>nava-api</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.demo</groupId>
                <artifactId>nava-service</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>


        

          
        

        
        

          

          AI 代码解读

api module

在 api module 中的 pom.xml 文件添加 dubbo 、gRPC 所需依赖、插件。
pom.xml

<?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.demo</groupId>
        <artifactId>nava</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>nava-api</artifactId>
    <name>nava-api</name>
    <description>api 模块，对外提供的 API</description>
    <dependencies>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-netty</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>io.netty</groupId>
                    <artifactId>netty-codec-http2</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>io.netty</groupId>
                    <artifactId>netty-handler-proxy</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-netty-shaded</artifactId>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-protobuf</artifactId>
        </dependency>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-stub</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-common</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.7.1</version>
                <executions>
                    <execution>
                        <id>os-maven-plugin</id>
                        <phase>initialize</phase>
                        <goals>
                            <goal>detect</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>0.6.1</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:3.7.1:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
                    <protocPlugins>
                        <protocPlugin>
                            <id>dubbo-grpc</id>
                            <groupId>org.apache.dubbo</groupId>
                            <artifactId>dubbo-compiler</artifactId>
                            <version>0.0.1</version>
                            <mainClass>org.apache.dubbo.gen.grpc.DubboGrpcGenerator</mainClass>
                        </protocPlugin>
                    </protocPlugins>
                </configuration>
                <executions>
                    <execution>
                        <id>protobuf-maven-plugin</id>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>


        

          
        

        
        

          

          AI 代码解读

在main文件夹下面创建proto文件夹，以及 DemoService.proto 文件。
在这里插入图片描述

DemoService.proto

syntax = "proto3";

option java_multiple_files = true;
option java_package = "com.demo.nava";
option java_outer_classname = "DemoServiceProto";
option objc_class_prefix = "DSP";

// The greeting service definition.
service DemoService {
   
   
  // Sends a greeting
  rpc service (RequestData) returns (ResponseData) {
   
   }
}

// The request message containing the user's name.
message RequestData {
   
   
  string name = 1;
}

// The response message containing the greetings
message ResponseData {
   
   
  string message = 1;
}


        

          
        

        
        

          

          AI 代码解读

service module

在 service module 中的 pom.xml 文件添加 api module 的依赖以及 dubbo 其他依赖。

pom.xml

<?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.demo</groupId>
        <artifactId>nava</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <artifactId>nava-service</artifactId>
    <name>nava-service</name>
    <description>service 模块，存放核心业务逻辑代码</description>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.demo</groupId>
            <artifactId>nava-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-registry-nacos</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.6.11</version>
                <configuration>
                    <mainClass>com.demo.nava.NavaApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>


        

          
        

        
        

          

          AI 代码解读

在 application.properties 文件中添加 dubbo 相关配置

application.properties


# 设置dubbo传输协议
dubbo.protocol.name=grpc
dubbo.protocol.port=-1
# dubbo nacos注册中心说明 https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/registry/nacos/
dubbo.registry.address: nacos://nacos:nacos@${
   
   nacos.address:127.0.0.1}:8848


        

          
        

        
        

          

          AI 代码解读

在 SpringBoot 启动类添加 @EnableDubbo 注解

在这里插入图片描述

添加 DemoServiceImpl 实现类进行业务编码。

DemoServiceImpl.java

package com.demo.nava.service;

import com.demo.nava.DubboDemoServiceGrpc;
import com.demo.nava.RequestData;
import com.demo.nava.ResponseData;
import io.grpc.stub.StreamObserver;
import org.apache.dubbo.config.annotation.DubboService;

@DubboService
public class DemoServiceImpl extends DubboDemoServiceGrpc.DemoServiceImplBase implements DubboDemoServiceGrpc.IDemoService {
   
   

    @Override
    public void service(RequestData request, StreamObserver<ResponseData> responseObserver) {
   
   
        ResponseData reply = ResponseData.newBuilder().setMessage("Hello " + request.getName()).build();
        responseObserver.onNext(reply);
        responseObserver.onCompleted();
    }
}


        

          
        

        
        

          

          AI 代码解读

注意事项

经过以上的步骤，一个简单的 SpringBoot 集成 Dubbo 启用 gRPC 协议的示例就完成了。这个时候直接启动项目是会报错的，因为protobuf相关的代码还没生成，我们需要对项目进行 maven install 以及 maven reload 操作。

maven install 的目的是为了生成protobuf相关代码，这个时候我们可以在 target 中看到

在这里插入图片描述

maven reload 的目的是为了更新加载 pom.xml 文件，从而将 api module 中生成的代码加载到 service module。

操作后就可以成功启动项目了。

区别

在项目启动成功后可以回头看下 Dubbo 支持的原生 gRPC 与原生 gRPC 在代码编写过程中的区别

  1. maven plugin 的区别，dubbo 在原先的基础上添加了 dubbo-grpc 的 plugin，目的是生成扩展的代码做到对 grpc 的支持。
    在这里插入图片描述
    对应生成的代码如下
    在这里插入图片描述

  1. service 实现区别，dubbo-grpc 的 plugin 生成了 dubbo 相关的 protobuf 的代码，所以在实现上有所区别。
    在这里插入图片描述

  2. RPC 调用区别，因为 grpc 接入了 dubbo 体系，所以使用 Dubbo 风格，基于接口的编程来定义和使用远程服务。
    在这里插入图片描述

文章标签：
应用服务中间件
Dubbo
Java
API
Maven
关键词：
Spring Boot grpc
集成springboot
Dubbo协议
Dubbo springboot
Dubbo grpc
王二蛋呀
+关注
62文章1问答
目录
打赏
0
0
0
0
5
分享
相关文章
蓝易云
|
1月前
|
Java 关系型数据库 MySQL
SpringBoot 通过集成 Flink CDC 来实时追踪 MySql 数据变动
通过详细的步骤和示例代码，您可以在 SpringBoot 项目中成功集成 Flink CDC，并实时追踪 MySQL 数据库的变动。
蓝易云
199 43
蓝易云
|
12天前
|
Cloud Native Java Nacos
springcloud/springboot集成NACOS 做注册和配置中心以及nacos源码分析
通过本文，我们详细介绍了如何在 Spring Cloud 和 Spring Boot 中集成 Nacos 进行服务注册和配置管理，并对 Nacos 的源码进行了初步分析。Nacos 作为一个强大的服务注册和配置管理平台，为微服务架构提供
蓝易云
160 14
大数据文摘
|
13天前
|
消息中间件 XML 前端开发
springBoot集成websocket实时消息推送
本文介绍了如何在Spring Boot项目中集成WebSocket实现实时消息推送。首先，通过引入`spring-boot-starter-websocket`依赖，配置`WebSocketConfig`类来启用WebSocket支持。接着，创建`WebSocketTest`服务器类，处理连接、消息收发及错误等事件，并使用`ConcurrentHashMap`管理用户连接。最后，前端通过JavaScript建立WebSocket连接，监听消息并进行相应处理。此方案适用于需要实时通信的应用场景，如聊天室、通知系统等。
大数据文摘
49 2
蓝易云
|
1月前
|
监控 前端开发 Java
SpringBoot集成Tomcat、DispatcherServlet
通过这些配置，您可以充分利用 Spring Boot 内置的功能，快速构建和优化您的 Web 应用。
蓝易云
67 21
蓝易云
|
2月前
|
监控 Java Nacos
使用Spring Boot集成Nacos
通过上述步骤，Spring Boot应用可以成功集成Nacos，利用Nacos的服务发现和配置管理功能来提升微服务架构的灵活性和可维护性。通过这种集成，开发者可以更高效地管理和部署微服务。
蓝易云
301 17
大数据文摘
|
2月前
|
XML JavaScript Java
SpringBoot集成Shiro权限+Jwt认证
本文主要描述如何快速基于SpringBoot 2.5.X版本集成Shiro+JWT框架，让大家快速实现无状态登陆和接口权限认证主体框架，具体业务细节未实现，大家按照实际项目补充。
大数据文摘
115 11
Harry技术
|
2月前
|
缓存 安全 Java
Spring Boot 3 集成 Spring Security + JWT
本文详细介绍了如何使用Spring Boot 3和Spring Security集成JWT，实现前后端分离的安全认证概述了从入门到引入数据库，再到使用JWT的完整流程。列举了项目中用到的关键依赖，如MyBatis-Plus、Hutool等。简要提及了系统配置表、部门表、字典表等表结构。使用Hutool-jwt工具类进行JWT校验。配置忽略路径、禁用CSRF、添加JWT校验过滤器等。实现登录接口，返回token等信息。
Harry技术
599 12
Harry技术
|
2月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面，可以在方法执行前后自动记录日志信息，包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等，并将这些信息保存到数据库中。此外，还使用了`ThreadLocal`变量来存储每个线程独立的日志数据，确保线程安全。文中还展示了项目实战中的部分代码片段，以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈，提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
Harry技术
95 8
阿里云云原生
|
4月前
|
Dubbo 安全 应用服务中间件
Apache Dubbo 正式发布 HTTP/3 版本 RPC 协议，弱网效率提升 6 倍
在 Apache Dubbo 3.3.0 版本之后，官方推出了全新升级的 Triple X 协议，全面支持 HTTP/1、HTTP/2 和 HTTP/3 协议。本文将围绕 Triple 协议对 HTTP/3 的支持进行详细阐述，包括其设计目标、实际应用案例、性能测试结果以及源码架构分析等内容。
阿里云云原生
302 9
大数据文摘
|
3月前
|
XML Java API
Spring Boot集成MinIO
本文介绍了如何在Spring Boot项目中集成MinIO，一个高性能的分布式对象存储服务。主要步骤包括：引入MinIO依赖、配置MinIO属性、创建MinIO配置类和服务类、使用服务类实现文件上传和下载功能，以及运行应用进行测试。通过这些步骤，可以轻松地在项目中使用MinIO的对象存储功能。
大数据文摘
196 5

热门文章

最新文章

  • 1
    Springboot使用Redis实现分布式锁
    8
  • 2
    spring boot 启动流程
    20
  • 3
    SpringBoot-打包&部署
    3
  • 4
    Springboot静态资源映射及文件映射
    16
  • 5
    详细介绍SpringBoot启动流程及配置类解析原理
    10
  • 6
    SpringBoot：SpringBoot通过注解监测Controller接口
    4
  • 7
    基于SpringBoot的智慧停车场微信小程序源码分享
    12
  • 8
    编写SpringBoot的自定义starter包
    2
  • 9
    Jeesite5：Star24k,Spring Boot 3.3+Vue3实战开源项目,架构深度拆解！让企业级项目开发效率提升300%的秘密武器
    7
  • 10
    🛡️Spring Boot 3 整合 Spring Cloud Gateway 工程实践
    20
  • 1
    如何将Dubbo应用接入服务网格
    126
  • 2
    Dubbo背景和简介
    79
  • 3
    理解java的springboot+mybatisplus+dubbo+nacos+kafka这一套技术栈
    143
  • 4
    Spring Boot 调用 Dubbo 接口与编写 Dubbo 接口实战
    831
  • 5
    分布式系统面试全集通第一篇（dubbo+redis+zookeeper----分布式+CAP+BASE+分布式事务+分布式锁）
    138
  • 6
    Dubbo怎么配置监控中心
    160
  • 7
    dubbo-admin安装(分离版本)
    76
  • 8
    DUBBO--基础篇（二）--监控中心
    81
  • 9
    DUBBO--基础篇（一）--简介（示意Demo）
    162
  • 10
    dubbo面试题收集
    87

    • 相关课程

    更多
  • SpringBoot实战教程
  • 基于Zookeeper、Dubbo构建互联网分布式基础架构
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Dubbo分布式服务治理实战
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • Dubbo 2.7.6 新特性
  • 集成智能接入网关APP：优化企业级移动办公网络
  • 云效助力企业集成安全到DevOps中

    • 相关实验场景

    更多
  • 基于MSE-Nacos实现服务的动态发现和配置动态管理
  • 快速玩转Dubbo生态之一致性事务篇（Seata）
  • 快速玩转Dubbo生态之限流降级篇（Sentinel）
  • 快速上手使用Dubbo进行远程调用
  • Spring-cloud-bus-rocketmq入门与实践
  • Spring-cloud-stream-binder-rocketmq入门与实践
    • 下一篇
    阿里云负载均衡SLB版本CLB、ALB和NLB有什么区别如何选择？
    目录
    AI助理

    你好，我是AI助理

    可以解答问题、推荐解决方案等