SpringCloud Zuul (五)

API網關服務 Spring Cloud Zuul

API網關是一個更爲智能的應用服務器，它的存在就像是整個微服務架構系統的門面，全部的外部客戶端訪問都須要通過它來進行調度和過濾。除了須要實現請求路由，負載均衡及校驗過濾等功能外還須要與服務治理框架的結合，請求轉發時的熔斷機制，服務的聚合等一系列高級功能。

在Spring Cloud中提供了基於Netflix Zuul實現的API網關組件Spring Cloud Zuul。對於路由規則與服務實例的維護，Spring Cloud Zuul經過與Spring Cloud Eureka進行整合，將自身註冊爲Eureka治理下的應用，同時從Eureka得到了全部其餘微服務的實例信息，使得將維護服務實例的工做交給了服務治理框架自動完成。不在須要人工介入。對於路由規則的維護，Zuul默認將經過以服務名做爲ContextPath的方式建立路由映射。對於相似簽名校驗及登陸校驗，能夠獨立成一個單獨的服務存在，只是它並非給各個微服務調用，而是在API網關服務上進行統一調用來對微服務接口作前置過濾，實現對微服務接口的攔截和校驗。Spring Cloud Zuul提供了一套過濾器機制，能夠很好地支持這樣的任務。

1. 快速集成 Spring Cloud Zuul

1.1 構建網關

1. 建立基礎Spring Boot工程

2. 添加依賴: spring-cloud-starter-zuul

3. 在主類上使用@EnableZuulProxy註解開啓Zuul的API網關服務功能

4. 配置Zuul應用的基礎信息

   spring.application.name=api-gateway
   spring.port=8080

1.2 請求路由

啓動Eureka服務註冊中心和微服務應用

• 傳統路由方式

  對api-gateway服務增長路由配置規則

  zuul.routes.api-a-url.path=/api-a-url/**
  zuul.routes.api-a-url.url=http://localhost:8081/

  定義發往API網關的請求中，全部符合/api-a-url/**規則的訪問都將被路由轉發到http://localhost:8081/地址上。api-a-url部分爲路由的名稱，可任意定義，一組path與url映射關係的路由名要相同。

• 面向服務的路由

  ​ Spring Cloud Zuul實現了與Spring Cloud Eureka的無縫整合，可讓路由的path不是映射具體的url，而是映射某個具體的服務，而具體的服務則交給Eureka的服務發現機制去自動維護，稱之爲面向服務的路由。

  1. 添加依賴：spring-cloud-starter-eureka

  2. 配置Zuul的Eureka註冊中心的位置

  3. 配置服務路由

     zuul.routes.api-a.path=/api-a/**
     zuul.routes.api-a.serviceId=hello-service

     簡潔配置方式

     zuul.routes.hello-service=/api-a/**

1.3 請求過濾

Zuul容許在API網關上經過定義過濾器實現對請求的攔截與過濾，只須要繼承ZuulFilter抽象類並定義它的四個抽象函數。

public class AccessFilter extends ZuulFilter {
    /**
     * 過濾器類型，決定過濾器在請求的哪一個生命週期執行
     */
    @Override
    public String filterType() {
        return "pre";
    }
    
    /**
     * 過濾器的執行順序，當同一階段存在多個過濾器時，須要根據該返回值指定執行順序
     */
    @Override
    public int filterOrder() {
        return 0;
    }
    
    /**
     * 過濾器是否執行
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }
    
    /**
     * 過濾器任務
     */
    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        
        String token = request.getHeader("Authorization");
        
        if (token == null) {
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            // ctx.setResponseBody(body);
        }
        
        return null;
    }
}

定義Zuul攔截器配置，並添加攔截器

@Configuration
public class ZuulFilterConfiguration {
    
    @Bean
    public AccessFilter accessFilter() {
        return new AccessFilter();
    }
}

2. 路由詳解

2.1 服務路由配置

簡潔配置方式

