Dubbo入門(2) - 簡單實踐

不洗碗工作室發表於2018-05-18

作者:不洗碗工作室 - Marklux

出處:Dubbo入門(2) - 簡單實踐

版權歸作者所有,轉載請註明出處

在瞭解什麼是分散式框架之後,我們需要上手實踐一下,來了解整個系統是如何運作起來的。

本文抱著學習的目的來嘗試使用dubbo搭建一個簡單的分散式服務,並且使用dubbokeeper來進行服務的監控。

參考自:聊聊dubbo最簡單的dubbo教程

準備工作

在正式使用dubbo之前,需要準備兩樣東西:

1. 服務註冊中心(ZooKeeper)

dubbo的消費方和服務方都需要在一個統一的註冊中心進行註冊才能使用,搭建一個zookeeper即可,當然你也可以使用其他的註冊中心並整合進去。

zookeeper的搭建流程很簡單,參考此文即可(僅僅是最簡單的單機版,並不複雜)。

2. 服務監控中心(dubbokeeper)

為了監控整個分散式服務的執行情況,最好能夠有一個視覺化的管理和監控應用,這裡選用由dubboclub團隊開發的dubbokeeper,當然也可以使用dubbo官方的dubboadmin專案。

由於dubbokeeper的部署有些複雜,在這裡還是簡要的描述一下,注意監控軟體並不是必要的,但是為了能夠看到服務執行的效果,建議還是部署一個。

部署流程參考此文

下載原始碼

首先需要獲取dubbokeeper的原始碼,可以從github上獲取,git地址:

https://github.com/dubboclub/dubbokeeper
複製程式碼

下面我們假設將dubbokeeper克隆到了~/dubbokeeper這個目錄下。

修改配置

在此之前,首先需要確定你要使用何種資料庫,dubbokeeper目前支援MySQL,MongoDB和Lucene三種資料儲存方案,我們以MySQL為例進行部署。

首先要填寫~/dubbokeeper/conf/dubbo-mysql.properties配置檔案,下面給出比較重要的配置項說明:

dubbo.registry.address=zookeeper://localhost:2181 #註冊中心地址
dubbo.protocol.name=dubbo
dubbo.protocol.port=20884 #dubbo服務埠
dubbo.monitor.mysql.url=jdbc:mysql://localhost:3306/dubbo-monitor #mysql服務地址
dubbo.monitor.mysql.username=root
dubbo.monitor.mysql.password=secret #使用者名稱及密碼
複製程式碼

接下來要填寫~/dubbokeeper/dubbokeeper-ui/src/main/resources/dubbo.properties配置檔案中的註冊中心和網路伺服器型別等引數。

初始化資料庫

建立一個mysql資料庫,並執行~/dubbokeeper/doc/storage/mysql/sql/application.sql建立表結構。

編譯打包

執行~/dubbokeeper/install-mysql.sh進行打包,最終會生成target輸出目錄。

啟動部署

這一步要啟動幾個服務後才能去部署應用,注意順序

首先需要啟動zookeeper服務,注意埠的配置要和配置檔案一致。

接下來執行target目錄下的mysql-dubbokeeper-server/bin/start-mysql.sh啟動儲存服務。

最後將target目錄下的mysql-dubbokeeper-ui中的war包複製到tomcat(自己部署)的webapps目錄下,啟動tomcat便會自動進行解壓和安裝,之後訪問http://localhost:8080/dubbokeeper-ui-1.0.1看到如下介面,即為安裝成功。

Dubbo入門(2) - 簡單實踐

建立API

現在正式開始程式設計。我們將使用dubbo建立一個非常簡單的、只有一個消費者和一個服務提供方的例子。

首先第一步是建立雙方都需要依賴的資料交換定義,通過一個interface來實現。

建立maven專案msa-demo-apipom.xml檔案內容如下:

<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.marklux</groupId>
    <artifactId>msa-demo-api</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <properties>
        <motan.version>0.3.0</motan.version>
        <!-- 在阿里巴巴內部廣泛使用的GA版本為:2.4.9,強烈推薦此版本 -->
        <dubbo.version>2.5.3</dubbo.version>
        <dubbox.version>2.8.4</dubbox.version>
        <spring.version>4.3.6.RELEASE</spring.version>
        <java.version>1.7</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>dubbo</artifactId>
            <version>2.5.3</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.github.sgroschupf</groupId>
            <artifactId>zkclient</artifactId>
            <version>0.1</version>
        </dependency>
        <!-- spring相關 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jms</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.6.11</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.6.11</version>
        </dependency>
    </dependencies>
</project>
複製程式碼

然後在com.marklux.dubbo.demo包中新增DemoService介面,程式碼如下:

package com.marklux.dubbo.demo;

/**
 * Created by lumin on 18/5/15.
 */
public interface DemoService {
    String sayHello(String name);
}
複製程式碼

之後的服務提供方根據這個介面實現服務,消費者根據介面呼叫服務。(有點類似Thrift裡的IDL檔案)

建立服務提供者

建立一個新的maven模組msa-demo-provider,用於實現DemoService服務。模組結構如下:

