dubbo实战之二：与SpringBoot集成

╰半夏微凉° 2022-12-15 15:27 166阅读 0赞

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

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

### 《dubbo实战》系列导航 ###

1.  [准备和初体验][Link 1]
2.  [与SpringBoot集成][SpringBoot]
3.  [使用Zookeeper注册中心][Zookeeper]
4.  [管理控制台dubbo-admin][dubbo-admin]

### 本篇概览 ###

*  本文是《dubbo实战》系列的第二篇，一起来实战SpringBoot（2.3.3.RELEASE版本）与dubbo的集成，这也是分布式服务的常用技术组合，本文由以下内容组成：

1.  创建子工程springbootmulticastprovider，对外提供服务；
2.  创建子工程springbootmulticastconsumer，启动后提供一个web接口，咱们调用这个web接口时，springbootmulticastconsumer会远程调用springbootmulticastprovider提供的服务，如下图：  
    ![在这里插入图片描述][20201018113745557.jpg_pic_center]
3.  本篇的实战暂不使用注册中心，而是服务提供方启动时广播自己的地址，再由消费方启动时订阅，并随时远程调用，调用逻辑如下图所示：  
    ![在这里插入图片描述][20201017231405581.jpg_pic_center]

### 源码下载 ###

1.  如果您不想编码，可以在GitHub下载所有源码，地址和链接信息如下表所示：

<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>

1.  这个git项目中有多个文件夹，本章的应用在dubbopractice文件夹下，如下图红框所示：  
    ![在这里插入图片描述][20201018102439720.jpg_pic_center]
2.  dubbopractice是父子结构的工程，本篇的代码在springbootmulticastprovider和springbootmulticastconsumer这两个子工程中，如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left]

### 编码(服务提供方) ###

*  先创建提供服务的工程springbootmulticastprovider，一共要创建4个文件，创建顺序和功能如下表：

*  完整的文件位置如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 1]
 *  接下来逐个创建上述内容；

1.  创建名为springbootmulticastprovider的子工程，pom.xml内容如下，要重点关注的是新增依赖dubbo-spring-boot-starter，这就是dubbo在SpringBoot环境的starter依赖：

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>dubbopractice</artifactId>
            <groupId>com.bolingcavalry</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.bolingcavalry</groupId>
        <artifactId>springbootmulticastprovider</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>springbootmulticastprovider</name>
        <description>Demo project for dubbo service provider from Spring Boot, multicast mode</description>
    
        
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${springboot.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <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>com.bolingcavalry</groupId>
                <artifactId>practiceinterface</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>${springboot.version}</version>
                </plugin>
            </plugins>
        </build>
    </project>

1.  配置文件application.yml，要注意的是registry.address的配置是广播模式：

dubbo:
      application:
        #application-name 本模块名字
        name: springboot-multicast-provider
        id: springboot-multicast-provider
      registry:
        address: multicast://224.5.6.7:1234
        id: registry
      protocol:
        name: dubbo
        port: 20880

1.  编写服务实现类DemoServiceImpl.java，注意@Service注解将当前类的实例作为远程服务对外暴露：

package com.bolingcavalry.springbootmulticastprovider;
    
    import com.bolingcavalry.dubbopractice.service.DemoService;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.dubbo.config.annotation.Service;
    import org.apache.dubbo.rpc.RpcContext;
    
    @Slf4j
    @Service
    public class DemoServiceImpl implements DemoService { 
        @Override
        public String sayHello(String name) { 
            log.info("I'm springboot-multicast-provider, Hello " + name + ", request from consumer: " + RpcContext.getContext().getRemoteAddress());
            try { 
                Thread.sleep(1000);
            } catch (InterruptedException e) { 
                e.printStackTrace();
            }
            return "I'm springboot-multicast-provider, Hello " + name + ", response from provider: " + RpcContext.getContext().getLocalAddress();
        }
    }

1.  编写SpringBoot启动类SpringBootMulticastProviderApplication.java，注意要添加@EnableDubbo注解：

package com.bolingcavalry.springbootmulticastprovider;
    
    import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @EnableDubbo
    public class SpringBootMulticastProviderApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(SpringBootMulticastProviderApplication.class, args);
        }
    }

1.  至此服务提供方编码完成，直接在IDEA上运行SpringBootMulticastProviderApplication类即可启动服务，启动成功后的日志输出如下图：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 2]

### 编码(服务消费方) ###

*  现在网络上已经有了服务，咱们再来编写服用消费方的代码，一共要创建6个文件，创建顺序和功能如下表：

<table> 
 <thead> 
  <tr> 
   <th>创建顺序</th> 
   <th>文件名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>pom.xml</td> 
   <td>工程的pom文件</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>src/main/resources/application.yml</td> 
   <td>配置文件</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>RemoteInvokeServiceImpl.java</td> 
   <td>service层，在这里远程调用服务提供方的服务</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>DemoController.java</td> 
   <td>web接口类，对外提供web服务</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>SwaggerConfig.java</td> 
   <td>swagger配置类，便于通过页面测试接口</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>SpringBootMulticastConsumerApplication.java</td> 
   <td>启动类</td> 
  </tr> 
 </tbody> 
</table>

