今日目標(biāo)

• 掌握Gateway服務(wù)網(wǎng)關(guān)

在當(dāng)今的微服務(wù)架構(gòu)中，一個(gè)高性能、可擴(kuò)展的網(wǎng)關(guān)是至關(guān)重要的。而Spring Cloud Gateway作為Spring Cloud生態(tài)系統(tǒng)的一部分，成為許多開發(fā)者選擇的首選網(wǎng)關(guān)解決方案。本文將為您提供一個(gè)簡(jiǎn)單易懂的Spring Cloud Gateway入門指南，幫助您快速上手并開始構(gòu)建強(qiáng)大的微服務(wù)網(wǎng)關(guān)。

一.Gateway服務(wù)網(wǎng)關(guān)介紹

Spring Cloud Gateway,它是一個(gè)基于Spring Framework 5、Project Reactor和Spring Boot 2的非阻塞(響應(yīng)式編程和事件技術(shù)流)API網(wǎng)關(guān)，它旨在為微服務(wù)架構(gòu)提供一種簡(jiǎn)單有效的統(tǒng)一的 API 路由管理方式。相比傳統(tǒng)的Zuul網(wǎng)關(guān)，Spring Cloud Gateway具有更高的性能和更靈活的配置選項(xiàng)。

為什么需要網(wǎng)關(guān)

在微服務(wù)架構(gòu)中，系統(tǒng)可能由多個(gè)服務(wù)組成。網(wǎng)關(guān)可以作為請(qǐng)求的入口，根據(jù)事先配置的路由規(guī)則將請(qǐng)求轉(zhuǎn)發(fā)到相應(yīng)的服務(wù)實(shí)例。

網(wǎng)關(guān)的核心功能特性：

• 請(qǐng)求路由
• 權(quán)限控制
• 限流

簡(jiǎn)單架構(gòu)圖：

核心功能作用:權(quán)限控制：網(wǎng)關(guān)作為微服務(wù)入口，需要校驗(yàn)用戶是是否有請(qǐng)求資格，如果沒有則進(jìn)行攔截。

路由和負(fù)載均衡：一切請(qǐng)求都必須先經(jīng)過gateway，但網(wǎng)關(guān)不處理業(yè)務(wù)，而是根據(jù)某種規(guī)則，把請(qǐng)求轉(zhuǎn)發(fā)到某個(gè)微服務(wù)，這個(gè)過程叫做路由。當(dāng)然路由的目標(biāo)服務(wù)有多個(gè)時(shí)，還需要做負(fù)載均衡。

限流：當(dāng)請(qǐng)求流量過高時(shí)，在網(wǎng)關(guān)中按照下流的微服務(wù)能夠接受的速度來放行請(qǐng)求，避免服務(wù)壓力過大。

二.Gateway快速入門

接下來我們演示Gateway網(wǎng)關(guān)基本路由功能，步驟如下：

• 1.創(chuàng)建微服務(wù)gateway-cloud-server,引入網(wǎng)關(guān)依賴
• 2.編寫網(wǎng)關(guān)啟動(dòng)類
• 3.編寫基礎(chǔ)配置和路由
• 4.啟動(dòng)Gateway網(wǎng)關(guān)進(jìn)行測(cè)試

【步驟一】：創(chuàng)建gateway-cloud-server服務(wù)，并引入依賴

在這里需要?jiǎng)?chuàng)建一個(gè)項(xiàng)目進(jìn)行演示，和之前的項(xiàng)目區(qū)別不大，可是為了區(qū)分，我還是重新創(chuàng)建了新的項(xiàng)目day32-cloud-gateway,不具體演示如何創(chuàng)建項(xiàng)目，大家可以去github地址查看

在pom.xml中引入Gateway依賴

<dependencies>
  <!--nacos服務(wù)發(fā)現(xiàn)依賴-->
  <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  </dependency>

  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-gateway</artifactId>
  </dependency>
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-loadbalancer</artifactId>
  </dependency>
</dependencies>

【步驟二】：編寫Gateway網(wǎng)關(guān)啟動(dòng)類

package com.zbbmeta.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author springboot葵花寶典
 * @description: TODO
 */
@SpringBootApplication
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}

【步驟三】:編寫基礎(chǔ)配置和路由

在resuorces目錄下創(chuàng)建application.yml文件，內(nèi)容如下:

server:
  port: 9999 # 網(wǎng)關(guān)端口
