SpringCloud微服務治理三（Zuul網關）

SpringCloud微服務治理一（介紹，環境搭建，Eureka）
SpringCloud微服務治理二(Robbin,Hystix,Feign)
SpringCloud微服務治理三（Zuul網關）

9.Zuul網關

經過前面的學習，使用Spring Cloud實現微服務的架構基本成型，大體是這樣的：

在該架構中，咱們的服務集羣包含：內部服務Service A和Service B，他們都會註冊與訂閱服務至Eureka Server，而Open Service是一個對外的服務，經過均衡負載公開至服務調用方。咱們把焦點彙集在對外服務這塊，直接暴露咱們的服務地址，這樣的實現是否合理，或者是否有更好的實現方式呢？

先來講說這樣架構須要作的一些事兒以及存在的不足：

• 首先，破壞了服務無狀態特色。
  • 爲了保證對外服務的安全性，咱們須要實現對服務訪問的權限控制，而開放服務的權限控制機制將會貫穿並污染整個開放服務的業務邏輯，這會帶來的最直接問題是，破壞了服務集羣中REST API無狀態的特色。
  • 從具體開發和測試的角度來講，在工做中除了要考慮實際的業務邏輯以外，還須要額外考慮對接口訪問的控制處理。
• 其次，沒法直接複用既有接口。
  • 當咱們須要對一個即有的集羣內訪問接口，實現外部服務訪問時，咱們不得不經過在原有接口上增長校驗邏輯，或增長一個代理調用來實現權限控制，沒法直接複用原有的接口。

面對相似上面的問題，咱們要如何解決呢？答案是：服務網關！

爲了解決上面這些問題，咱們須要將權限控制這樣的東西從咱們的服務單元中抽離出去，而最適合這些邏輯的地方就是處於對外訪問最前端的地方，咱們須要一個更強大一些的均衡負載器的 服務網關。

服務網關是微服務架構中一個不可或缺的部分。經過服務網關統一貫外系統提供REST API的過程當中，除了具有服務路由、均衡負載功能以外，它還具有了權限控制等功能。Spring Cloud Netflix中的Zuul就擔任了這樣的一個角色，爲微服務架構提供了前門保護的做用，同時將權限控制這些較重的非業務邏輯內容遷移到服務路由層面，使得服務集羣主體可以具有更高的可複用性和可測試性。

9.1.Zuul加入後的架構

• 不論是來自於客戶端（PC或移動端）的請求，仍是服務內部調用。一切對服務的請求都會通過Zuul這個網關，而後再由網關來實現 鑑權、動態路由等等操做。Zuul就是咱們服務的統一入口。

9.2.Zuul簡介

9.3.快速入門

9.3.1.新建工程

填寫基本信息：

添加Zuul依賴：

9.3.2.編寫啓動類

經過@EnableZuulProxy註解開啓Zuul的功能：

@SpringBootApplication
@EnableZuulProxy // 開啓Zuul的網關功能
public class ZuulDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(ZuulDemoApplication.class, args);
	}
}
複製代碼

9.3.3.編寫配置

server:
 port: 10010 #服務端口
spring: 
 application:  
 name: api-gateway #指定服務名
複製代碼

9.3.4.編寫路由規則

咱們須要用Zuul來代理user-service服務，先看一下控制面板中的服務狀態：

• ip爲：127.0.0.1
• 端口爲：8081

映射規則：

