4.服务注册中心之Consul

r囧r小猫 2022-12-15 02:52 145阅读 0赞

### **SpringCloud系列文章列表** ###

[0. SpringCloud实战专栏介绍准备][0. SpringCloud]  
[1. SpringCloud父工程搭建][1. SpringCloud]  
[2. 服务注册中心之Eureka（单机＋集群+Ribbon调用）][2. _Eureka_Ribbon]  
[3. 服务注册中心之Zookeeper][3. _Zookeeper]  
[4. 服务注册中心之Consul][4. _Consul]  
[5. eureka、zookeeper和consul三种注册中心之间的区别][5. eureka_zookeeper_consul]  
[6. 负载均衡服务调用之Ribbon][6. _Ribbon]  
[7. 服务调用之OpenFeign][7. _OpenFeign]  
[8. Hystrix断路器全面实战总结][8. Hystrix]  
[9. SpringCloud Gateway网关][9. SpringCloud Gateway]  
[10. SpringCloud Config配置中心][10. SpringCloud Config]  
[11. SpringCloud Bus消息总线][11. SpringCloud Bus]  
[12. SpringCloud Stream消息驱动][12. SpringCloud Stream]  
[13. SpringCloud Sleuth分布式请求链路追踪][13. SpringCloud Sleuth]

### 目录 ###

*   *   *  \*\*SpringCloud系列文章列表\*\*
         *  1 Consul介绍
         *   *  1.1 简介
             *  1.2 功能
         *  2 Consul安装(windows)
         *   *  2.1 下载
             *  2.2 安装运行
             *   *  2.2.1）解压后得到consul.exe，配置环境变量
                 *  2.2.2) 运行consul
                 *  2.2.3）访问自带的可视化界面 http://localhost:8500/
         *  3 Consul安装(linux)
         *  3 项目实战
         *   *  3.1 服务提供者
             *  3.2 服务消费者

### 1 Consul介绍 ###

#### 1.1 简介 ####

**官方文档**： [https://www.consul.io/docs/intro][https_www.consul.io_docs_intro]  
**中文文档**：[https://www.springcloud.cc/spring-cloud-consul.html][https_www.springcloud.cc_spring-cloud-consul.html]

Consul是一套开源的分布式**服务发现**和**配置管理**系统，由HashiCorp公司用Go语言开发。  
提供了微服务系统中的**服务治理、配置中心、控制总线**等功能。这些功能中的每一个都可以根据需要单独使用， 也可以-起使用以构建全方位的服务网格，总之Consul提供了一种完整的服务网格解决方案。  
它具有很多优点。包括:基于 raft协议,比较简洁;支持健康检查,同时支持HTTP和DNS协议支持跨数据中心的WAN集群提供图形界面跨  
平台，支持Linux、Mac、Windows

#### 1.2 功能 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center]

### 2 Consul安装(windows) ###

> 本文演示windows版本安装，linux可以采用docker安装，非常方便；

#### 2.1 下载 ####

官方下载地址 [https://www.consul.io/downloads][https_www.consul.io_downloads] ，选择对应系统下载；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 1]

ps: 网速贼慢，需要windows版本的找我要

#### 2.2 安装运行 ####

##### 2.2.1）解压后得到consul.exe，配置环境变量 #####

![在这里插入图片描述][20201014221911889.png_pic_center]  
系统变量 Path中，新增路径 D:\\consul  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 2]

##### 2.2.2) 运行consul #####

打开cmd命令行，执行 consul agent -dev  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 3]

##### 2.2.3）访问自带的可视化界面 http://localhost:8500/ #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 4]

### 3 Consul安装(linux) ###

docker安装

docker run -d -p 8500:8500 --name=dev-consul -e CONSUL_BIND_INTERFACE=eth0 consul

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 5]

同理，访问 http://IP:8500/  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 6]

### 3 项目实战 ###

> 启动consul，充当**注册中心**角色；  
> 新建两个工程；服务提供者和消费者；

服务提供者为 cloud-provider-consul8006  
消费者为 cloud-consumerzk-order80

#### 3.1 服务提供者 ####

新建子项目cloud-provider-consul8006

pom.xml

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

application.yml

server:
      port: 8006
    
    spring:
      application:
        name: provider-consul8006
     #consul配置
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            service-name: ${ spring.application.name}
            hostname: localhost

启动类加注解 @EnableDiscoveryClient

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

写个web接口便于测试

@RestController
    public class PaymentConsulController { 
    
        @Value("${server.port}")
        private Integer serverPort;
    
        @GetMapping("/payment/consul")
        public String paymentConsul(){ 
            return "springCloud with consul: "+serverPort+"\t "+ UUID.randomUUID().toString();
        }
    
    }

