Spring Cloud 升級之路 - 2020.0.x - 4. 使用 Eureka 作為註冊中心

乾貨滿滿張雜湊發表於2021-05-10
SpringCloud

Eureka 目前的狀態：Eureka 目前 1.x 版本還在更新，但是應該不會更新新的功能了，只是對現有功能進行維護，升級併相容所需的依賴。 Eureka 2.x 已經胎死腹中了。但是，這也不代表 Eureka 就是不能用了。如果你需要一個簡便易於部署的註冊中心，Eureka 還是一個很好的選擇。雲服務環境中，基本上所有例項地址和微服務名稱都在不斷變化，也並不太需要 Eureka 所缺少的持久化特性。當你的叢集屬於中小規模的時候（節點小於 1000 個）， Eureka 依然是一個不錯的選擇。當你的叢集很大的時候，Eureka 的同步機制可能就限制了他的表現。

Eureka 的設計

Eureka 的設計比較小巧，沒有複雜的同步機制，也沒有複雜的持久化機制，叢集關係只是簡單的將收到的客戶端請求轉發到叢集內的其他 Eureka 例項。Eureka 本身也只有註冊中心的功能，不像其他種類的註冊中心那樣，將註冊中心和配置中心合在一起，例如 Consul 和 nacos。

Eureka 的互動流程如下：

image

首先，Service A 通過 Eureka Client 傳送註冊請求（Register）到同一可用區的 Eureka Server 1。之後通過傳送心跳請求（Renew）到這個 Eureka Server 1. Eureka Server 1 收到這些請求的時候，會處理這些請求並將這些請求轉發到其他的叢集內的 Eureka Server 2 和 Eureka Server 3. Eureka Server 2 和 Eureka Server 3 不會再轉發收到的 Eureka Server 1 轉發過來的請求。然後，Service B 還有 Service C 通過 Eureka 獲取到了 Service A 的位置，最後呼叫了 Service A。

對於本地沒有查詢到的微服務，Eureka Server 還會從遠端 Region 的 Eureka Server 去獲取，例如這裡對於 Service D，本地沒有查到，Eureka Server 會返回遠端 Region 的 Service D 的例項。由於本地有 Service A，所以肯定不會返回遠端 Region 的 Service A 的例項。並且，本地是定時拉取的遠端 Region 的 Service 列表，並不是每次查詢的時候現查詢的。

一般的，微服務之間的互相呼叫，並不經過 Eureka，也不會涉及到 Eureka 客戶端了，而是通過負載均衡器呼叫，這個我們後面就會提到。

Eureka 相關概念

這裡我們忽略所有的 AWS 相關的術語以及配置還有相關邏輯處理。

Eureka 中的術語：

  1. Eureka 例項：每個註冊到 Eureka 上面的例項就是 Eureka 例項。
  2. Eureka 例項狀態：包括 UP（可以處理請求），DOWN（健康檢查失敗，不能正常處理請求），STARTING（啟動中，不能處理請求），OUT_OF_SERVICE（人為下線，暫時不處理請求），UNKNOWN（未知狀態）。
  3. Eureka 伺服器：作為註冊中心執行，主要提供例項管理功能（處理例項註冊（register）請求、處理例項登出（cancel）請求、處理例項心跳（renew）請求、內部處理例項過期（evict））、例項查詢功能（各種查詢例項資訊的介面，例如通過 AppName 獲取例項列表，通過例項 id 獲取例項資訊等等）
  4. Eureka 伺服器叢集：Eureka 伺服器的叢集，每個 Eureka 伺服器都配置了區域以及可用區，Eureka 伺服器收到的客戶端請求會轉發到同一區域內的其他 Eureka 伺服器，可以配置優先發到同一可用區的 Eureka 伺服器。非同一區域內 Eureka 伺服器，通過定時拉取的方式進行同步。
  5. Eureka 客戶端：請求 Eureka 伺服器的客戶端。封裝傳送例項註冊（register）請求、例項登出（cancel）請求和例項心跳（renew）請求。
  6. VIP（或者是 Virtual Hostname）: Eureka 中可以通過兩種方式獲取例項，一個是通過服務名稱，另一種是通過 VIP。每個例項都有服務名稱，以及 VIP。Eureka 伺服器中的索引方式是以服務名稱為 key 的索引，我們也可以通過遍歷所有例項資訊的方式通過 VIP 字串匹配獲取相關的例項。在 Spring Cloud 體系中，一個例項的 VIP、SVIP（其實就是 Secure VIP，即 https 的地址）以及服務名稱都是 spring.application.name 指定的服務名稱。