Dubbo入門(2) - 簡單實踐

專案的pom.xml中需要新增對msa-demo-api模組的依賴:

<?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.marklux</groupId>
    <artifactId>msa-demo-provider</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>com.marklux</groupId>
            <artifactId>msa-demo-api</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>
複製程式碼

首先編寫DemoServiceImpl實現服務內容,程式碼如下:

package com.marklux.dubbo.demo.impl;

import com.marklux.dubbo.demo.DemoService;
import org.springframework.stereotype.Service;

/**
 * Created by lumin on 18/5/15.
 */
@Service("demoService")
public class DemoServiceImpl implements DemoService {

    public String sayHello(String name) {
        return "Hello, " + name;
    }
}
複製程式碼

接下來填寫msa-demo-provider.xml配置檔案,配置服務接入註冊中心,以及暴露埠號:

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

    <!-- 提供方應用資訊,用於計算依賴關係 -->
    <dubbo:application name="dubbo_provider"  />

    <!-- 使用zookeeper註冊中心暴露服務地址 -->
    <dubbo:registry address="zookeeper://127.0.0.1:2181" />

    <!-- 用dubbo協議在20880埠暴露服務 -->
    <dubbo:protocol name="dubbo" port="20880" />

    <!-- 宣告需要暴露的服務介面 -->
    <dubbo:service interface="com.marklux.dubbo.demo.DemoService" ref="demoService" />
</beans>
複製程式碼

然後填寫springmvc.xml,用於給入口類提供Spring服務容器的配置:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:util="http://www.springframework.org/schema/util" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.springframework.org/schema/util
        http://www.springframework.org/schema/util/spring-util-4.0.xsd"
       default-autowire="byName">

    <aop:aspectj-autoproxy />
    <context:component-scan base-package="com.marklux.dubbo.demo" />
    <import resource="classpath:msa-demo-provider.xml" />
</beans>
複製程式碼

最後在com.marklux.dubbo.demo.test包中新增測試啟動類,用於啟動服務:

package com.marklux.dubbo.demo.test;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.io.IOException;

/**
 * Created by lumin on 18/5/15.
 */
public class DemoServiceImplTest  {
    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("classpath:spring-mvc.xml");
        context.start();
        System.out.println("Dubbo Service started....");
        try {
            System.in.read();   // 按任意鍵退出
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
複製程式碼

啟動DemoServiceImplTest類後服務就會註冊並啟動,這時候可以在dubbokeeper中看到服務的狀態:

Dubbo入門(2) - 簡單實踐

建立消費者

最後來建立一個呼叫服務的消費者,新增一個maven模組msa-demo-clientpom.xml同上,新增對msa-demo-api模組的依賴,注意並不需要msa-demo-provider的依賴。

模組的結構如下:

Dubbo入門(2) - 簡單實踐
只有一個測試的啟動類,程式碼如下:

package com.marklux.dubbo.demo.test;

import com.marklux.dubbo.demo.DemoService;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.io.IOException;

/**
 * Created by lumin on 18/5/15.
 */
public class DemoServiceConsumerTest {

    public static void main(String[] args) {
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(new String[]{"classpath:springmvc.xml"});

        context.start();
        DemoService demoService = (DemoService) context.getBean("demoService");

        System.out.println(demoService.sayHello("哈哈哈"));
        try {
            System.in.read();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }
}

複製程式碼

記得補充dubbo的配置檔案msa-demo-client.xml和spring的配置檔案springmvc.xml,如下:

<?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 ">
    <!-- 消費方應用名,用於計算依賴關係,不是匹配條件,不要與提供方一樣 -->
    <dubbo:application name="dubbo_consumer" />
    <!-- 使用multicast廣播註冊中心暴露發現服務地址 -->
    <dubbo:registry  protocol="zookeeper" address="zookeeper://127.0.0.1:2181" />
    <!-- 生成遠端服務代理,可以和本地bean一樣使用demoService -->
    <dubbo:reference id="demoService" interface="com.marklux.dubbo.demo.DemoService" />
</beans>
複製程式碼
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:util="http://www.springframework.org/schema/util" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-4.0.xsd
        http://www.springframework.org/schema/util
        http://www.springframework.org/schema/util/spring-util-4.0.xsd"
       default-autowire="byName">

    <aop:aspectj-autoproxy />
    <context:component-scan base-package="com.marklux.dubbo.demo" />
    <import resource="classpath:msa-demo-consumer.xml" />
</beans>
複製程式碼

萬事俱備,現在啟動DemoServiceConsumerTest,可以看到成功呼叫了DemoService

Dubbo入門(2) - 簡單實踐

在dubbokeeper中同樣可以檢視到其相關狀態:

Dubbo入門(2) - 簡單實踐

小結

至此,一個最簡單的使用dubbo協議進行服務-呼叫的demo就完成了。可以看到最顯著的特點是,在消費者中呼叫服務方提供的服務無需新增額外程式碼,整個呼叫過程完全透明。

另外借助dubbokeeper這樣的監控端,也更能夠直觀的理解整個應用服務的分佈和執行情況。