微服務（8）

微服務（8）

Spring Cloud Gateway 是 Spring Cloud 的一個全新項目，該項目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等響應式編程和事件流技術(shù)開發(fā)的網(wǎng)關(guān)，它旨在為微服務架構(gòu)提供一種簡單有效的統(tǒng)一的 API 路由管理方式。

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

Gateway網(wǎng)關(guān)是我們服務的守門神，所有微服務的統(tǒng)一入口。

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

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

架構(gòu)圖：

權(quán)限控制：網(wǎng)關(guān)作為微服務入口，需要校驗用戶是是否有請求資格，如果沒有則進行攔截。

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

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

在SpringCloud中網(wǎng)關(guān)的實現(xiàn)包括兩種：

• gateway
• zuul

Zuul是基于Servlet的實現(xiàn)，屬于阻塞式編程。而SpringCloudGateway則是基于Spring5中提供的WebFlux，屬于響應式編程的實現(xiàn)，具備更好的性能。

2. gateway快速入門

下面，我們就演示下網(wǎng)關(guān)的基本路由功能?；静襟E如下：

1. 創(chuàng)建SpringBoot工程gateway，引入網(wǎng)關(guān)依賴
2. 編寫啟動類
3. 編寫基礎(chǔ)配置和路由規(guī)則
4. 啟動網(wǎng)關(guān)服務進行測試

1）創(chuàng)建gateway服務，引入依賴

創(chuàng)建服務：

引入依賴：

<!--網(wǎng)關(guān)-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務發(fā)現(xiàn)依賴-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2）編寫啟動類

package cn.itcast.gateway;

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

@SpringBootApplication
public class GatewayApplication {

	public static void main(String[] args) {
		SpringApplication.run(GatewayApplication.class, args);
	}
}

3）編寫基礎(chǔ)配置和路由規(guī)則

創(chuàng)建application.yml文件，內(nèi)容如下：

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

同理，orderservice可以這樣配：

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

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

4）重啟測試

重啟網(wǎng)關(guān)，訪問http://localhost:10010/order/101時，符合/order/**規(guī)則，請求轉(zhuǎn)發(fā)到uri：http://orderservice/order/101，得到了結(jié)果：

5）網(wǎng)關(guān)路由的流程圖

整個訪問的流程如下：

