基于Dubbo 2.7.7的Nacos和Zookeeper的集成

前言

上一次使用Dubbo还是用的Dubbo 2.7.3版本的,最近有个项目打算用Dubbo来开发,查阅了文档,发现其最新的版本是3.x版本了,但是相关文档貌似还没有整理好,官方显示是在建设中,所以我使用了所谓稳定点的版本2.7.7,发现2.7.7版本已经有了些许的改动了,所以自己踩了一遍坑,做了这个Demo来记录下。

问题纪要

由于版本变更以及之前没有使用过Nacos作为Dubbo的注册中心,以至于集成的过程中遇到了一些问题,所以这里先给说明下遇到的问题

注解变更

由于@service和Spring中的@repository@service太容易混淆啦,许多人在issues上提出了该问题,在2.7.7版本的时候调整为了@DubboService@DubboReference

无需@EnableDubbo

无需再启动类上添加@EnableDubbo注解了,在我测试的过程中,发现了只要在代码中使用了@DubboService@DubboReference就会自动启用Dubbo。

使用Nacos做注册中心的时候,我发现没有引入相关DubboService的时候,我的消费服务虽然配置好了duboo相关的参数,都是nacos服务列表没有显示出来,当我使用了DubboService的时候,服务列表就出现了

Nacos 1.4.0服务列表不显示

不知道是否某些地方配置的问题,我使用Nacos 1.4.0的时候服务列表总是显示不出来(即使我的nacos-client也同步使用1.4.0),换成1.3.21.3.1就可以显示出来了,但是调用是正常的,/(ㄒoㄒ)/~~。

Demo解读

目录解读

├─common-api # 公共APi的包
├─consume-service-nacos # Nacos作为注册中心的消费者模块
├─consumer-service-zookeeper # zookeeper作为注册中心的消费者模块
├─provider-service-nacos # Nacos作为注册中心的服务提供者模块
└─provider-service-zookeeper # zookeeper作为注册中心的服务提供者模块

关于不同注册中心

Dobbo如果需要使用不同的注册中心的话不需要修改业务逻辑代码,只需要修改POM文件配置文件即可,所以本文将先说明下公共的业务代码,然后再分别提供Nacos和Zookeeper的pom和配置文件。

common-api

这里就定义了一个Model和一个接口,这里需要注意的是如果返回值是Model的话需要是可序列化的一个对象。

│common-api
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─martain
│  │  │          └─common
│  │  │              └─api
│  │  │                  │  IUserService.java  # 接口
│  │  │                  └─vo
│  │  │                          User.java # model

public class User implements Serializable {
    private String id;
    private String userName;
    private Integer age;
    ...getter and setter ...
}
public interface IUserService {
    /**
     * 通过Id获取用户
     * @param userId 用户ID
     * @return 用户实体
     */
    User getUserById(String userId);
}

服务提供者

│  ├─java
│  │  └─com
│  │      └─martain
│  │          └─provide
│  │              │  ProviderServiceXXX.java # 启动类
│  │              └─service
│  │                      UserService.java # 服务实现类
│  │
│  └─resources
│          application.yml # 配置文件
│  pom.xml  # pom 文件

POM文件

Nacos
    <properties>
        <spring-boot.version>2.3.0.RELEASE</spring-boot.version>
        <dubbo.version>2.7.7</dubbo.version>
        <nacos.version>1.3.2</nacos.version>
    </properties>

    <dependencies>
        <!-- Spring Boot dependencies -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>
        <!-- api -->
        <dependency>
            <groupId>com.martain</groupId>
            <artifactId>common-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!-- Dubbo Spring Boot Starter -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>${dubbo.version}</version>
        </dependency>
        <!-- Dubbo Registry Nacos -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
            <version>${nacos.version}</version>
        </dependency>
    </dependencies>
Zookeeper
    <properties>
        <spring-boot.version>2.3.0.RELEASE</spring-boot.version>
        <dubbo.version>2.7.7</dubbo.version>
    </properties>

    <dependencies>
        <!-- Spring Boot dependencies -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>
        <!-- Dubbo Spring Boot Starter -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>${dubbo.version}</version>
        </dependency>
        <!-- 公共api -->
        <dependency>
            <groupId>com.martain</groupId>
            <artifactId>common-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!-- Zookeeper dependencies -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

    </dependencies>

配置文件

spring:
  application:
    name: provider-service
dubbo:
  application:
    name: provider-service
  registry:
    address: zookeeper://127.0.0.1:2181 # 如果是nacos 就填 nacos://127.0.0.1:8848
    timeout: 10000
  protocol:
    name: dubbo
    port: 20880
  scan:
    base-packages: com.martain.provide.service
  metadata-report:
    address: zookeeper://127.0.0.1:2181 # 如果是nacos 就填 nacos://127.0.0.1:8848

userService

接口实现类上需要添加@DubboService注解,表名这个类中的接口是需要注册到注册中心去的。而这个注解也有许多可选参数,详情可查看dubbo的源码了解这些参数的作用。

dubbo官方推荐做法是尽量在provider端多做配置,比如timeout这种配置,应该在服务提供者端配置,而不是在消费者端配置,因为提供者更清楚他提供的方法大致会花费多长时间。(虽然按照dubbo的配置覆盖规则,在consumer端的配置会覆盖provider端的配置)。

<details>
<summary>@DubboService</summary>

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Inherited
public @interface DubboService {
    Class<?> interfaceClass() default void.class;

    String interfaceName() default "";

    String version() default "";

    String group() default "";

    String path() default "";

    boolean export() default true;

    String token() default "";

    boolean deprecated() default false;