Eureka 相關配置

  1. Eureka 例項配置：Eureka 例項，每個註冊到 Eureka 上面的例項就是 Eureka 例項。Eureka 例項包含以下元素，以及相關配置：
  2. 基本資訊：包括 IP，埠等訪問這個 Eureka 例項所需的資訊：
eureka:
  instance:
    #一般不用我們自己設定，EurekaInstanceConfigBean 的構造器會通過 InetUtils 獲取 ip 地址
    #ip-address:
    #一般不用我們自己設定，EurekaInstanceConfigBean 的構造器會通過 InetUtils 獲取 hostname
    #hostname:
    #註冊到 eureka 上面供其他例項訪問的地址使用 ip 進行註冊，其他例項會通過 ip 進行訪問
    prefer-ip-address: true
    #不用設定 non-secure-port，自動使用 server.port 作為 non-secure-port
    #non-secure-port:
    #如果 secure-port-enabled 是 true，則會自動使用 server.port 作為 secure-port;我們一般內部呼叫不用 ssl，所以不需要配置 secure-port
    #secure-port:
    #預設是啟用 non-secure-port 的
    non-secure-port-enabled: true
    #預設是不啟用 secure-port 的，我們一般內部呼叫不用 ssl
    secure-port-enabled: false
    #個性化的例項id，包括 ip:微服務名稱:埠
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}
    # app名稱，不填寫在 Spring-cloud-netflix 體系下預設就是 spring.application.name
    appname: ${spring.application.name}
    #app組名稱歸類用的，目前也沒什麼用
    app-group-name: common
    #例項名稱空間，目前也沒什麼用
    namespace: public
  1. 基本連結資訊：包括首頁路徑地址以及健康檢查路徑地址：
eureka:
  instance:
    # 健康檢查地址，預設是 /actuator/health
    health-check-url-path: /actuator/health
    # 例項狀態地址，預設是 /actuator/info
    status-page-url-path: /actuator/info
    # 首頁地址，預設是 /
    home-page-url-path: /
  1. 例項註冊行為，即例項註冊後的行為，以及心跳間隔等配置：
eureka:
  instance:
    # 服務過期時間配置,超過這個時間沒有接收到心跳EurekaServer就會將這個例項剔除
    # 注意，EurekaServer一定要設定eureka.server.eviction-interval-timer-in-ms否則這個配置無效
    # 這個配置一般為服務重新整理時間配置的三倍
    # 預設90s
    lease-expiration-duration-in-seconds: 15
    #服務重新整理時間配置，每隔這個時間會主動心跳一次
    #預設30s
    lease-renewal-interval-in-seconds: 5
    registry:
      #請參考 wait-time-in-ms-when-sync-empty 配置說明
      default-open-for-traffic-count: 1
      #初始期望傳送心跳請求的例項個數，預設為1，在有新例項註冊的時候，會 +1，有登出的時候會 -1，初始預設為 1 一般因為自己也註冊到 eureka 上
      expected-number-of-clients-sending-renews: 1
    #例項註冊後是否立刻開始服務，預設為 false，一般註冊後還需要做一些操作，所以註冊例項的狀態是 STARTING。後面改變狀態後會更新為 UP
    instance-enabled-onit: false
  1. 例項後設資料：
