1.什么是网关

API 网关是一个搭建在客户端和微服务之间的服务，我们可以在 API 网关中处理一些非业务功能的逻辑，例如权限验证、监控、缓存、请求路由等。

网关的核心作用就是路由转发 API 网关就像整个微服务系统的门面一样，是系统对外的唯一入口。有了它，客户端会先将请求发送到 API 网关，然后由 API 网关根据请求的标识信息将请求转发到微服务实例。如下图：

2. 为什么要网关

在微服务架构中，一个系统往往由多个微服务组成，而这些服务可能部署在不同机房、不同地区、不同域名下。这种情况下，客户端（例如浏览器、手机、软件工具等）想要直接请求这些服务，就需要知道它们具体的地址信息，例如 IP 地址、端口号等。这种客户端直接请求服务的方式存在以下问题：

●当服务数量众多时，客户端需要维护大量的服务地址，这对于客户端来说，是非常繁琐复杂的。

●在某些场景下可能会存在跨域请求的问题。

●身份认证的难度大，每个微服务需要独立认证。

我们可以通过 API 网关来解决这些问题

3. 网关的优点

对于服务数量众多、复杂度较高、规模比较大的系统来说，使用 API 网关具有以下好处：

• 客户端通过 API 网关与微服务交互时，客户端只需要知道 API 网关地址即可，而不需要维护大量的服务地址，简化了客户端的开发。

• 客户端直接与 API 网关通信，能够减少客户端与各个服务的交互次数。

• 客户端与后端的服务耦合度降低。

• 节省流量，提高性能，提升用户体验。

• API 网关还提供了安全、流控、过滤、缓存、计费以及监控等 API 管理功能。

4. 网关的种类

1Spring Cloud Gateway

2Spring Cloud Netflix Zuul

3Kong

4Nginx+Lua

5Traefik

5. Spring Cloud Gateway

5.1 什么是Spring Cloud Gateway

Spring Cloud Gateway 是 Spring Cloud 团队基于 Spring 5.0、Spring Boot 2.0 和 Project Reactor 等技术开发的高性能 API 网关组件。Spring Cloud Gateway 旨在提供一种简单而有效的途径来发送 API，并为它们提供横切关注点，例如：安全性，监控/指标和弹性。

Spring Cloud Gateway 是基于 WebFlux响应式编程框架实现的，而 WebFlux 框架底层则使用了高性能的 Reactor 模式通信框架 Netty。

5.2 Spring Cloud Gateway的核心概念

注意：其中 Route 和 Predicate 必须同时声明。

5.3 Spring Cloud Gateway的特征

• 基于 Spring Framework 5、Project Reactor 和 Spring Boot 2.0 构建。

• 能够在任意请求属性上匹配路由。

• predicates（断言） 和 filters（过滤器）是特定于路由的。

• 集成了 Hystrix 熔断器。

• 集成了 Spring Cloud DiscoveryClient（服务发现客户端）。

• 易于编写断言和过滤器。

• 能够限制请求频率。

• 能够重写请求路径。

5.4 Spring Cloud Gateway工作流程

• 客户端将请求发送到 Spring Cloud Gateway 上。

• Spring Cloud Gateway 通过 Gateway Handler Mapping 找到与请求相匹配的路由，将其发送给 Gateway Web Handler。

• Gateway Web Handler 通过指定的过滤器链（Filter Chain），将请求转发到实际的服务节点中，执行业务逻辑返回响应结果。

• 过滤器之间用虚线分开是因为过滤器可能会在转发请求之前（pre）或之后（post）执行业务逻辑。

• 过滤器（Filter）可以在请求被转发到服务端前，对请求进行拦截和修改，例如参数校验、权限校验、流量监控、日志输出以及协议转换等。

• 过滤器可以在响应返回客户端之前，对响应进行拦截和再处理，例如修改响应内容或响应头、日志输出、流量监控等。

• 响应原路返回给客户端。

• 

总而言之，客户端发送到 Spring Cloud Gateway 的请求需要通过一定的匹配条件，才能定位到真正的服务节点。在将请求转发到服务进行处理的过程前后（pre 和 post），我们还可以对请求和响应进行一些精细化控制。Predicate 就是路由的匹配条件，而 Filter 就是对请求和响应进行精细化控制的工具。有了这两个元素，再加上目标 URI，就可以实现一个具体的路由了。

6. Predicate 断言

Spring Cloud Gateway 通过 Predicate 断言来实现 Route 路由的匹配规则。简单点说，Predicate 是路由转发的判断条件，请求只有满足了 Predicate 的条件，才会被转发到指定的服务上进行处理。使用 Predicate 断言需要注意以下 3 点：

