Day09_06_Dubbo教程之Springboot方式实现Dubbo服务的发布和消费

约定不等于承诺〃 2024-01-20 08:03 41阅读 0赞

## 以Springboot方式实现Dubbo服务的发布和消费 ##

### 一. 创建SprintBoot项目 ###

整个项目的目录结构为:  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70][]

**修改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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.syc.dubbo</groupId>
        <artifactId>dubbo_demos</artifactId>
        <packaging>pom</packaging>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.1.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

### 二. 创建通用的接口模块 ###

在项目中创建一个名为 `dubbo_service_api` 的模块,该项目只负责**定义user相关接口.**

![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1][]

2.1 修改POM文件

2.2 定义服务接口

package com.syc.dubbo.service.user;
    
    /**
     * 定义接口方法
     */
    public interface UserService {
    
        String sayHi();
    }

### 三. 创建服务提供者模块 ###

创建一个名为 `dubbo_service_user_provider` 的项目,该项目主要用于实现接口.  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2][]

#### 1. 修改POM文件 ####

<?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>dubbo_demos</artifactId>
            <groupId>com.syc.dubbo</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <modelVersion>4.0.0</modelVersion>
        <artifactId>dubbo_service_user_provider</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>0.2.0</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>dubbo-spring-boot-actuator</artifactId>
                <version>0.2.0</version>
            </dependency>
    
            <dependency>
                <groupId>com.syc.dubbo</groupId>
                <artifactId>dubbo_service_api</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    
    </project>

主要增加了以下依赖:

*  `com.alibaba.boot:dubbo-spring-boot-starter:0.2.0`: Dubbo Starter，0.2.0 版本支持 Spring Boot 2.x,是一个长期维护的版本.  
    注: 0.1.0 版本已经不推荐使用了,是个短期维护的版本,如果你还在用旧版,请大家尽快升级.
 *  `com.alibaba.boot:dubbo-spring-boot-actuator:0.2.0`: Dubbo 的服务状态检查
 *  `com.syc.dubbo:dubbo_service_api:1.0.0-SNAPSHOT`: 刚才创建的接口项目,如果无法依赖别忘记先 `mvn clean install`到本地仓库.

#### 2. 通过 `@Service` 注解声明服务提供者 ####

package com.syc.dubbo.service.impl;
    
    import com.alibaba.dubbo.config.annotation.Service;
    import com.syc.dubbo.service.user.UserService;
    
    /**
     * 接口实现类
     */
    @Service(version = "${user.service.version}")
    public class UserServiceImpl implements UserService {
    
        @Override
        public String sayHi() {
    
            return "Hello Dubbo";
        }
    }

#### 3. 创建Application启动类 ####

package com.syc.dubbo.service;
    
    import com.alibaba.dubbo.container.Main;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class ProviderApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ProviderApplication.class, args);
            // 启动 Provider 容器,注意这里的 Main 是 com.alibaba.dubbo.container 包下的.
            Main.main(args);
        }
    }

#### 4. 创建application.yml配置文件 ####

# Spring boot application
    spring:
      application:
        name: dubbo-service-user-provider
    
    # UserService service version
    user:
      service:
        version: 1.0.0
    
    # Dubbo Config properties
    dubbo:
      #扫描@Service注解所在包:@com.alibaba.dubbo.config.annotation.Service
      scan:
        basePackages: com.syc.dubbo.service.impl
      ## ApplicationConfig Bean
      application:
        id: dubbo-service-user-provider
        name: dubbo-service-user-provider
        qos-port: 22222
        qos-enable: true
      ## ProtocolConfig Bean
      protocol:
        id: dubbo
        name: dubbo
        #自定义的服务提供者端口号
        port: 12345
        status: server
      ## RegistryConfig Bean
      registry:
        id: zookeeper
        address: zookeeper://127.0.0.1:2181?backup=127.0.0.1:2182,127.0.0.1:2183
    
    # Enables Dubbo All Endpoints
    management:
      endpoint:
        dubbo:
          enabled: true
        dubbo-shutdown:
          enabled: true
        dubbo-configs:
          enabled: true
        dubbo-services:
          enabled: true
        dubbo-references:
          enabled: true
        dubbo-properties:
          enabled: true
      # Dubbo Health
      health:
        dubbo:
          status:
            ## StatusChecker Name defaults (default : "memory", "load" )
            defaults: memory
            ## StatusChecker Name extras (default : empty )
            extras: load,threadpool

### 四. 创建服务消费者模块 ###

创建一个名为 `hello-dubbo-service-user-consumer` 的项目,该项目用于消费接口(调用接口).  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3][]

#### 1. 修改POM文件 ####

<?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>dubbo_demos</artifactId>
            <groupId>com.syc.dubbo</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        <modelVersion>4.0.0</modelVersion>
        <artifactId>dubbo_service_user_consumer</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>dubbo-spring-boot-starter</artifactId>
                <version>0.2.0</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba.boot</groupId>
                <artifactId>dubbo-spring-boot-actuator</artifactId>
                <version>0.2.0</version>
            </dependency>
    
            <dependency>
                <groupId>com.syc.dubbo</groupId>
                <artifactId>dubbo_service_api</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
        </dependencies>
    
    </project>

#### 2. 通过 `@Reference` 注入 `UserService` ####

package com.syc.dubbo.controller;
    
    import com.alibaba.dubbo.config.annotation.Reference;
    import com.syc.dubbo.service.user.UserService;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class UserController {
    
        @Reference(version = "${user.service.version}")
        private UserService userService;
    
        @RequestMapping(value = "hi")
        public String sayHi() {
            return userService.sayHi();
        }
    }

#### 3. 创建Application类 ####

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

#### 4. 创建application.yml配置文件 ####

# Spring boot application
    spring:
      application:
        name: dubbo-service-user-consumer
    server:
      port: 9090
    
    # UserService service version
    user:
      service:
        version: 1.0.0
    
    # Dubbo Config properties
    dubbo:
      scan:
        basePackages: com.syc.dubbo.controller
      ## ApplicationConfig Bean
      application:
        id: dubbo-service-user-consumer
        name: dubbo-service-user-consumer
      ## RegistryConfig Bean
      registry:
        id: zookeeper
        address: zookeeper://127.0.0.1:2181?backup=127.0.0.1:2182,127.0.0.1:2183
    
    # Dubbo Endpoint (default status is disable)
    endpoints:
      dubbo:
        enabled: true
    
    management:
      server:
        port: 9091
      # Dubbo Health
      health:
        dubbo:
          status:
            ## StatusChecker Name defaults (default : "memory", "load" )
            defaults: memory
      # Enables Dubbo All Endpoints
      endpoint:
        dubbo:
          enabled: true
        dubbo-shutdown:
          enabled: true
        dubbo-configs:
          enabled: true
        dubbo-services:
          enabled: true
        dubbo-references:
          enabled: true
        dubbo-properties:
          enabled: true
      endpoints:
        web:
          exposure:
            include: "*"

### 五. 启动 Dubbo Admin 控制台 ###

查看是否成功注册服务,效果图如下:  
![Image 1][]  
![Image 1][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4][]

[Image 1]: 
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/ca75901d3f554ce3b4f3d2a1a195f252.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/599450f2b8f94399b6347391b6d2b612.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/4864df5564184f29860c5f8d71b58d46.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/8e318fd60b6546af860d02a025be086d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N5YzAwMDY2Ng_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/20/d11d2afaf562498aa490bf93e215efde.png