eureka:
  instance:
    #後設資料map，我們可以自己使用，放一些個性化的後設資料，目前只有 configPath 和 zone 比較有用。 configPath 是使用 spring-cloud-config 的時候會設定 
    metadata-map:
      # spring cloud 體系中，可用區的配置放入後設資料中，key 為 zone
      zone: zone1
  1. Eureka 客戶端配置：
  2. Eureka 伺服器地址配置，可以直接指定連結，也可以通過 region 和 zone 進行配置，也可以通過 DNS 配置：
eureka:
  instance:
    # 可用區列表，key 為 region，value 為 zone
    availability-zones:
      region1: zone1, zone2
      region2: zone3
    # 所在區域，通過這個讀取 availability-zones 獲取 zone，然後通過 zone 讀取 service-url 獲取對應的 eureka url
    # 這裡的邏輯對應的類是 ConfigClusterResolver 和 ZoneAffinityClusterResolver
    region: region1
    # key 為 zone，value 為 eureka 連結，以逗號分隔
    service-url:
      # 預設eureka叢集,這裡必須是defaultZone，不能用-替換大寫，與其他的配置不一樣，因為實在EurekaClientConfigBean裡面寫死的
      defaultZone: http://127.0.0.1:8211/eureka/
      zone1: http://127.0.0.1:8212/eureka/
      zone2: http://127.0.0.1:8213/eureka/
      zone3: http://127.0.0.1:8214/eureka/
    # 如果上面 eureka server 地址相關配置更新了，多久之後會重新讀取感知到
    eureka-service-url-poll-interval-seconds: 300
    # 是否使用 dns 獲取，如果指定了則通過下面的 dns 配置獲取，而不是上面的 service-url
    use-dns-for-fetching-service-urls: false
    # dns 配置
    # eureka-server-d-n-s-name:
    # dns 配置的 eureka server 的 port
    # eureka-server-port:
    # dns 配置的 eureka server 的 port 後面的 uri 字首 context
    # eureka-server-u-r-l-context:
    # 如果設定為 true，則同一個 zone 下的 eureka 會跑到前面優先訪問。預設為 true
    prefer-same-zone-eureka: true
  1. 拉取服務例項資訊相關配置：
eureka:
  instance:
    # 是否從 eureka 上面拉取例項
    fetch-registry: true
    # 如果只想獲取一個特定 virtual host name 的例項列表，就配置 registry-refresh-single-vip-address
    #registry-refresh-single-vip-address:
    # 客戶端請求頭指定服務端返回的例項資訊是壓縮的資訊還是完整資訊，預設是完整資訊
    # full, compact
    client-data-accept: full
    # eureka client 重新整理本地快取時間
    # 預設30s
    registry-fetch-interval-seconds: 5
    # eureka client 重新整理本地快取(定時拉取 eureka 例項列表)執行緒池大小，預設為 2
    cache-refresh-executor-thread-pool-size: 2
    # eureka client 重新整理本地快取(定時拉取 eureka 例項列表)執行緒池任務最大延遲時間，這個配置是定時拉取任務延遲(registry-fetch-interval-seconds)的倍數，預設 10 倍
    cache-refresh-executor-exponential-back-off-bound: 10
    # 是否禁用增量拉取，如果網路條件不好，可以禁用，每次都會拉取全量
    disable-delta: false
    # 只保留狀態為 UP 的例項，預設為 true
    filter-only-up-instances: true
    #可以指定也從某些 region 拉取服務例項
    #fetch-remote-regions-registry:
    # 是否打日誌記錄每次拉取例項資訊與當前快取內的例項資訊變化
    log-delta-diff: true
    
    #在spring cloud 環境中，DiscoveryClient 用的其實都是 CompositeDiscoveryClient，這個 CompositeDiscoveryClient 邏輯其實就是多個 DiscoveryClient 共存，先訪問一個，沒找到就通過下一個尋找
    #這個order決定了順序，預設為 0
    order: 0
  1. 當前例項註冊相關配置：
