SpringCloud注册中心之consul详细讲解使用方法

前言

今天我们开始学习spring cloud的又一个注册中心consul，前面文章大概也讲解了一下各个注册中心的区别，今天我们直接开始配置consul到spring cloud。

从Springcloud官网Spring Cloud Consul篇章中我们可以看到官网对于consul的解释

大致的意思就是Consul提供了自动化配置的方式来使我们快速的绑定Consul到我们的spring环境及集成到我们的程序，使用一些简单的注解方式就可以为我们快速的部署大型分布式系统，Consul为我们提供服务注册发现、分布式配置及控制总线。

继续往下查看

Quick start中我们基本了解，与zk一样的我们需要使用@EnableDiscoveryClient注解来声明服务发现，配置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. 官网提示我们需要运行一个consul才能使用，consul的agent分为client及server，对于我们的spring cloud而已，不管是client还是server，都是当作服务注册中心看待即可。

1、创建服务提供者

我们创建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

创建我们的配置文件application.yml，并将我们的consul进行配置

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

创建主启动类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 "你请求的生产者的端口号为：" + port;
    }
}

2、创建服务消费者

接下来我们创建消费者的子工程consumer-consul8002，与生产者一样我们引入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>

创建配置文件application.yml，并进行配置

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

创建主启动类，消费接口类，负载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、测试

启动我们的生产者和消费者，登录10.1.12.13:8500进行查看是否成功注册到我们的consul服务中。

我们发现服务已经成功注入，但是出现了一个红色的叉，提示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的实例名称，部署集群的时候会出现相同实例名称会被顶替
        #替换service-name来进行实例名称注入，使用名称加ip来识别唯一性，进行集群部署防止同名顶替
        instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}
        # 心跳开启，如果不开启心跳，注册到consul会报错
        heartbeat:
          enabled: true

consul需要进行健康检查，所以需要服务将自己的ip进行注册，hostname配置的是死的地址不够灵活，使用prefer-ip-address来进行动态配置。

多个实例使用一个名称的时候，会出现同名顶替，所以使用instance-id来做实例id注册唯一性可避免，心跳需要手动开启，不开启心跳consul无法进行健康检查会报错。

重新配置后启动项目，已经正常注册

这里注册两个provider来验证咱们的集群，上面讲到会被顶替的问题，这里同一个服务器启动多个的时候，最好将端口号也加入来作为唯一健，这样就不会顶替，上面错误那个就是因为顶替了重启留下来的。

好了，现在我们项目已经成功注册到了consul，我们调用消费者接口进行验证http://localhost:8002/consumer/getProviderPort

到此我们使用consul作为注册中心就完成了。

上面注册的失效的服务，如果不进行移除，可能会出现请求会转发到异常的服务上面，因为consul不会自动移除失效的注册列表，所以这里可以参考官网文档（Deregister Service）进行手动移除。

到此这篇关于SpringCloud注册中心之consul详细讲解使用方法的文章就介绍到这了,更多相关SpringCloud consul内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！