spring:
  application:
    name: gateway-service # 服務(wù)名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    # 開啟nacos負(fù)載均衡策略
    loadbalancer:
      nacos:
        enabled: true
    gateway:
      routes: # 網(wǎng)關(guān)路由配置
        - id: user-service # 路由id，自定義，只要唯一即可
          #uri: http://127.0.0.1:8088 # 路由的目標(biāo)地址 http就是固定地址
          uri: lb://user-service # 路由的目標(biāo)地址 lb就是負(fù)載均衡，后面跟服務(wù)名稱
          predicates: # 路由斷言，也就是判斷請(qǐng)求是否符合路由規(guī)則的條件
            - Path=/user/** # 這個(gè)是按照路徑匹配，只要以/user/開頭就符合要求

我們將符合Path 規(guī)則的一切請(qǐng)求，都代理到 uri參數(shù)指定的地址。

本案例中，我們將 /user/**開頭的請(qǐng)求，代理到lb://user-service，lb是負(fù)載均衡，根據(jù)服務(wù)名拉取服務(wù)列表，實(shí)現(xiàn)負(fù)載均衡。

【步驟四】:啟動(dòng)Gateway網(wǎng)關(guān)進(jìn)行測(cè)試

重啟網(wǎng)關(guān)，訪問http://localhost:9999/user/1時(shí)，符合/user/**規(guī)則，請(qǐng)求轉(zhuǎn)發(fā)到uri：http://user-service/user/1，得到了結(jié)果：

Gateway網(wǎng)關(guān)路由配置圖

請(qǐng)求訪問流程如下:

網(wǎng)關(guān)搭建步驟：

1.創(chuàng)建項(xiàng)目，引入nacos服務(wù)發(fā)現(xiàn)和gateway依賴

2.配置application.yml，包括服務(wù)基本信息、nacos地址、路由

路由配置：

1.路由id：路由的唯一標(biāo)示

2.路由目標(biāo)（uri）：路由的目標(biāo)地址，http代表固定地址，lb代表根據(jù)服務(wù)名負(fù)載均衡

3.路由斷言（predicates）：判斷路由的規(guī)則，

4.路由過濾器（filters）：對(duì)請(qǐng)求或響應(yīng)做處理

三.Gateway斷言工廠(PredicateFactory)

配置文件中寫的斷言規(guī)則只是字符串，這些字符串會(huì)被Predicate Factory讀取并處理，轉(zhuǎn)變?yōu)槁酚膳袛嗟臈l件

例如Path=/user/**是按照路徑匹配，這個(gè)規(guī)則是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory類來

處理的，像這樣的斷言工廠在SpringCloudGateway還有十幾個(gè):只需要掌握Path這種路由工程就可以了

可以訪問Gateway官網(wǎng)查看每一個(gè)的具體說明

標(biāo)頭路由謂詞工廠實(shí)例:

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+

如果請(qǐng)求具有名為 X-Request-Id 其值與 \d+正則表達(dá)式匹配的標(biāo)頭（即，它的值為一個(gè)或多個(gè)數(shù)字），則此路由匹配。

四.過濾器工廠( GatewayFilter Factory)

Spring提供了31種不同的路由過濾器工廠,具體每一種過濾器的使用方式，你也可以去其官網(wǎng)查看，這邊我們只介紹記住常用的過濾器

4.1. 請(qǐng)求頭過濾器(AddRequestHeader)

下面我們以AddRequestHeader 為例來講解。

需求：給所有進(jìn)入user-service的請(qǐng)求添加一個(gè)請(qǐng)求頭：Learn=跟著 springboot葵花寶典一起學(xué)習(xí)開發(fā)!

【步驟一】:Gateway網(wǎng)關(guān)添加請(qǐng)求頭配置

只需要修改gateway服務(wù)的application.yml文件，添加路由過濾即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 過濾器
        - AddRequestHeader=Learn, learn springboot! # 添加請(qǐng)求頭

注意:AddRequestHeader=Learn, learn springboot：

• 請(qǐng)求頭格式: key:value
• Learn:表示請(qǐng)求頭的key
• learn springboot：表示value 當(dāng)前過濾器寫在user-service路由下，因此僅僅對(duì)訪問user-service的請(qǐng)求有效。

【步驟二】：修改user-service控制器獲取請(qǐng)求頭

@GetMapping("/{id}")
public User test(@PathVariable("id") Long id, HttpServletRequest httpRequest){
    String learn = httpRequest.getHeader("Learn");

    System.out.println("Learn = " + learn);


    User user = userService.getById(id);

    return user;
}

【步驟三】：測(cè)試

使用瀏覽器訪問http://localhost:9999/user/2,查看控制臺(tái)

圖片

思考：剛才我們展示的是user-service單個(gè)微服務(wù)的過濾器，如何可以寫一個(gè)過濾器對(duì)所有的路由都生效?

默認(rèn)過濾器

spring:
    gateway:
      routes: # 網(wǎng)關(guān)路由配置
      - id: user-service # 路由id，自定義，只要唯一即可
        #uri: http://127.0.0.1:8088 # 路由的目標(biāo)地址 http就是固定地址
        uri: lb://user-service # 路由的目標(biāo)地址 lb就是負(fù)載均衡，后面跟服務(wù)名稱
        predicates: # 路由斷言，也就是判斷請(qǐng)求是否符合路由規(guī)則的條件
          - Path=/user/** # 這個(gè)是按照路徑匹配，只要以/user/開頭就符合要求
      default-filters: # 默認(rèn)過濾項(xiàng)
        - AddRequestHeader=Learn, learn springbot! # 添加請(qǐng)求頭

總結(jié)

1.過濾器的作用是什么？

對(duì)路由的請(qǐng)求或響應(yīng)做加工處理，比如添加請(qǐng)求頭

配置在路由下的過濾器只對(duì)當(dāng)前路由的請(qǐng)求生效

2.defaultFilters的作用是什么？

      對(duì)所有路由都生效的過濾器

5.全局過濾器

學(xué)習(xí)的過濾器，網(wǎng)關(guān)提供了31種，但每一種過濾器的作用都是固定的。如果我們希望攔截請(qǐng)求，做自己的業(yè)務(wù)邏輯則沒辦法實(shí)現(xiàn)。那就需要全局過濾器。

5.1. 全局過濾器作用

全局過濾器的作用也是處理一切進(jìn)入網(wǎng)關(guān)的請(qǐng)求和微服務(wù)響應(yīng)，與GatewayFilter的作用一樣。區(qū)別在于GatewayFilter通過配置定義，處理邏輯是固定的；而GlobalFilter的邏輯需要自己寫代碼實(shí)現(xiàn)。

5.2.實(shí)現(xiàn)方式

定義方式是實(shí)現(xiàn)GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  處理當(dāng)前請(qǐng)求，有必要的話通過{@link GatewayFilterChain}將請(qǐng)求交給下一個(gè)過濾器處理
     *
     * @param exchange 請(qǐng)求上下文，里面可以獲取Request、Response等信息
     * @param chain 用來把請(qǐng)求委托給下一個(gè)過濾器 
     * @return {@code Mono<Void>} 返回標(biāo)示當(dāng)前過濾器業(yè)務(wù)結(jié)束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中編寫自定義邏輯，可以實(shí)現(xiàn)下列功能：

• 登錄狀態(tài)判斷
• 權(quán)限校驗(yàn)
• 請(qǐng)求限流等

5.3 自定義全局過濾器

需求：定義全局過濾器，攔截請(qǐng)求，判斷請(qǐng)求頭中是否有滿足下面條件：

• 請(qǐng)求頭key是否有authorization，
• authorization參數(shù)值是否為admin

如果同時(shí)滿足則放行，否則攔截

實(shí)現(xiàn)：

package com.zbbmeta.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import reactor.netty.http.server.HttpServerRequest;

import java.util.List;

/**
 * @author springboot葵花寶典
 * @description: TODO
 */
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.獲取請(qǐng)求頭
        HttpHeaders headers = exchange.getRequest().getHeaders();
        // 2.獲取請(qǐng)求頭key是authorization
        List<String> auths = headers.get("authorization");
        // 3.校驗(yàn)
        if(auths.contains("admin")){
            // 放行
            return chain.filter(exchange);
        }
        // 4.攔截
        // 4.1.禁止訪問，設(shè)置狀態(tài)碼
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.結(jié)束處理
        return exchange.getResponse().setComplete();
    }
}