eureka:
  instance:
    # 是否將自己註冊到 eureka 上面
    register-with-eureka: true
    # 是否在初始化的時候就註冊到 eureka，一般設定為 false，因為例項還不能正常提供服務
    should-enforce-registration-at-init: false
    # 是否在關閉的時候登出例項，預設為 true
    should-unregister-on-shutdown: true
    # 是否對於例項狀態改變更新進行限流，預設為 true
    on-demand-update-status-change: true
    # 例項資訊同定時同步到 Eureka Server 的間隔時間。每隔這麼長時間，檢查例項資訊（即eureka.instance配置資訊）是否發生變化，如果發生變化，則同步到 Eureka Server，預設 30s
    # 主要檢查兩類資訊，分別是服務地址相關資訊，以及服務過期時間與重新整理時間配置資訊
    instance-info-replication-interval-seconds: 30
    # 例項資訊同定時同步到 Eureka Server 的初始延遲時間，預設 40s
    initial-instance-info-replication-interval-seconds: 40
  1. http連線相關配置：
eureka:
  instance:
    # 代理相關配置
    # proxy-host:
    # proxy-port:
    # proxy-user-name:
    # proxy-password:
    # 是否對於發往 Eureka Server 的 http 請求啟用 gzip，目前已經過期了，只要 Eureka Server 啟用了 gzip，請求就是 gzip 壓縮的
    g-zip-content: true
    # httpclient 的連結超時，預設 5s
    eureka-server-connect-timeout-seconds: 5
    # httpclient 的讀取超時，預設 5s
    eureka-server-read-timeout-seconds: 8
    # httpclient 的空閒連線超時，預設 30s
    eureka-connection-idle-timeout-seconds: 30
    # httpclient 的總連線數量，預設 200
    eureka-server-total-connections: 200
    # httpclient 的每個 host 的連線數量
    eureka-server-total-connections-per-host: 50
    # tls 相關配置，預設沒有啟用
#      tls:
#        enabled: false
#        key-password:
#        key-store:
#        key-store-password:
#        key-store-type:
#        trust-store:
#        trust-store-password:
#        trust-store-type:
  1. Eureka 伺服器配置：
  2. 定時檢查例項過期相關配置：例項註冊後需要傳送心跳證明這個例項是活著的， Eureka 伺服器中也有定時任務檢查例項是否已經過期：
eureka:
  server:
    #主動檢查服務例項是否失效的任務執行間隔，預設是 60s
    eviction-interval-timer-in-ms: 3000
    #這個配置在兩個地方被使用：
    #如果啟用用了自我保護，則會 renewal-threshold-update-interval-ms 指定的時間內，收到的心跳請求個數是否小於例項個數乘以這個 renewal-percent-threshold
    #定時任務檢查過期例項，每次最多過期 1 - renewal-percent-threshold 這麼多比例的例項
    renewal-percent-threshold: 0.85
  1. 自我保護相關配置：Eureka 伺服器中有定時過期的任務，檢查遲遲沒有心跳的例項，並登出他們。自我保護主要針對叢集中網路出現問題，導致有很多例項無法傳送心跳導致很多例項狀態異常，但是實際例項還在正常工作的情況，不要讓這些例項不參與負載均衡:
