Springcloud Consul部署实战 -2

上一篇文章介绍了如何构建一个最简单consul集群，下面将继续详细介绍如何详细配置和使用consul。

consul是支持多配置文件加载的，可以在/etc/consul.d/ 路径下创建任意名字的.json文件，如config.json

可以在该文件中添加详细的consul agent配置。例如，设置如下json字段，设置log的级别为info，更改consul agent的节点的启动名字为nn1,设置本机ip可以通过http,https,grpc,dns对外开放，http、dns、grpc、serf_lan、serf_wan、consul server的默认地址分别为8500 8600 8400 8301 8302 8300，如果在配置文件中不显示指定，那么consul启动后可能会更改默认的端口号。如果当我们启动其他consul时，通过-retry-join 加入server端时报错，拒绝连接，原因就是因为server端的端口发生了改动，它默认去连接8301端口，此时-retry-join不能直接写ip地址，需要写对应的修改后的serf_lan端口 列如：-retry-join x.x.x.x:8311。下面是一个config.json的配置文件例子，目前我的测试集群就是这么配的。

{
  "log_level": "INFO",
  "node_name": "nn1",
  "addresses": {
    "https": "0.0.0.0",
    "http": "0.0.0.0",

    "gRPC": "0.0.0.0",

     "DNS": "0.0.0.0"
  },
  "ports": {
    "https": 8501,
    "http": 8500,

    "gRPC": 8502,

    DNS: 8600"
  }
}

 

Consul UI

集群搭建成功后可以通过http://配置了UI的服务器ip:consul服务端口号/ui    访问consul的UI

服务注册和服务服务

consul 集群搭建好后，我们就可以把自己的微服务注册到consul集群，通过consul来管理和查询我们的微服务。以下大部分内容来自spring cloud官方文档，如果有理解不到位之处，请大家给与指正https://cloud.spring.io/spring-cloud-consul/multi/multi_spring-cloud-consul-discovery.html

 

如何引入服务发现

Consul通过HTTP API和DNS提供服务发现服务。 Spring Cloud Consul利用HTTP API进行服务注册和发现。 但这并不妨碍非Spring Cloud应用程序利用DNS接口。 Consul Agents服务器运行在cluster中，群集通过gossip protocol 协议进行通信并使用Raft一致性协议来保证各个agent的一致性。

要激活Consul Service Discovery，应该使用group id 为org.springframework.cloud和artifact id 为spring-cloud-starter-consul-discovery的starter。 利用Spring Cloud Release Train构建系统的详细信息，请参阅Spring Cloud Project页面。

利用consul进行服务注册

当微服务向Consul注册时，需要提供自身的元数据信息，例如host和port，id，name和tags。 默认情况下会创建一个HTTP health Check ，Consul每10秒向 / health endpoint 发送一次状态信息。 如果运行状况检查失败，则将服务实例标记为critical。

下面是一个spring cloud 微服务yml的配置例子

application.yml. 

spring:
  cloud:
    consul:
      host: localhost   /*consul client的部署地址*/
      port: 8500        /*consul 的http api 服务端口号*/

 

注意：如果使用的是Spring Cloud Consul Config，则需要将上述值放在bootstrap.yml而不是application.yml中。

从环境变量中获取的默认服务名称，实例ID和端口分别是$ {spring.application.name}，Spring Context ID和$ {server.port}。

要禁用Consul 的服务发现，您可以将spring.cloud.consul.discovery.enabled设置为false。 当spring.cloud.discovery.enabled设置为false时，Consul Discovery Client也将被禁用。

要禁用服务注册，可以将spring.cloud.consul.discovery.register设置为false。

将management server注册为单独的服务

当management server port设置为与应用程序端口不同时，通过设置management.server.port属性，management server将注册为与应用程序服务不同的服务。 例如：

application.yml. 

spring:
  application:
    name: myApp
management:
  server:
    port: 4452

 

以上配置将会注册为如下 2个 服务:

• Application Service:

ID: myApp
Name: myApp

• Management Service:

ID: myApp-management
Name: myApp-management

管理服务将从应用程序服务继承其instanceId和serviceName。 例如：

application.yml. 

spring:
  application:
    name: myApp
management:
  server:
    port: 4452
