SpringCloud解析八:Consul的服务发现

与Eureka相比,Consul不仅可用于服务发现,还可以用作基于微服务体系结构中的配置服务器。我们可以通过以下方式引入Consul所需的依赖:

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

当我们引入该依赖的时候,等同于将以下几个依赖添加进了应用

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-consul-bus</artifactId>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-consul-config</artifactId>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-consul-discovery</artifactId>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <scope>compile</scope>
  <optional>true</optional>
</dependency>

本次我们只关注Consul的服务发现功能,所以只需要添加以下依赖即可:

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

一:向Consul进行服务注册(Registering with Consul)

当客户端(client )向Consul注册时,它会提供有关自身的元数据,如主机(host)和端口(port)、id、名称(name)和标记(tags)。默认情况下,会创建一个HTTP检查,Consul每10秒访问一次/health端点。如果运行状况检查失败,则将服务实例标记为严重。

默认情况下,Spring尝试在地址localhost:8500上与Consul连接。如果您需要覆盖此地址,则安装下面的格式进行配置即可,例如(在application.yml中):

spring:
  cloud:
    inetutils:
      preferred-networks: #springcloud提供工具,解决多IP地址问题
        - 10.2.2.9
        - 172.18.88.209
    consul:
      host: localhost
      port: 8500

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

默认的服务名(service name)、实例Id(instance id)、端口(port)取自Spring环境参数对象Environment中的${spring.application.name}、Spring Context ID和${server.port} 的值

如果要禁用Consul Discovery Client,您可以设置spring.cloud.consul.discovery.enabled为false,或者设置spring.cloud.discovery.enabled为false均可。

如果要禁止服务的注册,可设置spring.cloud.consul.discovery.register为false.

当管理服务器端口(management server port)设置为与应用程序端口不同的端口时,通过设置management.server.port属性,管理服务(management service )将注册为与应用程序服务不同的单独服务。例如(application.yml):

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

此时会注册两个服务

Application Service Management Service
instanceId : myApp
Name: myApp
instanceId : myApp-management
Name: myApp-management

这里在进行服务注册的时候默认是使用了应用的名称,可以通过以下的方式来修改注册的名称从而与应用名称不同

spring:
  application:
    name: myApp
management:
  server:
    port: 4452
spring:
  cloud:
    consul:
      discovery:
        instance-id: ${spring.application.name}-${server.port}-${spring.cloud.client.ip-address}  #Consuls使用的唯一标识。如果多个服务一样则Consul只会保留一个,默认:${spring.application.name}-${server.port}; 也可用:${spring.application.name}-${server.port}-${spring.cloud.client.hostname}
        serviceName: ${spring.application.name}
        tags: version=1.0
        prefer-ip-address: true  #开启使用IP而非主机名注册,根据需要选择是否开启
        #ip-address: 10.2.2.9   #直接指定IP地址(也可使用上面的inetutils方案)

此时注册的两个服务的ID和名称分别如下:

Application Service Management Service
instanceId : custom-service-id
Name: myprefix-myApp
instanceId : custom-service-id-management
Name: myprefix-myApp-management

从结果可见,Management服务的ID和名称都会在Application服务的基础上加上后缀“-management”,这是默认值,我们可以通过下面的参数来进行修改

/** Port to register the management service under (defaults to management port) */
spring.cloud.consul.discovery.management-port

/** Suffix to use when registering management service (defaults to "management" */
spring.cloud.consul.discovery.management-suffix

/** Tags to use when registering management service (defaults to "management" */
spring.cloud.consul.discovery.management-tags

健康检查

Consul 实例的健康检查默认为“/health”,这是Spring Boot Actuator 应用程序中有用端点的默认位置。如果使用非默认的上下文路径(context path)或servlet路径(例如server.servletPath=/foo)或管理端点路径(例如management.server.servlet.context-path=/admin),则即使是Actuator 应用程序,也需要更改这些内容。Consul用来检查健康端点(health endpoint)的时间间隔也可以配置。例如:10秒(10s)或1分钟(1m)。例子:

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

当然,你也可以通过设置management.health.consul.enabled=false来禁用健康检查。


二:服务发现

Spring Cloud中可以使用Feign或RestTemplate利用Ribbon来进行客户端负载均衡,其与Ribbon的集成在启动时自动完成。

由于Spring Cloud Ribbon正在维护中,建议您将spring.cloud.loadbalancer.ribbon.enabled设置为false,以便使用BlockingLoadBalancerClient 而不是RibbonLoadBalancerClient。

假设使用RestTemplate来访问“STORES”服务,则可以使用类似下面的代码:

@Autowired
RestTemplate restTemplate;

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

但是,如果“STORES”服务并不在当前的数据中心中,则还需要添加以下的配置告知该服务所在的数据中心才行

spring.cloud.consul.discovery.datacenters.STORES=dc-west

这里的dc-west就是STORES所在的数据中心。


使用DiscoveryClient

您还可以使用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进行服务发现的使用方法,至于更深入的分析将留在后面的章节。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,104评论 6 515
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,816评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,697评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,836评论 1 298
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,851评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,441评论 1 310
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,992评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,899评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,457评论 1 318
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,529评论 3 341
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,664评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,346评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,025评论 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,511评论 0 24
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,611评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,081评论 3 377
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,675评论 2 359

推荐阅读更多精彩内容