阿里巴巴dubbo使用教程（可直接應用於企業開發）

版權聲明：【分享也是一種提高】個人轉載請在正文開頭明顯位置註明出處，未經作者同意禁止企業/組織轉載，禁止私自更改原文，禁止用於商業目的。

目錄(?)[-]

1. 服務提供者DubboProvider
   1. 1 定義接口IProviderService和接口IUserService
   2. 2 接口IProviderService實現
   3. 3 dubbo-provider的相關參數配置
   4. 4 app-contextxml 以及 webxml 相關配置
2. 消費者DubboConsumer
   1. 1 定義接口IConsumerService
   2. 2 接口實現類ConsumerServiceImpl
   3. 3 dubbo-consumer的相關參數配置
   4. 4 webxml節選
3. 註冊中心zookeeper
4. 服務使用
   1. 1 啓動註冊中心
   2. 42啓動DubboProvider
   3. 3 啓動DubboConsumer

        本dubbo使用教程基於zookeeper-3.4.9搭建，包含服務提供者DubboProvider、和消費者DubboConsumer，可直接在Tomcat上運行。DubboProvider對外開放2個接口，DubboConsumer調用DubboProvider，並對外暴露HTTP服務。DubboProvider還提供了對數據庫的操作，基於SpringJDBC並加入了RowMapper通用類，這點在下文《SpringJDBC之RowMapper通用類》詳講。

        項目完整源碼見文末鏈接，下載即可用。

        網上現有教程大多是直接照搬官網，用main函數啓動，未使用Tomcat啓動，直接應用於企業開發較爲困難。當然我也是參照官網，學習了前輩的經驗，哈哈。

        開發環境：Windows10、Eclipse、JDK8、Spring4.3.7、zookeeper-3.4.9。

1、服務提供者DubboProvider

先看下整體架構，摺疊部分爲基於SpringJDBC的數據庫操作，可暫不考慮。

1.1 定義接口IProviderService和接口IUserService

package com.zxiaofan.dubboProvidder.service;

import com.zxiaofan.dubboProvidder.model.HelloBo;

/**
 *
 * @author xiaofan
 */
public interface IProviderService {
    /**
     * 測試字符串傳輸.
     *
     * @param name
     * @return
     */
    String helloBoy(String name);

    /**
     * 測試bean傳輸.
     *
     * @param bo
     * @return
     */
    HelloBo helloGirl(HelloBo bo);
}

接口IUserService略過，詳見源碼。

1.2 接口IProviderService實現

package com.zxiaofan.dubboProvidder.service.impl;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import com.zxiaofan.dubboProvidder.model.HelloBo;
import com.zxiaofan.dubboProvidder.service.IProviderService;

/**
 *
 * @author xiaofan
 */
@Component("providerService")
public class ProviderServiceImpl implements IProviderService {
    @Value("${param.url}")
    private String url;

    /**
     * {@inheritDoc}.
     */
    @Override
    public String helloBoy(String name) {
        String result = "hello " + name + ", This is dubboProvider[" + url + "]";
        System.out.println(result);
        return result;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public HelloBo helloGirl(HelloBo helloBo) {
        if (null == helloBo.getName()) {
            helloBo.setName("DefaultName");
        }
        helloBo.setUrl(helloBo.getName() + ":This is dubboProvider[csdn.zxiaofan.com]");
        return helloBo;
    }

}

1.3 dubbo-provider的相關參數配置

<?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-4.3.xsd
    http://code.alibabatech.com/schema/dubbo
    http://code.alibabatech.com/schema/dubbo/dubbo.xsd">

    <!-- 提供方應用信息，用於計算依賴關係 -->
    <dubbo:application name="${dubbo.applicationName}" />

    <!-- 使用zookeeper廣播註冊中心暴露服務地址 -->
    <dubbo:registry protocol="${dubbo.registryProtocol}" address="${dubbo.registryAddress}" />

    <!-- 用dubbo協議在20880端口暴露服務 -->
    <dubbo:protocol name="dubbo" port="${dubbo.port}" />
    <!-- <dubbo: protocol="registry"></dubbo:monitor> -->


