天天看點
傳回

Spring Cloud 之 Gateway.

一、Gateway 和 Zuul 的差別

Zuul 基于servlet 2.5 (works with 3.x)，使用阻塞API。它不支援任何長期的連接配接，如websocket。

Gateway建立在Spring Framework 5，Project Reactor 和Spring Boot 2 上，使用非阻塞API。支援Websocket，因為它與Spring緊密內建，是以它是一個更好的開發者體驗。

為什麼 Spring Cloud 最初選擇了使用 Netflix 幾年前開源的 Zuul 作為網關，之後又選擇了自建 Gateway 呢？有一種說法是，高性能版的 Zuul2 在經過了多次跳票之後，對于 Spring 這樣的整合專家可能也不願意再繼續等待，是以 Spring Cloud Gateway 應運而生。

本文不對 Spring Cloud Gateway 和 Zuul 的性能作太多贅述，基本可以肯定的是 Gateway 作為現在 Spring Cloud 主推的網關方案， Finchley 版本後的 Gateway 比 zuul 1.x 系列的性能和功能整體要好。

二、快速入門

我們來搭建一個基于 Eureka 注冊中心的簡單網關，不對 Gateway 的全部功能做過多解讀，畢竟官方文檔已經寫的很詳細了，或者可以閱讀中文翻譯文檔。

SpringBoot 版本号：2.1.6.RELEASE

SpringCloud 版本号：Greenwich.RELEASE

1. pom.xml 

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>
  • spring-cloud-starter-gateway：Spring Cloud Gateway 的啟動類
  • spring-cloud-starter-netflix-hystrix：Hystrix 作為網關的熔斷方案
  • spring-cloud-starter-netflix-eureka-client：将網關納入 Eureka 注冊中心管理
  • spring-boot-starter-data-redis-reactive：限流方案，Spring Cloud Gateway 預設以 redis 實作限流
  • spring-boot-starter-actuator：用來監控 Gateway 的路由資訊。

2. application.yml 

spring:
  application:
    name: cloud-gateway
  redis:
    host: 127.0.0.1
    timeout: 3000
    password: xxxx
    jedis:
      pool:
        max-active: 8
        max-idle: 4
  cloud:
    gateway:
      enabled: true
      metrics:
        enabled: true
      discovery:
        locator:
          enabled: true
      routes:
        # 普通服務的路由配置
        - id: cloud-eureka-client
          uri: lb://cloud-eureka-client
          order: 0
          predicates:
            - Path=/client/**
          filters:
            #  parts 參數訓示在将請求發送到下遊之前，要從請求中去除的路徑中的節數。比如我們通路 /client/hello，調用的時候變成 http://localhost:2222/hello
            - StripPrefix=1
            # 熔斷器
            - name: Hystrix
              args:
                name: fallbackcmd
                # 降級處理
                fallbackUri: forward:/fallback
            # 限流器
            # 這定義了每個使用者 10 個請求的限制。允許 20 個突發，但下一秒隻有 10 個請求可用。
            - name: RequestRateLimiter
              args:
                # SPEL 表達式擷取 Spring 中的 Bean，這個參數表示根據什麼來限流
                key-resolver: '#{@ipKeyResolver}'
                # 允許使用者每秒執行多少請求（令牌桶的填充速率）
                redis-rate-limiter.replenishRate: 10
                # 允許使用者在一秒内執行的最大請求數。（令牌桶可以儲存的令牌數）。将此值設定為零将阻止所有請求。
                redis-rate-limiter.burstCapacity: 20
        # websocket 的路由配置
        - id: websocket service
          uri: lb:ws://serviceid
          predicates:
            - Path=/websocket/**
management:
  endpoints:
    web:
      exposure:
        # 開啟指定端點
        include: gateway,metrics
eureka:
  client:
    service-url:
      defaultZone: http://user:password@localhost:1111/eureka/
  • spring.redis.*： redis 相關配置是為了實作 Gateway 的限流方案。
  • eureka.client.*：eureka 注冊中心資訊。
  • spring.cloud.gateway.discovery.locator.enabled：将網關配置為基于使用相容 DiscoveryClient 注冊中心注冊的服務來建立路由。
  • spring.cloud.gateway.routes.*：配置路由資訊
    • id：路由唯一辨別
    • uri：路由轉發位址，以 lb 開頭的路由，會由 ribbon 處理，轉發到 cloud-eureka-client 的服務處理。也可配置成 http 的單機路由 — http://localhost:2222。
    • order：路由執行順序（也可了解成過濾器的執行順序），執行順序是從小到大執行，較高的值被解釋為較低的優先級。
    • predicates：路由斷言，比對通路路徑為 "/client/**" 的請求。
    • filters：網關的過濾器配置
  • management.endpoints.web.exposure.include：暴露 actuator 可以通路的端點
    • /actuator/gateway/routes 檢視路由清單
    • /actuator/gateway/globalfilters 檢索全局路由 — 對所有路由生效
    • /actuator/gateway/routefilters 檢索局部路由 — 可配置隻對單個路由生效
    • /actuator/gateway/refresh 清理路由緩存
    • /actuator/metrics/gateway.requests 獲得路由請求資料

3. GatewayApplication.java 

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

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

    /**
     * 限流的鍵定義，根據什麼來限流
     */
    @Bean
    public KeyResolver ipKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getHostName());
    }

}

三、過濾器