启动项目，查看consul如下图，注册成功  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 7]  
点击我们注册的服务，可以看到具体的健康状态；  
实际上就是调用/actuator/health来进行健康检查的；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 8]  
测试下本地接口，成功  
![在这里插入图片描述][20201015225054974.png_pic_center]

#### 3.2 服务消费者 ####

搭建消费者项目 cloud-consumerconsul-order80

pom.xml 跟生产者一样

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

application.yml

server:
      port: 80
    
    spring:
      application:
        name: consumer-consul
      #consul
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            service-name: ${ spring.application.name}
            hostname: localhost

启动类增加 @EnableDiscoveryClient注解

新增RestTemplate配置类

@Configuration
    public class RestTemplateConfig { 
    
        @Bean
        @LoadBalanced
        RestTemplate restTemplate(){ 
            return new RestTemplate();
        }
    }

写个web接口，调用服务提供者

@RestController
    public class PaymentController { 
    
        private final String  url = "http://provider-consul8006";
    
        @Autowired
        RestTemplate restTemplate;
    
        @GetMapping("/consumer/payment/consul")
        public String paymentConsul(){ 
            return restTemplate.getForObject(url+"/payment/consul",String.class);
        }
    }

启动消费者，查看consul注册成功；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 9]

测试消费者调用服务提供者是否成功

![在这里插入图片描述][20201015225901646.png_pic_center]  
如图远程调用成功；

注意：

> 如果实战过程中，发现项目在consul上不在线；一定先要明白一个问题，在consul中要能够访问http://项目ip:8006/actuator/health接口；  
> 也就是说consul要和你的项目在同一个网内；  
> 例如consul在外网linux服务器，项目跑着本地，那死活是无法在线的

> 点赞+评论+关注  
> 本文源码地址： https://gitee.com/shuaidawang/SpringCloudDemo.git  
> 有错误的地方欢迎指正！可以加入qq交流群： 700637673

[0. SpringCloud]: https://blog.csdn.net/shuai8624/article/details/108027323
[1. SpringCloud]: https://blog.csdn.net/shuai8624/article/details/108089864
[2. _Eureka_Ribbon]: https://blog.csdn.net/shuai8624/article/details/108111529
[3. _Zookeeper]: https://blog.csdn.net/shuai8624/article/details/108177121
[4. _Consul]: https://blog.csdn.net/shuai8624/article/details/109085205
[5. eureka_zookeeper_consul]: https://blog.csdn.net/shuai8624/article/details/109267643
[6. _Ribbon]: https://blog.csdn.net/shuai8624/article/details/109274118
[7. _OpenFeign]: https://blog.csdn.net/shuai8624/article/details/109275543
[8. Hystrix]: https://blog.csdn.net/shuai8624/article/details/109557105
[9. SpringCloud Gateway]: https://blog.csdn.net/shuai8624/article/details/109587848
[10. SpringCloud Config]: https://blog.csdn.net/shuai8624/article/details/109749674
[11. SpringCloud Bus]: https://blog.csdn.net/shuai8624/article/details/109871700
[12. SpringCloud Stream]: https://blog.csdn.net/shuai8624/article/details/110735489
[13. SpringCloud Sleuth]: https://blog.csdn.net/shuai8624/article/details/110748777
[https_www.consul.io_docs_intro]: https://www.consul.io/docs/intro
[https_www.springcloud.cc_spring-cloud-consul.html]: https://www.springcloud.cc/spring-cloud-consul.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/0d1e87887fb44943ae123cdd7aedb3b8.png
[https_www.consul.io_downloads]: https://www.consul.io/downloads
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/b49ae4f7ed3c4983b4f4edc3752c79d2.png
[20201014221911889.png_pic_center]: /images/20221123/aaa84a5c94e14dd0b93ae3fd5213d485.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/9f9daffd6b754c0384dab5cfd940f7e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/5cbb74613b79443295c8bd7bd7a1b226.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/a7bbbf3f36ba4dbc99ab2357d7ff54d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/44cfef4e2ce44cecaf850c552aa2959c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/e90cec85d0544703b4990b0ba4cdc865.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221123/fee78f93d1d54cc49cf1e5b3756c58be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221123/67fccb906e544b439e277ae074e22ae0.png
[20201015225054974.png_pic_center]: /images/20221123/8a1db49e58d140f2882058ee53afe672.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3NodWFpODYyNA_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221123/ffa0cd9305a94e2f8e0faa0404124d5e.png
[20201015225901646.png_pic_center]: /images/20221123/c78f73404db64a3299e4b2940435a8cf.png