    boolean dynamic() default true;

    String accesslog() default "";

    int executes() default 0;

    boolean register() default true;

    int weight() default 0;

    String document() default "";

    int delay() default 0;

    /** @deprecated */
    String local() default "";

    String stub() default "";

    String cluster() default "";

    String proxy() default "";

    int connections() default 0;

    int callbacks() default 1;

    String onconnect() default "";

    String ondisconnect() default "";

    String owner() default "";

    String layer() default "";

    int retries() default 2;

    String loadbalance() default "random";

    boolean async() default false;

    int actives() default 0;

    boolean sent() default false;

    String mock() default "";

    String validation() default "";

    int timeout() default 0;

    String cache() default "";

    String[] filter() default {};

    String[] listener() default {};

    String[] parameters() default {};

    String application() default "";

    String module() default "";

    String provider() default "";

    String[] protocol() default {};

    String monitor() default "";

    String[] registry() default {};

    String tag() default "";

    Method[] methods() default {};
}

</details>

package com.martain.provide.service;

import com.martain.common.api.IUserService;
import com.martain.common.api.vo.User;
import org.apache.dubbo.config.annotation.DubboService;

@DubboService
public class UserService implements IUserService {

    public User getUserById(String userId) {
        User user = new User();
        user.setId(userId);
        user.setUserName("小明");
        user.setAge(18);
        return user;
    }
}

Application 启动类

启动类上添加@EnableAutoConfiguration注解即可,这个注解也是spring的自动配置的注解。

package com.martain.provide;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.builder.SpringApplicationBuilder;

@EnableAutoConfiguration
public class ProviderServiceZookeeper {
    public static void main(String[] args) {
        new SpringApplicationBuilder(ProviderServiceZookeeper.class).run(args);
    }
}

服务消费者

服务消费者

│  pom.xml # POM文件
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─martain
│  │  │          └─consumer
│  │  │              │  ConsumerServiceZookeeper.java # 启动类
│  │  │              └─controller
│  │  │                      UserController.java # web控制器
│  │  │
│  │  └─resources
│  │          application.yml # 配置文件

POM文件

Nacos
    <properties>
        <spring-boot.version>2.3.3.RELEASE</spring-boot.version>
        <dubbo.version>2.7.7</dubbo.version>
        <nacos.version>1.3.2</nacos.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>
        <dependency>
            <groupId>com.martain</groupId>
            <artifactId>common-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>${dubbo.version}</version>
        </dependency>

        <!-- Dubbo Registry Nacos -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
            <version>${nacos.version}</version>
        </dependency>
    </dependencies>
Zookeeper
   <properties>
        <spring-boot.version>2.3.0.RELEASE</spring-boot.version>
        <dubbo.version>2.7.7</dubbo.version>
    </properties>

    <dependencies>
        <!-- Spring Boot dependencies -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>

        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>${dubbo.version}</version>
        </dependency>

        <dependency>
            <groupId>com.martain</groupId>
            <artifactId>common-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <!-- Zookeeper dependencies -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-dependencies-zookeeper</artifactId>
            <version>${dubbo.version}</version>
            <type>pom</type>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

    </dependencies>

配置文件

dubbo:
  application:
    name: consumer-service
  registry:
    address: nacos://127.0.0.1:8848 # 如果是zookeeper 就填 zookeeper://127.0.0.1:2181

UserController

需要在接口上添加@DubboReference注解声名该接口的服务器要是dubbo服务,需要去远程调用。

<details>
<summary>@DubboReference</summary>

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
public @interface DubboReference {
 Class<?> interfaceClass() default void.class;

 String interfaceName() default "";

 String version() default "";

 String group() default "";

 String url() default "";

 String client() default "";

 boolean generic() default false;

 boolean injvm() default true;

 boolean check() default true;

 boolean init() default false;

 boolean lazy() default false;

 boolean stubevent() default false;

 String reconnect() default "";

 boolean sticky() default false;

 String proxy() default "";

 String stub() default "";

 String cluster() default "";

 int connections() default 0;

 int callbacks() default 0;

 String onconnect() default "";

 String ondisconnect() default "";

 String owner() default "";

 String layer() default "";

 int retries() default 2;

 String loadbalance() default "";

 boolean async() default false;

 int actives() default 0;

 boolean sent() default false;

 String mock() default "";

 String validation() default "";

 int timeout() default 0;

 String cache() default "";

 String[] filter() default {};

 String[] listener() default {};

 String[] parameters() default {};

 String application() default "";

 String module() default "";

 String consumer() default "";

 String monitor() default "";

 String[] registry() default {};

 String protocol() default "";

 String tag() default "";

 String merger() default "";

 Method[] methods() default {};

 String id() default "";
}

</details>

package com.martain.consumer.controller;

import com.martain.common.api.IUserService;
import com.martain.common.api.vo.User;
import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/user")
public class UserController {

    @DubboReference
    IUserService userService;

    @GetMapping("/getUserInfo/{userId}")
    public Object getUserInfo(@PathVariable String userId){
        return userService.getUserById(userId);
    } 
}

Application 启动类

和普通的springboot项目一致即可

package com.martain.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ConsumerServiceZookeeper {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerServiceZookeeper.class,args)
    }
}

测试

访问 http://127.0.0.1:8080/user/getUserInfo/123

附件

image-20201204144935046

仓库地址

Gitee

Github

简书地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,002评论 6 509
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,777评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,341评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,085评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,110评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,868评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,528评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,422评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,938评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,067评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,199评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,877评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,540评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,079评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,192评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,514评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,190评论 2 357

推荐阅读更多精彩内容