Spring Cloud和Dubbo整合开发笔记(1)

一、需求背景：

1. 公司内部老项目微服务技术栈使用Dubbo, 新项目技术栈使用主流的Spring Cloud相关组件开发，新旧项目涉及交互调用，无法直接通信数据传递。
2. 老项目基于Dubbo,重构代码升级使用Spring Cloud,改造升级要求成本最低，不影响现有系统运行。

二、Dubbo和Spring Cloud 的比较

　　首先Dubbo是一个分布式服务框架，以及SOA治理方案。它的功能主要包括：高性能NIO通讯及多协议集成，服务动态寻址与路由，软负载均衡与容错，依赖分析与降级等,它是著名的阿里服务治理的核心框架。Spring Cloud更加关心为开发人员提供开箱即用的一系列常见的分布式工具（例如配置管理，服务发现，断路器，智能路由，微代理，控制总线），它是基于轻量级框架Spring家族，维护版本速度相对较快。

想深入了解的朋友，可以参考这篇文章专门分析了两者的区别：听听八年阿里架构师怎样讲述Dubbo和Spring Cloud微服务架构  

改造思路：Spring Cloud和Dubbo用于协调服务组件需要进行统一，使得Dubbo服务和Spring Cloud 服务能够相互感知。其次统一微服务之间的通信协议，Spring Cloud使用Http协议，Dubbo支持Dubbo,Hessian,rmi,http,webservice,thrift,redis,rest,memcached协议;数据传输载体或者说格式在网络中也是统一的，和调用的服务架构无关。改造前需要明确的是两种架构Spring Cloud和Dubbo在项目中的主次，不然容易造成开发人员使用API困惑，代码接口混乱，其次不要急于期望短期将架构统一，改造完整，特别是Spring Cloud带来了项目开发更多的环节，更多的组件（意味着有更多的坑）。

改造方案：

• 传统方案：保留完整的Dubbo老系统，Dubbo服务不需要向SpringCloud组件注册服务，通过Ribbon/Fegin调用Dubbo服务暴露的Restful Api.缺点也明显，需要人工维护Dubbo服务和Spring Cloud服务的关系，当Dubbo服务较多时，不同的环境配置太多。
• 传统方案：借助SideCar支持多语言的特性，连接Dubbo和Spring Cloud底层使用Sidecar交互，同时Dubbo也可以将信息传播到Eureka上面。缺点明显，需要每个Dubbo服务节点额外配置Sidecar服务节点，同时增加了链路的长度。

我的方案：Spring Cloud和Dubbo的服务中心选择阿里的Nacos，它是一个动态服务发现、配置管理和服务管理平台，为什么不选择使用Zookeeper，因为zookeeper是个CP系统，强一致性。如果其中master挂掉，此时zookeeper集群会进行重新选举，不能提供服务列表信息的服务，其次zookeeper通过tcp不能准确判断服务此时是否可用，数据库挂了，数据库连接池满了等也能提供TCP信息。通信协议我选择Http协议，Dubbo2.6之后支持http协议，数据格式使用Json,前端无需根据服务区分数据格式解析。

Nacos支持部署的模式有单机，集群，多集群模式，Nacos 0.8之后支持数据库持久化，可以方便看见服务信息的前后变化。单机模式很简单启动，下载最新版Nacos:https://github.com/alibaba/nacos/releases ,解压直接运行bin/startup.sh或者startup.cmd即可。

Nacos不仅提供服务发现和服务健康监测，它也提供控制台可视化页面进行动态配置服务，动态 DNS 服务，服务及其元数据管理等功能，Nacos0.8版本支持简单登录功能，默认用户名/密码为 nacos/nacos。：

相比Eureka提供的单一的看板页面，提供的管理功能可以说没得比，具体使用手册参考官方：https://nacos.io/zh-cn/docs/console-guide.html，这里不再赘述。

首先开发基于Spring Cloud+Nacos架构的微服务,nacos-discovery-provider为服务提供者，nacos-discovery-consumer为服务消费方, 

nacos-discovery-provider的pom.xml加入相关依赖:

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>0.2.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.0.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <version>2.0.6.RELEASE</version>
        </dependency>
    </dependencies>

application.properties的配置为：

server.port=18082
spring.application.name=service-provider
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848   
management.endpoints.web.exposure.include=*

其中spring.cloud.nacos.discovery.server-addr为配置的Nacos地址，management.endpoints.web.exposure.include=*表示对外暴露所有项目信息。

