关于java:Spring-Cloud-Gateway新一代微服务-API-网关用起来真优雅

35次阅读

共计 5952 个字符，预计需要花费 15 分钟才能阅读完成。

1. 网关介绍

如果没有网关，难道不行吗？性能上是能够的，咱们间接调用提供的接口就能够了。那为什么还须要网关？

因为网关的作用不仅仅是转发申请而已。咱们能够试想一下，如果须要做一个申请认证性能，咱们能够接入到 API 服务中。然而假使后续又有服务须要接入，咱们又须要反复接入。这样咱们不仅代码要反复编写，而且前期也不利于保护。

因为接入网关后，网关将转发申请。所以在这一层做申请认证，人造适合。这样这须要编写一次代码，在这一层过滤结束，再转发给上面的 API。

所以 API 网关的通常作用是实现一些通用的性能，如申请认证，申请记录，申请限流，黑白名单判断等。

API 网关是一个服务器，是零碎的惟一入口。

API 网关形式的外围要点是，所有的客户端和生产端都通过对立的网关接入微服务，在网关层解决所有的非业务性能。通常，网关提供 REST/HTTP 的拜访 API。

2.Spring Cloud Gateway 介绍

Spring Cloud Gateway 是 Spring Cloud 的新一代 API 网关，基于 WebFlux 框架实现，它旨在为微服务架构提供一种简略而无效的对立的 API 路由治理形式。

Spring Cloud Gateway 作为 Spring Cloud 生态系统中的网关，指标是代替 Netflix ZUUL，具备更好的性能、更强的扩展性、以及更丰盛的性能个性，其不仅提供对立的路由形式，并且基于 Filter 链的形式提供了网关根本的性能，例如: 平安，监控 / 埋点，限流等。

3.Spring Cloud Gateway 的个性

  • 基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0
  • 动静路由：可能匹配任何申请属性
  • 能够对路由指定 Predicate 和 Filter
  • 集成 Hystrix 断路器
  • 集成 Spring Cloud DiscoveryClient 服务发现性能
  • 易于编写的 Predicate 和 Filter
  • 申请限流
  • 反对门路重写

4.Spring Cloud Gateway 的三大外围概念

路由(Route)： 路由是网关最根底的局部，路由信息由一个 ID，一个指标 URI，一组断言和过滤器组成。路由断言 Predicate 用于匹配申请，过滤器 Filter 用于批改申请和响应。如果断言为 true，则阐明申请 URI 和配置匹配，则执行路由。