eureka:
  server: 
    #注意，最好所有的客戶端例項配置的心跳時間相關的配置，是相同的。這樣使用自我保護的特性最準確。
    #關閉自我保護
    #我們這裡不使用自我保護，因為：
    #自我保護主要針對叢集中網路出現問題，導致有很多例項無法傳送心跳導致很多例項狀態異常，但是實際例項還在正常工作的情況，不要讓這些例項不參與負載均衡
    #啟用自我保護的情況下，就會停止對於例項的過期
    #但是，如果出現這種情況，其實也代表很多例項無法讀取註冊中心了。
    #並且還有一種情況就是，Eureka 重啟。雖然不常見，但是對於映象中其他的元件更新我們還是很頻繁的
    #我傾向於從客戶端對於例項快取機制來解決這個問題，如果返回例項列表為空，則使用上次的例項列表進行負載均衡，這樣既能解決 Eureka 重啟的情況，又能處理一些 Eureka 網路隔離的情況
    #自我保護模式基於每分鐘需要收到 renew （例項心跳）請求個數，如果啟用了自我保護模式，只有上一分鐘接收到的 renew 個數，大於這個值，例項過期才會被登出
    enable-self-preservation: false
    # 每分鐘需要收到 renew （例項心跳）請求個數是需要動態重新整理的，這個重新整理間隔就是 renewal-threshold-update-interval-ms
    #更新流程大概是：計算當前一共有多少例項，如果大於之前期望的例項量 * renewal-percent-threshold（或者沒開啟自我保護模式）,則更新期望的例項數量為當前一共有多少例項
    #之後根據期望的例項數量，計算期望需要收到的例項心跳請求個數 = 期望的例項數量 * （60 / expected-client-renewal-interval-seconds） * renewal-percent-threshold
    #公式中 60 代表一分鐘，因為公式用到了 expected-client-renewal-interval-seconds，也就是例項平均心跳間隔，為了使這個公式準確，最好每個例項配置一樣的心跳時間
    #預設 900000ms = 900s = 15min
    renewal-threshold-update-interval-ms: 900000
    #上面提到的例項平均心跳間隔，或者說是期望的心跳間隔，為了使這個公式準確，最好每個例項配置一樣的心跳時間
    #預設 30s
    expected-client-renewal-interval-seconds: 30
    #這個配置在兩個地方被使用：
    #如果啟用用了自我保護，則會 renewal-threshold-update-interval-ms 指定的時間內，收到的心跳請求個數是否小於例項個數乘以這個 renewal-percent-threshold
    #定時任務檢查過期例項，每次最多過期 1 - renewal-percent-threshold 這麼多比例的例項
    renewal-percent-threshold: 0.85
  1. 同一區域內叢集配置相關：上面我們提到了，同一區域內的 Eureka 伺服器例項，收到的客戶端請求，會轉發到同一區域內的的其他 Eureka 伺服器例項。同時，在某一 Eureka 伺服器例項啟動的時候，會從同一區域內其他 Eureka 伺服器同步例項列表。並且，轉發到其他 Eureka 伺服器例項是非同步轉發的，這就有專門的執行緒池進行轉發。同時，轉發的也是 HTTP 請求，這就需要 HTTP 連線池：
eureka:
  server: 
    #Eureka Server 從配置中更新同一區域內的其他 Eureka Server 例項列表間隔，預設10分鐘
    peer-eureka-nodes-update-interval-ms: 600000
    #啟動時從其他 Eureka Server 同步服務例項資訊的最大重試次數，直到例項個數不為 0，預設為 0，這樣其實就是不同步
    registry-sync-retries: 0
    #啟動時從其他 Eureka Server 同步服務例項資訊重試間隔
    registry-sync-retry-wait-ms: 30000
    #叢集內至少有多少個 UP 的 Eureka Server 例項數量，當前 Eureka Server 狀態為 UP。預設 -1，也就是 Eureka Server 狀態不考慮 UP 的叢集內其他 Eureka Server 數量。
    min-available-instances-for-peer-replication: -1
    #請求其他例項任務的最大超時時間，預設 30 秒
    max-time-for-replication: 30000
    #用來處理同步任務的執行緒數量，有兩個執行緒池，一個處理批量同步任務，預設大小為20
    max-threads-for-peer-replication: 20
    #另一個處理非批量任務（如果沒用 AWS Autoscaling 對接相關特性則沒有啥用），預設大小為20
    max-threads-for-status-replication: 20
    #處理批量任務的執行緒池佇列長度，預設為 10000
    max-elements-in-peer-replication-pool: 10000
    #處理非批量任務的執行緒池佇列長度，預設為 10000
    max-elements-in-status-replication-pool: 10000
    #Eureka Server 通過 httpclient 訪問其他 Eureka Server 同步例項，httpclient 的連線超時，預設 200ms
    peer-node-connect-timeout-ms: 200
    #httpclient 的讀取超時，預設 200ms，一般不用太長
    peer-node-read-timeout-ms: 200
    #httpclient 的最大總連線數量，預設 1000
    peer-node-total-connections: 1000
    #httpclient 的對於某一 host 最大總連線數量，預設 500
    peer-node-total-connections-per-host: 500
    #httpclient 的連線空閒保持時間，預設 30s
    peer-node-connection-idle-timeout-seconds: 30
  1. 跨區域相關配置。Eureka 伺服器會定時拉取其他區域的服務例項列表快取在本地。在查詢本地查詢不到某個微服務的時候，就會查詢這個遠端區域服務例項的快取。相關配置如下：
