Gateway网关

8/3/2022 SpringCloudGateway技术网关拦截器

SpringCloud Alibaba中的Gateway网关学习

# 为什么需要网关

image-20220803143310988

网关的功能:

  • 身份认证和权限校验
  • 服务路由、负载均衡
  • 请求限流

# 网关的技术实现

SpringCloud中网关有两种:

  • gateway
  • zuul

Zuul是基于Servlet的实现,属于阻塞式编程。

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

# 搭建网关服务

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>
1
2
3
4
5
6
7
8
9
10
11

创建启动类:

@SpringBootApplication
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}
1
2
3
4
5
6

2、编写路由配置以及nacos地址

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

若要再代理多一个服务,则从-id开始,模仿第一个来添加:

gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
1
2
3
4
5
6
7
8
9
10
11

启动服务后,直接访问网关的端口号加请求名称http://localhost:10010/user/1

请求成功:

image-20220803145844136

# 网关服务的流程

image-20220803150107859

# 路由断言工厂(Route Predicate Factory)

网关路由可以配置的内容包括:

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

说明:

  • 我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
  • 例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的
  • 像这样的断言工厂在SpringCloudGateway还有十几个

Spring提供了11中基本的Predicate工厂:

image-20220803150816314

可以参照spring的官方网站,上面有对这些断言的使用讲解:

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

例子:

predicates:
            - Path=/order/**
            - After=2022-08-03T15:15:00.789+08:00[Asia/Shanghai]
1
2
3

这里选择了After断言规则,表示在这个时间之后的请求才能通过。否则会报404的错误。

# 断言工厂小结

  • PredicateFactory的作用是什么?

    读取用户定义的断言条件,对请求做出判断

  • Path=/user/**是什么含义?

    路径是以/user开头的就认为是符合的

# 路由过滤器(GatewayFilter)

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

image-20220803151943736

# 过滤器工厂(GateFilterFactory)

参考spring官方地址:

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

Spring提供了31种不同的过滤器,其中的有:

image-20220803152721884

# 配置过滤器

官方例子:

# The AddRequestHeader GatewayFilter Factory (opens new window)

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue
1
2
3
4
5
6
7
8

This listing adds X-Request-red:blue header to the downstream request’s headers for all matching requests.

AddRequestHeader is aware of the URI variables used to match a path or host. URI variables may be used in the value and are expanded at runtime. The following example configures an AddRequestHeader GatewayFilter that uses a variable:

运用:

在配置文件中添加filters配置:

filters:
            - AddRequestHeader=Truth,LazyEgg is Awesome!
1
2

现在已经配置完成,如何在后端直接看到请求头的数据呢?

我们可以在controller层的接口中加上@RequestHeader的注解,这样就可以获取到指定的请求头中的参数:

@GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "Truth",required = false) String truth) {
        System.out.println("truth:"+truth);
        return userService.queryById(id);
    }
1
2
3
4
5

这样的话,通过测试,确实可以拿到请求头信息。

truth:LazyEgg is Awesome!
1

# 配置默认过滤器(所有路由)

如果需要在所有路由上都配置相同的过滤器,则只需要在配置文件中配置default-filters,要注意,default-filters要与routes同级,这样就不会针对于某一个路由了,实现了所有路由过滤。

default-filters:
        - AddRequestHeader=Truth,SleepyEgg is Awesome2!
1
2

这样的话,通过测试是可以实现的。

# 过滤器工厂小结

  • 过滤器的作用是什么?

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

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

  • defaultFilters的作用是什么?

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

# 全局过滤器(GlobalFilter)

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与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);
}
1
2
3
4
5
6
7
8
9
10

说明:Mono类型是属于Spring5中WebFlux,WebFlux是Spring5.0+SpringBoot2.0+WebFlux等技术开发的,属于响应式编程。

# 全局过滤器实例

目的:拦截判断用户身份

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

  • 参数中是否有authorization,
  • authorization参数值是否为admin如果

同时满足则放行,否则拦截

代码实现:

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

/**
 * @Author 早睡蛋
 * @Date 2022/8/3 16:01:16
 * @Desc:
 */
@Component
//@Order(-1)过滤器的顺序,也可以实现Ordered接口方法进行设置
public class AuthorizeFilter implements GlobalFilter , Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1.获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        //2.获取参数中的 authorization 参数
        String auth = params.getFirst("authorization");//getFirst为取出第一个匹配的
        //3.判断参数数值是否等于 admin
        if ("admin".equals(auth)){
            //4.是:放行
            return chain.filter(exchange);//chain是链,会从过滤器链中找到下一个过滤器,等于放行
        }
        //5.否:拦截
        //5.1.设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//setStatusCode要传枚举类,UNAUTHORIZED为401,未登录的意思
        //5.2.拦截请求
        return exchange.getResponse().setComplete();
    }

		//过滤器执行的顺序
    @Override
    public int getOrder() {
        return -1;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

再次发起请求,浏览器会报401(也就是我们自定义设置的未登录错误),若在请求中加上"?authorization=admin"则会访问成功。

# 过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器

image-20220803162548814

  • 每一个过滤器都必须指定一个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排序,组织过滤器链

1
2
3
4

# 网关Cors跨域处理

跨域:域名不一致就是跨域,主要包括:

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

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

解决方案:CORS

# CORS跨域配置

参照官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#cors-configuration

spring:
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "https://docs.spring.io"
            allowedMethods:
            - GET
1
2
3
4
5
6
7
8
9

注意:针对OPTIONS请求被拦截的问题,需要在上述配置中再加一条add-to-simple-url-handler-mapping: true

To provide the same CORS configuration to requests that are not handled by some gateway route predicate, set the spring.cloud.gateway.globalcors.add-to-simple-url-handler-mapping property to true. This is useful when you try to support CORS preflight requests and your route predicate does not evalute to true because the HTTP method is options.

# 配置详情

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]': #拦截哪一些请求
            allowedOrigins: # 允许哪些网站的跨域请求
              - "http://localhost:8090"
              - "http://www.baidu.com"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19