spring:
  cloud:
    gateway:
      # 定义多个路由
      routes:
      # 一个路由 route 的 id
      - id: path_route
        # 该路由转发的指标 URI
        uri: https://example.org
        # 路由条件汇合
        predicates:
        - Path=/test/**
        # 过滤器汇合
        filters:
        - AddRequestHeader=X-Request-Id, 1024
        - AddRequestParameter=color, red

断言(Predicate)： 参考 Java8 中的断言 Predicate，用于实现申请匹配逻辑，例如匹配门路、申请头、申请参数等。申请与断言匹配则执行该路由。

过滤器 (Filter)： 指的是 Spring 框架中GatewayFilter 的实例，应用过滤器，能够在申请被路由前后对申请进行批改。

5.Gateway 工作流程

客户端向 Spring Cloud Gateway 发出请求，而后在 Gateway Handler Mapping 中找到与申请相匹配的路由，将其发送到Gateway Web Handler。Handler 再通过指定的过滤器链来对申请进行过滤解决，最初发送到咱们理论的服务执行业务逻辑，而后返回。

过滤器链被虚线分隔，是因为过滤器既能够在转发申请前拦挡申请，也能够在申请解决之后对响应进行拦挡解决。

举荐一个开源收费的 Spring Boot 实战我的项目：

https://github.com/javastacks/spring-boot-best-practice

6.Gateway 外围配置

依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

启动类

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

}

application.yml

spring: 
  application:
    name: cloud-gateway 
  cloud:
    gateway:
      routes:
      # 路由的 ID，没有固定规定但要求惟一，倡议配合服务名
      - id: config_route
       # 匹配后提供服务的路由地址
        uri: http://ityouknow.com
        # 断言，门路相匹配的条件
        predicates:
        - Path=/routeconfig/rest/**
      - id: header_route
        uri: http://ityouknow.com
        predicates:
        - Header=X-Request-Id, \d+

7. 动静路由

网关接管内部申请，依照肯定的规定，将申请转发给其余服务或者利用。如果站在服务调用的角度，网关就扮演着服务消费者的角色，此时，如果再来看看服务调用的指标 URI 配置，就会很天然的发现一个问题，服务提供者调用的地址是写死的，即网关没有动静的发现服务，这就波及到了服务的主动发现问题，以及发现服务后，所波及到的服务调用的负载平衡的问题。

能够通过 Nacos 或者 Eureka 注册核心动静发现服务，通过 Ribbon 进行服务调用的负载平衡。同样，Gateway 也能够整合 Nacos 或者 Eureka，Ribbon 从而实现动静路由的性能。

想要应用动静路由的性能，首先要整合注册核心，这里以 Nacos 为例

<!--SpringCloud ailibaba nacos -->
<dependency>
 <groupId>com.alibaba.cloud</groupId>
 <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
spring:
  application:
    name: cloud-gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      routes:
        #路由的 ID，没有固定规定但要求惟一，倡议配合服务名
        - id: config_route
  #匹配后提供服务的路由地址, 这里 lb 之后，跟的是要调用的服务名称
          uri: lb://nacos-provider-8002
  # 断言，门路相匹配的条件
          predicates:
            - Path=/routeconfig/rest/**

此时，当 id 为 config_route 的路由规定匹配某个申请后，在调用该申请对应的服务时，就会从 nacos 注册核心主动发现服务，并在服务调用的时候实现负载平衡。

8.Predicate

在 Gateway 中，有一些的内置Predicate Factory，有了这些Pridicate Factory，在运行时，Gateway 会 主动依据须要创立其对应的 Pridicate 对象测试路由条件。

Path 路由断言 Factory： 依据申请门路匹配的路由条件工厂

spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: https://example.org
        predicates:
        # 如果能够匹配的 PathPattern 有多个，则每个门路模式以，离开
        - Path=/red/{segment},/blue/{segment}

After 路由断言 Factory： 在指定日期工夫之后产生的申请都将被匹配

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

Cookie 路由断言 Factory： Cookie 路由断言 Factory 有两个参数，cookie 名称和正则表达式。申请蕴含此 cookie 名称且正则表达式为真的将会被匹配。

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: https://example.org
        predicates:
        - Cookie=chocolate, ch.p

Header 路由断言 Factory： Header 路由断言 Factory 有两个参数，header 名称和正则表达式。申请蕴含此 header 名称且正则表达式为真的将会被匹配。

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+

Host 路由断言 Factory： Host 路由断言 Factory 包含一个参数：host name 列表。应用 Ant 门路匹配规定，. 作为分隔符。

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: https://example.org
        predicates:
        - Host=**.somehost.org,**.anotherhost.org

Method 路由断言 Factory： Method 路由断言 Factory 只蕴含一个参数：须要匹配的 HTTP 申请形式

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: https://example.org
        predicates:
        - Method=GET

自定义 Predicate

能够自定义 Predicate 来实现简单的路由匹配规定:

// 实现自定义 Predicate 工厂
// 通过 HostRoutePredicateFactory 创立 Predicate 进行路由判断
@Component
public class MyHostRoutePredicateFactory extends AbstractRoutePredicateFactory<MyHostRoutePredicateFactory.Config> {public MyHostRoutePredicateFactory() {
      // Config 类作为 Predicate 的配置参数类
      super(Config.class);
  }

  public static class Config {
      // 路由匹配规定
      private String hostName;

      public String getHostName() {return hostName;}

      public void setHostName(String hostName) {this.hostName = hostName;}
  }

  // 生成一个 Predicate 实例
  @Override
  public Predicate<ServerWebExchange> apply(Config config) {
      // 实现匹配逻辑
      return exchange -> {
          // 依据 config 实现匹配判断
          
          String host = exchange.getRequest().getURI().getHost();
          // 匹配配置中的域名
          return host.equals(config.getHostName());
      };
  } 

}

// 应用
RouteLocator locator = new RouteLocatorBuilder(router)
  .routes()
  .route("test_route", r -> r.path("/test")
  .filters(f -> f.filter(new MyHostRoutePredicateFactory.Config("www.test.com")))
  .uri("http://localhost:8080"))
  .build();

9. 自定义 Filter

能够通过实现 GatewayFilter 和 Ordered 接口自定义 Filter 来实现申请解决逻辑:

@Component
public class TokenFilter implements GatewayFilter, Ordered {

   @Override
   public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
      // 申请解决逻辑
      log.info("申请门路:"+ exchange.getRequest().getPath());
      
      ServerHttpRequest request = exchange.getRequest();
   MultiValueMap<String, HttpCookie> cookies = request.getCookies();
   List<HttpCookie> tokens = cookies.get("access_token");
   if (tokens == null || tokens.size() == 0) {throw new RuntimeException("少了 cookie！");
   }
      
      return chain.filter(exchange);
   }

   @Override
   public int getOrder() {return 0;}

}

10. 默认过滤器

Spring Cloud Gateway 内置了多种过滤器, 例如:

  • AddRequestHeader GatewayFilter: 在申请头中增加参数
  • PrefixPath GatewayFilter: 申请门路前缀
  • Hystrix GatewayFilter: 断路器
  • RateLimit GatewayFilter: 限流
  • Retry GatewayFilter: 重试

起源：blog.csdn.net/Cristiano272/article/details/131814765

近期热文举荐：

1.1,000+ 道 Java 面试题及答案整顿(2022 最新版)

2. 劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4. 别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！

5.《Java 开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞 + 转发哦！

正文完
java
发表至： java
2023-09-11
 0
关于java:jvm类文件结构
回怼文章为什么甲骨文被裁员不值得同情
关于java:Soul-学习笔记搭建编译项目一
关于java:MyBatisPlus-通用查询工具类