6. Gateway网关

86 阅读3分钟

1 什么是Gateway

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

为什么要使用网关?

image.png

网关技术的实现方式

在SpringCloud中网关的实现包括两种:1. gateway 2. zuul

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

2 创建gateway模块

导入依赖

<dependencies> 
    <!--网关依赖--> 
    <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>

配置文件 application.yml

server:
  port: 10010 #网关入口
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: 82.157.254.250:8848 #单机地址 方便
    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 # 路由id,自定义,只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://orderservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/order/** # 这个是按照路径匹配,只要以/user/开头就符合要求
          filters: # 过滤器 只对单个路由起作用
            - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
      default-filters:
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

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

启动

网关启动后,根据配置文件的 路径进行匹配,匹配成功后跳转到指定的service

image.png 网关的请求

image.png

小总结

image.png

3 路由断言工厂RoutePredicate Factory

网关匹配规则 使用断言工程来实现 包括好多种断言方式. 我们在配置文件中写的断言规则只是字符串,这些字符串会被PredicateFactory读取并处理,转变为路由判断的条件,

例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的, 像这样的断言工厂在SpringCloudGateway还有十几个

image.png

常用断言工厂

image.png

小总结

image.png

4 路由过滤器 GatewayFilter

image.png

常用过滤器

image.png 使用

两种方式 一种添加到具体路由 一种是默认配置 (作用全局)

image.png

小总结

image.png 5 全局过滤器 GlobalFilter

GlobalFilter和GatewayFilter区别

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
// 2.获取authorization参数
        String auth = params.getFirst("authorization");
// 3.校验
//        if ("admin".equals(auth)) {
        if (true){
            // 放行
            return chain.filter(exchange);
        }
// 4.拦截
//    4.1.禁止访问
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
//    4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

案例

image.png

过滤器

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
// 2.获取authorization参数
        String auth = params.getFirst("authorization");
// 3.校验
//        if ("admin".equals(auth)) {
        if (true){
            // 放行
            return chain.filter(exchange);
        }
// 4.拦截
//    4.1.禁止访问
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
//    4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

拦截成功

image.png

小总结

image.png

5 过滤器执行顺序

image.png

image.png

小总结

image.png

6 跨域问题

image.png

解决方案

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

image.png