    <!-- 和本地bean一樣實現服務 -->
    <bean id="providerService" class="com.zxiaofan.dubboProvidder.service.impl.ProviderServiceImpl" />
    <!-- 和本地bean一樣實現服務 -->
    <bean id="userService" class="com.zxiaofan.dubboProvidder.service.impl.UserServiceImpl" />
    <!-- 聲明需要暴露的服務接口 -->
    <dubbo:service interface="com.zxiaofan.dubboProvidder.service.IProviderService"
        ref="providerService"  retries="${dubbo.retries}" timeout="${dubbo.serverTimeout}"/>
    <!-- 聲明需要暴露的服務接口 -->
    <dubbo:service interface="com.zxiaofan.dubboProvidder.service.IUserService"
        ref="userService"  retries="${dubbo.retries}" timeout="${dubbo.serverTimeout}"/>
</beans>

結合配置文件dubbo.properties來看

# dubbo param
dubbo.applicationName=dubboProvider
dubbo.registryProtocol=zookeeper
dubbo.registryAddress=127.0.0.1:2181
dubbo.port=20880
#服務端超過serverTimeout未返回結果則拋500異常
dubbo.serverTimeout=120000
#客戶端超過clientTimeout未獲取到數據則拋500異常
dubbo.clientTimeout=120000
#dubbo調用失敗，默認重試2次
dubbo.retries=0

    <bean id="providerService" class="com.zxiaofan.dubboProvidder.service.impl.ProviderServiceImpl" />聲明瞭對外暴露的接口;

    <dubbo:service interface="com.zxiaofan.dubboProvidder.service.IProviderService"
ref="providerService"  retries="${dubbo.retries}" timeout="${dubbo.serverTimeout}"/>聲明瞭接口的實現類以及重試次數、服務超時時間。

1.4 app-context.xml 以及 web.xml 相關配置

    app-context.xml指定包掃描路徑以及引入相關配置文件和dubbo-provider.xml。

<bean
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <value>/WEB-INF/config/param.properties</value>
                <value>/WEB-INF/config/dubbo.properties</value>
                <value>/WEB-INF/config/jdbc.properties</value>
            </list>
        </property>
        <property name="fileEncoding" value="UTF8"></property>
    </bean>
    <bean
        class="org.springframework.context.annotation.CommonAnnotationBeanPostProcessor" />

    <!-- Aspect -->
<!-- <aop:aspectj-autoproxy proxy-target-class="true" />-->
    <context:component-scan base-package="com.zxiaofan"></context:component-scan>
    <import resource="classpath:com/zxiaofan/config/spring/dubbo-provider.xml"/>

web.xml一定要引入app-context.xml以及設置監聽ContextLoaderListener。

<context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            classpath:/com/zxiaofan/config/spring/app-context.xml
         </param-value>
  </context-param>
   <!--初始化spring上下文 -->
    <listener>
      <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

2、消費者DubboConsumer

整體架構如下：

2.1 定義接口IConsumerService

package com.zxiaofan.dubboConsumer.service;

/**
 *
 * @author zxiaofan
 */
public interface IConsumerService {
    String hi(String name);
}

2.2 接口實現類ConsumerServiceImpl

package com.zxiaofan.dubboConsumer.service.impl;

import javax.annotation.Resource;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import com.zxiaofan.dubboConsumer.service.IConsumerService;
import com.zxiaofan.dubboProvidder.model.HelloBo;
import com.zxiaofan.dubboProvidder.service.IProviderService;
import com.zxiaofan.dubboProvidder.service.IUserService;

/**
 *
 * @author zxiaofan
 */
@Component("consumerService")
public class ConsumerServiceImpl implements IConsumerService {
    @Resource(name = "providerService")
    private IProviderService providerService;

    @Resource(name = "userService")
    private IUserService userService;

    @Value("${param.url}")
    private String url;

    /**
     * {@inheritDoc}.
     */
    @Override
    public String hi(String name) {
        String result = null;
        if (null != name && name.startsWith("boy")) {
            System.out.println("Hi Boy!");
            result = providerService.helloBoy(name.replace("boy", "~~~"));
        } else if (null != name && name.startsWith("select")) {
            System.out.println("hi select!");
            result = userService.selectByID(name.replace("select", ""));
            return result;
        } else {
            HelloBo helloBo = new HelloBo();
            helloBo.setName(name);
            HelloBo helloBoResult = null;
            helloBoResult = providerService.helloGirl(helloBo);
            if (null != helloBoResult) {
                result = helloBoResult.getUrl();
            }
        }
        result += "; This is dubboConsumer[" + url + "]";
        return result;
    }

}

總共有3個分支：

name.startsWith("boy")，跳轉helloBoy，其入參是單個字符串；

name.startsWith("select")，跳轉userService.selectByID，該接口調用服務提供者的IUserService接口，對數據庫進行查詢操作；

else：跳轉helloGirl接口，其入參是model。

2.3 dubbo-consumer的相關參數配置

<?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-4.3.xsd
    http://code.alibabatech.com/schema/dubbo
    http://code.alibabatech.com/schema/dubbo/dubbo.xsd">


