• 前言
  • 環境
  • 路由配置示例
• 路由配置的兩種形式
  • 路由到指定URL
    • 通配
    • 精確匹配
  • 路由到微服務
    • 通配
    • 精確匹配
• 路由謂詞工廠
  • 內建的路由謂詞工廠
    • Method 謂詞工廠示例
  • 自定義路由謂詞工廠
    • 程式碼配置
    • 測試

前言

Route（路由）是Spring Cloud Gateway的基礎元素，就是一個轉發規則，其包含ID、目標URL、Predicate集合以及Filter集合

環境

Spring Cloud Hoxton.SR9 + Spring Cloud Alibaba 2.2.6.RELEASE

路由配置示例

• 如果訪問gateway的/baidu這個路徑就會進入該路由，會用AddRequestHeader這個過濾器去處理，再將請求轉發到http://www.baidu.com

spring:
  cloud:
    gateway:
      routes: 
        - id: some_route
          uri: http://www.baidu.com
          predicates:
            - Path=/baidu
          filters:
            - AddRequestHeader=X-Request-Foo, Bar

路由配置的兩種形式

路由到指定URL

通配

• 訪問GATEWAY_URL/**會轉發到http://www.baidu.com/**

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一標識}
        uri: http://www.baidu.com
 

精確匹配

• 訪問GATEWAY_URL/user-center/user/轉發到http://www.coisini.club/user-center/user/

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一標識}
        uri: http://www.coisini.club/user-center/user/

路由到微服務

通配

• 訪問GATEWAY_URL/**轉發到user-center微服務的/**

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一標識}
        uri: lb://user-center
 

精確匹配

• 訪問GATEWAY_URL/user-center/user/name轉發到user-center微服務的/user/name

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一標識}
        uri: lb://user-center/user/name

路由謂詞工廠

路由謂詞工廠（Route Predicate Factories）是作用在指定路由之上的一堆謂詞條件

內建的路由謂詞工廠

Method 謂詞工廠示例

• Method謂詞工廠示例，當HTTP請求方法是GET時才轉發

gateway:
  discovery:
    locator:
      # 讓gateway通過服務發現元件找到其他的微服務
      enabled: true
  routes:
    - id: method_route
      uri: lb://user-center
      predicates:
        # 當HTTP請求方法是GET時，才會轉發使用者微服務
        # 如請求方法滿足條件，訪問http://localhost:8040/** -> user-center/**
        # eg. 訪問http://localhost:8040/test/coisini -> user-center/test/coisini
        - Method=GET

• GET請求測試

• POST請求測試

自定義路由謂詞工廠

• 實現限制服務只能在09:00 - 17:00內才可以訪問

程式碼配置

• application.yml

spring:
  application:
    name: core-gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      routes:
        - id: user-center
          uri: http://www.baidu.com
          predicates:
            - TimeBetween=上午9:00,下午5:00

• TimeBetweenConfig.java

import lombok.Data;
import java.time.LocalTime;

@Data
public class TimeBetweenConfig {
    private LocalTime start;
    private LocalTime end;
}

• TimeBetweenRoutePredicateFactory.java

import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

/**
 * 自定義路由謂詞工廠
 * 路由謂詞工廠必須以RoutePredicateFactory結尾
 */
@Component
public class TimeBetweenRoutePredicateFactory extends AbstractRoutePredicateFactory<TimeBetweenConfig> {

    public TimeBetweenRoutePredicateFactory() {
        super(TimeBetweenConfig.class);
    }

    /**
     * 控制路由的條件
     * @param config
     * @return
     */
    @Override
    public Predicate<ServerWebExchange> apply(TimeBetweenConfig config) {
        LocalTime start = config.getStart();
        LocalTime end = config.getEnd();

        return exchange -> {
            LocalTime now = LocalTime.now();
            return now.isAfter(start) && now.isBefore(end);
        };
    }

    /**
     * 控制配置類和配置檔案的對映關係
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("start", "end");
    }
}

測試

• 09:00 - 17:00外訪問

• 09:00 - 17:00內訪問