SpringCloudAlibaba学习系列（2）dubbo集成

最新推荐文章于 2023-02-19 10:19:18 发布

~木木木~

最新推荐文章于 2023-02-19 10:19:18 发布

阅读量869

点赞数

分类专栏： SpringCloud

本文链接：https://blog.csdn.net/u012661488/article/details/118102637

版权

SpringCloud 专栏收录该内容

9 篇文章 3 订阅

订阅专栏

一、简介

Apache Dubbo 是一个高性能、基于 Java 的开源 RPC 框架。大家可以通过访问官网（http://dubbo.apache.org/）查看快速入门指南和文档。

dubbo的特点具有：基于透明接口的RPC、智能负载均衡、自动服务注册和发现、高扩展性、运行时流量路由、可视化服务治理。架构图如下：

二、实战

1、项目说明

项目将采用springcloud框架，nacos作为注册中心（可参考文章《SpringCloudAlibaba学习系列（1）Nacos入门》），服务间调用采用dubbo的RPC调用。

目录结构预览如下：

引用的版本为：

Spring Cloud Version	Spring Cloud Alibaba Version	Spring Boot Version
Spring Cloud Hoxton.SR8	2.2.3.RELEASE	2.3.2.RELEASE

magic-cloud父项目的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>
    <packaging>pom</packaging>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.2.RELEASE</version>
        <relativePath/>
    </parent>

    <groupId>com.sam.cloud</groupId>
    <artifactId>magic-cloud</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>magic-cloud</name>

    <modules>
        <module>magic-provider</module>
        <module>magic-consumer</module>
        <module>magic-provider-api</module>
    </modules>

    <properties>
        <project.version>0.0.1-SNAPSHOT</project.version>
        <provider.api.version>1.0.0</provider.api.version>
        <spring-boot.version>2.3.2.RELEASE</spring-boot.version>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR8</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.2.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>com.sam.cloud</groupId>
                <artifactId>magic-provider-api</artifactId>
                <version>${provider.api.version}</version>
            </dependency>

        </dependencies>
    </dependencyManagement>

</project>

2、接口项目magic-provider-api

子项目api作为公共引用包，定义了dubbo需要注册的接口，用于服务提供者和服务消费者的项目引入，保持版本的一致性。实际应用中会将这个api打包成jar包，上传到公司仓库中。

项目结构预览如下：

2.1、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">
    <parent>
        <artifactId>magic-cloud</artifactId>
        <groupId>com.sam.cloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>magic-provider-api</artifactId>
    <name>magic-provider-api</name>
    <version>${provider.api.version}</version>

    <dependencies>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <finalName>magic-provider-api</finalName>
    </build>
</project>

2.2、创建注册接口类MagicProviderFacade.java

package com.sam.cloud.provider.api.facade;

import com.sam.cloud.provider.api.domain.UserDTO;

public interface MagicProviderFacade {

    public UserDTO queryUser(String name);

}

这个接口用于根据名称，获取用户信息

2.3、创建用户信息返回类UserDTO.java

package com.sam.cloud.provider.api.domain;

import java.io.Serializable;

public class UserDTO implements Serializable {

    private Integer userId;

    private String name;

    private Long age;

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getAge() {
        return age;
    }

    public void setAge(Long age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "UserDTO{" +
                "userId=" + userId +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

注意：这里要继承Serializable序列化接口。

3、提供者项目magic-provider

这个子项目具体实现了magic-provider-api中注册的接口，负责将服务注册到nacos注册中心。

项目结构预览如下：（采用的是springboot的启动方式，在提供dubbo接口服务的同时，还提供web的http请求接口，controller作为测试nacos的配置中心功能，如果不需要可自行去掉）

3.1、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">
    <parent>
        <artifactId>magic-cloud</artifactId>
        <groupId>com.sam.cloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>magic-provider</artifactId>
    <name>magic-provider</name>
    <version>${project.version}</version>

    <dependencies>
        <dependency>
            <groupId>com.sam.cloud</groupId>
            <artifactId>magic-provider-api</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <finalName>magic-provider</finalName>
    </build>
</project>

这里要引入之前创建的接口项目：magic-provider-api

nacos作为注册中心引入：spring-cloud-starter-alibaba-nacos-discovery

nacos作为配置中心引入：spring-cloud-starter-alibaba-nacos-config

dubbo引入：spring-cloud-starter-dubbo

3.2、配置文件bootstrap.properties

server.port=8082
server.servlet.context-path=/magic/provider
spring.application.name=magic-provider

# nacos配置中心地址，逗号间隔
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

# dubbo配置项
dubbo.application.id=magic-provider-dubbo-id
dubbo.application.name=magic-provider-dubbo-name
dubbo.registry.address=nacos://127.0.0.1:8848
dubbo.protocol.name=dubbo
# 协议端口（ -1 表示自增端口，从 20880 开始）
dubbo.protocol.port=20881
dubbo.protocol.id=dubbo
# 如果有订阅服务，这里是填服务提供者的dubbo.application.id
dubbo.cloud.subscribed-services=
# 禁用QOS同一台机器可能会有端口冲突现象,qos=Quality of Service 是Dubbo的在线运维命令，可以对服务进行动态的配置、控制(上下线)及查询
dubbo.application.qos-enable=true
# 默认端口号是22222
dubbo.application.qos-port=22223
# 允许访问的ip，缺省就是false，表示任何ip都可访问
dubbo.application.qos-accept-foreign-ip=true

3.3、注册接口实现类 MagicProviderFacadeImpl.java

package com.sam.cloud.provider.facade;

import com.sam.cloud.provider.api.domain.UserDTO;
import com.sam.cloud.provider.api.facade.MagicProviderFacade;
import org.apache.dubbo.config.annotation.DubboService;

@DubboService(version = "1.0.0", group = "magic", interfaceClass = MagicProviderFacade.class)
public class MagicProviderFacadeImpl implements MagicProviderFacade {

    @Override
    public UserDTO queryUser(String name) {
        UserDTO user = new UserDTO();
        user.setUserId(1);
        user.setName("sam");
        user.setAge(1L);
        return user;
    }

}

实现类继承了接口类MagicProviderFacade，实现接口queryUser具体业务。

@DubboService注解标注类在启动的时候将会被dubbo扫描到加载到容器中。

3.4、控制类 ConfigController.java

package com.sam.cloud.provider.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${my.name:haha}")
    private String myName;

    @GetMapping("/get")
    public String get(String msg) {
        return "hi, " + msg + ", my name is " + myName;
    }

}

在nacos管理页面中，已经配置了好DataId=magic-provider的配置，内容是my.name=Jack;

3.5、启动类 MagicProviderApplication

package com.sam.cloud.provider;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableDubbo
public class MagicProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(MagicProviderApplication.class, args);
    }

}