1. 指定了nacos的地址，所以是知道在哪里拉取服務列表并做負載均衡的
2. 加了路由目標就知道拉取哪些服務，lb代表負載均衡，后面再加上服務名
3. predicate指定了，這里有一種路徑斷言，例如：Path=/user/**，如果是user開頭的路由，就斷定是要定向到user-service這個路由，也就是lb://userservice
   • Predicate這個函數(shù)式接口就是條件，其實斷言就是條件啦，滿足某個條件就可以定向
   • Path就必須有，否則壓根就不知道什么路由可以定向到哪些服務

總結(jié)：

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

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

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

路由配置包括：

1. 路由id：路由的唯一標示

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

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

4. 路由過濾器（filters）：對請求或響應做處理

接下來，就重點來學習路由斷言和路由過濾器的詳細知識

3. 斷言工廠

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

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

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

處理的，像這樣的斷言工廠在SpringCloudGateway還有十幾個:

Spring Cloud Gateway

• 這是官網(wǎng)可以去了解一下這些斷言工廠

如果路由沒有一個滿足所有斷言條件的route，就會404

例如時間路由斷言：

斷言：

1. /order開頭
2. 指定時區(qū)的時間之前發(fā)來的請求

滿足這兩個條件的路由會被定向到指定的route

重啟gateway服務后：

反之，如果是這個After，就需要某個時間之后才能訪問：

• 這個值的格式一定要嚴格滿足官方提供的要求！
• 例如Path=…，Before=…之類的，不能自定義XX=…，而是只能有官方給的幾個斷言工程
• 至于=后面的值，例如時間要符合時間格式…

但其實，我們只需要掌握Path這種路由工程就可以了??~

• 我把剛才多加的predicate條件注釋掉了，繼續(xù)我們后面的學習

注意：通過斷言規(guī)則可以模擬出類似于攔截的效果，但是不要誤解成是對該路由的攔截，而是滿足斷言規(guī)則才會定向到該路由，如果每個route都不滿足，那么就404，找不到向誰請求

你可能會覺得單單從Path就可以找到了呀，但是他的機制就是這樣的，遵循約定，不必糾結(jié)！

4. 過濾器工廠

GatewayFilter是網(wǎng)關(guān)中提供的一種過濾器，可以對進入網(wǎng)關(guān)的請求和微服務返回的響應做處理：

3.4.1.路由過濾器的種類

Spring提供了31種不同的路由過濾器工廠。例如：

Spring Cloud Gateway

• 官方地址，用到啥學啥_(|3」∠)_

4.2 請求頭過濾器

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

需求：給所有進入userservice的請求添加一個請求頭：Truth=itcast is freaking awesome!

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 過濾器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加請求頭

當前過濾器寫在一個route里，例如userservice路由下，因此僅僅對訪問userservice的請求有效。

一樣的，過濾器工程XX=…，必須是官方給出的，按照具體的含義，例如這里是增加請求頭=a,b

• 也就是添加key為a，value為b的請求頭（這是約定，不要跳糾結(jié)為啥）

你會發(fā)現(xiàn)用代理看請求結(jié)構(gòu)的時候，并沒有這個，這個是經(jīng)過我們的gateway服務才加上去的，所以這里沒有，我們可以這樣子去檢驗是否有這個請求頭：

訪問一下看控制臺：

4.3 默認過濾器

如果要對所有的路由都生效，則可以將過濾器工廠寫到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默認過濾項,是default-filters，不是filters
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

但是你會發(fā)現(xiàn)，order訪問不了了

不過訪問order也會打?。?/p>

這代表,向網(wǎng)關(guān)發(fā)送的請求請求頭是帶這兩個請求頭的，但是orderservice向userservice發(fā)請求，是不經(jīng)過網(wǎng)關(guān)的，所以沒有Name這個請求頭~

既然服務a發(fā)請求給服務b不需要通過網(wǎng)關(guān)，在這里你也可以得到一些結(jié)論：

并不是必須訪問網(wǎng)關(guān)才能訪問我們的服務，訪問網(wǎng)關(guān)可以通過斷言規(guī)則定向到我們的接口罷了；

如果請求不是通過訪問網(wǎng)關(guān)定向到對應路由的，那么自然也沒有經(jīng)過過濾器，也就不會進行過濾

例如我加了一個predicate為假的在orderservice對應的“routes.predicates”里

通過訪問網(wǎng)關(guān)不能定向到對應的接口

但是直接訪問接口可以，并且這個接口不需要authorization參數(shù)的值，證明GlobalFilter沒生效

若是直接訪問這個order/101接口，則會因為請求頭缺少Truth/Name而報異常，這說明路由過濾器和DefaultFilter都沒有生效

4.4 總結(jié)

過濾器的作用是什么？

① 對路由的請求或響應做加工處理，比如添加請求頭

② 配置在路由下的過濾器只對當前路由的請求生效

defaultFilters的作用是什么？

① 對所有路由都生效的過濾器

5. 全局過濾器

上一節(jié)學習的過濾器，網(wǎng)關(guān)提供了31種，但每一種過濾器的作用都是固定的。如果我們希望攔截請求，做自己的業(yè)務邏輯則沒辦法實現(xiàn)。

5.1 全局過濾器作用

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

配置文件配置的方式，肯定不能完成我們的一些實際上更具體的需求邏輯，這些過濾邏輯需要我們寫代碼去完善

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

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

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

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

5.2 自定義全局過濾器

需求：定義全局過濾器，攔截請求，判斷請求的參數(shù)是否滿足下面條件：

• 參數(shù)中是否有authorization，

• authorization參數(shù)值是否為admin

如果同時滿足則放行，否則攔截

實現(xiàn)：

在gateway中定義一個過濾器：

package cn.itcast.gateway;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
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;

//@Order(-1)//過濾器有很多，通過這里設(shè)置的值來決定哪個過濾器先過濾，值越小，優(yōu)先級越高！
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1. 獲取請求參數(shù)
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        // 2. 獲取參數(shù)中的某個參數(shù)
        String auth = queryParams.getFirst("authorization");
        // 3. 判斷參數(shù)值是否等于admin，判斷是否放行
        if("admin".equals(auth)) {
            // 是
            return chain.filter(exchange);//代表放行
        }
        // 否
//        exchange.getResponse().setStatusCode(HttpStatus.valueOf(401));// 401 restful里代表未登錄
        // 設(shè)置狀態(tài)（方便前端你選人用戶感知，bug排查...）
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);// 401 restful里代表未登錄
        return exchange.getResponse().setComplete();//代表終結(jié)（不放行）
    }

    // 實現(xiàn)Ordered的這個方法，獲取優(yōu)先級的時候就可以通過這個方法獲取order值（其實注解實現(xiàn)的也是這個邏輯吧）
    @Override
    public int getOrder() {
        return -1;
    }
}

5.3 過濾器執(zhí)行順序

請求進入網(wǎng)關(guān)會碰到三類過濾器：當前路由的過濾器、DefaultFilter、GlobalFilter

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

路由過濾器和DefaultFilter，你會發(fā)現(xiàn)，他們的值: 過濾器列表其實是同一套東西的（重合）

兩種過濾器本質(zhì)內(nèi)核是一樣的，對應的“同類”過濾器(例如AddRequestHeader過濾器)，路由過濾器和DefaultFilter都由同一個過濾器工廠生成GatewayFilter：

而我們的GlobalFilter則會被框架內(nèi)的某個適配器適配成GatewayFilter：

• 了解大概的那個意思就行，看不懂代碼無所謂

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

• 每一個過濾器都必須指定一個int類型的order值，order值越小，優(yōu)先級越高，執(zhí)行順序越靠前。
• GlobalFilter通過實現(xiàn)Ordered接口，或者添加@Order注解來指定order值，由我們自己指定
• 路由過濾器和defaultFilter的order由Spring指定，默認是按照聲明順序從1遞增（配置中不同的過濾器配置分開計數(shù)）。

當過濾器的order值一樣時，會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執(zhí)行。，兩個GF的order相同的話，前后隨機

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

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

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

重啟后訪問一下：

加上querystring：（?authorization=admin）

6. 跨域問題

6.1 什么是跨域問題

跨域：域名不一致就是跨域，主要包括：

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost:8080和localhost8081

例如這一個跨域問題：瀏覽器禁止請求的發(fā)起者與服務端發(fā)生跨域ajax請求，請求被瀏覽器攔截的問題

解決方案：CORS，這個以前應該學習過，這里不再贅述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

6.2 模擬跨域問題

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <meta http-equiv="X-UA-Compatible" content="ie=edge" />
        <title>Document</title>
    </head>
    <body>
        <h1>Test</h1>
    </body>
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    <script>
        axios
            .get("http://localhost:10010/user/1?authorization=admin")
            .then((resp) => console.log(resp.data))
            .catch((err) => console.log(err));
    </script>
</html>

VSCode打開，下載Live Server插件，點擊VSCode右下角的Go Live，我分配的端口是5500，在瀏覽器訪問一下：

可以在瀏覽器控制臺看到下面的錯誤：

從localhost:5500訪問localhost:10010，端口不同，顯然是跨域的請求。

6.3 解決跨域問題

這個需要放行的是http://localhost:5500，我們必須分毫不差地放行“http://localhost:5500”，而不是這些：

1. 127.0.0.1:5500
2. localhost:5500
3. http://127.0.0.1:5500

跨域檢查是強區(qū)分這些的~

還有，如果80端口發(fā)出的跨域請求，那么應該是http://localhost，而不是http://localhost:80，等等…

• 反正就是報錯要我們放行什么就放行什么，不是放行什么“等價”的地址

在gateway服務的application.yml文件中，添加下面的配置：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域處理
        add-to-simple-url-handler-mapping: true # 每次跨域檢測，發(fā)的就是options請求，這里解決的是options請求被攔截問題，默認是false
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允許哪些網(wǎng)站的跨域請求 
              - "http://localhost:5500"
            allowedMethods: # 允許的跨域ajax的請求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允許在請求中攜帶的頭信息
            allowCredentials: true # 是否允許攜帶cookie
            maxAge: 360000 # 這次跨域檢測的有效期，如果檢驗通過，瀏覽器會緩存了這次跨域檢驗，這段時間對該網(wǎng)關(guān)的跨域請求將會被直接放行

跨域問題解決??：

文章到此結(jié)束！謝謝觀看
可以叫我 小馬，我可能寫的不好或者有錯誤，但是一起加油鴨??！

代碼：云服務: 云服務相關(guān)代碼 (gitee.com)文章來源地址http://www.zghlxwxcb.cn/news/detail-789002.html

到了這里，關(guān)于【微服務 SpringCloudAlibaba】實用篇 · Gateway服務網(wǎng)關(guān)的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！