dubbo整合springboot入门案例

最新推荐文章于 2024-07-03 07:00:00 发布

JokerDa

最新推荐文章于 2024-07-03 07:00:00 发布

阅读量2.4k

点赞数 1

分类专栏：学习笔记

学习笔记专栏收录该内容

52 篇文章 2 订阅

订阅专栏

一、我的配置

在开始构建前，默认你已经能够成功安装并启动 Zookeeper 注册中心，能够成功安装并启动 Dubbo 控制台；
在本例中，我的 Zookeeper 注册中心 IP 地址为 192.168.175.131，端口号为 2181，Dubbo 控制台的访问地址为 http://192.168.175.131:8080/；
为了体现分布式调用，本例中创建了以下两个项目，dubbo-consumer 远程调用 dubbo-provider 提供的服务：
dubbo-provider Dubbo 服务提供者
dubbo-consumer Dubbo 服务消费者
dubbo-consumer 项目的访问路径为 http://localhost:8012/test/{name} 格式，其中 {name} 为请求参数；

二、使用 Spring Starter Project构建 Dubbo 服务提供者 dubbo-provider 项目，记得勾选web的配置
1.eclipse先得安装sts插件

这里写图片描述

dubbo-provider 项目结构如下：

这里写图片描述

2.为 dubbo-provider 项目添加依赖：

<?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.joker</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>springboot-dubbo-provider</name>
    <description></description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.7.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

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

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

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>dubbo</artifactId>
            <version>2.5.3</version>
            <exclusions>
                <exclusion>
                    <artifactId>spring</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
            <version>3.4.6</version>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.github.sgroschupf</groupId>
            <artifactId>zkclient</artifactId>
            <version>0.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

3.定义接口：

package dubbo.test.remote;

public interface TestService {
    String sayHello(String name);
}

4 . 实现接口方法：

package dubbo.test.remote.impl;

import dubbo.test.remote.TestService;

public class TestServiceImpl implements TestService {  
    @Override  
    public String sayHello(String name) {  
        return "Hello " + name + "! Springboot-Dubbo test success!";  
    }  
}

5 . 在 resource/ 下添加 providers.xml 配置文件，用于向 zookeeper 注册中心注册服务

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
    xsi:schemaLocation="http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd  
       http://code.alibabatech.com/schema/dubbo  
       http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
    <!-- 配置可参考 http://dubbo.io/User+Guide-zh.htm -->
    <!-- 服务提供方应用名，用于计算依赖关系 -->
    <dubbo:application name="dubbo-provider" owner="dubbo-provider" />
    <!-- 定义 zookeeper 注册中心地址及协议 -->
    <dubbo:registry protocol="zookeeper" address="192.168.175.131:2181"
        client="zkclient" />
    <!-- 定义 Dubbo 协议名称及使用的端口，dubbo 协议缺省端口为 20880，如果配置为 -1 或者没有配置 port，则会分配一个没有被占用的端口 -->
    <dubbo:protocol name="dubbo" port="-1" />
    <!-- 声明需要暴露的服务接口 -->
    <dubbo:service interface="dubbo.test.remote.TestService"
        ref="testService" timeout="10000" />
    <!-- 和本地 bean 一样实现服务 -->
    <bean id="testService" class="dubbo.test.remote.impl.TestServiceImpl" />
</beans>

6 . DubboProviderApplication 中使用 providers.xml 配置文件；

package dubbo.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication  
@ImportResource(value = {"classpath:providers.xml"}) // 使用 providers.xml 配置；  
public class DubboProviderApplication {  
    public static void main(String[] args) {  
        SpringApplication.run(DubboProviderApplication.class, args);  
    }  
}

7 . application.properties 中指定项目启动时占用的端口号：

server.port=8011

8 . 启动 dubbo-provide 项目，可以通过 Dubbo 服务控制台看到服务已经被注册到 zookeeper

三、使用 Spring Starter Project构建 Dubbo 服务提供者 dubbo-consumer 项目，记得勾选web的配置
1.同上dubbo-provider

dubbo-consumer 项目结构如下：

这里写图片描述

2 . 为 dubbo-consumer 项目添加依赖：

<?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.joker</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>springboot-dubbo-consumer</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.7.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

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

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

        <!-- 格式化对象，方便输出日志 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.1.41</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>dubbo</artifactId>
            <version>2.5.3</version>
            <exclusions>
                <exclusion>
                    <artifactId>spring</artifactId>
                    <groupId>org.springframework</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
            <version>3.4.6</version>
            <exclusions>
                <exclusion>
                    <artifactId>slf4j-log4j12</artifactId>
                    <groupId>org.slf4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.github.sgroschupf</groupId>
            <artifactId>zkclient</artifactId>
            <version>0.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

3 . 引入接口（此处偷懒了，没有将接口打成 jar 包后导入，而是直接把接口文件添加到项目下，强烈不建议此种做法）

package dubbo.test.remote;

public interface TestService {
    String sayHello(String name);
}

4 . 定义测试用的 Controller 类

package dubbo.test.handler;

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.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import dubbo.test.remote.TestService;

/**
 * 测试用的 Controller 类；
 */
@RestController
public class TestController {
    @Autowired
    TestService testService;

    /**
     * 测试 JSON 接口；
     */
    @ResponseBody
    @RequestMapping("/test/{name}")
    public String testJson(@PathVariable("name") String name) {
        String testStr = testService.sayHello(name);
        return testStr;
    }
}

5 . 在 resource/ 下添加 consumers.xml 配置文件，用于向 zookeeper 注册中心注册服务

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
       xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"  
       xsi:schemaLocation="http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd  
       http://code.alibabatech.com/schema/dubbo  
       http://code.alibabatech.com/schema/dubbo/dubbo.xsd">  
    <!-- 配置可参考 http://dubbo.io/User+Guide-zh.htm -->  
    <!-- 消费方应用名，用于计算依赖关系，不是匹配条件，不要与提供方一样 -->  
    <dubbo:application  name="dubbo-consumer" owner="dubbo-consumer"/>  
    <!-- 定义 zookeeper 注册中心地址及协议 -->  
    <dubbo:registry protocol="zookeeper" address="192.168.175.131:2181" client="zkclient" />  
    <!-- 生成远程服务代理，可以和本地 bean 一样使用 testService -->  
    <dubbo:reference id="testService" interface="dubbo.test.remote.TestService"/>  
</beans>

6 . DubboConsumerApplication 中使用 consumers.xml 配置文件；

package dubbo.test;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

@SpringBootApplication
@ImportResource(value = { "classpath:consumers.xml" }) // 使用 consumers.xml 配置；
public class DubboConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(DubboConsumerApplication.class, args);
    }
}

7 . application.properties 中指定项目启动时占用的端口号：

server.port=8012

8 . 启动 dubbo-consumer 项目，可以通过 Dubbo 服务控制台看到当前项目已经在消费 Dubbo 服务：

这里写图片描述

10 . 通过浏览器访问 http://localhost:8012/test/joker123 （此路径为 dubbo-consumer 项目的 WEB 访问路径），可以看到如下页面，证明 dubbo-consumer 已经成功远程调用了 dubbo-provider 项目提供的 Dubbo 服务；

这里写图片描述