spring:
  cloud:
    consul:
      discovery:
        instance-id: custom-service-id
        serviceName: myprefix-${spring.application.name}

以上配置将创建两个服务

• Application Service:

ID: custom-service-id
Name: myprefix-myApp

• Management Service:

ID: custom-service-id-management
Name: myprefix-myApp-management

更深层次的定制化可以通过如下配置实现

/** 注册management server的端口 (默认上述配置中的 management port) */
spring.cloud.consul.discovery.management-port

/** 注册management server名字后缀 (默认是 "management"） */
spring.cloud.consul.discovery.management-suffix

/** 注册management server时使用的标签 (默认是 "management"） */
spring.cloud.consul.discovery.management-tags

http健康检查

Consul默认使用“/ health”进行健康检查，这是Spring Boot Actuator应用程序中一个有用端点的默认位置。如果你配置了非默认的context path 或者 servlet path ，例如server.servletPath=/foo 或者  management.server.servlet.context-path=/admin  ，那么你必须更改healthCheckPath。还可以配置Consul用于检查健康端点的时间间隔，“10s”和“1m”分别代表10秒和1分钟。 例如：

application.yml. 

spring:
  cloud:
    consul:
      discovery:
        healthCheckPath: ${management.server.servlet.context-path}/health
        healthCheckInterval: 15s

 

你可以通过 management.health.consul.enabled=false. 将健康检查设置为不可用。

元数据和consul tags

Consul尚不支持元数据。 Spring Cloud的ServiceInstance有一个Map <String，String>元数据字段。 Spring Cloud Consul使用Consul标签来近似元数据，直到Consul正式支持元数据。 形式为key = value的标签将被拆分并分别用作Map的键和值。 没有等号=的标签将同时用作键和值。

application.yml. 

spring:
  cloud:
    consul:
      discovery:
        tags: foo=bar, baz

 

上述配置 将会在map中 以 foo→bar 和baz→baz的形式存储

 

使consul的Instance ID唯一

默认情况下，consul实例注册的ID等于其Spring Application Context ID。 默认情况下，Spring Application Context ID为${spring.application.name}:comma,separated,profiles:${server.port}。 对于大多数情况，这将允许在一台机器上运行一个服务的多个实例。 如果需要进一步的唯一性，Spring Cloud可以通过在spring.cloud.consul.discovery.instanceId中提供唯一标识符来覆盖这个值。 例如：

application.yml. 

spring:
  cloud:
    consul:
      discovery:
        instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

使用此元数据在localhost上部署多个服务实例时，随机值将保证实例唯一性。 在Cloudfoundry中，vcap.application.instance_id将在Spring Boot应用程序中自动填充，因此不需要随机值。

 

将headers添加至健康检查请求

headers可以添加至健康检查请求。 例如，如果使用Vault后端来注册一个Spring Cloud Config server。

application.yml. 

spring:
  cloud:
    consul:
      discovery:
        health-check-headers:
          X-Config-Token: 6442e58b-d1ea-182e-cfa5-cf9cddef0722

根据HTTP标准，每个header可以有多个值，在这种情况下，可以提供一个数组：

application.yml. 

spring:
  cloud:
    consul:
      discovery:
        health-check-headers:
          X-Config-Token:
            - "6442e58b-d1ea-182e-cfa5-cf9cddef0722"
            - "Some other value"

 

服务查找

1 使用 Ribbon

Spring Cloud支持Feign（一个REST客户端构造器）和Spring RestTemplate，用于使用逻辑服务名称或 ids 代替服务的物理URL来查找服务。 Feign和RestTemplate都使用Ribbon进行客户端负载均衡。

如果您想使用RestTemplate访问一个名字叫做STORES的服务，只需声明

@LoadBalanced
@Bean
public RestTemplate loadbalancedRestTemplate() {
     new RestTemplate();
}

然后像这样使用它（注意我们使用的是STORES服务的服务名称或id，而不是完全限定的域名）

@Autowired
RestTemplate restTemplate;

public String getFirstProduct() {
   return this.restTemplate.getForObject("https://STORES/products/1", String.class);
}

注：上述是spring cloud官方文档中介绍，本人强烈建议在程序中使用@Feign来构建restful 形式的接口，非常方便和简洁。具体资料可以网上查找。

