微服務（七）Gateway服務閘道器

iucbjb發表於2021-11-02
微服務Gateway

1 為什麼要有閘道器


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

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

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

在SpringCloud中閘道器的實現包括兩種：

  • gateway
  • zuul

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

2 gateway快速入門

2.1 建立gateway微服務，引入依賴

    <dependencies>
        <!--閘道器-->
        <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>
    </dependencies>

2.2 主啟動類

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

2.3 編寫基礎配置和路由規則

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 112.124.4.214:8848
    gateway:
      routes: # 閘道器路由配置
        - id: user-service # 路由id，自定義，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標地址 http就是固定地址
          uri: lb://userservice # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
        - id: order-service # 路由id，自定義，只要唯一即可
          uri: lb://order-service # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/order/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求

我們將符合Path 規則的一切請求，都代理到 uri引數指定的地址。

我們將 /user/**開頭的請求，代理到lb://userservice，lb是負載均衡，根據服務名拉取服務列表，實現負載均衡。

2.4 啟動測試

訪問http://localhost:10010/user/1時，符合/user/**規則，請求轉發到uri：http://userservice/user/1，得到了結果：
訪問http://localhost:10010/order/101時，符合/order/**規則，請求轉發到uri：http://order-service/order/101，得到了結果：

執行流程

3 斷言工廠

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

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

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

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

名稱 說明 示例
After 是某個時間點後的請求 - After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before 是某個時間點之前的請求 - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between 是某兩個時間點之前的請求 - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie 請求必須包含某些cookie - Cookie=chocolate, ch.p
Header 請求必須包含某些header - Header=X-Request-Id, \d+
Host 請求必須是訪問某個host（域名） - Host=.somehost.org,.anotherhost.org
Method 請求方式必須是指定方式 - Method=GET,POST
Path 請求路徑必須符合指定規則 - Path=/red/{segment},/blue/**
Query 請求引數必須包含指定引數 - Query=name, Jack或者- Query=name
RemoteAddr 請求者的ip必須是指定範圍 - RemoteAddr=192.168.1.1/24
Weight 權重處理

只需要掌握Path這種路由工程就可以了

4 過濾器工廠

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


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

名稱 說明
AddRequestHeader 給當前請求新增一個請求頭
RemoveRequestHeader 移除請求中的一個請求頭
AddResponseHeader 給響應結果中新增一個響應頭
RemoveResponseHeader 從響應結果中移除有一個響應頭
RequestRateLimiter 限制請求的流量

4.1 請求頭過濾器

只需要修改gateway服務的application.yml檔案，新增路由過濾即可：

    gateway:
      routes: # 閘道器路由配置
        - id: user-service # 路由id，自定義，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標地址 http就是固定地址
          uri: lb://userservice # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
        - id: order-service # 路由id，自定義，只要唯一即可
          uri: lb://order-service # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/order/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
          filters:
            - AddRequestHeader=Truth, hello xiaoman!

當前過濾器寫在orderservice路由下，因此僅僅對訪問orderservice的請求有效。

在orderservice中任意一介面加@RequestHeader(required = false) String truth

 @GetMapping("{orderId}")
    public Order queryOrderByUserId(@PathVariable("orderId") Long orderId, @RequestHeader(required = false) String truth) {
        // 根據id查詢訂單並返回
        System.out.println("truth: "  + truth);
        Order order = orderService.queryOrderById(orderId);
        return order;
    }

訪問後控制檯有輸出

4.2 預設過濾器

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

gateway:
      routes: # 閘道器路由配置
        - id: user-service # 路由id，自定義，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標地址 http就是固定地址
          uri: lb://userservice # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
        - id: order-service # 路由id，自定義，只要唯一即可
          uri: lb://order-service # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/order/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
        default-filters: # 預設過濾項
          - AddRequestHeader=Truth, Itcast is freaking awesome!

4.3 過濾器執行順序

請求進入閘道器會碰到三類過濾器：當前路由的過濾器、DefaultFilter、GlobalFilter

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

排序的規則是什麼呢？

  • 每一個過濾器都必須指定一個int型別的order值，order值越小，優先順序越高，執行順序越靠前。
  • GlobalFilter通過實現Ordered介面，或者新增@Order註解來指定order值，由我們自己指定
  • 路由過濾器和defaultFilter的order由Spring指定，預設是按照宣告順序從1遞增。
  • 當過濾器的order值一樣時，會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執行。

5 跨域問題

跨域問題：瀏覽器禁止請求的發起者與服務端發生跨域ajax請求，請求被瀏覽器攔截的問題
解決方案：CORS

gateway解決跨域問題

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 # 這次跨域檢測的有效期

相關文章