SpringCloud第九篇-服务注册(consul)

客官°小女子只卖身不卖艺 2022-06-05 08:49 285阅读 0赞

### 文章目录 ###

*   *  简介
     *   *  和其他服务注册对比
     *  安装准备工作
     *   *  安装consul
         *   *  windows上安装
         *  linux安装
         *  docker环境部署
         *  \*\*consul常用命令+常用选项\*\*
         *  启动consul
         *   *  springcloud项目中使用consul客户端实现注册
             *   *  创建项目consul-server
                 *  application.yml
                 *  java
     *  consul的key/value操作
     *  断电恢复outage recover
     *  源码地址
     *  参考资料

## 简介 ##

> Consul是强一致性的数据存储，使用gossip形成动态集群。它提供分级键/值存储方式，不仅可以存储数据，而且可以用于注册器件事各种任务，从发送数据改变通知到运行健康检查和自定义命令，具体如何取决于它们的输出。下面两张图是Consul的原理图

Consul是分布式的、高可用、横向扩展的。consul提供的一些关键特性：

*  service discovery：consul通过DNS或者HTTP接口使服务注册和服务发现变的很容易，一些外部服务，例如saas提供的也可以一样注册。
 *  health checking：健康检测使consul可以快速的告警在集群中的操作。和服务发现的集成，可以防止服务转发到故障的服务上面。
 *  key/value storage：一个用来存储动态配置的系统。提供简单的HTTP接口，可以在任何地方操作。
 *  multi-datacenter：无需复杂的配置，即可支持任意数量的区域。
 *  Raft： Raft算法来实现分布式一致性

### 和其他服务注册对比 ###

<table> 
 <thead> 
  <tr> 
   <th> Feature</th> 
   <th> Consul</th> 
   <th> zookeeper</th> 
   <th> etcd</th> 
   <th> euerka</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td> 服务健康检查</td> 
   <td> 服务状态，内存，硬盘等</td> 
   <td> (弱)长连接，keepalive</td> 
   <td> 连接心跳</td> 
   <td> 可配支持</td> 
  </tr> 
  <tr> 
   <td> 多数据中心</td> 
   <td> 支持</td> 
   <td> —</td> 
   <td> —</td> 
   <td> —</td> 
  </tr> 
  <tr> 
   <td> kv存储服务</td> 
   <td> 支持</td> 
   <td> 支持</td> 
   <td> 支持</td> 
   <td> —</td> 
  </tr> 
  <tr> 
   <td> 一致性</td> 
   <td> raft</td> 
   <td> paxos</td> 
   <td> raft</td> 
   <td> —</td> 
  </tr> 
  <tr> 
   <td> cap</td> 
   <td> ca</td> 
   <td> cp</td> 
   <td> cp</td> 
   <td> ap</td> 
  </tr> 
  <tr> 
   <td> 使用接口(多语言能力)</td> 
   <td> 支持http和dns</td> 
   <td> 客户端</td> 
   <td> http/grpc</td> 
   <td> http（sidecar）</td> 
  </tr> 
  <tr> 
   <td> watch支持</td> 
   <td> 全量/支持long polling</td> 
   <td> 支持</td> 
   <td> 支持 long polling</td> 
   <td> 支持 long polling/大部分增量</td> 
  </tr> 
  <tr> 
   <td> 自身监控</td> 
   <td> metrics</td> 
   <td> —</td> 
   <td> metrics</td> 
   <td> metrics</td> 
  </tr> 
  <tr> 
   <td> 安全</td> 
   <td> acl /https</td> 
   <td> acl</td> 
   <td> https支持（弱）</td> 
   <td> —</td> 
  </tr> 
  <tr> 
   <td> spring cloud集成</td> 
   <td> 已支持</td> 
   <td> 已支持</td> 
   <td> 已支持</td> 
   <td> 已支持</td> 
  </tr> 
 </tbody> 
</table>

