Spring Cloud 之 Gateway.

時間  2020-04-22
標籤 spring cloud gateway 欄目 Spring 简体版
原文   原文鏈接

1、Gateway 和 Zuul 的區別

Zuul 基於servlet 2.5 (works with 3.x)，使用阻塞API。它不支持任何長期的鏈接，如websocket。html

Gateway創建在Spring Framework 5，Project Reactor 和Spring Boot 2 上，使用非阻塞API。支持Websocket，由於它與Spring緊密集成，因此它是一個更好的開發者體驗。java

爲何 Spring Cloud 最初選擇了使用 Netflix 幾年前開源的 Zuul 做爲網關，以後又選擇了自建 Gateway 呢？有一種說法是，高性能版的 Zuul2 在通過了屢次跳票以後，對於 Spring 這樣的整合專家可能也不肯意再繼續等待，因此 Spring Cloud Gateway 應運而生。react

本文不對 Spring Cloud Gateway 和 Zuul 的性能做太多贅述，基本能夠確定的是 Gateway 做爲如今 Spring Cloud 主推的網關方案， Finchley 版本後的 Gateway 比 zuul 1.x 系列的性能和功能總體要好。git

2、快速入門

咱們來搭建一個基於 Eureka 註冊中心的簡單網關，不對 Gateway 的所有功能作過多解讀，畢竟<span style="color:blue">官方文檔</span>已經寫的很詳細了，或者能夠閱讀<span style="color:blue">中文翻譯文檔</span>。github

SpringBoot 版本號：2.1.6.RELEASEweb

SpringCloud 版本號：Greenwich.RELEASEredis

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());
    }

}

3、過濾器

Spring Cloud Gateway 同 Zuul 相似，有 「pre」 和 「post」 兩種方式的 filter。客戶端的請求先通過 「pre」 類型的 filter，而後將請求轉發到具體的業務服務，收到業務服務的響應以後，再通過「post」類型的filter處理，最後返回響應到客戶端。spring

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

全局過濾器

咱們一般用全局過濾器實現鑑權、驗籤、限流、日誌輸出等。websocket

經過實現 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

<b style="color:red">tips：</b>能夠去閱讀下 Gateway 中默認提供的幾種過濾器，好比 StripPrefixGatewayFilterFactory.java 等。

4、動態路由

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請求 <b>/actuator/gateway/routes/{id_route_to_create}</b>，參數爲JSON結構，具體參數數據結構：

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

要刪除一個路由，發送 DELETE請求 <b>/actuator/gateway/routes/{id_route_to_delete}</b>

5、附錄

原文出處：https://www.cnblogs.com/jmcui/p/11259200.html

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程