天天看點
傳回

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

Gateway服務網關

  • 一、網關介紹
  • 二、gateway快速入門
    • 1.建立gateway服務，引入依賴
    • 2.編寫啟動類
    • 3.編寫基礎配置和路由規則
    • 4.重新開機測試
    • 5.網關路由的流程圖
  • 三、斷言工廠
  • 四、過濾器工廠
    • 1.路由過濾器的種類
    • 2.請求頭過濾器
    • 3.預設過濾器
    • 4.總結
  • 五、全局過濾器
    • 1.全局過濾器作用
    • 2.自定義全局過濾器
    • 3.過濾器執行順序
  • 六、跨域問題
    • 1.什麼是跨域問題
    • 2.解決跨域問題
Spring Cloud Gateway 是 Spring Cloud 的一個全新項目，該項目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等響應式程式設計和事件流技術開發的網關，它旨在為微服務架構提供一種簡單有效的統一的 API 路由管理方式。

一、網關介紹

Gateway網關是我們服務的守門神，所有微服務的統一入口。

網關的核心功能特性：

  • 請求路由
  • 權限控制
  • 限流

架構圖：

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

權限控制：網關作為微服務入口，需要校驗使用者是是否有請求資格，如果沒有則進行攔截。

路由和負載均衡：一切請求都必須先經過gateway，但網關不處理業務，而是根據某種規則，把請求轉發到某個微服務，這個過程叫做路由。當然路由的目标服務有多個時，還需要做負載均衡。

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

在SpringCloud中網關的實作包括兩種：

  • gateway
  • zuul

Zuul是基于Servlet的實作，屬于阻塞式程式設計。而SpringCloudGateway則是基于Spring5中提供的WebFlux，屬于響應式程式設計的實作，具備更好的性能。

二、gateway快速入門

下面，操作下網關的基本路由功能。基本步驟如下：

  1. 建立SpringBoot工程gateway，引入網關依賴
  2. 編寫啟動類
  3. 編寫基礎配置和路由規則
  4. 啟動網關服務進行測試

1.建立gateway服務，引入依賴

建立項目工程（gateway）

引入依賴：

<!--網關-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務發現依賴-->
<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.編寫基礎配置和路由規則

建立application.yml檔案，内容如下：

server:
  port: 10010 # 網關端口
spring:
  application:
    name: gateway # 服務名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos位址，由于網關也是一個服務，是以需要注冊到nacos
    gateway:
      routes: # 網關路由配置
        - id: user-service # 路由id，自定義，隻要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标位址 http就是固定位址
          uri: lb://userservice # 路由的目标位址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑比對，隻要以/user/開頭就符合要求

我們将符合

Path

規則的一切請求，都代理到

uri

參數指定的位址。

本例中，我們将