測(cè)試

使用postman訪問http://localhost:9999/user/1，并在請(qǐng)求頭添加authorizatinotallow=admin

錯(cuò)誤展示請(qǐng)求頭添加authorizatinotallow=admin1

5.4. 過濾器執(zhí)行順序

請(qǐng)求進(jìn)入網(wǎng)關(guān)會(huì)碰到三類過濾器：

• 當(dāng)前路由的過濾器
• DefaultFilter
• GlobalFilter

請(qǐng)求路由后，會(huì)將當(dāng)前路由過濾器和DefaultFilter、GlobalFilter，合并到一個(gè)過濾器鏈（集合）中，排序后依次執(zhí)行每個(gè)過濾器：

排序的規(guī)則是什么呢？

• 每一個(gè)過濾器都必須指定一個(gè)int類型的order值，order值越小，優(yōu)先級(jí)越高，執(zhí)行順序越靠前。
• GlobalFilter通過實(shí)現(xiàn)Ordered接口，或者添加@Order注解來指定order值，由我們自己指定
• 路由過濾器和defaultFilter的order由Spring指定，默認(rèn)是按照聲明順序從1遞增。
• 當(dāng)過濾器的order值一樣時(shí)，會(huì)按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執(zhí)行。

詳細(xì)內(nèi)容，可以查看源碼：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加載defaultFilters，然后再加載某個(gè)route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法會(huì)加載全局過濾器，與前面的過濾器合并后根據(jù)order排序，組織過濾器鏈

總結(jié)

本文針對(duì)微服務(wù)中另一重要組件：網(wǎng)關(guān) 進(jìn)行了實(shí)戰(zhàn)性演練，網(wǎng)關(guān)作為分布式架構(gòu)中的重要中間件，不僅承擔(dān)著路由分發(fā)（重點(diǎn)關(guān)注Path規(guī)則配置），同時(shí)可根據(jù)自身負(fù)載均衡策略，對(duì)多個(gè)注冊(cè)服務(wù)實(shí)例進(jìn)行均衡調(diào)用。我們借助GateWay實(shí)現(xiàn)的網(wǎng)關(guān)只是技術(shù)實(shí)現(xiàn)的方案之一，后續(xù)大家可能會(huì)接觸像：Zuul、Kong等，其實(shí)現(xiàn)細(xì)節(jié)或有差異，但整體目標(biāo)是一致的。