从零开始的Spring Cloud Gateway指南：构建强大微服务架构

目录

• 一、 什么是Gateway？
• • 1. ***的由来
  • 2. ***的作用
  • 3. ***的技术实现
• 二、如何搭建一个简易***服务
• • 1. 引入依赖
  • 2. 配置yml文件
• 三、进阶话题：过滤器和路由配置
• • 1. gateway的执行原理
  • 2. 路由断言工厂: Predicate Factory
  • 3. ***过滤器：GatewayFilter
  • • 自定义***过滤器
  • 4. 默认过滤器：default Filter
  • 5. 全局过滤器：GlobalFilter
  • 6. 过滤器的执行顺序
  • 7. GlobalFilter和GatewayFilter的区别
• 四、实战经验分享：处理微服务间通信
• • 1. 跨域问题处理
  • 2. 504 Gateway Timeout ***超时处理
  • 3. ***统一异常处理

微服务架构的兴起已经改变了软件开发的面貌，使得开发者能够更灵活地构建、部署和维护应用程序。而在这个微服务的时代，强大而灵活的***是确保微服务之间通信顺畅的关键之一。在本文中，我们将深入研究Spring Cloud Gateway，一款开源的、基于Spring Framework的微服务***，带领你从零开始构建强大的微服务架构。

一、 什么是Gateway？

1. ***的由来

单体应用拆分成多个服务后，对外需要一个统一入口，解耦客户端与内部服务
注：图片来自网络

2. ***的作用

Spring Cloud Gateway是Spring Cloud生态系统中的一员，它被设计用于处理所有微服务的入口流量。作为一个反向代理，它不仅提供了负载均衡和路由功能，还支持灵活的过滤器机制，过滤器可以在请求进入***和离开***时执行，用于处理各种逻辑，如身份验证、日志记录和性能监测，使得开发者能够定制和扩展其功能。

***核心功能是路由转发，因此不要有耗时操作在***上处理，让请求快速转发到后端服务上。

注：图片来自网络

3. ***的技术实现

在SpringCloud中***的实现包括两种:

• gateway
• zuul

Zuul 是基于Servlet的实现，在1.x版本属于阻塞式编程，在2.x后是基于netty，是非阻塞的。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

目前一般都选用SpringCloudGateway，毕竟都是Spring家族一员，支持性更好。

二、如何搭建一个简易***服务

1. 引入依赖

需要先搭建一个SpringBoot项目，在父pom中引入依赖

<properties>         <spring-cloud.version>2021.0.1</spring-cloud.version>         <spring-cloud-alibaba.version>2021.0.1.0</spring-cloud-alibaba.version>     </properties>      <dependencyManagement>         <dependencies>             <!-- SpringCloud 微服务 -->             <dependency>                 <groupId>org.springframework.cloud</groupId>                 <artifactId>spring-cloud-dependencies</artifactId>                 <version>${spring-cloud.version}</version>                 <type>pom</type>                 <scope>import</scope>             </dependency>              <!-- SpringCloud Alibaba 微服务 -->             <dependency>                 <groupId>com.alibaba.cloud</groupId>                 <artifactId>spring-cloud-alibaba-dependencies</artifactId>                 <version>${spring-cloud-alibaba.version}</version>                 <type>pom</type>                 <scope>import</scope>             </dependency>      </dependencyManagement> 

在gateway服务中引入相关依赖

<dependencies>         <!--spring cloud gateway-->         <dependency>             <groupId>org.springframework.cloud</groupId>             <artifactId>spring-cloud-starter-gateway</artifactId>         </dependency>         <!--nacos 服务发现-->         <dependency>             <groupId>com.alibaba.cloud</groupId>             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>         </dependency>      </dependencies> 

此外，请检查一下你的依赖中是否含有spring-boot-starter-web，如果有， 请干掉它 。因为我们的SpringCloud Gateway是一个netty+webflux实现的web服务器，和Springboot Web本身就是冲突的。

2. 配置yml文件

server:   port: 8081 # ***端口 spring:   application:     name: gateway # 服务名称   cloud:     nacos:       server-addr: 127.0.0.1:8848 # nacos地址     gateway:       routes: # ***路由配置         - id: baidu # 路由id, 自定义，较早即可           # uri: 127.0.0.1:/order # - 路由目的地，支持lb和http两种           uri: lb://orderService # 路由的目的地，lb是负载均衡，后面跟服务名称           predicates: # 路由断言，也就是判断是否符合路由规则的条件             - Path=/order-service/** # path 按照路径进行匹配，只要以/order-service/开头就符合规则           filters:             - StripPrefix=1 # 过滤器，去除请求的前缀路径，StripPrefix=1 表示去除请求路径的靠前个路径片段 

***路由可以配置的内容包括：

• 路由id:路由较早标示
• uri: 路由目的地，支持lb和http两种
• predicates: 路由断言，判断请求是否符合要求，符合则转发到路由目的地
• filters:路由过滤器，处理请求或响应