stackshare官方提供的使用情况对比统计  
[https://stackshare.io/stackups/consul-vs-zookeeper-vs-etcd][https_stackshare.io_stackups_consul-vs-zookeeper-vs-etcd]

## 安装准备工作 ##

其他操作系统的安装包下载地址  
[https://www.consul.io/downloads.html][https_www.consul.io_downloads.html]

### 安装consul ###

#### windows上安装 ####

1.  解压：  
    ![这里写图片描述][aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE0ODU5ODM3]
2.  设置环境变量：  
    计算机-右键-属性-高级属性-设置环境-变量设置  
    在path下加上：D:\\opt\\consul；
3.  cmd启动：  
    如果环境变量不起 作用则直接cmd进入该目录

D:
    cd D:\opt\consul
    consul agent -dev

可以看到启动成功。

打开网址：[http://localhost:8500][http_localhost_8500] ，可以看到界面，相关服务发现的界面。

### linux安装 ###

$ mkdir -p $GOPATH/src/github.com/hashicorp && cd $!
    $ git clone https://github.com/hashicorp/consul.git
    $ cd consul
    $ make bootstrap
    $ make bootstrap

### docker环境部署 ###

setenforce 0
    sed --follow-symlinks -i "s/SELINUX=enforcing/SELINUX=disabled/g" /etc/selinux/config
    yum install docker
    systemctl enable docker && systemctl start docker
    firewall-cmd --set-default-zone=trusted
    firewall-cmd --complete-reload

### **consul常用命令+常用选项** ###

-bind：该地址用来在集群内部的通讯，集群内的所有节点到地址都必须是可达的，默认是0.0.0.0。
    -client：consul绑定在哪个client地址上，这个地址提供HTTP、DNS、RPC等服务，默认是127.0.0.1。
    -node consul节点ID，集群内唯一
    -join  192.168.1.60   节点加入集群(leader 192.168.1.60)
    -server agent启用server模式运行。不加入此参数则client模式运行。
    -ui   启用web管理页面
    -data-dir  指定agent储存状态的数据目录

### 启动consul ###

![这里写图片描述][aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE0OTQzMTgy]

打开浏览器地址：[http://localhost:8500][http_localhost_8500]  
![这里写图片描述][aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE1MDI2NDg1]

#### springcloud项目中使用consul客户端实现注册 ####

##### 创建项目consul-server #####

这里使用的是DIEA

**pom**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>bamboo</groupId>
        <artifactId>consul-server</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.2.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-consul-discovery</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Dalston.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    
    </project>

##### application.yml #####

spring:
      cloud:
        consul:
          host: localhost
          port: 8500
          discovery:
            healthCheckPath: /health
            healthCheckInterval: 5s
            instance-id: consul-server
      application:
        name: consul-server
    server:
      port: 8501

*  healthCheckPath:健康检查的REST地址
 *  healthCheckInterval：检查的时间间隔

这里说明一下：healthCheckPath中的REST借口需要在代码中实现并可以get方式正常访问，否则健康检查的结果将会一直是critical状态，即不可用严重状态

##### java #####

package bamboo;
    
    
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.builder.SpringApplicationBuilder;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * 使用consul作为服务注册发现中心
     *
     * 这里是一个服务启动类
     *
     * Created by xialeme on 2017/11/22.
     */
    
    @SpringBootApplication
    @EnableDiscoveryClient
    @RestController
    public class ConsulServerApplication {
    
        @RequestMapping("/hi")
        public String home() {
            return "hello ConsulServer ";
        }
    	
    	//健康检查的实现REST部分
        @RequestMapping("/health")
        public String health() {
            return "hello health ";
        }
    
        public static void main(String[] args) {
            new SpringApplicationBuilder(ConsulServerApplication.class).web(true).run(args);
        }
    
    
    }

运行ConsulServerApplication

可以在监控台看到如下信息，说明已经成功了

![这里写图片描述][aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE1OTE2NzAy]

## consul的key/value操作 ##

consul还提供了键/值存储的功能。  
可以在http://localhost:8500中点击KEY/VALUE按钮进行操作

使用API的方法如下：  
如 查询 所有K/V  
curl -v [http://localhost:8500/v1/kv/?recurse][http_localhost_8500_v1_kv_recurse]

保存键为web/key2, flags 为42， 值为true的记录。  
curl -X PUT -d ‘test’ [http://localhost:8500/v1/kv/web/key2?flags=42][http_localhost_8500_v1_kv_web_key2_flags_42]  
true

删除记录：  
curl -X DELETE [http://localhost:8500/v1/kv/web/sub?recurse][http_localhost_8500_v1_kv_web_sub_recurse]

更新值：  
curl -X PUT -d ‘newval’ [http://localhost:8500/v1/kv/web/key1?cas=97][http_localhost_8500_v1_kv_web_key1_cas_97]  
true

更新index：  
curl “[http://localhost:8500/v1/kv/web/key2?index=101&wait=5s][http_localhost_8500_v1_kv_web_key2_index_101_wait_5s]”

结果：\[\{“CreateIndex”:98,“ModifyIndex”:101,“Key”:“web/key2”,“Flags”:42,“Value”:“dGVzdA==”\}\]

更详细的consul命令详解：

[http://m.oschina.net/blog/353392][http_m.oschina.net_blog_353392]

## 断电恢复outage recover ##

当有一台服务器不可用时，处理的方法有：

1.  对服务器进恢复，然后重新上线
2.  用新服务器，替代旧的consul服务器  
    这两种方式都需要将服务器ip与原来的ip相同。
3.  添加新的服务器，而ip无需与原来的相同。步骤： 停掉所有的consul服务器，将损坏的服务器ip从raft/peer.json中移除，重启其他服务器，并将新的服务器加入集群。

## 源码地址 ##

[https://github.com/BambooZhang/spring-cloud/tree/master/chapter9][https_github.com_BambooZhang_spring-cloud_tree_master_chapter9]

其他教程的源码请在下面的地址中查找  
[https://github.com/BambooZhang/spring-cloud/][https_github.com_BambooZhang_spring-cloud]

## 参考资料 ##

[https://www.cnblogs.com/newP/p/6349316.html][https_www.cnblogs.com_newP_p_6349316.html]  
sprngcloud中国提供的翻译  
[https://springcloud.cc/spring-cloud-consul.html][https_springcloud.cc_spring-cloud-consul.html]

[https_stackshare.io_stackups_consul-vs-zookeeper-vs-etcd]: https://stackshare.io/stackups/consul-vs-zookeeper-vs-etcd
[https_www.consul.io_downloads.html]: https://www.consul.io/downloads.html
[aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE0ODU5ODM3]: /images/20220605/db2025b6fb1740a091af3340f5c5d193.png
[http_localhost_8500]: http://localhost:8500
[aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE0OTQzMTgy]: /images/20220605/caa8f0892f5b4ab8a5888f84857b89a5.png
[aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE1MDI2NDg1]: /images/20220605/10654fedd238428e995351bbf62d0508.png
[aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcxMTIyMjE1OTE2NzAy]: /images/20220605/e169c91a5f1549218cd50284267bb81b.png
[http_localhost_8500_v1_kv_recurse]: http://localhost:8500/v1/kv/?recurse
[http_localhost_8500_v1_kv_web_key2_flags_42]: http://localhost:8500/v1/kv/web/key2?flags=42
[http_localhost_8500_v1_kv_web_sub_recurse]: http://localhost:8500/v1/kv/web/sub?recurse
[http_localhost_8500_v1_kv_web_key1_cas_97]: http://localhost:8500/v1/kv/web/key1?cas=97
[http_localhost_8500_v1_kv_web_key2_index_101_wait_5s]: http://localhost:8500/v1/kv/web/key2?index=101&wait=5s
[http_m.oschina.net_blog_353392]: http://m.oschina.net/blog/353392
[https_github.com_BambooZhang_spring-cloud_tree_master_chapter9]: https://github.com/BambooZhang/spring-cloud/tree/master/chapter9
[https_github.com_BambooZhang_spring-cloud]: https://github.com/BambooZhang/spring-cloud/
[https_www.cnblogs.com_newP_p_6349316.html]: https://www.cnblogs.com/newP/p/6349316.html
[https_springcloud.cc_spring-cloud-consul.html]: https://springcloud.cc/spring-cloud-consul.html