dubbo环境搭建小结

说明

为了通过将服务拆分成SOA形式的微服务集群来提高服务器的性能，采用了dubbo框架来构建了RPC形式的服务集群，从而实现了微服务的分离和集群化。
将配属过程中的注意点和相关的demo记录下来，以供后续备忘使用，以及拆分线上服务时进行参考。

demo搭建

1. 相关资源

• 官方文档
• git项目
• 参考资料
• 我搭建的demo

2. 大致原理&存在问题

dubbo框架可以通过相关的配置进行插件的替换和更改，十分方便，但是主要的原理是不变的。具体原理在参考资料和官方文档中有具体阐释，对于我们日常使用来说，主要就是通过配属provider的xml文件来外暴接口，同时在consumer的xml中进行接口的说明就可以了。

之后直接通过jar包服务的方式启动provider，consumer根据需要以jar或者web的方式启动即可。

但是官方的例子中，相关示例的链接存在一定问题，因此需要在示例文件中进行一定修改后进行打包来实现示例程序的问题。且由于连接权限的原因，需要调整pom依赖来重新打包dubbo-admin和dubbo-monitor等项目。特别的：如果使用了jdk1.8版本，会因为dubbo-admin中的部分依赖比较老，需要重新调整部分包的依赖版本（已经上传的git示例中已经重新更改了相关依赖，并且打了war包，可以直接在jdk1.8上使用了）。

• 调整后的示例程序

3. 项目示例
   可以根据上一节中的调整后的示例程序地址获取到最新的示例项目和dubbo-admin和dubbo-monitor的war包（可以直接部署在tomcat中使用），并且依据官方给出的示例构建了可以直接运行的demo程序。
   注： 由于之后使用了zookeeper作为注册中心，需要自己再安装一下zookeeper，或者改为默认的注册中心就可以了，将一下内容进行替换。

<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181" />

替换为

<!-- 使用multicast广播注册中心暴露服务地址 -->
<!-- 如果在单机上使用，需要将广播注册中心中加上参数： multicast://224.5.6.7:1234?unicast=false -->
<dubbo:registry address="multicast://224.5.6.7:1234" />

• 运行方法：
  demo-provider中直接运行Provider中的main函数（可以通过eclipse的run功能启动）
  consumer中以Junit的方式直接运行ConsumerTest即可（当然也可以以main函数的方式来运行，只是这样方便一些）

• 项目结构
  根据总的POM工程可以看出来，模块主要分为了三个部分，其中consumer和provider部分都依赖于api部分，这样的好处是可以通过在api中声明公共的接口信息，在provider中提供具体实现，从而实现了解耦。同时consumer也不需要知道具体的实现原理，但可以知道可获取的服务有哪些，有利于服务的拆分。

    <modelVersion>4.0.0</modelVersion>
    <groupId>test</groupId>
    <artifactId>dubbo-demo</artifactId>
    <version>0.0.1</version>    
    <packaging>pom</packaging>
    <description>The demo module of dubbo project</description>

    <modules>
        <module>dubbo-demo-api</module>
        <module>dubbo-demo-provider</module>
        <module>dubbo-demo-consumer</module>
    </modules>

• 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 protocol="zookeeper" address="127.0.0.1:2181" />

    <!-- for provider  -->
    <!-- 用dubbo协议在20880端口暴露服务 -->
    <dubbo:protocol name="dubbo" port="20880" />

    <!-- 声明需要暴露的服务接口 -->
    <dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoService" />

    <!-- 和本地bean一样实现服务 -->
    <bean id="demoService" class="com.alibaba.dubbo.demo.provider.DemoServiceImpl" />

</beans>

主入口程序