    <!-- 消費方應用名，用於計算依賴關係，不是匹配條件，不要與提供方一樣 -->
    <dubbo:application name="${dubbo.applicationName}"/>

    <!-- 使用dubbo協議   註冊中心暴露服務地址 -->
    <dubbo:registry protocol="${dubbo.registryProtocol}"  address="${dubbo.registryAddress}"/>

    <!-- 生成遠程服務代理，可以像使用本地bean一樣使用demoService -->
    <dubbo:reference id="providerService" interface="com.zxiaofan.dubboProvidder.service.IProviderService"  retries="${dubbo.retries}"  timeout="${dubbo.clientTimeout}"/>
    <dubbo:reference id="userService" interface="com.zxiaofan.dubboProvidder.service.IUserService"  retries="${dubbo.retries}"  timeout="${dubbo.clientTimeout}"/>
</beans>

該配置文件配置了2個服務的調用關係：providerService（入參爲單字符串接口、入參爲model接口）、userService（基於SpringJDBC的數據庫服務）。

2.4 web.xml節選

<!--  <listener>
   <listener-class>
       org.springframework.web.util.Log4jConfigListener
     </listener-class>
 </listener> -->

 <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>
        classpath:/com/zxiaofan/config/spring/app-context.xml
     </param-value>
 </context-param>

 <!--初始化spring上下文 -->
<listener>
     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<!-- 必須有servlet -->
    <servlet>
    <servlet-name>HttpServer</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
             classpath*:/com/zxiaofan/config/spring/httpServer-servlet.xml
           </param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>HttpServer</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

引入app-context.xml，監聽ContextLoaderListener，注意加上servlet，方便暴露HTTP服務。

3、註冊中心zookeeper

zookeeper可從官網下載，亦可從此處免費下載：http://download.csdn.net/detail/u010887744/9787895

4、 服務使用

4.1 啓動註冊中心

        Windows下雙擊zookeeper-3.4.9\bin下的zkServer.cmd即可直接啓動，linux下則啓動zkServer.sh即可。如果你是從官網下載的原生zookeeper，還得手動修改配置文件zoo_sample.cfg，複製一份命名爲zoo.cfg即可。啓動成功會看到如下畫面：

4.2、啓動DubboProvider

        啓動成功後，會在註冊中心看到註冊信息，包含了我們註冊的2個接口信息。注意不要被上面的Error:KeeperErrorCode = NodeExists for 誤導了，這是正常的，不用理會。

4.3、 啓動DubboConsumer

        建議新開一個Tomcat，專門用來啓動DubboConsumer，注意需要修改相關端口號哦，比如這裏修改HTTP端口爲8010，另外2個端口也要修改，避免衝突。

        測試第1個接口的第1個方法：單個字符串參數，HTTP服務地址：http://localhost:8010/DubboConsumer/api，參數csdn，結果如下，返回值包含了DubboConsumer、和DubboProvider添加的信息，證明服務是OK的。

測試第1個接口的第2個方法，dubboProvider的入參是model（dubboConsumer入參記得以boy開頭哦）。

        

        測試第2個接口的方法，dubboProvider的數據操作（dubboConsumer入參記得以select開頭哦，select後拼接數據庫中的id字段）。

Note：\dubbo\DubboProvider\test\com\zxiaofan\test\config\initDB.sql有建庫建表的SQL，可直接使用。

        最後放大招，項目源碼地址：https://github.com/zxiaofan/OpenSource_Study/tree/master/dubbo，項目OpenSource_Study下包含了本人各類開源軟件、框架學習的相關demo，包含Apache、Thrift、Guava、quartz等項目，持續學習ing。

        有任何問題，歡迎留言討論。

歡迎個人轉載，但須在文章頁面明顯位置給出原文連接；
未經作者同意必須保留此段聲明、不得隨意修改原文、不得用於商業用途，否則保留追究法律責任的權利。

【 CSDN 】：csdn.zxiaofan.com
【GitHub】：github.zxiaofan.com

如有任何問題，歡迎留言。祝君好運！
Life is all about choices！
將來的你一定會感激現在拼命的自己！