文章目录

  • 前言
  • 一、网关的作用
  • 二、快速入门
  • 三、路由断言工厂Route Predicate Factory
  • 四、路由过滤器
  • 1、GateWayFilter
  • 2、GlobalFilter
  • 3、过滤器执行顺序
  • 五、跨域问题



前言

本文用来记录网关学习

一、网关的作用

springcloud学习到这里,我们的微服务结构是有很不同的微服务,每个微服务都需要去访问自己的数据库来完成自己的业务,并且微服务都可以去Nacos中完成服务的注册和配置的管理。当微服务内部有相互调用关系时,就可以采用Feign这个组件去完成相互调用。当外部需要调用时,直接发送请求到指定的微服务就可以了。

spring cloud gateway路由400_gateway


这里存在一个问题,我们目前的微服务允许任何人进行访问显然是不合理的,因为并不是所有的业务是对外公开的,有些业务是公司内部或者管理人员才可以访问的。这个时候我们需要对用户的身份进行验证,是公司内部人员则允许访问,否则拒绝。网关就可以帮助我们实现这个需求。此外,网关可以将请求路由到具体的微服务上,并实现负载均衡。

spring cloud gateway路由400_spring_02


网关的技术实现

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

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

二、快速入门

搭建网关服务的步骤:

  1. 创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖(网关本身也是一个微服务,也必须注册到nacos):
<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
  1. 编写路由配置及nacos地址
server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8848 #nacos地址
    gateway:
      routes:
        - id: user-service # 路由标示,必须唯一
          uri: lb://userservice # 路由的目标地址
          predicates: # 路由断言,判断请求是否符合规则
            - Path=/user/** # 路由断言,判断路径是否是以/user开头,如果是则符合
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

spring cloud gateway路由400_spring cloud_03


小结

网关搭建步骤:

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

路由配置包括:

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

三、路由断言工厂Route Predicate Factory

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

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

spring cloud gateway路由400_spring cloud_04

四、路由过滤器

1、GateWayFilter

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

spring cloud gateway路由400_spring cloud_05


Spring提供了31种不同的路由过滤器工厂。

spring cloud gateway路由400_gateway_06


案例:给所有进入userservice的请求添加一个请求头

Truth=itcast is freaking awesome!

实现方式:在gateway中修改application.yml文件,给userservice的路由添加过滤器:

```yaml
 gateway:
      routes:
        - id: user-service # 路由标示,必须唯一
          uri: lb://userservice # 路由的目标地址
          predicates: # 路由断言,判断请求是否符合规则
            - Path=/user/** # 路由断言,判断路径是否是以/user开头,如果是则符合
          filters:
            - AddRequestHeader=Truth, Itcast is freaking awersome! # 添加请求投头
```
@GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "Truth", required = false) String truth) {
        System.out.println(truth);
        return userService.queryById(id);
    }

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

2、GlobalFilter

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

案例:定义全局过滤器,拦截并判断用户身份
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下列条件:

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

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

@Order(-1) // 过滤器的优先级
@Component
public class AuthorizeFilter implements GlobalFilter {
    /**
     * 处理当前请求
     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器
     * @return
     */
    @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");
        // 3、判断参数值是否等于admin
        if("admin".equals(auth)){
            // 4、是,放行
            return chain.filter(exchange);
        }
        // 5、否,拦截
        // 5.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 5.2拦截请求
        return exchange.getResponse().setComplete();
    }
}

小结
全局过滤器的作用是什么?

  • 对所有路由都生效的过滤器,并且可以自定义处理逻辑

实现全局过滤器的步骤?

  • 实现GlobalFilter接口
  • 添加@Order注解或实现Ordered接口
  • 编写处理逻辑

3、过滤器执行顺序

spring cloud gateway路由400_gateway_07

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

五、跨域问题

参考