spring cloud consul基礎掃盲

前言

最近一段時間開始了一個新項目，幾個同事共同開發，同時使用了PHP和JAVA兩種語言，分紅了各個模塊，在相互調用時的配置難以維護，因而就開始尋找服務發現的方案，spring 系列的目前提供了eureka、consul、zookeeper,最終選擇consul.

eureka

eureka由JAVA語言開發，在spring cloud中使用方便，容易配置，是首先想到的方案，但基於如下緣由放棄:

1. 目前spring集成的爲1.X版本，且2.0已閉源，前景不明朗;
2. 與其它語言協同開發時，非JAVA語言須要開啓一個sidecar進程才能夠通訊;

consul

consul由GO語言開發,是專門用來作服務發現的，具備服務註冊、服務必現、服務檢測、UI管理、命令管理、API管理、數據存儲等;且spring在此基礎上作了封裝，優先採用;

zookeeper

zooKeeper最早使用於hadoop集羣管理，用來維護集羣狀態，是一個大而全的組件，學習成本略高

consul安裝

1. 從官網下載相應平臺的包： 官網地址;
2. 解壓到指定目錄，直接運行便可: consul agent -server -bootstrap-expect=1 -data-dir=/data/data/consul/consul1 -node=master_1 -bind=0.0.0.0 -client=0.0.0.0 -enable-script-checks=true -config-dir=/etc/consul/consul1 -ui
3. 至此consul安裝完成，其它常規操做(如集羣部署、經常使用命令)請參考官方文檔或CSDN博客

spring-cloud配置

1. 引入依賴包

//consul-all包含consul-bus、consul-discovery、consul-config三部分
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-all</artifactId>
        </dependency>

1. application.yml/bootstrap.yml配置

spring:
  cloud:
    consul:
      host: 192.168.1.40
      port: 8500
      discovery:
        heartbeat:
          enabled: true
        enabled: true
        register: true
        deregister: true
        prefer-ip-address: true
        instance-id: ${spring.application.name}:${random.value}
#        只查詢有效的記錄
        query-passing: true
      config:
#      在consul中配置的key路徑爲: config/cloud-consul/key 在啓動或更新時會覆蓋項目中原先配置
        format: key_value
        enabled: true
#        全部項目共用的配置 consul的配置路徑爲： config/application/key
        default-context: application
        data-key: data
        prefix: config

1. 在入口中加入服務發現註解

@SpringBootApplication
@EnableDiscoveryClient

1. 獲取指定服務的信息

//經過feign或restTemplate便可遠程調用
    @Autowired
    private ConsulDiscoveryClient discoveryClient;
    
    public List<ServiceInstance> test2(String serviceName){
        List<ServiceInstance> instanceList = discoveryClient.getInstances(serviceName);
        return instanceList;
    }

1. 至此，一個簡單的服務註冊發現完工，能夠到consul ui界面查詢相關信息,默認爲8500端口

consul-config

consul自帶數據存儲功能，是config-client和config-server的替代方案，因爲上文已經引入consul-all功能，已包含consul-config功能，因此consul的配置位置要由application.yml轉到bootstrap.yml中，以官方的說明，consul中的數據將會在一個特定的啓動階段加入到spring容器中，當consul中數據變動時，會觸發refresh操做，完成參數的熱更新;

1. 配置參數

config:
#      在consul中配置的key路徑爲: config/cloud-consul/key 在啓動或更新時會覆蓋項目中原先配置
        format: key_value
        enabled: true
#        全部項目共用的配置 consul的配置路徑爲： config/application/key
        default-context: application
        data-key: data
        prefix: config

1. 經過consul-ui或命令設置屬性
   

2. 在須要同步更新的類上加上@RefreshScope的註解

3. 更改consul中的key值，觸發更新
   

注意內容:
全局的配置屬性所在路徑:/config/application/ 或 /config/application,profile,項目配置屬性全部路徑: /config/service-name 或 /config/service-name,profile

可能會現現的坑

• consul默認綁定IP爲127.0.0.1,可經過-client= 和 -bind來修改
• 負載均衡器會選取失效的服務節點 請確保query-passing的屬性爲true
• 在spring項目關閉時，會觸發服務自動註銷，如因意外狀況形成失效的節點未註銷，可能會形成異常狀況(因consul不能自動剔除失效節點)，特別是上query-passing的屬性爲false時，須要手動註銷失效節點，方法請參考consul官方文檔;

重要說明

最好的教程就是官方文檔，把consul和spring-cloud-consul文檔過一遍，大部分問題均可以解決，若是有一些弄不清楚，就google吧.............. 若是發現有任何錯誤，歡迎各位大神指正