做到这里，一个简易的路由转发***服务就搭建成功了，直接运行GatewayApplication服务，得到结果如图：

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到 Gateway Web Handler。Handler 再通过指 定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前（“pre”）或之后（“post”）执行业务逻辑。
Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。

2. 路由断言工厂: Predicate Factory

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件。

例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。

像这样的断言工厂在SpringCloudGateway还有十几个：

在上图中，有很多类型的Predicate。
比如说时间类型的Predicated（AfterRoutePredicateFactory、 BeforeRoutePredicateFactory、BetweenRoutePredicateFactory），当只有满足特定时间要求的请求才会交由router处理；

spring:   cloud:     gateway:       routes: # ***路由配置         - id: order           uri: lb://orderService            predicates:              - Before=2023-12-25T14:33:47.789+08:00 

这个路由规则会在东8区的2023-12-25 14:33:47后，将请求转跳到订单服务。

cookie类型的CookieRoutePredicateFactory，cookie名字和正则表达式的value作为两个输入参数，请求的cookie需要匹配cookie名和符合其中value的正则，才会进入此router;

spring:   cloud:     gateway:       routes: # ***路由配置         - id: order           uri: lb://orderService            predicates:              - Cookie=cookiename, cookievalue 

路由匹配请求存在cookie名为cookiename，cookie内容匹配cookievalue的，将请求转发到订单服务。

以及host、method、path、querparam、remoteaddr类型的predicate，每一种predicate都会对当前的客户端请求进行判断，是否满足当前的要求，如果满足则交给当前请求处理。

如果有很多个Predicate，并且一个请求满足多个Predicate，则按照配置的顺序靠前个生效。

请注意：一个请求满足多个路由的谓词条件时，请求只会被比较早的成功匹配的路由转发。

3. ***过滤器：GatewayFilter

GatewayFilter是***中提供的一种过滤器，可以对进入***的请求和微服务返回的响应做处理

针对某些特殊的场景，Spring Cloud Gateway提供了31种不同的路由过滤器工厂。例如

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器>GlobalFilter的顺序执行

可以参考下面几个类的源码查看：

7. GlobalFilter和GatewayFilter的区别

Spring Cloud Gateway 根据作用范围划分为 GatewayFilter 和 GlobalFilter，二者区别如下：

• GatewayFilter：***过滤器，需要通过 spring.cloud.routes.filters 配置在具体路由下，只作用在当前路由上或通过 spring.cloud.default-filters 配置在全局，作用在所有路由上。
• GlobalFilter：全局过滤器，不需要在配置文件中配置，作用在所有的路由上，最终通过 GatewayFilterAdapter 包装成 GatewayFilterChain 可识别的过滤器，它为请求业务以及路由的 URI 转换为真实业务服务请求地址的核心过滤器，不需要配置系统初始化时加载，并作用在每个路由上。

四、实战经验分享：处理微服务间通信

1. 跨域问题处理

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题。它是由浏览器的同源策略所造成的，是浏览器对于JavaScript所定义的安全限制策略。

同源策略：是指协议，域名，端口都要相同，其中有一个不同都会产生跨域。

• 同一协议， 如http或https
• 同一IP地址或域名, 如127.0.0.1
• 同一端口, 如8080

例如：

• 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com
• 域名相同，端口不同: localhost:8080和localhost:8081

解决方案：

跨源资源共享 (CORS)：（或通俗地译为跨域资源共享）是一种基于 HTTP 头的机制，该机制通过允许服务器标示除了它自己以外的其它origin（域，协议和端口），这样浏览器可以访问加载这些资源。现代浏览器支持在 API 容器中（例如 XMLHttpRequest 或 Fetch）使用 CORS，以降低跨源 HTTP 请求所带来的风险。

***处理跨域采用的同样是CORS方案，并且只需要简单配置即可实现。

CORS跨域要配置的参数包括：

• 允许哪些域名跨域?
• 允许哪些请求头?
• 允许哪些请求方式?
• 是否允许使用cookie?
• 有效期是多久?

spring:    cloud:     gateway:       globalcors: # 全局跨域处理       add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题         cors-configurations:           '[/**]':             # 允许跨域的源(网站域名/ip)，设置*为全部             # 允许跨域请求里的head字段，设置*为全部             # 允许跨域的method， 默认为GET和OPTIONS，设置*为全部             allow-credentials: true # 是否允许携带cookie             allowed-origins: # 运行的跨域请求的网站               - "http://taobao.123.com"               - "http://www.xx.com"             allowed-headers: "*" # 允许在请求中携带的头信息             allowed-methods: # 允许跨域ajax请求方式               - OPTIONS               - GET               - POST               - ｄｅｌｅｔｅ               - PUT               - PATCH             max-age: 36000  # 跨域检测的有效期  

2. 504 Gateway Timeout ***超时处理

504 Gateway Timeout 错误是一个 HTTP 状态码，表示***或代理服务器在尝试从上游服务器（如 Web 服务器或另一个代理）获取响应时，等待的时间超过了指定的超时限制。

