SpringBoot系列: 使用 consul 作为服务注册组件

本文基本上摘自纯洁的微笑的博客 http://www.ityouknow.com/springcloud/2018/07/20/spring-cloud-consul.html . 感谢作者的付出.

=============================
服务注册基础组件选择
=============================
在服务注册这个环节, 业界有很多组件可供选择, 主要有:
1. Spring Cloud Eureka
Spring Cloud Eureka 是 Spring Cloud Netflix 项目下的服务治理模块, 而 Sping Cloud Netflix 是 Spring Cloud 的子项目之一, 主要是对 Netflix 公司开源的一些产品的封装, 这包括, 服务发现 (Eureka), 智能路由 (Zuul), 客户端负载均衡 (Ribbon), 断路器 (Hystrix).
2. Consul
Consul 主要用于服务注册, 分布式配置管理等领域, 对于服务注册方面它是一个一站式的解决方案, 提供健康检查, DNS 域名解析等功能. Spring Cloud 也有基于 consul 的服务治理子项目 Spring Cloud Consul, 主要提供服务注册和分布式配置管理功能.
3. Zookeeper
Zookeeper 也是一个流行的开源项目, 主要用于分布式事务协调, 服务注册, 分布式配置管理等领域. Spring Cloud 也有基于 zookeeper 的服务治理子项目 Spring Cloud Zookeeper, 主要提供服务注册和分布式配置管理功能.

我的推荐: Consul + Spring Cloud Consul. 原因有:
1. Consul 胜出 Eureka 的地方: Consul 更知名, 更流行, Consul 集群运维成本自然低了不少.
2. Consul 胜出 Zookeeper 的地方: ZooKeeper 的知名度要比 Consul 高, 但 Consul 在流行程度上也不会差很多. 回到服务注册这个领域, Consul 比 ZooKeeper 更加全面更完善, 健康检查和 DNS 服务是拿来即用的.

=============================
Demo 整体设计 和 Consul 启动
=============================
服务生产者项目将向 consul 注册自己, 另一个项目是服务消费者. 整个架构包括:
1. 服务生产者项目部署两份, 这样能提供要给 HA
2. 服务消费者项目, 服务消费者能自动应用负载均衡策略向两个生产者服务发出请求.
3. consul 的作用, 不管是 HA 还是 LB, 都是需要 consul 提供的 DNS 支持.

服务生产者项目的要点:
1. 主程序加上 @EnableDiscoveryClient 注解

在消费项目主要用到了下面 3 个接口/类:
1. DiscoveryClient 接口, 用于服务发现操作, 自动注入的实际类型为 CompositeDiscoveryClient 类.
2. LoadBalancerClient 接口, 用于负载均衡,自动注入的实际类型为 RibbonLoadBalancerClient 类.
3. RestTemplate 类, 用于进行 http 请求, 有两种方式实现负载均衡. 一个方法是在发出web请求的时候, 传入 LoadBalancerClient.getServiceId() url; 另一个方法是直接创建一个负载均衡的 RestTemplate实例, web 请求的 url 格式就可以泛化为 http://service-producer/your_api .

=============================
Consul 启动
=============================
consul server 直接使用 consul agent --dev 命令, 启动一个测试 server 即可, 得到两个重要的访问端口.
输出有:
Started DNS server 127.0.0.1:8600 (tcp)
Started HTTP server on 127.0.0.1:8500 (tcp)

=============================
spring-cloud-starter-consul-discovery 一些重要属性
=============================

# 直接指定服务的 consul service id(即 instance id).
# 默认情况下为 spring.application.name + server.port, 如果在多个服务器上同一个服务, 因为应用名和端口都一致, 会导致service id 会重复, 所以一般情况都需要引入一个随机数避免重复 .
spring.cloud.consul.discovery.instance-id=${spring.application.name}-${random.value}

# 指定服务的 consul service name
spring.cloud.consul.discovery.service_name=some_name

# consul 服务器主机名
spring.cloud.consul.discovery.hostname=your_host

# consul 服务器端口
spring.cloud.consul.discovery.port=

# 维护 tags
$ 下面示例的 tag map 是:  foo->bar 和 baz->baz
spring.cloud.consul.discovery.tags:foo=bar, baz

# 是否启用服务发现
spring.cloud.consul.discovery.enabled=true 

# 使用 consul 服务器 IP, 而不是 hostname, 需要搭配 prefer-ip-address 属性
spring.cloud.consul.discovery.ip-address=127.0.0.1

# 在注册时使用 consul IP, 而不是 hostname
spring.cloud.consul.discovery.prefer-ip-address=false

#设定 consul acl token 值
spring.cloud.consul.discovery.acl-token=4efb1523-76a3-f476-e6d8-

# 健康检查的频率, 默认  秒
spring.cloud.consul.discovery.health-check-interval=10s

# actuator 健康检查的 url 路径
# 默认为 为${management.endpoints.web.base-path} +/health
spring.cloud.consul.discovery.health-check-path=

# 自定义健康检查的 url(适合于不适用 actuator 的场景)
spring.cloud.consul.discovery.health-check-url=

=============================
服务生产者项目 1
=============================
一个简单的 Restful Service 项目.

----------------------------
pom.xml
----------------------------
项目使用 spring starter 向导生成, 增加 actuator 和 consul-discovery 依赖.
1. actuator 是必需的, 用于 consul 监控 web 项目的健康状态.
2. spring-cloud-starter-consul-discovery 也是必需的, Consul 服务发现的 starter jar 包.