public class StartProvider {
    public static void main(String[] args){
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(new String[]{"dubbo-demo-provider.xml"});
        context.start();
        System.out.println("dubbo-provider start, press any key to exit");
        try {
            System.in.read();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

• consumer配置
  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"  />
    
    <!-- 使用zookeeper注册中心暴露服务地址 -->    
    <dubbo:registry protocol="zookeeper" address="127.0.0.1:2181" />
    
    <!-- for consumer  -->
    <!-- 生成远程服务代理，可以和本地bean一样使用demoService -->
    <dubbo:reference id="demoService" interface="com.alibaba.dubbo.demo.DemoService" />
</beans>

consumer主入口（使用junit的方式）

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/dubbo-demo-consumer.xml")
public class ConsumerTest {

    @Autowired
    private DemoService demoService;
    
    @Before
    public void setUp() throws Exception {
    }

    @Test
    public void test() {
        String result = demoService.sayHello("I am consumer!");
        System.out.println(result);
    }
}

demo改进

为了更好的实现服务的拆分并且最大程度的实现少的改动，根据文档我们可以在xml将声明方式改为声明扫描注入的方式（在实际的项目中我们主要就使用了该方式）。
如需使用这种方式，改动点如下：

1. 将spring的@service注解改为dubbo的@service注解（需要注意引入的包是不同的）
2. 将spring的@Autowire注解改为dubbo的@Reference注解
3. 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="mocha-serviceProvider"  />

    <!-- 使用zookeper广播注册中心暴露服务地址 -->
    <dubbo:registry protocol="zookeeper" address="127.0.0.1:2181" />

    <!-- for provider  -->
    <!-- 用dubbo协议在20880端口暴露服务 -->
    <dubbo:protocol name="dubbo" port="20888" />

    <!-- 不使用之前的接口模式
    <dubbo:service interface="com.yunyao.mocha.Service" ref="pService" />
    <bean id="pService" class="com.yunyao.mocha.service.impl" />
    -->
    
    <!-- 扫描注解包路径，多个包用逗号分隔，不填pacakge表示扫描当前ApplicationContext中所有的类 -->
    <dubbo:annotation package="com.yunyao.mocha.service" />

</beans>

注意点

1. 因为dubbo自己依赖了spring 2.5.6版本，在实际使用中，因为经常使用了更高版本的spring，因此需要在pom（或gradle）中将dubbo的spring依赖exclude掉，否者运行中可能会出现错误（如我们自己的项目中由于依赖了3.1.2的spring版本就造成了直接调用了3.1.2中的方法，但是在2.5.6中该方法不存在造成了异常）
2. 在以main方法的方式启动provider的时候，需要使用spring的上下文来运行。因此如果项目中还使用了其它框架的（比如我们使用了paoding-rose）的话，由于其它框架可能还会对context进行包装（rose的RoseContext），会造成一些功能无法正常使用，可能需要重新使用框架的context来启动，并以import的方式来引入dubbo的xml配置文件即可。
3. eclipse等IDE可能由于缺少dubbo的dubbo.xsd文件，从而在文件校验中会出错（对dubbo:register等标签标记为错误，但是可以正常运行），此时只需将dubbo包解压后，将其中的dubbo.xsd（仔细找一找）文件引入到eclipse的preference的xml catalog中，重新validate文件即可。

以下为第二点中的具体代码：
applicationContext中引入dubbo-provider.xml

<import resource="classpath:service-postphoto-provider.xml" />

使用rose的context来启动main

    public static void main(String[] args) throws Exception {
        RoseAppContext context = new RoseAppContext();
        context.start();
        //com.alibaba.dubbo.container.Main.main(args);
        
        System.out.println("post provider start...");
        logger.debug("**********************************");
        logger.debug("provider start");
        try {
            System.in.read();
            System.out.println("post provider stop...");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

那些年部署中遇到的坑

1. 以Junit的方式启动来进行service的调用测试时，使用注解或者xml配置的方式，均可以正常处理。但是通过tomcat来部署controller的时候，会发现使用注解的时候会导致consumer的注册不生效从而访问空指针的问题。没有针对这个点进行验证（有可能是因为使用了paoding-rose，打开部署的包看到rose也自己生成了一个自己的applicationContext.xml，不太清楚是否和这个有关系），但是改为xml的方式部署后，访问均正常。考虑到后续针对不同的服务和方法可能会有针对性的配置，才有注解的方式在这个角度上来说可能会有不足，因此最后还是决定采用xml的方式，就没有对这个问题进行深究（虽然使用注解确实节省了很多工作量，并且使得项目的迁移更加简单了）
2. 在使用gradle打包时，如果使用富jar的方式来打包，需要将所有的jar包导入进去，而不能仅仅是将所有的class导入形成新的jar包，因为在dubbo.jar中存在的dubbo.xsd文件如果确实，会导致application.xml无法正确的识别dubbo:application等标签。所以推荐还是以当前导出依赖jar后以脚本启动的方式来处理。
3. 在tomcat部署过程中，需要特别注意如果使用了zookeeper作为注册中心，一定要先启动zookeeper后再启动tomcat，不然会导致项目一直卡住等待zookeeper（不显示其它错误）的情况。
4. （未验证原因）部分情况下，如果先通过tomcat启动了consumer，再去启动provider时，可能会造成consumer启动中因为没有对应的provider造成@Autowired注解抛异常的情况（于是需要在启动了provider后再次重启consumer）
5. （未验证原因）在多个网卡（如阿里云线上环境）启动dubbo-admin时，会在tomcat启动时抛一个127.0.0.1相关的异常，NetUtil类是dubbo做网卡处理的功能类，网上资料说dubbo针对这个问题会有一个对所有网卡遍历然后根据正则筛选有效IP地址的情况，但是这个异常的原因还不太清楚，不过不影响admin功能的正常使用，所以暂未解决。