Spring Cloud Gateway 同 Zuul 類似，有 “pre” 和 “post” 兩種方式的 filter。用戶端的請求先經過 “pre” 類型的 filter，然後将請求轉發到具體的業務服務，收到業務服務的響應之後，再經過“post”類型的filter處理，最後傳回響應到用戶端。

與 Zuul 不同的是，filter 除了分為 “pre” 和 “post” 兩種方式的 filter 外，在 Spring Cloud Gateway 中，filter 從作用範圍可分為另外兩種，一種是針對于單個路由的 gateway filter，它需要像上面 application.yml 中的 filters 那樣在單個路由中配置；另外一種是針對于全部路由的global gateway filter，不需要單獨配置，對所有路由生效。

全局過濾器

我們通常用全局過濾器實作鑒權、驗簽、限流、日志輸出等。

通過實作 GlobalFilter 接口來自定義 Gateway 的全局過濾器；通過實作 Ordered 接口或者使用 @Order 注解來定義過濾器的執行順序，執行順序是從小到大執行，較高的值被解釋為較低的優先級。

@Bean
    @Order(-1)
    public GlobalFilter a() {
        return (exchange, chain) -> {
            log.info("first pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("third post filter");
            }));
        };
    }

    @Bean
    @Order(0)
    public GlobalFilter b() {
        return (exchange, chain) -> {
            log.info("second pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("second post filter");
            }));
        };
    }

    @Bean
    @Order(1)
    public GlobalFilter c() {
        return (exchange, chain) -> {
            log.info("third pre filter");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("first post filter");
            }));
        };
    }

優先級最高的 filter ，它的 “pre” 過濾器最先執行，“post” 過濾器最晚執行。

局部過濾器

我們來定義一個 “pre” 類型的局部過濾器：

@Component
public class PreGatewayFilterFactory extends AbstractGatewayFilterFactory<PreGatewayFilterFactory.Config> {
    
    public PreGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        // grab configuration from Config object
        return (exchange, chain) -> {
            //If you want to build a "pre" filter you need to manipulate the
            //request before calling chain.filter
            ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
            //use builder to manipulate the request
            ServerHttpRequest request = builder.build();
            return chain.filter(exchange.mutate().request(request).build());
        };
    }

    public static class Config {
        //Put the configuration properties for your filter here
    }
}

其中，需要的過濾器參數配置在 PreGatewayFilterFactory.Config 中。然後，接下來我們要做的，就是把局部過濾器配置在需要的路由上，根據 SpringBoot 約定大于配置的思想，我們隻需要配置 PreGatewayFilterFactory.java 中，前面的參數就行了，即

spring:
  cloud:
    gateway:
      routes:
        - id: cloud-eureka-client
          uri: lb://cloud-eureka-client
          order: 0
          predicates:
            - Path=/client/**
          filters:
            - pre
tips：

可以去閱讀下 Gateway 中預設提供的幾種過濾器，比如 StripPrefixGatewayFilterFactory.java 等。

四、動态路由

Spring Cloud Gateway 實作動态路由主要利用 RouteDefinitionWriter 這個 Bean：

public interface RouteDefinitionWriter {

	Mono<Void> save(Mono<RouteDefinition> route);

	Mono<Void> delete(Mono<String> routeId);
}

之前翻閱了網上的一些文章，基本都是通過自定義 controller 和出入參，然後利用 RouteDefinitionWriter 實作動态網關。但是，我在翻閱 Spring Cloud Gateway 文檔的時候，發現 Gateway 已經提供了類似的功能：

@RestControllerEndpoint(id = "gateway")
public class GatewayControllerEndpoint implements ApplicationEventPublisherAware {

    /*---省略前面代碼---*/

	@PostMapping("/routes/{id}")
	@SuppressWarnings("unchecked")
	public Mono<ResponseEntity<Void>> save(@PathVariable String id, @RequestBody Mono<RouteDefinition> route) {
		return this.routeDefinitionWriter.save(route.map(r ->  {
			r.setId(id);
			log.debug("Saving route: " + route);
			return r;
		})).then(Mono.defer(() ->
			Mono.just(ResponseEntity.created(URI.create("/routes/"+id)).build())
		));
	}

	@DeleteMapping("/routes/{id}")
	public Mono<ResponseEntity<Object>> delete(@PathVariable String id) {
		return this.routeDefinitionWriter.delete(Mono.just(id))
				.then(Mono.defer(() -> Mono.just(ResponseEntity.ok().build())))
				.onErrorResume(t -> t instanceof NotFoundException, t -> Mono.just(ResponseEntity.notFound().build()));
	}

     /*---省略後面代碼---*/
}

要建立一個路由，發送POST請求

/actuator/gateway/routes/{id_route_to_create}

，參數為JSON結構，具體參數資料結構：

{
  "id": "first_route",
  "predicates": [{
    "name": "Path",
    "args": {"_genkey_0":"/first"}
  }],
  "filters": [],
  "uri": "http://www.uri-destination.org",
  "order": 0
}]

要删除一個路由，發送 DELETE請求

/actuator/gateway/routes/{id_route_to_delete}

五、附錄

  • 更多 Cloud Gateway 使用可關注： https://github.com/JMCuixy/spring-cloud-demo/tree/master/cloud-gateway
  • 博文參考：https://blog.csdn.net/forezp/article/details/85057268
上一篇: 可重入鎖 公平鎖 讀寫鎖、CLH隊列、CLH隊列鎖、自旋鎖、排隊自旋鎖、MCS鎖、CLH鎖
下一篇: [源碼分析] 消息隊列 Kombu 之 啟動過程