zuul:
 routes:
 user-service: # 這裏是路由id，隨意寫
 path: /user-service/** # 這裏是映射路徑
 url: http://127.0.0.1:8081 # 映射路徑對應的實際url地址
複製代碼

咱們將符合path 規則的一切請求，都代理到 url參數指定的地址

本例中，咱們將 /user-service/**開頭的請求，代理到http://127.0.0.1:8081

9.3.5.啓動測試：

訪問的路徑中須要加上配置規則的映射路徑，咱們訪問：http://127.0.0.1:8081/user-service/user/10

9.4.面向服務的路由

在剛纔的路由規則中，咱們把路徑對應的服務地址寫死了！若是同一服務有多個實例的話，這樣作顯然就不合理了。

咱們應該根據服務的名稱，去Eureka註冊中心查找 服務對應的全部實例列表，而後進行動態路由纔對！

9.4.1.添加Eureka客戶端依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
複製代碼

9.4.2.開啓Eureka客戶端發現功能

@SpringBootApplication
@EnableZuulProxy // 開啓Zuul的網關功能
@EnableDiscoveryClient
public class ZuulDemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(ZuulDemoApplication.class, args);
	}
}
複製代碼

9.4.3.添加Eureka配置，獲取服務信息

eureka:
 client:
 registry-fetch-interval-seconds: 5 # 獲取服務列表的週期：5s
 service-url:
 defaultZone: http://127.0.0.1:10086/eureka
 instance:
 prefer-ip-address: true
 ip-address: 127.0.0.1
複製代碼

9.4.4.修改映射配置，經過服務名稱獲取

由於已經有了Eureka客戶端，咱們能夠從Eureka獲取服務的地址信息，所以映射時無需指定IP地址，而是經過服務名稱來訪問，並且Zuul已經集成了Ribbon的負載均衡功能。

zuul:
 routes:
 user-service: # 這裏是路由id，隨意寫
 path: /user-service/** # 這裏是映射路徑
 serviceId: user-service # 指定服務名稱
複製代碼

9.4.5.啓動測試

再次啓動，此次Zuul進行代理時，會利用Ribbon進行負載均衡訪問：

日誌中能夠看到使用了負載均衡器：

9.5.簡化的路由配置

在剛纔的配置中，咱們的規則是這樣的：

• zuul.routes.<route>.path=/xxx/**： 來指定映射路徑。<route>是自定義的路由名
• zuul.routes.<route>.serviceId=/user-service：來指定服務名。

而大多數狀況下，咱們的<route>路由名稱每每和 服務名會寫成同樣的。所以Zuul就提供了一種簡化的配置語法：zuul.routes.<serviceId>=<path>

比方說上面咱們關於user-service的配置能夠簡化爲一條：

zuul:
 routes:
 user-service: /user-service/** # 這裏是映射路徑
複製代碼

省去了對服務名稱的配置。

9.6.默認的路由規則

在使用Zuul的過程當中，上面講述的規則已經大大的簡化了配置項。可是當服務較多時，配置也是比較繁瑣的。所以Zuul就指定了默認的路由規則：

• 默認狀況下，一切服務的映射路徑就是服務名自己。
  • 例如服務名爲：user-service，則默認的映射路徑就是：/user-service/**

也就是說，剛纔的映射規則咱們徹底不配置也是OK的

9.7.路由前綴

配置示例：

zuul:
 prefix: /api # 添加路由前綴
 routes:
 user-service: # 這裏是路由id，隨意寫
 path: /user-service/** # 這裏是映射路徑
 service-id: user-service # 指定服務名稱
複製代碼

咱們經過zuul.prefix=/api來指定了路由的前綴，這樣在發起請求時，路徑就要以/api開頭。

路徑/api/user-service/user/1將會被代理到/user-service/user/1

9.8.過濾器

Zuul做爲網關的其中一個重要功能，就是實現請求的鑑權。而這個動做咱們每每是經過Zuul提供的過濾器來實現的。

9.8.1.ZuulFilter

ZuulFilter是過濾器的頂級父類。在這裏咱們看一下其中定義的4個最重要的方法：

public abstract ZuulFilter implements IZuulFilter{

    abstract public String filterType();

    abstract public int filterOrder();
    
    boolean shouldFilter();// 來自IZuulFilter

    Object run() throws ZuulException;// IZuulFilter
}
複製代碼

• shouldFilter：返回一個Boolean值，判斷該過濾器是否須要執行。返回true執行，返回false不執行。
• run：過濾器的具體業務邏輯。
• filterType：返回字符串，表明過濾器的類型。包含如下4種：
  • pre：請求在被路由以前執行
  • routing：在路由請求時調用
  • post：在routing和errror過濾器以後調用
  • error：處理請求時發生錯誤調用
• filterOrder：經過返回的int值來定義過濾器的執行順序，數字越小優先級越高。

9.8.2.過濾器執行生命週期：

這張是Zuul官網提供的請求生命週期圖，清晰的表現了一個請求在各個過濾器的執行順序。

​

• 正常流程：
  • 請求到達首先會通過pre類型過濾器，然後到達routing類型，進行路由，請求就到達真正的服務提供者，執行請求，返回結果後，會到達post過濾器。然後返回響應。
• 異常流程：
  • 整個過程當中，pre或者routing過濾器出現異常，都會直接進入error過濾器，再error處理完畢後，會將請求交給POST過濾器，最後返回給用戶。
  • 若是是error過濾器本身出現異常，最終也會進入POST過濾器，然後返回。
  • 若是是POST過濾器出現異常，會跳轉到error過濾器，可是與pre和routing不一樣的時，請求不會再到達POST過濾器了。

全部內置過濾器列表：

​

9.8.3.使用場景

場景很是多：

• 請求鑑權：通常放在pre類型，若是發現沒有訪問權限，直接就攔截了
• 異常處理：通常會在error類型和post類型過濾器中結合來處理。
• 服務調用時長統計：pre和post結合使用。

9.9.自定義過濾器

接下來咱們來自定義一個過濾器，模擬一個登陸的校驗。基本邏輯：若是請求中有access-token參數，則認爲請求有效，放行。

9.9.1.定義過濾器類

@Component
public class LoginFilter extends ZuulFilter{
    @Override
    public String filterType() {
        // 登陸校驗，確定是在前置攔截
        return "pre";
    }

    @Override
    public int filterOrder() {
        // 順序設置爲1
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        // 返回true，表明過濾器生效。
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        // 登陸校驗邏輯。
        // 1）獲取Zuul提供的請求上下文對象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2) 從上下文中獲取request對象
        HttpServletRequest req = ctx.getRequest();
        // 3) 從請求中獲取token
        String token = req.getParameter("access-token");
        // 4) 判斷
        if(token == null || "".equals(token.trim())){
            // 沒有token，登陸校驗失敗，攔截
            ctx.setSendZuulResponse(false);
            // 返回401狀態碼。也能夠考慮重定向到登陸頁。
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校驗經過，能夠考慮把用戶信息放入上下文，繼續向後執行
        return null;
    }
}

複製代碼

9.10.負載均衡和熔斷

Zuul中默認就已經集成了Ribbon負載均衡和Hystix熔斷機制。可是全部的超時策略都是走的默認值，好比熔斷超時時間只有1S，很容易就觸發了。所以建議咱們手動進行配置：

zuul:
 retryable: true
ribbon:
 ConnectTimeout: 250 # 鏈接超時時間(ms)
 ReadTimeout: 2000 # 通訊超時時間(ms)
 OkToRetryOnAllOperations: true # 是否對全部操做重試
 MaxAutoRetriesNextServer: 2 # 同一服務不一樣實例的重試次數
 MaxAutoRetries: 1 # 同一實例的重試次數
hystrix:
 command:
  	default:
 execution:
 isolation:
 thread:
 timeoutInMillisecond: 6000 # 熔斷超時時長：6000ms
複製代碼