• Route 路由与 Predicate 断言的对应关系为“一对多”，一个路由可以包含多个不同断言。

• 一个请求想要转发到指定的路由上，就必须同时匹配路由上的所有断言。

• 当一个请求同时满足多个路由的断言条件时，请求只会被首个成功匹配的路由转发。

常见的 Predicate 断言如下表：

7. 动态路由实现简单的路由服务器

引入依赖

<!--特别注意：在 gateway 网关服务中不能引入 spring-boot-starter-web 的依赖，否则会报错-->
<!-- Spring cloud gateway 网关依赖-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

编写配置文件

server:
  port: 9527

spring:
  application:
    name: gateway
  cloud:
    gateway: #网关路由配置
      routes:
        #将service5提供的服务隐藏起来，不暴露给客户端，只给客户端暴露API网关的地址9527
        - id: service5_routh   #路由id,没有固定规则，但唯一，建议与服务名对应
          uri: lb://service5   #动态路由匹配后提供服务的路由地址：lb://${服务名}
          predicates:
            #以下是断言条件，必选全部符合条件
            - Path=/api/v1/service5/**               #断言，路径匹配 注意：Path 中 P 为大写

eureka:
  instance:
    instance-id: spring-cloud-gateway
    prefer-ip-address: true
    lease-expiration-duration-in-seconds: 15  #服务过期时间，如果超过这个时间没有检测到心跳，就将这个实例剔除
    lease-renewal-interval-in-seconds: 5  #client发送心跳给server端的频率
  client:
    registry-fetch-interval-seconds: 5
    service-url:
      defaultZone: http://eureka1001.com:1001/eureka/,http://eureka2001.com:2001/eureka/

默认情况下，Spring Cloud Gateway 会根据服务注册中心（例如 Eureka Server）中维护的服务列表，以服务名（spring.application.name）作为路径创建动态路由进行转发，从而实现动态路由功能。

我们可以在配置文件中，将 Route 的 uri 地址修改为以下形式：lb://service-name 以上配置说明如下：

• lb（loadBalance）：uri 的协议，表示开启 Spring Cloud Gateway 的负载均衡功能。

• service-name：服务名，Spring Cloud Gateway 会根据它获取到具体的微服务地址

启动类添加注解

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

8. Filter 过滤器

通常情况下，出于安全方面的考虑，服务端提供的服务往往都会有一定的校验逻辑，例如用户登录状态校验、签名校验等。在微服务架构中，系统由多个微服务组成，所有这些服务都需要这些校验逻辑，此时我们就可以将这些校验逻辑写到 Spring Cloud Gateway 的 Filter 过滤器中。

Filter 的分类

Spring Cloud Gateway 提供了以下两种类型的过滤器，可以对请求和响应进行精细化控制。

按照作用范围划分，Spring Cloud gateway 的 Filter 可以分为 2 类：

●GatewayFilter：应用在单个路由或者一组路由上的过滤器。

●GlobalFilter：应用在所有的路由上的过滤器。

GatewayFilter 网关过滤器

GatewayFilter 是 Spring Cloud Gateway 网关中提供的一种应用在单个或一组路由上的过滤器。它可以对单个路由或者一组路由上传入的请求和传出响应进行拦截，并实现一些与业务无关的功能，比如登陆状态校验、签名校验、权限校验、日志输出、流量监控等。

GatewayFilter 在配置文件（例如 application.yml）中的写法与 Predicate 类似，格式如下:

spring:
  cloud:
    gateway: 
      routes:
        - id: xxxx
          uri: xxxx
          predicates:
            - Path=xxxx
          filters:
            - AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹配的请求头加上一对请求头，名称为 X-Request-Id 值为 1024
            - PrefixPath=/dept #在请求路径前面加上 /dept
            ……

Spring Cloud Gateway 内置了多达 31 种 GatewayFilter，下表中列举了几种常用的网关过滤器及其使用示例。

GlobalFilter 全局过滤器

GlobalFilter 是一种作用于所有的路由上的全局过滤器，通过它，我们可以实现一些统一化的业务功能，例如权限认证、IP 访问限制等。当某个请求被路由匹配时，那么所有的 GlobalFilter 会和该路由自身配置的 GatewayFilter 组合成一个过滤器链。Spring Cloud Gateway 为我们提供了多种默认的 GlobalFilter，例如与转发、路由、负载均衡等相关的全局过滤器。但在实际的项目开发中，通常我们都会自定义一些自己的 GlobalFilter 全局过滤器以满足我们自身的业务需求，而很少直接使用 Spring Cloud  Config 提供这些默认的 GlobalFilter。

关于默认的全局过滤器的详细内容，请参考 Spring Cloud 官网。

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters

9. 全局过滤器的各种姿势

9.1 白名单路由、获取请求URL参数

@Component
public class GlobalFilter1 implements GlobalFilter, Ordered {

    @Override
    public int getOrder() {
        return Integer.MIN_VALUE;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        System.out.println("通过参数过滤器");

        //1.对于特定路由的放行逻辑
        URI uri = exchange.getRequest().getURI();
        if ("/api/v1/service8".equals(uri.getPath())) {
            return chain.filter(exchange);
        }

        //2.获取URL参数
        MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams();

        //3.其他路由进行权限校验
        if (null == queryParams.get("p1")) {
            exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
            return exchange.getResponse().writeWith(Flux.just(exchange.getResponse().bufferFactory()
                    .wrap("请填写请求参数p1".getBytes())));
        } else {
            return chain.filter(exchange);
        }
    }
}

PS：

• getOrder方法可以用于指定当前filter在执行链路的顺序，整个链路按照Order由小到大的顺序执行

• 对于白名单链路放行，整个filter链路都要编写放行逻辑

9.2 获取请求体参数

@Component
public class GatewayFilter2 implements GatewayFilter, Ordered {

    @Override
    public int getOrder() {
        return Integer.MIN_VALUE + 1;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        System.out.println("通过特定过滤器2");

        //1.获取POST请求体参数
        Mono<Void> postBody = DataBufferUtils.join(exchange.getRequest().getBody()).flatMap(dataBuffer -> {

            //2.获取请求体参数
            byte[] bytes = new byte[dataBuffer.readableByteCount()];
            dataBuffer.read(bytes);
            String bodyString = new String(bytes, StandardCharsets.UTF_8);

            //TODO 3.在这里可以对请求体参数为所欲为了
            System.out.println("bodyString:" + bodyString);

            //4.释放内存
            DataBufferUtils.release(dataBuffer);

            //5.以下操作为了将请求体再次封装写回到request里
            exchange.getAttributes().put("POST_BODY", bodyString);
            Flux<DataBuffer> cachedFlux = Flux.defer(() -> {
                DataBuffer buffer = exchange.getResponse().bufferFactory().wrap(bytes);
                return Mono.just(buffer);
            });

            //6.将请求体再次封装写回到request里，传到下一级，否则，由于请求体已被消费，后续的服务将取不到值
            ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
                @Override
                public Flux<DataBuffer> getBody() {
                    return cachedFlux;
                }
            };

            //7.封装request，传给下一级
            return chain.filter(exchange.mutate().request(mutatedRequest).build());
        });

        //8.返回
        return postBody;
    }
}

9.3 为某个路由或某一组路由定制专属过滤器

@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator appRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes().route(r -> r.path("/api/v1/service5/**")
                .filters(f -> f.filter(new GatewayFilter2()))
                .uri("lb://service5")
                .id("service5_routh"))
                .build();
    }
}

9.4 处理请求响应

@Component
public class AfterGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public int getOrder() {
        return NettyWriteResponseFilter.WRITE_RESPONSE_FILTER_ORDER;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        //1.获取字节工厂
        DataBufferFactory bufferFactory = exchange.getResponse().bufferFactory();

        //3.获取响应体
        final ServerHttpResponseDecorator serverHttpResponseDecorator = new ServerHttpResponseDecorator(exchange.getResponse()) {
            @Override
            public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
                if (body instanceof Flux) {

                    //4.返回响应
                    Flux<? extends DataBuffer> fluxBody = (Flux<? extends DataBuffer>) body;
                    return super.writeWith(fluxBody.map(dataBuffer -> {

                        //5.读取字节
                        byte[] content = new byte[dataBuffer.readableByteCount()];
                        dataBuffer.read(content);

                        //6.释放掉内存
                        DataBufferUtils.release(dataBuffer);

                        //7.这段代码我们可以自由发挥
                        String responseStr = new String(content, StandardCharsets.UTF_8);
                        super.setStatusCode(HttpStatus.valueOf(Integer.parseInt(responseStr)));

                        //8.返回
                        return bufferFactory.wrap(content);
                    }));
                }

                return super.writeWith(body);
            }
        };

        //2.返回
        System.out.println("通过响应过滤器");
        return chain.filter(exchange.mutate().response(serverHttpResponseDecorator).build());
    }
}

source: www.yuque.com/u27809381/ca4o9w/ggap14

记得点「赞」和「在看」↓

爱你们