eureka:
  server: 
    #請求其他 Region 的 httpclient 的連線超時，預設 1000ms
    remote-region-connect-timeout-ms: 1000
    #請求其他 Region 的 httpclient 的讀取超時，預設 1000ms
    remote-region-read-timeout-ms: 1000
    #請求其他 Region 的 httpclient 的最大總連線數量，預設 1000
    remote-region-total-connections: 1000
    #請求其他 Region 的 httpclient 的對於某一 host 最大總連線數量，預設 500
    remote-region-total-connections-per-host: 500
    #請求其他 Region 的 httpclient 的連線空閒保持時間，預設 30s
    remote-region-connection-idle-timeout-seconds: 30
    #請求其他 Region 的 http 請求是否開啟 gzip，對於其他 Region 我們認為網路連線是比較慢的，所以預設開啟壓縮
    g-zip-content-from-remote-region: true
    #    remote-region-urls-with-name:
    #      region2eureka1: http://127:0:0:1:8212/eureka/
    #      region2eureka2: http://127:0:0:1:8213/eureka/
    #    remote-region-app-whitelist:
    #如果需要從其他 Region 獲取例項資訊，這個獲取間隔，預設為 30s
    remote-region-registry-fetch-interval: 30
    #如果需要從其他 Region 獲取例項資訊，這個任務的執行緒池，預設為 20個
    remote-region-fetch-thread-pool-size: 20

啟動一個 Eureka Server

啟動一個 Eureka 註冊中心伺服器非常簡單，我們這裡使用的是 Spring Cloud 封裝好的啟動包。Eureka 1.x 的 Eureka Server 是純基於 servlet 的應用。為了與 Spring Cloud 結合使用，需要粘合模組，這就是 spring-cloud-netflix-eureka-server。在 spring-cloud-netflix-eureka-server 中，也有一個和 com.netflix.eureka.EurekaBootStrap 程式碼很類似的啟動類，即 org.springframework.cloud.netflix.eureka.server.EurekaServerBootstrap。在我們啟動 EurekaServer 例項的時候，只用加入對於 spring-cloud-starter-eureka-server 的依賴即可。之後通過 @EnableEurekaServer 註解即可啟動一個 Eureka 伺服器例項。

Eureka Server 的依賴：

pom.xml

<?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">
    <parent>
        <artifactId>spring-cloud-iiford</artifactId>
        <groupId>com.github.hashjang</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>spring-cloud-iiford-eureka-server</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.github.hashjang</groupId>
            <artifactId>spring-cloud-iiford-service-common</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-netflix-eureka-server</artifactId>
        </dependency>
    </dependencies>
</project>

Eureka Server 的配置：
參考我們上面的配置即可：
application.yml

Eureka Server 的啟動類：
EurekaServerApplication.java

package com.github.hashjang.iiford.eureka.server;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

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

相關文章