Spring 整合 Dubbo（注解方式）_spring 用例

一、项目结构

按照 Dubbo 官方文档推荐的服务最佳化方案，建议将服务接口、服务模型、服务异常等均放在单独的 API 包中，所以项目采用 maven 多模块的构建方式，在 spring-dubbo 下构建三个子模块：

dubbo-common ：公共模块，用于存放公共的接口和 bean，被 dubbo-provider 和 dubbo-provider 所引用；
dubbo-provider ：服务的提供者，提供商品的查询服务；
dubbo-provider ：是服务的消费者，调用 provider 提供的查询服务。

另外，本项目 Dubbo 的搭建采用 ZooKeeper 作为注册中心。

二、项目依赖

在父工程的项目中统一导入依赖 Dubbo 的依赖：

<!--dubbo 依赖-->
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>2.6.2</version>
</dependency>
<dependency>
    <groupId>org.apache.curator</groupId>
    <artifactId>curator-framework</artifactId>
    <version>4.0.0</version>
    <exclusions>
        <exclusion>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.apache.zookeeper</groupId>
    <artifactId>zookeeper</artifactId>
    <version>3.4.13</version>
</dependency>

上面之所以要排除 curator-framework 中的 zookeeper，然后再次进行引入，是因为默认情况下 curator-framework 自动引用的最新的 3.5.x 的 zookeeper，但我本地安装是 3.4.x 的 zookeeper （因为我安装时候 zookeeper 3.5 还是 beta 版本），此时会出现 KeeperException$UnimplementedException 异常。因为 ZooKeeper 3.5.x 和 ZooKeeper 3.4.x 存在不兼容的情况，详见官方说明 ZooKeeper Version Compatibility 。

三、公共模块

API 下为公共的调用接口；
bean 下为公共的实体类。

四、服务提供者

4.1 提供者配置

@Configuration
public class DubboConfiguration {
    /**
     * 提供方应用信息，用于计算依赖关系
     */
    @Bean
    public ApplicationConfig applicationConfig() {
        ApplicationConfig applicationConfig = new ApplicationConfig();
        applicationConfig.setName("dubbo-ano-provider");
        return applicationConfig;
    }
    /**
     *  使用 zookeeper 注册中心暴露服务地址
     */
    @Bean
    public RegistryConfig registryConfig() {
        RegistryConfig registryConfig = new RegistryConfig();
        registryConfig.setAddress("zookeeper://127.0.0.1:2181");
        registryConfig.setClient("curator");
        return registryConfig;
    }
    /**
     * 用 dubbo 协议在 20880 端口暴露服务
     */
    @Bean
    public ProtocolConfig protocolConfig() {
        ProtocolConfig protocolConfig = new ProtocolConfig();
        protocolConfig.setName("dubbo");
        protocolConfig.setPort(20880);
        return protocolConfig;
    }
}

4.2 暴露服务

使用注解 @Service 暴露服务，需要注意的是这里的 @Service 注解不是 Spring 的注解，而是 dubbo 的注解，完整路径为：com.alibaba.dubbo.config.annotation.Service ：

import com.alibaba.dubbo.config.annotation.Service;
@Service(timeout = 5000)
public class ProductService implements IProductService {
    private static List<Product> productList = new ArrayList<>();
    static {
        for (int i = 0; i < 20; i++) {
            productList.add(new Product(i, "产品" + i, i / 2 == 0, new Date(), 66.66f * i));
        }
    }
    public Product queryProductById(int id) {
        for (Product product : productList) {
            if (product.getId() == id) {
                return product;
            }
        }
        return null;
    }
    public List<Product> queryAllProducts() {
        return productList;
    }
}

五、服务消费者

5.1 消费者配置

@Configuration
public class DubboConfiguration {
    /**
     * 消费方应用名，用于计算依赖关系，不是匹配条件，不要与提供方一样
     */
    @Bean
    public ApplicationConfig applicationConfig() {
        ApplicationConfig applicationConfig = new ApplicationConfig();
        applicationConfig.setName("dubbo-ano-consumer");
        return applicationConfig;
    }
    /**
     * 设置调用服务超时时间
     * 关闭所有服务的启动时检查
     */
    @Bean
    public ConsumerConfig consumerConfig() {
        ConsumerConfig consumerConfig = new ConsumerConfig();
        consumerConfig.setTimeout(3000);
        consumerConfig.setCheck(false);
        return consumerConfig;
    }
    /**
     * 使用 zookeeper 注册中心暴露发现服务地址
     */
    @Bean
    public RegistryConfig registryConfig() {
        RegistryConfig registryConfig = new RegistryConfig();
        registryConfig.setAddress("zookeeper://127.0.0.1:2181");
        registryConfig.setClient("curator");
        return registryConfig;
    }
}

5.2 调用远程服务

使用注解 @Reference 引用远程服务：

import com.alibaba.dubbo.config.annotation.Reference;
@Controller
@RequestMapping("sell")
public class SellController {
    // dubbo 远程引用注解
    @Reference
    private IProductService productService;
    @RequestMapping
    public String productList(Model model) {
        List<Product> products = productService.queryAllProducts();
        model.addAttribute("products", products);
        return "products";
    }
    @RequestMapping("product/{id}")
    public String productDetail(@PathVariable int id, Model model) {
        Product product = productService.queryProductById(id);
        model.addAttribute("product", product);
        return "product";
    }
}

六、项目构建

在项目中，consumer 和 provider 模块均依赖公共模块，所以在构建 consumer 和 provider 模块前需要将 common 模块安装到本地仓库，依次对父工程和 common 模块执行以下命令：

mvn install -Dmaven.test.skip = true

七、Dubbo 控制台

Dubbo 新版本管理控制台的安装步骤如下：

git clone https://github.com/apache/incubator-dubbo-ops.git /var/tmp/dubbo-ops
cd /var/tmp/dubbo-ops
mvn clean package

配置：

# 配置文件为：
dubbo-admin-backend/src/main/resources/application.properties
# 可以在其中修改zookeeper的地址
dubbo.registry.address=zookeeper://127.0.0.1:2181

启动：

mvn --projects dubbo-admin-backend spring-boot:run

访问：
```
http://127.0.0.1:8080
```