SpringCloud超詳細講解微服務閘道器Zuul

2022-07-16 18:01:42

閘道器的作用

微服務架構中，服務範例的地址可能經常會發生變化，所以我們不能直接將服務的地址暴露出來。如果每一個微服務都直接暴露介面，會導致一系列的問題，比如呼叫過於複雜，涉及到賬戶、許可權不能統一處理等。另外基於高內聚低耦合的設計準則來講，我們也應該將內部系統和外部系統做切割。

因此，這時就需要有一個獨立的元件來處理外部的請求，這個元件就是服務閘道器。服務閘道器就是為了簡化前端的呼叫邏輯，通常情況下也會實現相關的認證邏輯，根據外部不同的請求響應不同的資料，從而簡化內外部系統之間呼叫的複雜度。

服務閘道器負責服務請求路由、組合及協定轉換。使用者端的所有請求都首先經過服務閘道器，然後由它將請求路由到合適的微服務。服務閘道器經常會通過呼叫多個微服務併合並結果來處理一個請求，它可以在系統外部與內部響應之間友好的轉換。

本文將先著重介紹Zuul元件。

Spring Cloud 閘道器元件Zuul介紹

Zuul 是 Netflix 公司開源的產品，被稱為第一代閘道器，也是 Spring Cloud 前幾個版本預設使用的一款提供動態路由微服務閘道器元件。Zuul 接收所有外來請求，並將請求轉發到對應的後端服務。作為一個前置服務，Zuul 旨在實現動態路由，監控，彈性和安全性等功能。

Zuul 提供了不同型別的 filter 用於處理請求，這些 filter 可以讓我們實現以下功能：

許可權控制和安全性：可以識別認證需要的資訊和拒絕不滿足條件的請求。
監控：與邊緣位置追蹤有意義的資料和統計結果，從而帶來精確的生產檢視。
動態路由：根據需要動態地路由請求到後臺的不同叢集。
壓力測試：逐漸增加指向叢集的流量，以瞭解效能。
負載均衡：為每一種負載型別分配對應容量，並棄用超出限定值的請求
靜態資源處理：直接在 zuul 處理靜態資源的響應，從而避免其轉發到內部叢集。

Zuul閘道器實戰

之前的介紹中，我們啟動了註冊中心registry，dms服務，和app服務，請求時，直接呼叫了app服務的介面，app服務又呼叫了dms服務：

加上閘道器服務之後，就會變成如下：

接下來，我們建立zuul服務：

1、建立服務

建立子模組zuul，pom.xml引入eureka-client 和zuul的依賴

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- feign -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!-- zuul路由 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>3.1.0</version>
        </dependency>

2、建立組態檔

server:
port: 8004
spring:
application:
name: zuul

eureka:
client:
service-url:
defaultZone: http://localhost:8001/eureka/
feign:
hystrix:
enabled: true
zuul:
routes:
app: #活動
path: /app/** #設定請求URL的請求規則
serviceId: app #指定Eureka註冊中心中的服務id
dms: #活動
path: /dms/** #設定請求URL的請求規則
serviceId: dms #指定Eureka註冊中心中的服務id
logging:
pattern:
console: '%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} - %msg%n'

3、建立Zuul過濾器

public class MyZuulFilter extends ZuulFilter {
//    pre ：可以在請求被路由之前呼叫
//    route ：在路由請求時候被呼叫
//    post ：在route和error過濾器之後被呼叫
//    error ：處理請求時發生錯誤時被呼叫
    @Override
    public String filterType() {
        return "pre";// 前置過濾器
    }
    //通過int值來定義過濾器的執行順序,優先順序為0，數位越大，優先順序越低
    @Override
    public int filterOrder() {
        return 0;
    }
    //返回一個boolean型別來判斷該過濾器是否要執行，所以通過此函數可實現過濾器的開關
    @Override
    public boolean shouldFilter() {
        return true;//此處為true，說明需要過濾
    }
    //過濾器的具體邏輯。
    @Override
    public Object run() throws ZuulException {
        // 獲取上下文
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        String accessToken = request.getParameter("accessToken");
        if (StringUtils.isEmpty(accessToken)) {
            //setSendZuulResponse(false)令zuul過濾該請求，不進行路由
            currentContext.setSendZuulResponse(false);
            //設定返回的錯誤碼
            currentContext.setResponseStatusCode(401);
            currentContext.setResponseBody("AccessToken is null");
            return null;
        }
        System.out.println("獲取到AccessToken為:"+accessToken);
        // 否則正常執行業務邏輯.....
        return null;
    }
}

4、編寫啟動類

注意增加@EnableZuulProxy註解

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