在 Spring Cloud Gateway 中，这个错误通常是由以下原因引起的：

1. 上游服务响应缓慢：上游服务（可能是您的微服务或其他后端服务）可能由于性能问题、资源瓶颈或处理逻辑复杂而响应缓慢。
2. 网络问题：网络延迟或不稳定也可能导致请求在传输过程中花费的时间超过预期。
3. 配置不当：Spring Cloud Gateway 的超时配置可能设置得太低，不适合您的应用或服务。

为了解决这个问题，您可以尝试以下步骤：

1. 检查上游服务：确保上游服务正在运行并且性能良好。您可以使用工具（如 Prometheus、Grafana、JMeter 等）来监控和分析服务的性能和响应时间。
2. 增加超时时间：在 Spring Cloud Gateway 的配置中增加超时时间。您可以在配置文件中（如 application.yml 或 application.properties）设置 spring.cloud.gateway.httpclient 相关的属性来调整超时时间。
   例如，在 application.yml 中：

spring:     cloud:       gateway:         # 设置全局超时时间       httpclient:           connect-timeout: 1000 # 连接超时时间，单位毫秒           response-timeout: 5000 # 响应超时时间，单位毫秒   # 配置路由规则       routes:         - id: lucky-blog-admin           # 采用 LoadBalanceClient 方式请求，以 lb:// 开头，后面的是注册在 Nacos 上的服务名           uri: lb://lucky-blog-admin           predicates:             # 路径匹配，以 api 开头，直接配置是不生效的，看 filters 配置             - Path=/api/**           filters:             # 此处配置去掉 1 个路径前缀，再配置上面的 Path=/api/**，就能按照 http://localhost:8888/api/** 的方式访问了             - StripPrefix=1           # 设置当前路由超时时间           metadata:             response-timeout: 10000 # 连接超时时间，单位毫秒               connect-timeout: 10000 # 响应超时时间，单位毫秒 

3. ***统一异常处理

我们在通过gateway进行路由转发时，可能会遇到各种的问题，通过统一异常处理器，可以将不同的异常进行集中式处理和管理。在开发或者使用过程中报错时，可以更加清晰明了的发现错误提示信息，方便更快地理解和解决问题，还可以优化用户体验并降低维护成本。

自定义异常处理器方式：
可以通过实现ErrorWebExceptionHandler接口来自定义异常处理器，对全局异常进行统一处理。
在这个处理器中，可以根据异常的类型、状态码等信息，返回不同的响应结果给前端。

import com.alibaba.fastjson.JSON; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.web.reactive.error.ErrorWebExceptionHandler; import org.springframework.cloud.gateway.support.NotFoundException; import org.springframework.context.annotation.Configuration; import org.springframework.core.annotation.Order; import org.springframework.core.io.buffer.DataBuffer; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.server.reactive.ServerHttpResponse; import org.springframework.web.server.ResponseStatusException; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; import com.fd.luckyblog.gateway.result.ResultEntity;  /**  * ***统一异常处理  */ @Order(-1) @Configuration public class GatewayExceptionHandler implements ErrorWebExceptionHandler {     private static final Logger log = LoggerFactory.getLogger(GatewayExceptionHandler.class);      @Override     public Mono<Void> handle(ServerWebExchange exchange, Throwable ex)     {         ServerHttpResponse response = exchange.getResponse();          # 首先检查响应是否已经提交（即是否已经发送给客户端）。如果已提交，则直接返回包含异常的Mono。         if (exchange.getResponse().isCommitted())         {             return Mono.error(ex);         }          String msg = "";          if (ex instanceof NotFoundException)         {             msg = "服务器迷路啦，30秒后再重试一下. O(∩_∩)O ";         }         else if (ex instanceof ResponseStatusException)         {             ResponseStatusException responseStatusException = (ResponseStatusException) ex;             msg = responseStatusException.getMessage();         }         else         {             msg = "内部服务器异常，请联系管理员";         }          log.error("[***异常处理]请求路径:{},异常信息:{}", exchange.getRequest().getPath(), ex.getMessage());          return webFluxResponseWriter(response, MediaType.APPLICATION_JSON_VALUE, HttpStatus.OK, msg);     }      /**      * 设置webflux模型响应      *      * @param response ServerHttpResponse      * @param contentType content-type      * @param status http状态码      * @param value 响应内容      * @return Mono<Void>      */     public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, String contentType, HttpStatus status, Object value)     {         response.setStatusCode(status);         response.getHeaders().add(HttpHeaders.CONTENT_TYPE, contentType);         # 通用的响应实体类，使用自己定义的通用返回类就行         ResultEntity<?> result = ResultEntity.failed(value.toString());         DataBuffer dataBuffer = response.bufferFactory().wrap(JSON.toJSONString(result).getBytes());         return response.writeWith(Mono.just(dataBuffer));     } } 

微服务网关