SpringCloud注冊中心之consul詳細講解使用方法

更新時間：2022年11月11日 10:23:16 作者：麻儂

Consul是一款由HashiCorp公司開源的，用于服務治理的軟件，Spring Cloud Consul對其進行了封裝，這篇文章主要介紹了springcloud組件consul服務治理,需要的朋友可以參考下

前言

今天我們開始學習spring cloud的又一個注冊中心consul，前面文章大概也講解了一下各個注冊中心的區(qū)別，今天我們直接開始配置consul到spring cloud。

從Springcloud官網(wǎng)Spring Cloud Consul篇章中我們可以看到官網(wǎng)對于consul的解釋

大致的意思就是Consul提供了自動化配置的方式來使我們快速的綁定Consul到我們的spring環(huán)境及集成到我們的程序，使用一些簡單的注解方式就可以為我們快速的部署大型分布式系統(tǒng)，Consul為我們提供服務注冊發(fā)現(xiàn)、分布式配置及控制總線。

繼續(xù)往下查看

Quick start中我們基本了解，與zk一樣的我們需要使用@EnableDiscoveryClient注解來聲明服務發(fā)現(xiàn)，配置consul的url和port分別為spring.cloud.consul.host和spring.cloud.consul.port。

A local Consul agent must be running.See the Consul agent documentation on how to run an agent. 官網(wǎng)提示我們需要運行一個consul才能使用，consul的agent分為client及server，對于我們的spring cloud而已，不管是client還是server，都是當作服務注冊中心看待即可。

1、創(chuàng)建服務提供者

我們創(chuàng)建consul的服務提供者provider-consul8001，然后引入我們的maven依賴

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

consul會默認使用springboot的actuator來進行健康檢查，所以這里我們引入它的依賴

這里我之前引用錯了依賴spring-boot-actuator，注意正確的依賴應該是spring-boot-starter-actuator

創(chuàng)建我們的配置文件application.yml，并將我們的consul進行配置

server:
port: 8001
spring:
application:
name: provider
cloud:
consul:
host: 10.1.12.13
port: 8500

創(chuàng)建主啟動類ProviderConsul8001Application.class及我們的測試接口文件ProviderController.class

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

@RestController
public class ProviderController {
    @Value("${server.port}")
    private String port;
    @GetMapping("/consul/provider/getPort")
    public String getPort(){
        return "你請求的生產(chǎn)者的端口號為：" + port;
    }
}

2、創(chuàng)建服務消費者

接下來我們創(chuàng)建消費者的子工程consumer-consul8002，與生產(chǎn)者一樣我們引入maven依賴

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

創(chuàng)建配置文件application.yml，并進行配置

server:
port: 8002
spring:
application:
name: consumer
cloud:
consul:
port: 8500
host: 10.1.12.13

創(chuàng)建主啟動類，消費接口類，負載Ribbon的配置文件

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

@RestController
@RequestMapping("/consumer")
public class ConsumerController {
    @Autowired
    private RestTemplate loadBalancedRestTemplate;
    @GetMapping("/getProviderPort")
    public String getProviderPort(){
        return loadBalancedRestTemplate.getForObject("http://provider/consul/provider/getPort",String.class);
    }
}

@Configuration
public class RibbonConfig {
    @Bean
    @LoadBalanced
    public RestTemplate loadBalancedRestTemplate(){
        return new RestTemplate();
    }
}

3、測試

啟動我們的生產(chǎn)者和消費者，登錄10.1.12.13:8500進行查看是否成功注冊到我們的consul服務中。

我們發(fā)現(xiàn)服務已經(jīng)成功注入，但是出現(xiàn)了一個紅色的叉，提示At least one health check on one instance is failing。是因為我們沒有配置服務注冊到consul的地址和心跳等配置這里我們加上相應的配置之后再啟動服務。

spring:
application:
name: provider
cloud:
consul:
host: 10.1.12.13
port: 8500
discovery:
#hostname: localhost 此配置是服務注冊到consul的ip地址，因為服務部署有時候是沒有辦法確定的，所以盡量不要使用
#這里是將服務運行的ip作為注冊ip注冊到consul，consul在進行健康檢查的時候會使用，替代掉consul.discovery.hostname
prefer-ip-address: true
#service-name: ${spring.application.name} 這個是服務注冊到consul的實例名稱，部署集群的時候會出現(xiàn)相同實例名稱會被頂替
#替換service-name來進行實例名稱注入，使用名稱加ip來識別唯一性，進行集群部署防止同名頂替
instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}
# 心跳開啟，如果不開啟心跳，注冊到consul會報錯
heartbeat:
enabled: true