zuul.routes.hello-service=/api-a/**

2.2 服務路由默認規則

爲Spring Cloud Zuul構建的API網關服務引入Spring Cloud Eureka以後，它爲Eureka中的每一個服務都自動建立一個默認路由規則，默認路由規則的path使用serviceId配置的服務名做爲請求前綴，以hello-service爲例：

zull.routes.hello-service.path=/hello-service/**
zull.routes.hello-service.serviceId=hello-service

2.3 路徑匹配

在Spring Cloud Zuul中，路由匹配的路徑表達式採用了Ant風格定義

通配符	說明
?	匹配任意單個字符
*	匹配任意數量字符
**	匹配任意數量字符，支持多級目錄

2.4 忽略表達式

Spring Cloud Zuul忽略表達式參數zuul.ignored-patterns用來設置不但願被API網關進行路由的URL表達式。

zuul.ignored-patterns=/**/hello/**

2.5 Cookie與頭信息

默認狀況下，Spring Cloud Zuul請求路由時，會過濾掉HTTP請求頭信息中的一些敏感信息，防止它們被傳遞到下游的外部服務器。默認的敏感頭信息經過zuul.sensitiveheaders參數定義，包括Cookie, Set-Cookie, Authorization三個屬性。

解決方案：

• 設置全局參數爲空覆蓋默認值

  zuul.sensitiveheaders=

• 設置指定路由的參數

  // 對指定路由開啓自定義敏感頭
  zuul.routes.<router>.customSensitiveHeaders=true
  // 將指定路由的敏感頭設置爲空
  zuul.routes.<router>.sensitiveheaders=

2.6 Hystrix與Ribbon支持

Zuul自身包含了對Hystrix和Ribbon的模塊依賴，所以Zuul擁有線程隔離和斷路器的自我保護功能，以及對服務調用的客戶端負載均衡功能。當使用path和url的映射關係配置路由規則時沒有上述功能，所以使用Zuul時儘可能使用path和serviceId的組合進行配置。參數配置以下：

ribbon:
  ReadTimeout: 600000      // 設置路由轉發請求的超時時間
  ConnectTimeout: 600000   // 設置路由轉發請求，建立請求鏈接的超時時間

hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 60000  // 設置API網關路由轉發請求HystrixCommand執行超時時間

2.7 過濾器詳解

在Zuul中，路由功能真正運行時，它的路由映射和請求轉發由幾個不一樣的過濾器完成。路由映射主要經過pre類過濾器完成，它將請求路徑與配置的路由規則進行匹配，找到須要轉發的路由地址。請求轉發的部分由route類過濾器完成。

在Spring Cloud Zuul中實現的過濾器必須包含4個基本特徵：過濾類型，執行順序，執行條件，具體操做。實際上它們就是ZuulFilter接口中定義的4個抽象方法：

String filterType();
int filterOrder();
boolean shouldFilter();
Object run();

• filterType：過濾器類型
  • pre：能夠再請求被路由前調用
  • routing：在路由請求時被調用
  • post：在routing和error過濾器以後被調用
  • error：處理請求時發生錯誤時被調用
• filterOrder：過濾器執行順序，數值越小優先級越高
• shouldFilter：是否執行過濾器
• run：過濾邏輯

2.8 異常處理

在Spring Cloud Zuul中，在HTTP請求生命週期的各個階段默認實現了一批覈心過濾器，在API網關服務啓動的時候被自動加載和啓用，但核心過濾器中沒有實現error階段的過濾器，所以須要在自定義過濾器中處理異常內容：

• try-catch處理

  error相關三個主要參數：

  1. error.status_code：錯誤碼
  2. error.exception：Exception異常對象
  3. error.message：錯誤信息（優先級高於Exception對象中的message）

  public Object run() {
      RequestContext ctx = RequestContext.getCurrentContext();
      
      try {
          // TODO
      } catch (Exception exception) {
          ctx.set("error.status_code", HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
          ctx.set("error.exception", exception);
      }
      
      return null;
  }

• ErrorFilter處理

  在請求生命週期的pre，route，post三個階段有異常拋出的時候都會進入到error階段處理，經過建立error類型過濾器捕獲異常信息並處理。

  public Object run() {
      RequestContext ctx = RequestContext.getCurrentContext();
      Throwable throwable = ctx.getThrowable();
      
      ctx.set("error.status_code", HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
      ctx.set("error.exception", throwable.getCause());
      
      return null;
  }