如果在多个数据中心中拥有Consul群集，并且想要访问另一个数据中心的服务，仅靠服务名称或者 ID是不够的。 在这种情况下，可以在ym中配置spring.cloud.consul.discovery.datacenters.STORES = dc-west，其中STORES是服务的名称或 id，dc-west是STORES服务所在的数据中心。

2 使用DiscoveryClient（不建议使用）

如果不使用Netflix插件，则还可以使用org.springframework.cloud.client.discovery.DiscoveryClient，它也提供了一些简单的API，例如：

@Autowired
private DiscoveryClient discoveryClient;

public String serviceUrl() {
    List<ServiceInstance> list = discoveryClient.getInstances("STORES");
    if (list != null && list.size() > 0 ) {
        return list.get(0).getUri();
    }
    return null;
}

Consul Catalog Watch

Consul Catalog Watch利用consul的能力来watch services。 Catalog Watch会向consul发送一个阻塞的HTTP API调用来确定是否有任何服务已更改。 如果有新的服务数据，则发布一个心跳事件。

要更改调用Config Watch的频率，请更改spring.cloud.consul.config.discovery.catalog-services-watch-delay。 默认值为1000，以毫秒为单位。 延迟是上一次调用结束和下一次调用开始之后的时间量。

要禁用Catalog Watch，请设置spring.cloud.consul.discovery.catalogServicesWatch.enabled = false。

Catalog Watch使用Spring 的TaskScheduler来安排对consul api的调用。 默认情况下，它是一个ThreadPoolTaskScheduler，其poolSize为1. 要更改TaskScheduler，请创建一个TaskScheduler类型的bean，bean的名字是ConsulDiscoveryClientConfiguration.CATALOG_WATCH_TASK_SCHEDULER_NAME常量。

 

以上就是对如何在spring cloud应用配置consul来实现服务注册和发现。下面给一个完整的配置文件来实现上述主要功能。

因为我们是使用spring cloud来编写我们的服务，spring cloud会根据微服务中的配置调用consul的restful api接口自动在consul替我们注册服务。这里需要注意的是，consul的http 接口默认端口是8500，https是8501，gRPC: 8502, DNS: 8600，LAN: 8301, WAN: 8302 因此我们在自己的微服务中配置时要写对对应的端口。以下是一个微服务的配置例子：

 

spring:
    application:
      name: myApp
management:
    server:
      port: 4452
server：
    port：7093
spring:
    cloud:
      consul:
        host: 127.0.0.1   consul client 部署的地址
        port: 8500  consul http注册服务的端口号
      discovery:
          instanceId: ${spring.application.name}:${random.value} 配置 Consul 注册服务 ID
          serviceName: ${spring.application.name} 配置 Consul 注册的服务名称，${spring.application.name}变量是上我们配置的服务名（myApp）
        healthCheckInterval: 15s  心跳检查的时间间隔

 

微服务需要在主类上加入@EnableDiscoveryClient注解，例如：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * Hello world!
 *
 */
@SpringBootApplication
@EnableDiscoveryClient
public class App 
{
    public static void main( String[] args )
    {
        try {
            SpringApplication.run(App.class, args);
        }catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

在微服务的pom文件中的必须加入如下依赖：

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>

 

启动微服务后就可以在consul ui上看到我们的微服务了。

 

从Consul注销服务

使用命令

consul services deregister -id=serviceid

虽然服务会被注销，但是consul UI上有时仍然可以看到，问题如下：

We have a number of Spring Boot applications that register themselves with Consul (via Spring Cloud Consul). If I stop those applications via docker-compose stop myservice then they de-register themselves correctly and disappear from Consul.

If I use docker-compose kill myservice then the deregistration doesn't happen. I understand that on a UNIX system it's impossible to catch the SIGKILL event, so there's no way to force the de-registration.

What we're therefore seeing is services in Consul that never removed (marked as critical but still visible in the UI). Is there a way to force Consul to refresh what's registered, so that the dead services are removed?

解决方案如下：

It seems, that you have to use Consul HTTP API and manually deregister unavailable services. API gives you 2 different ways to deregister some service, the first one via agent endpoint like so

curl -v -X PUT http://%CONSUL_IP%:8500/v1/agent/service/deregister/<ServiceID>

and the second via catalog. Unfortunately in both cases you have to make http-request manually.