pom.xml 重要内容有:

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

----------------------------
主入口程序 SvcProducerApplication
----------------------------
在主入口程序类上增加 @EnableDiscoveryClient 注解后, 自动完成服务注册.

@SpringBootApplication
@EnableDiscoveryClient
public class SvcProducerApplication {
    public static void main(String[] args) {
        SpringApplication.run(SvcProducerApplication.class, args);
    }
}

----------------------------
Rest 服务类 HelloController
----------------------------
很简单的一个服务类, 提供一个 Restful API.

public class HelloController {
    private String port="8080" ;

    @RequestMapping("/hello")
    public String hello() {
        return "hello consul from "+this.port;
    }
}

----------------------------
application.properties 文件
----------------------------
设定 consul 的 http 注册 IP 和端口 (8500), 并设定 consul service id 和 consul service name.
consul service id 是必需的, 生成的规则: spring.application.name+[-[server.port]]
consul service name 不是必需的, 但往往需要配置. 设定属性为: spring.cloud.consul.discovery.serviceName, 不设定的话, name 值同 Id 值.
consul service name 和 consul service id 的简单类比, consul service name 相当于 DNS 的域名, id 相当于 DNS A 记录.

文件的内容:

spring.application.name=spring-cloud-consul-producer
server.port=
spring.cloud.consul.discovery.serviceName=service-producer
spring.cloud.consul.host=localhost
spring.cloud.consul.port=

启动后将有下面的服务注册日志:
Registering service with consul: NewService{id='spring-cloud-consul-producer-8080', name='service-producer', tags=[secure=false], address='admin-PC', port=8080, enableTagOverride=null, check=Check{script='null', interval='10s', ttl='null', http='http://admin-PC:8080/actuator/health', tcp='null', timeout='null', deregisterCriticalServiceAfter='null', tlsSkipVerify=null, status='null'}, checks=null}

=============================
服务生产者项目 2
=============================
服务生产者项目 2 和项目 1 其实应该完全一致, 因为我们想要在一台电脑上部署, 所以修改一下对应端口即可.

=============================
服务消费者项目
=============================

----------------------------
pom.xml
----------------------------
pom.xml 同 服务生产者项目. 需要说明的是:
1. actuator 对于服务消费者来讲, 并不是必需的.
2. spring-cloud-starter-consul-discovery 是必需的, Consul 服务发现的 starter jar 包.

----------------------------
application.properties 文件
----------------------------
只需要指定 consul 的服务 hostname 和端口即可.

spring.application.name=spring-cloud-consul-consumer
server.port=
spring.cloud.consul.host=127.0.0.1
spring.cloud.consul.port=

----------------------------
消费类文件 ServiceController.java
----------------------------

在消费代码中, 主要用到了下面 3 个接口/类:
1. DiscoveryClient 接口, 用于服务发现操作, 自动注入的实际类型为 CompositeDiscoveryClient 类.
2. LoadBalancerClient 接口, 用于负载均衡,自动注入的实际类型为 RibbonLoadBalancerClient 类.
3. RestTemplate 类, 用于进行 http 请求, 有两种方式实现负载均衡. 一个方法是在发出web请求的时候, 传入 LoadBalancerClient.getServiceId() url; 另一个方法是直接创建一个负载均衡的 RestTemplate实例, web 请求的 url 格式就可以泛化为 http://service-producer/your_api .

@RestController
public class ServiceController {
    @Autowired
    private LoadBalancerClient loadBalanacer;
    @Autowired
    private DiscoveryClient discoverClient;

    /**
     * 获取所有的服务
     */
    @RequestMapping("/services")
    public Object services() {
        return discoverClient.getInstances("service-producer");
    }

    @RequestMapping("/discover")
    public Object discover() {
        return loadBalanacer.choose("service-producer").getUri().toString();
    }
}

@RestController
class HelloController {
    @Autowired
    private LoadBalancerClient loadBalancer;

    /*
     * 声明一个负载均衡的 RestTemplate bean
     * */
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    /*
     * 自动注入一个负载均衡的 RestTemplate
     * */
    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/call")
    public String call() {
        ServiceInstance serviceInstance = loadBalancer.choose("service-producer");
        System.out.println("Hostname:" + serviceInstance.getUri());
        System.out.println("service name:" + serviceInstance.getServiceId());

        //String serviceResult = new RestTemplate().getForObject(serviceInstance.getUri().toString() + "/hello",String.class);
        String serviceResult=restTemplate.getForObject("http://service-producer/hello",String.class);
        return serviceResult ;
    }
}

=============================
参考
=============================
springcloud(十三)：注册中心 Consul 使用详解
http://www.ityouknow.com/springcloud/2018/07/20/spring-cloud-consul.html
https://www.cnblogs.com/ityouknow/p/9340591.html

Spring Cloud Finchley 版中 Consul 多实例注册的问题处理
http://blog.didispace.com/Spring-Cloud-Finchley-Consul-InstanceId/

Spring Cloud 构建微服务架构：服务注册与发现（Eureka、Consul）【Dalston 版】
http://blog.didispace.com/spring-cloud-starter-dalston-1/

https://howtodoinjava.com/spring-cloud/consul-service-registration-discovery/

使用 Spring Cloud Consul 实现服务的注册和发现
https://blog.csdn.net/mn960mn/article/details/51775212

Spring Cloud（二） Consul 服务治理实现
https://segmentfault.com/a/1190000012245512