Spring Cloud之API网关（Gateway）

API网关

好处

解决方案

Gateway

简介

特征

核心概念

Route(路由)

Predicate(断言)

Filter(过滤器)

工作流程

Route(路由)

路由配置方式

1.yml配置文件路由

2.bean进行配置

3.动态路由

动态路由

Predicate(断言)

特点

常见断言

示例

Filter(过滤器)

filter分类

Pre 类型

Post 类型

网关过滤器

格式

示例

全局过滤器

示例

在微服务架构中，一个系统由多个微服务组成，而这些服务可能部署在不同的地区、不同的机房，客户端想要连接，就需要知道它们具体的地址信息；

存在问题：

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

2.某些情况下存在跨域请求问题

3.认证难度大，每个微服务需要独立认证

API网关

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

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

好处

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

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

3.客户端与后端的服务耦合度降低

4.节省流量，提高性能，提升用户体验

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

解决方案

1.gateway

2.zuul

3.kong

4.Nginx+Lua

Gateway

简介

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

特征

1.基于 Spring Framework 5、Project Reactor 和 Spring Boot 2.0 构建

2.任意请求属性上匹配路由

3.断言和过滤器是特定于路由的

4.集成了 Hystrix 熔断器

5.集成了 Spring Cloud DiscoveryClient（服务发现客户端）

6.易于编写断言和过滤器

7.能够限制请求频率

8.能够重写请求路径

核心概念

gateway最主要的功能就是路由转发，而在定义转发规则时主要涉及到三个核心概念

Route(路由)

网关最基本的模块。它由一个 ID、一个目标 URI、一组断言（Predicate）和一组过滤器（Filter）组成

Predicate(断言)

路由转发的判断条件，我们可以通过 Predicate 对 HTTP 请求进行匹配，例如请求方式、请求路径、请求头、参数等，如果请求与断言匹配成功，则将请求转发到相应的服务。

Filter(过滤器)

我们可以使用它对请求进行拦截和修改，还可以使用它对上文的响应进行再处理

工作流程

说明：

1.客户端将请求发送到gateway

2.gateway通过gateway Handler Mapping找到相匹配得到路由，将其发送给gateway web Handler

3.gateway web Handler通过指定的过滤器链，将请求转发到实际的服务节点中，执行业务返回响应结果

注意：

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

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

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

Gateway 的请求需要通过一定的匹配条件，才能定位到真正的服务节点。在将请求转发到服务进行处理的过程前后（pre 和 post），我们还可以对请求和响应进行一些精细化控制。

Route(路由)

路由是网关最基础的部分，路由信息由一个ID、一个目的URL、一组断言工厂和一组Filter组成。如果断言为真，则说明请求URL和配置的路由匹配。

格式：

id：我们自定义的路由 ID，保持唯一

uri：目标服务地址

路由配置方式

1.yml配置文件路由

#第一种：ws(websocket)方式: uri: ws://localhost:8888
#第二种：http方式: uri: http://localhost:8888/
#第三种：lb(注册中心中服务名字)方式: uri: lb://consumer
spring:cloud:gateway:routes:# 路由id,没有固定规则，建议配合服务名- id: consumer# 匹配后提供服务的路由地址# 需要注意的是uri的协议为lb，表示启用Gateway的负载均衡功能。lb://serviceName是spring cloud gateway在微服务中自动为我们创建的负载均衡uri。uri: lb://consumerpredicates:# 断言：路径相匹配的进行路由- Path=/**

2.bean进行配置

@Configuration
public class GatewayConfig {@Beanpublic RouteLocator customerRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();// 第一个参数是路由的唯一idroutes.route("consumer",r -> r.path("/hello").uri("http://localhost:8888/hello")).build();return routes.build();}
}

3.动态路由

可以通过服务名进行转发，无需配置routes也可以转发

spring:application:name: gatewaycloud:gateway:discovery:locator:#开启根据微服务名称自动转发enabled: true#小写lower-case-service-id: true

动态路由

默认情况下，Gateway 会根据服务注册中心中维护的服务列表，以服务名作为路径创建动态路由进行转发，从而实现动态路由功能。

形式：

lb://service-name

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

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

Predicate(断言)

Predicate 断言来实现 Route 路由的匹配规则。Predicate 是路由转发的判断条件，请求只有满足了 Predicate 的条件，才会被转发到指定的服务上进行处理；

特点

1.路由与断言的关系为：一对多，一个路由可以包含多个不同断言

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

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

常见断言

示例

配置文件 application.yml中添加配置内容

server:port: 9527  #端口号
spring:application:name: microServiceCloudGatewaycloud:gateway: #网关路由配置routes:#将 micro-service-cloud-provider-dept-8001 提供的服务隐藏起来，不暴露给客户端，只给客户端暴露 API 网关的地址 9527- id: provider_dept_list_routh   #路由 id,没有固定规则，但唯一，建议与服务名对应uri: http://localhost:8001          #匹配后提供服务的路由地址predicates:#以下是断言条件，必选全部符合条件- Path=/dept/list/**               #断言，路径匹配 注意：Path 中 P 为大写- Method=GET #只能时 GET 请求时，才能访问

配置中在 spring.cloud.gateway.routes 下使用 predicates 属性，定义了以下两个断言条件：

- Path=/dept/list/*

-Method=GET

HTTP 请求同时满足以上所有的断言时，该请求才会被转发到指定的服务端中

Filter(过滤器)

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

filter分类

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

Pre 类型

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

Post 类型

这种过滤器在微服务对请求做出响应后可以对响应进行拦截和再处理，例如修改响应内容或响应头、日志输出、流量监控等。

网关过滤器

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

格式

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

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

示例

application.yml 中在添加一个动态路由：

- id: provider_dept_get_routh

        uri: lb://MICROSERVICECLOUDPROVIDERDEPT #使用服务名代替上面的具体带端口         predicates:

                - Path=/get/**

        filters:

                - PrefixPath=/dept #在请求路径上增加一个前缀 /dept

全局过滤器

GlobalFilter 是一种作用于所有的路由上的全局过滤器，通过它，我们可以实现一些统一化的业务功能，例如权限认证、IP 访问限制等。当某个请求被路由匹配时，那么所有的 GlobalFilter 会和该路由自身配置的 GatewayFilter 组合成一个过滤器链；

示例

1.新建一个名为 MyGlobalFilter 全局过滤器配置类

/**
* 自定义全局网关过滤器（GlobalFilter）
*/
@Component
@Slf4j
public class MyGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {log.info("进入自定义的全局过滤器 MyGlobalFilter" + new Date());String uname = exchange.getRequest().getQueryParams().getFirst("uname");if (uname == null) {log.info("参数 uname 不能为 null！");exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);return exchange.getResponse().setComplete();}return chain.filter(exchange);}@Overridepublic int getOrder() {//过滤器的顺序，0 表示第一个return 0;}
}

2.使用浏览器访问“http://eureka7001.com:9527/dept/list”，我们会发现访问报 406 错误