@EnableDubbo注解就是开启dubbo的扫描和注册。

3.6、启动验证

启动后在网页输入地址：http://localhost:8082/magic/provider/config/get?msg=sam

这个测试证明：web服务启动成功，并不会由于引入dubbo产生影响。

我们在看下nacos上的服务注册列表：

可以看到magic-prorvider已经把接口注册到nacos注册中心中。

4、消费者项目magic-consumer

这个子项目将会使用magic-provider-api中注册的接口，调用服务提供者magic-provider的具体实现获取数据。

项目结构预览如下：（采用的是springboot的启动方式，在提供dubbo接口服务的同时，还提供web的http测试接口）

4.1、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">
    <parent>
        <artifactId>magic-cloud</artifactId>
        <groupId>com.sam.cloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>magic-consumer</artifactId>
    <name>magic-consumer</name>
    <version>${project.version}</version>

    <dependencies>
        <dependency>
            <groupId>com.sam.cloud</groupId>
            <artifactId>magic-provider-api</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-dubbo</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <finalName>magic-consumer</finalName>
    </build>
</project>

这里要引入之前创建的接口项目：magic-provider-api

nacos作为注册中心引入：spring-cloud-starter-alibaba-nacos-discovery

dubbo引入：spring-cloud-starter-dubbo

4.2、配置bootstrap.properties

server.port=8083
server.servlet.context-path=/magic/consumer
spring.application.name=magic-consumer

# 配置dubbo
dubbo.application.id=magic-consumer-id
dubbo.application.name=magic-consumer-name
dubbo.registry.address=nacos://127.0.0.1:8848
# 只订阅服务，而不注册正在开发的服务，就是项目只作为消费者
dubbo.registry.register=false
# 订阅服务提供方的应用列表，订阅多个服务提供者使用"," 连接,这里是填服务提供者的dubbo.application.id
dubbo.cloud.subscribed-services=magic-provider-dubbo-id
# 禁用QOS同一台机器可能会有端口冲突现象; qos=Quality of Service 是Dubbo的在线运维命令，可以对服务进行动态的配置、控制(上下线)及查询
dubbo.application.qos-enable=true
dubbo.application.qos-port=22224
dubbo.application.qos-accept-foreign-ip=true

4.2、创建UserService.java类

package com.sam.cloud.consumer.service;

import com.sam.cloud.provider.api.facade.MagicProviderFacade;
import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @DubboReference(version = "1.0.0", check = false, group = "magic")
    private MagicProviderFacade magicProviderFacade;

    public String getMsg(String name) {
        return magicProviderFacade.queryUser(name).toString();
    }

}

@DubboReference注解标注的会被描述加载到容器，进行初始化，生成代理类。

这里就通过远程调用MagicProviderFacade的queryUser方法获取用户信息。

4.3、控制器类 ConsumerController.java

package com.sam.cloud.consumer.controller;

import com.sam.cloud.consumer.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@RestController
@RequestMapping("/test")
public class ConsumerController {

    @Resource
    private UserService userService;

    @GetMapping(value = "/dubbo")
    public String testHello(String name) {
        return "consumer : " + userService.getMsg(name);
    }

}

4.4、启动类

package com.sam.cloud.consumer;

import org.apache.dubbo.config.spring.context.annotation.EnableDubbo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableDubbo
public class MagicConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(MagicConsumerApplication.class, args);
    }

}

使用@EnableDubbo开启dubbo的扫描注册。

4.5、启动验证

启动后在网页输入地址：http://localhost:8083/magic/consumer/test/dubbo?name=sam