通過前面幾篇文章的介紹，Spring Cloud微服務架構可通過Eureka實現服務註冊與發現，通過Ribbon或Feign來實現服務間的負載均衡呼叫，通過Hystrix來為服務呼叫提供服務降級、熔斷機制避免雪崩效應，通過Spring Cloud Config實現服務配置的集中化管理。微服務架構內部管理的基本元件差不多都已涵蓋了，但是我們的服務最終是需要提供給客戶端訪問的，客戶端如何來訪問這些微服務，就需要引入一個叫服務閘道器的元件了。

zuul

zuul是netflix提供的一個基於JVM的路由與服務端負載均衡器。它在客戶端與後端服務之間建立了一道關卡，客戶端所有請求必須經過zuul轉發到後端對應的微服務，返回結果再經由zuul返回給客戶端。zuul與Eureka，Config組合的基本結構如圖

zuul作為Eureka Client從Eureka Server獲取其它微服務的配置資訊，從而可以將客戶端請求通過Service ID來負載均衡地轉發到後端的服務例項，同時也作為Config Client從Config Server獲取自身所需的配置資訊。

在netflix內部，zuul被用來實現安全認證、動態路由、反向代理、服務遷移、服務削峰、壓力測試、金絲雀測試（灰度釋出測試）等功能。本文介紹zuul的基本使用與路由規則。

基本使用

建立maven專案 springcloud-zuul

1.pom.xml中引入依賴 spring-cloud-starter-netflix-zuul

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
 

2.application.yml配置檔案中新增必要的配置，主要是eureka客戶端配置

spring:
  application:
    name: zuul-server

server:
  port: 8765

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

3.啟動類添加註解 @EnableZuulProxy

@SpringBootApplication
@EnableZuulProxy
public class ZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
    }
}

一如既往的簡單，Spring Cloud之所以流行就是因為它基於Spring Boot將一些通用的功能進行了開箱即用的封裝，使得開發者簡單幾步就能快速整合一個微服務框架。

依次啟動前文所建立的springcloud-eureka, springcloud-config, springcloud-eureka-client, springcloud-zuul，http://localhost:8765/hello-service/hello 返回 Hello, welcome to spring cloud. env: hello-service-dev, value: hello-service-dev 可見通過zuul的請求轉發到了hello-service。

為了驗證zuul轉發請求具備負載均衡的能力，可以將springcloud-eureka-client 中的hello介面返回值做一些調整，並改變埠重啟一個例項，再次請求http://localhost:8765/hello-service/hello 將能看到返回結果在兩者之間切換。

以上配置檔案中並沒有加任何路由配置，zuul是怎麼將請求正確轉發到對應的微服務的呢？ 請看下面的路由規則。

路由規則

1.預設路由規則

zuul提供了預設的路由規則，不需要任何配置就會預設將註冊的服務進行路徑對映。我們可以通過actuator提供的介面來檢視，在application.yml中新增配置

management:
  endpoints:
    web:
      exposure:
        include: "*"

放開actuator的其它介面訪問（預設只放開了/info 與/health介面）， 瀏覽器中訪問 http://localhost:8765/actuator/routes， 可以看到返回的zuul預設的路由對映關係

zuul預設將 /service-id/** 的請求路由到Service ID（即spring.application.name的值）為 service-id的服務，如 /hello-service/hello，將轉發到hello-service服務的/hello介面。

2.自定義路由規則

我們看到zuul的預設路由規則將config-server也映射出來了，對於這類內部服務我們不希望暴露，則可以通過 zuul.ignoredServices 來進行遮蔽，在application.yml配置檔案中新增

zuul:
  ignored-services: "config-server"

重啟，再次檢視http://localhost:8765/actuator/routes ， config-server已經被遮蔽了。

通過zuul.routes可新增自定義路由，可以有 zuul.routes.{route-name}.path + zuul.routes.{route-name}.serviceId或url 或 zuul.routes.{service-id}: path 兩個格式， 如下

zuul:
  ignored-services: "config-server"
  routes:
    hello:
      path: /hi/**
      serviceId: hello-service
    hello-service: /hi2/**
    jboost:
      path: /jboost/**
      url: http://blog.jboost.cn

訪問 http://localhost:8765/hi/hello 或 http://localhost:8765/hi2/hello 都將路由到 hello-service的hello介面，訪問 http://localhost:8765/jboost/ 將訪問到jboost部落格首頁。新增自定義路由後，預設路由仍然存在， 你仍然可以通過 http://localhost:8765/hello-service/hello 來訪問 hello-service的hello介面。

預設的路由規則將Service ID作為匹配路徑，看起來有點長，我們想將匹配路徑縮短一點，比如hello-service的匹配路徑想改為 /hello/**， 而不是/hello-service/**， 如果像上面配置，一個微服務系統可能涉及幾十甚至上百個服務，那配置起來將是一場噩夢。別急， zuul提供了 ServiceRouteMapper 介面來解決這一問題，其中 PatternServiceRouteMapper 可以基於正則表示式來進行路由抽取。

建立一個配置類，注入一個 PatternServiceRouteMapper 的bean，如下

@Configuration
public class ZuulConfiguration {

    @Bean
    public PatternServiceRouteMapper serviceRouteMapper() {
        return new PatternServiceRouteMapper(
                "(?<name>^.+)-(?<postfix>.+$)",
                "${name}");
    }
}

該實現將會對所有服務的路由進行調整，service id 形如 name-postfix的匹配路徑為 /name/**， 如hello-service 匹配 /hello/**。 如果正則表示式匹配失敗，則還是以預設規則進行路由，如果匹配成功，則預設規則失效，但在配置檔案中定義的路由仍然有效。上述驗證中，你都可以通過 http://localhost:8765/actuator/routes 來檢視當前生效的路由。

其它配置

zuul使用Ribbon來定位服務例項，所有請求都在hystrix command裡執行，所以在zuul中可以新增Ribbon， Hystrix相關配置（具體參考前面Ribbon、Hystrix相關文章）

• zuul.ignoredPatterns 對某些路徑進行遮蔽，如 /**/admin/** 將會遮蔽所有路徑中包含admin的介面訪問
• zuul.sensitiveHeaders 對一些header進行過濾，不傳遞給後端服務，預設包括Cookie,Set-Cookie,Authorization， 如果要讓zuul傳送所有header，則需要顯式地將sensitiveHeaders置空值
• zuul.prefix 為所有對映新增字首，如/api， 這樣route裡配的 /myusers/** 就能匹配客戶端請求的/api/myusers/**。預設zuul代理在轉發時，字首會被移除，通過設定zuul.stripPrefix=false可不移除

總結

本文簡單介紹了zuul的基本使用與路由規則，更高階的應用我們後面繼續。
認真生活，快樂分享
歡迎關注微信公眾號：空山新雨的技術空間
獲取Spring Boot，Spring Cloud，Docker等系列技術文章

相關推薦