1.  创建名为springbootmulticastconsumer的子工程，pom.xml内容如下，同样需要依赖dubbo-spring-boot-starter：

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>dubbopractice</artifactId>
            <groupId>com.bolingcavalry</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.bolingcavalry</groupId>
        <artifactId>springbootmulticastconsumer</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>springbootmulticastconsumer</name>
        <description>Demo project for dubbo service consumer from Spring Boot, multicast mode</description>
    
        
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${springboot.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <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>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
            </dependency>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
            </dependency>
            <dependency>
                <groupId>com.bolingcavalry</groupId>
                <artifactId>practiceinterface</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
            <dependency>
                <groupId>org.apache.dubbo</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>${springboot.version}</version>
                </plugin>
            </plugins>
        </build>
    </project>

1.  编写配置文件application.yml，注意dubbo.registry.address的值，除了是广播模式，还要添加unicast=false，这样才能保证多个消费者进程都能收到广播：

dubbo:
      application:
        name: springboot-multicast-consumer
        id: springboot-multicast-consumer
        qosEnable: false
      registry:
        address: multicast://224.5.6.7:1234?unicast=false
        id: registry
      protocol:
        name: dubbo
        port: 20880
    server:
      port: 8081

1.  编写调用远程服务的代码，如下，可见如果想调用远程服务，只要对接口做@Reference注释即可，另外还通过timeout属性增加了超时配置：

package com.bolingcavalry.springbootmulticastconsumer.service;
    
    import com.bolingcavalry.dubbopractice.service.DemoService;
    import org.apache.dubbo.config.annotation.Reference;
    import org.springframework.stereotype.Service;
    
    @Service
    public class RemoteInvokeServiceImpl { 
    
        @Reference(timeout = 2000)
        private DemoService demoService;
    
        public String sayHello(String name) { 
            return "from dubbo remote (multicast mode) : " + demoService.sayHello(name);
        }
    }

1.  再编写对外提供web服务的Controller类：

package com.bolingcavalry.springbootmulticastconsumer.controller;
    
    import com.bolingcavalry.springbootmulticastconsumer.service.RemoteInvokeServiceImpl;
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/demo")
    @Api(tags = { "DemoController"})
    public class DemoController { 
        @Autowired
        private RemoteInvokeServiceImpl remoteInvokeService;
    
        @ApiOperation(value = "获取dubbo service provider的响应", notes="\"获取dubbo service provider的响应")
        @ApiImplicitParam(name = "name", value = "昵称", paramType = "path", required = true, dataType = "String")
        @RequestMapping(value = "/{name}", method = RequestMethod.GET)
        public String sayHello(@PathVariable String name){ 
            return remoteInvokeService.sayHello(name);
        }
    }

1.  还要添加swagger配置类：

package com.bolingcavalry.springbootmulticastconsumer;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.service.Tag;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig { 
    
        @Bean
        public Docket createRestApi() { 
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .tags(new Tag("DemoController", "演示服务"))
                    .select()
                    // 当前包路径
                    .apis(RequestHandlerSelectors.basePackage("com.bolingcavalry.springbootmulticastconsumer.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
    
        //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
        private ApiInfo apiInfo() { 
            return new ApiInfoBuilder()
                    //页面标题
                    .title("dubbo远程调用服务的操作(广播模式)")
                    //创建人
                    .contact(new Contact("程序员欣宸", "https://github.com/zq2599/blog_demos", "zq2599@gmail.com"))
                    //版本号
                    .version("1.0")
                    //描述
                    .description("API 描述")
                    .build();
        }
    }

1.  最后是启动类SpringBootMulticastConsumerApplication.java：

package com.bolingcavalry.springbootmulticastconsumer;
    
    import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @EnableDubbo
    public class SpringBootMulticastConsumerApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(SpringBootMulticastConsumerApplication.class, args);
        }
    }

1.  至此，服务消费方编码完成，直接在IDEA上运行SpringBootMulticastConsumerApplication类即可启动；
2.  通过浏览器访问swagger，地址是：http://localhost:8081/swagger-ui.html ，如下图，点击红框位置展开接口详情：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center]
3.  如下图，输入web接口参数发起请求：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 1]
4.  下图红框中就是响应的数据，内容是springbootmulticastconsumer远程调用springbootmulticastprovider的服务得到的：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 2]

*  至此，dubbo与springboot集成的实战就完成了，希望能给您提供一些参考，助您快速开发dubbo应用；

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

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

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[Link 1]: https://xinchen.blog.csdn.net/article/details/109096867
[SpringBoot]: https://xinchen.blog.csdn.net/article/details/109142783
[Zookeeper]: https://xinchen.blog.csdn.net/article/details/109147843
[dubbo-admin]: https://xinchen.blog.csdn.net/article/details/109267151
[20201018113745557.jpg_pic_center]: /images/20221123/bb478d4fce4146b39e851b7a532a8076.png
[20201017231405581.jpg_pic_center]: /images/20221123/1447311583804946a2a1aae7f67d3143.png
[20201018102439720.jpg_pic_center]: /images/20221123/4581c3a3d6e64620b2f12396b97f49c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left]: /images/20221123/c58e5ab1d5c6401e8bb339639da39606.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 1]: /images/20221123/32caf91d83034dc384c3c486ec4ff105.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 2]: /images/20221123/29ad9cdbe01f45aca3a1b2bcea1041cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_left 3]: /images/20221123/c3d7b4129e214388a1eda0d42fbf3d43.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/cf7ba9f02ca141f8bdd6fc7cb43a70e9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/25979e07c7114555a805dfd0f256bd6f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/1320fac6efad469ab20249162c5ff8e2.png