一文搞懂 Gateway 网关搭建、过滤器、断言工厂及跨域问题

顾轻鸿

已于 2023-08-03 14:03:15 修改

阅读量368

点赞数

分类专栏：微服务文章标签： java spring cloud 微服务 gateway

于 2023-08-03 13:59:57 首次发布

本文链接：https://blog.csdn.net/weixin_46209120/article/details/132081906

版权

微服务专栏收录该内容

12 篇文章 2 订阅

订阅专栏

Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

1.为什么需要网关

Gateway网关是我们服务的守门神，所有微服务的统一入口。

网关的核心功能特性：

请求路由==也就是分发，比如有用户服务，订单服务，商品服务，gateway会根据请求分发到不同的服务中。
权限控制==判断用户是否有登录的权限等。
限流==对于某些请求可以进行限制，比如同一个用户某个时间多次请求同一个接口的限制，或者为了微服务不会因为并发太大，而导致服务崩溃而进行的限流。不过微服务中有专门的限流组件---Sentinel

架构图：

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下游的微服务能够接受的速度来放行请求，避免服务压力过大。

在SpringCloud中网关的实现包括两种：

gateway
zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

SpringCloudGateway:
	WebFlux: 框架
        非阻塞IO
    Netty: 服务器

2.gateway快速入门

下面，我们就演示下网关的基本路由功能。基本步骤如下：

创建SpringBoot工程gateway，引入网关依赖
编写启动类
编写基础配置和路由规则
启动网关服务进行测试

1）创建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>

2）编写启动类

