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;
  }
  

標籤：Java

上一篇：SpringCloud Feign (四)

下一篇：SpringCloud Config (六)