/user/**

開頭的請求，代理到

lb://userservice

，lb是負載均衡，根據服務名拉取服務清單，實作負載均衡。

4.重新開機測試

重新開機網關，通路http://localhost:10010/user/1時，符合

/user/**

規則，請求轉發到uri：http://userservice/user/1，得到了結果。

5.網關路由的流程圖

整個通路的流程如下：

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

總結：

網關搭建步驟：

  1. 建立項目，引入nacos服務發現和gateway依賴
  2. 配置application.yml，包括服務基本資訊、nacos位址、路由

路由配置包括：

  1. 路由id：路由的唯一标示
  2. 路由目标（uri）：路由的目标位址，http代表固定位址，lb代表根據服務名負載均衡
  3. 路由斷言（predicates）：判斷路由的規則，
  4. 路由過濾器（filters）：對請求或響應做處理

接下來，重點實作路由斷言和路由過濾器

三、斷言工廠

我們在配置檔案中寫的斷言規則隻是字元串，這些字元串會被Predicate Factory讀取并處理，轉變為路由判斷的條件

例如Path=/user/**是按照路徑比對，這個規則是由

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

類來

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

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

四、過濾器工廠

GatewayFilter是網關中提供的一種過濾器，可以對進入網關的請求和微服務傳回的響應做處理：

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

1.路由過濾器的種類

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

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

2.請求頭過濾器

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

需求：給所有進入userservice的請求添加一個請求頭：Truth=Happy new year!

隻需要修改gateway服務的application.yml檔案，添加路由過濾即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 過濾器
        - AddRequestHeader=Truth, Happy new year! # 添加請求頭;格式：名字, 内容

目前過濾器寫在userservice路由下，是以僅僅對通路userservice的請求有效。

3.預設過濾器

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 預設過濾項
      - AddRequestHeader=Truth, Happy new year!

4.總結

過濾器的作用是什麼？

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

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

defaultFilters的作用是什麼？

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

五、全局過濾器

網關提供了31種過濾器，但每一種過濾器的作用都是固定的。如果我們希望攔截請求，做自己的業務邏輯則沒辦法實作。

1.全局過濾器作用

全局過濾器的作用也是處理一切進入網關的請求和微服務響應，與GatewayFilter的作用一樣。差別在于GatewayFilter通過配置定義，處理邏輯是固定的；而GlobalFilter的邏輯需要自己寫代碼實作。

定義方式是實作GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  處理目前請求，有必要的話通過{@link GatewayFilterChain}将請求交給下一個過濾器處理
     *
     * @param exchange 請求上下文，裡面可以擷取Request、Response等資訊
     * @param chain 用來把請求委托給下一個過濾器 
     * @return {@code Mono<Void>} 傳回标示目前過濾器業務結束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中編寫自定義邏輯，可以實作下列功能：

  • 登入狀态判斷
  • 權限校驗
  • 請求限流等

2.自定義全局過濾器

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

  • 參數中是否有authorization，
  • authorization參數值是否為admin

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

實作：

在gateway中定義一個過濾器：

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)  // 排序注解，值越小，優先級越高
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.擷取請求參數
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.擷取authorization參數
        String auth = params.getFirst("authorization");
        // 3.校驗
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.攔截
        // 4.1.禁止通路，設定狀态碼
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.結束處理
        return exchange.getResponse().setComplete();
    }
}

3.過濾器執行順序

請求進入網關會碰到三類過濾器：目前路由的過濾器、DefaultFilter、GlobalFilter

請求路由後，會将目前路由過濾器和DefaultFilter、GlobalFilter，合并到一個過濾器鍊（集合）中，排序後依次執行每個過濾器：

Gateway服務網關一、網關介紹二、gateway快速入門三、斷言工廠四、過濾器工廠五、全局過濾器六、跨域問題

排序的規則：

  • 每一個過濾器都必須指定一個int類型的order值，order值越小，優先級越高，執行順序越靠前。
  • GlobalFilter通過實作Ordered接口，或者添加@Order注解來指定order值，由我們自己指定
  • 路由過濾器和defaultFilter的order由Spring指定，預設是按照聲明順序從1遞增。
  • 當過濾器的order值一樣時，會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執行。

詳細内容，可以檢視源碼：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()

方法是先加載defaultFilters，然後再加載某個route的filters，然後合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()

方法會加載全局過濾器，與前面的過濾器合并後根據order排序，組織過濾器鍊

六、跨域問題

1.什麼是跨域問題

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

  • 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
  • 域名相同，端口不同：localhost:8080和localhost8081

跨域問題：浏覽器禁止請求的發起者與服務端發生跨域ajax請求，請求被浏覽器攔截的問題

2.解決跨域問題

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

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域處理
        add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允許哪些網站的跨域請求 
              - "http://localhost:8090"
            allowedMethods: # 允許的跨域ajax的請求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允許在請求中攜帶的頭資訊
            allowCredentials: true # 是否允許攜帶cookie
            maxAge: 360000 # 這次跨域檢測的有效期
springCloud gateway java spring boot
上一篇: @Transactional的踩坑和實踐
下一篇: qlexpress踩坑之旅

繼續閱讀