package cn.itcast.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class GatewayApplication {

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

3）编写基础配置和路由规则

创建application.yml文件，内容如下：

我们前面引入了nacos服务发现依赖的包后，就可以直接去nacos拉取服务的集群地址了，不需要再另外做负载均衡。

lb：localbalance

predicates：断言的意思

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    #配置nacos地址,网关连接nacos
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          uri: lb://user-service # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

本例中，我们将 /user/**开头的请求，代理到lb://user-service，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

4）启动网关服务测试

访问nacos，可以发现多了一个gateway的服务：

访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://user-service/user/2，得到了结果：

5）网关路由的流程图

整个访问的流程如下：

网关搭建步骤：

创建项目，引入nacos服务发现和gateway依赖
配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

路由id：路由的唯一标示
路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
路由断言（predicates）：判断路由的规则，
路由过滤器（filters）：对请求或响应做处理

接下来，讲下路由断言和路由过滤器的知识

3.网关路由断言工厂

我们前面讲的是根据path做的请求分发（也就是路由），但其实除了path还是很多种方式，还可以根据请求参数、请求头、请求cookie等进行路由。

在spring官网中可以看到目前提供的路由断言工厂：

Spring Cloud Gateway

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

例如Path=/user/**是按照路径匹配，这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的，Path 路由断言工厂接收一个参数，根据 Path 定义好的规则来判断访问的 URI 是否匹配。也可以组合使用多个路由断言工厂，像这样的断言工厂在SpringCloudGateway还有十几个：

名称	说明	示例
After	是某个时间点后的请求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某个时间点之前的请求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某两个时间点之前的请求	- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	请求必须包含某些cookie	- Cookie=chocolate, ch.p
Header	请求必须包含某些header	- Header=X-Request-Id, \d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/{segment},/blue/**
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

常用的路由断言工厂有Path、Header及Method 等。

像Before Route Predicate Factory、After Route Predicate Factory和Between Route Factory也比较有意思，根据官网的描述，他可以配置java时区的某个时间之前、之后或之间的请求，我们可以对这些请求路由到指定的服务器上，那么比如我们有一些特定时间的高并发场景即可以以此作为方案，路由到一些配置高或集群节点多的服务上。

各种断言工厂的配置方式在官网都有例子，小伙伴们有兴趣可以自己去学习一下。

4.网关过滤器工厂

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

4.1.路由过滤器的种类

Spring提供了37种不同的路由过滤器工厂。例如：

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

详见spring官网：

4.2.请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求：给所有进入user-service的请求添加一个请求头：- AddRequestHeader=X-Request-red, blue

AddRequestHeader：工厂名称

X-Request-red：请求头的名称

blue: 请求头的值，名称和值以逗号分割

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://user-service 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=X-Request-red, blue # 添加请求头

当前过滤器配置在user-service的路由下，因此仅仅对访问user-service的请求有效。

测试在UserController中获取请求头：

@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id, HttpServletRequest request) {
    String header = request.getHeader("X-Request-red");
    System.out.println("header = " + header);
   // return userService.queryById(id);
}

重启user-servoce服务,访问http://localhost:10010/user/2，可以发现获取到了blue

4.3.默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=X-Request-red, blue

注意：以上所有配置如果复制我的，但在启动时出错了，可以尝试删除配置文件中的注释，再不行直接去官网copy。

4.4.总结

过滤器的作用是什么？

① 对路由的请求或响应做加工处理，比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

① 对所有路由都生效的过滤器

5.全局过滤器

前面讲的过滤器，网关提供了37种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

5.1.全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中编写自定义逻辑，可以实现下列功能：

登录状态判断
权限校验
请求限流等

5.2.自定义全局过滤器

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

参数中是否有authorization，
authorization参数值是否为admin

如果同时满足则放行，否则拦截

实现：

在gateway中定义一个过滤器AuthorizeFilter：

@Order：顺序定义带注释组件的排序顺序。该值是可选的，value 值越低，优先级越高。默认值为Ordered.LOWEST_PRECDENCE，表示最低优先级。

package cn.itcast.gateway.filter;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * 全局过滤器(自定义过滤器): 全局有效(对所有的路由都生效)
 */
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    /**
     * @param exchange 封装了请求和响应的所有数据(Request,Response)
     * @param chain 过滤器链对象
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 请求信息对象,封装了所有请求信息
        ServerHttpRequest request = exchange.getRequest();
        // 响应信息对象,封装了所有响应信息
        ServerHttpResponse response = exchange.getResponse();
        // 1.获取请求参数 (获取请求携带的所有参数,并封装到map集合中)
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2.获取authorization参数   http://127.0.0.1:10010/user/1?authorization=admin
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        response.setStatusCode(HttpStatus.UNAUTHORIZED);
        // 4.2.结束处理
        Mono<Void> voidMono = response.setComplete();
        return voidMono;
    }
}

浏览器发请求测试：http://127.0.0.1:10010/user/2?authorization=admin

http://127.0.0.1:10010/user/2?authorization=notAdmin

5.3.过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：

排序的规则是什么呢？

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

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

6.跨域问题

同源策略: 
	一个页面上展示的所有内容都应来自同一台服务器
	浏览器默认遵循同源策略
非同源则为跨域:
	浏览器不能展示跨域的数据信息
    不能保存和共享跨域的cookie
    ....
现代的大部分浏览器都可以展示跨域数据,但需要经过对方服务器的同意

6.1.什么是跨域问题

协议,域名,端口三者中任意一者不同即为跨域

跨域：域名不一致就是跨域，主要包括：

域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
域名相同，端口不同：localhost:8080和localhost8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS，不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

6.2.模拟跨域问题

找到课前资料的页面文件：

放入tomcat或者nginx这样的web服务器中，启动并访问。

可以在浏览器控制台看到下面的错误：

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

6.3.解决跨域问题

在gateway服务的application.yml文件中，添加下面的配置：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

总结

Nacos组件:
	概述: alibaba提供的一个组件
    作用: 
		Nacos注册中心
        Nacos配置中心
	注意: nacos注册中心和配置中心各有各的依赖,用哪个导哪个
    安装: 安装nacos,并启动
          startup.cmd -m standalone
Nacos注册中心:
	问题由来:
		两个微服务远程调用时存在硬编码问题
        如果保存多个微服务的地址
        如何监控微服务的健康状态
	作用:
		...
      	内容:
			namespace:
				group:
					XxxService:
			异地容灾:
				将一个服务下的多个实例,存放在不同的地区,形成不同的集群
                微服务在调用时,优先本集群(就近原则)
	使用步骤:
		1.导入注册中心依赖
        2.配置nacos的地址
        配置微服务集群时,需要设置优先本集群
Nacos配置中心
    问题由来:
		在一个微服务集群中,每一个微服务内都可能存在相同的配置,修改起来不方便
	作用:
		将配置文件从微服务中分离,存放在nacos中
        微服务启动时,从nacos中加载配置文件,并使用配置文件中的配置
        配置文件的热更新: 2种
        配置文件中的多种编写方式:
			服务名-环境.yaml > 服务名.yaml > application.yaml
            在SpringBoot中外部配置(指定配置大于默认配置) 大于 内部配置
	使用步骤:
		0.在nacos中编写配置文件
		1.导入注册中心依赖
        2.配置nacos
            在bootstrap.yml文件中配置nacos配置中心的相关信息
网关: SpringCloudGateway
    网关组件我们学习的是SpringCloud官方的
    问题由来:
		微服务直接被外界访问的话存在安全隐患,容易被攻击
    作用:
		在请求到达微服务前做一次拦截,包含微服务群的安全
    使用:
		1.创建maven项目,导入网关组件jar包
        2.编写引导类
        3.在配置文件中配置路由规则,和过滤器
底层实现:
	WebFlux
    netty: 8080
路由断言工厂:
	Path: 判断请求路径,根据路径进行路由请求
过滤器:
	Gateway官方提供了31个写好的过滤器可以直接配置并使用
    局部过滤器/路由过滤器: 使用定义好的31个过滤器
    默认过滤器: 使用定义好的31个过滤器
    全局过滤器/自定义过滤器: 
		创建一个类,实现GlobalFilter接口,重写方法
        自定义业务流程
网关跨域:
	配置