启动类的代码：

package org.springframework.cloud.alibaba.cloud.examples;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@EnableDiscoveryClient
public class ProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(ProviderApplication.class, args);
    }

    @RestController
    class EchoController {
        @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
        public String echo(@PathVariable String string) {
            return "hello Nacos Discovery " + string;
        }

        @RequestMapping(value = "/divide", method = RequestMethod.GET)
        public String divide(@RequestParam Integer a, @RequestParam Integer b) {
            return String.valueOf(a / b);
        }
    }
}

使用SpringCloud的原生注解@EnableDiscoveryClient 开启服务注册发现功能。

接下来创建服务消费方nacos-discovery-consumer进行服务消费：

pom.xml:

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.0.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>0.2.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
            <version>2.0.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
            <version>2.0.2.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>2.0.2.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-sentinel</artifactId>
            <version>0.2.1.RELEASE</version>
        </dependency>
    </dependencies>

其中sentinel和传统的Spring Cloud组件Hystrix类似，提供熔断降级，系统负载保护等功能。application.properties的配置为：

spring.application.name=service-consumer
server.port=18083
management.endpoints.web.exposure.include=*
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

feign.sentinel.enabled=true

spring.cloud.sentinel.transport.dashboard=localhost:8080
spring.cloud.sentinel.eager=true

spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
spring.cloud.sentinel.datasource.ds1.file.data-type=json
spring.cloud.sentinel.datasource.ds1.file.rule-type=flow

其中flowrule.json配置了限流降级的规则：

[
  {
    "resource": "GET:http://service-provider/echo/{str}",
    "controlBehavior": 0,
    "count": 1,
    "grade": 1,
    "limitApp": "default",
    "strategy": 0
  }
]

消费启动类ConsumerApplication.java:

package org.springframework.cloud.alibaba.cloud.examples;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.alibaba.cloud.examples.ConsumerApplication.EchoService;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.client.RestTemplate;

/**
 * @author liujie037
 */
@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ConsumerApplication {

    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }

    @FeignClient(name = "service-provider", fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class)
    public interface EchoService {
        @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
        String echo(@PathVariable("str") String str);

        @RequestMapping(value = "/divide", method = RequestMethod.GET)
        String divide(@RequestParam("a") Integer a, @RequestParam("b") Integer b);

        @RequestMapping(value = "/notFound", method = RequestMethod.GET)
        String notFound();
    }

}

class FeignConfiguration {
    @Bean
    public EchoServiceFallback echoServiceFallback() {
        return new EchoServiceFallback();
    }
}

class EchoServiceFallback implements EchoService {
    @Override
    public String echo(@PathVariable("str") String str) {
        return "echo fallback";
    }

    @Override
    public String divide(@RequestParam Integer a, @RequestParam Integer b) {
        return "divide fallback";
    }

    @Override
    public String notFound() {
        return "notFound fallback";
    }
}

通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能。给 RestTemplate 实例添加 @LoadBalanced 注解，开启 @LoadBalanced 与 Ribbon 的集成：

消费的接口TestController.java：

package org.springframework.cloud.alibaba.cloud.examples;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.alibaba.cloud.examples.ConsumerApplication.EchoService;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

/**
 * @author liujie037
 */
@RestController
public class TestController {

    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    private EchoService echoService;

    @Autowired
    private DiscoveryClient discoveryClient;

    @RequestMapping(value = "/echo-rest/{str}", method = RequestMethod.GET)
    public String rest(@PathVariable String str) {
        return restTemplate.getForObject("http://service-provider/echo/" + str,
                String.class);
    }

    @RequestMapping(value = "/notFound-feign", method = RequestMethod.GET)
    public String notFound() {
        return echoService.notFound();
    }

    @RequestMapping(value = "/divide-feign", method = RequestMethod.GET)
    public String divide(@RequestParam Integer a, @RequestParam Integer b) {
        return echoService.divide(a, b);
    }

    @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
    public String feign(@PathVariable String str) {
        return echoService.echo(str);
    }

    @RequestMapping(value = "/services/{service}", method = RequestMethod.GET)
    public Object client(@PathVariable String service) {
        return discoveryClient.getInstances(service);
    }

    @RequestMapping(value = "/services", method = RequestMethod.GET)
    public Object services() {
        return discoveryClient.getServices();
    }
}

访问Nacos控制台：

测试服务消费正常使用postman:

 下一篇中我将继续展示Dubbo服务创建和Spring Cloud 互相调用。