SpringCloud Gateway从搭建到登录鉴权+自定义过滤器

目录

一、什么是微服务的网关和应用场景

二、网关SpringCloud Gateway的介绍

 三、创建SpringCloud网关项目和依赖添加

 四、上述网关这种做法存在哪些问题？

 4.1 存在的问题

4.2 解决方法之添加Nacos服务治理配置

五、进阶掌握 SpringCloud Gateway配置和交互流程

 六、什么是Gateway路由断言

 七、Gateway内置断言实现接口定时下线

 八、什么是网关的过滤器

九、Gateway全局过滤器实现用户鉴权

---

一、什么是微服务的网关和应用场景

什么是网关
    API Gateway，是系统的唯一对外的入口，介于客户端和服务器端之间的中间层，处理非业务功能 提供路由请求、鉴权、监控、缓存、限流等功能
应用场景
    统一接入、智能路由、AB测试、灰度测试、负载均衡、容灾处理
    日志埋点（类似Nignx日志）、流量监控、限流处理、服务降级、安全防护
    鉴权处理、监控、机器网络隔离
主流的网关有:
zuul：是Netflix开源的微服务网关，和Eureka,Ribbon,Hystrix等组件配合使用，依赖组件比较多，性能教差
kong: 由Mashape公司开源的，基于Nginx的API gateway
nginx+lua：是一个高性能的HTTP和反向代理服务器,lua是脚本语言，让Nginx执行Lua脚本，并且高并发、非阻塞的处理各种请求
springcloud gateway: Spring公司专门开发的网关，替代zuul

注意：AlibabaCloud全家桶还没对应的网关，我们就用SpringCloud官方推荐的Gateway

 

二、网关SpringCloud Gateway的介绍

什么是 SpringCloud Gateway
    Spring官方出品，基于Spring5+Reactor技术开发的网关
    性能强劲基于Reactor+WebFlux、功能多样
    基于springboot2.x, 直接可以jar包方式运行
官方文档
    https://spring.io/projects/spring-cloud-gateway

 三、创建SpringCloud网关项目和依赖添加

第一步：创建一个新的Gateway项目

第二步 :添加pom.xml依赖

<!--锁定版本-->
<dependencyManagement>
    <dependencies>
        <!--https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-dependencies/2.3.3.RELEASE-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.3.3.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>

        <!--https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies/Hoxton.SR8-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Hoxton.SR8</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>

        <!--https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-alibaba-dependencies/2.2.1.RELEASE-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2.2.1.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>

    </dependencies>
</dependencyManagement>
 

 <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

第三步：配置application.properties

server:
  port: 8888
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 112.74.xxx.xxxx:88498
    gateway:
      routes: #数组形式
        - id: order-service  #路由唯一标识
          uri: http://127.0.0.1:8000  #想要转发到的地址
          order: 1 #优先级，数字越小优先级越高
          predicates: #断言 配置哪个路径才转发
            - Path=/order-server/**
          filters: #过滤器，请求在传递过程中通过过滤器修改
            - StripPrefix=1  #去掉第一层前缀


#访问路径 http://localhost:8888/order-server/api/v1/video_order/list
#转发路径 http://localhost:8000/api/v1/video_order/list  
#需要过滤器去掉前面第一层

第四步:启动项目后访问订单项目里面的列表接口

访问结果如下:

 四、上述网关这种做法存在哪些问题？

 4.1 存在的问题

       微服务地址写死
       负载均衡没做到

4.2 解决方法之添加Nacos服务治理配置

  网关添加naocs依赖

  <!--添加nacos客户端-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

启动类开启支持
   @EnableDiscoveryClient

 修改配置文件:

 启动2个订单服务，端口号分别为8000和8001 

  这样就完成了可以根据服务名称来绑定以及做负载均衡:

五、进阶掌握 SpringCloud Gateway配置和交互流程

网关的配置项：
路由：是网关的基本单元，由ID、URI、一组Predicate、一组Filter组成，根据Predicate进行匹配转发
route组成部分
id：路由的ID
uri：匹配路由的转发地址
predicates：配置该路由的断言，通过PredicateDefinition类进行接收配置。
order：路由的优先级，数字越小，优先级越高。

交互流程:

        客户端向Spring Cloud Gateway发出请求
        如果网关处理程序映射确定请求与路由匹配
        则将其发送到网关Web处理程序
        通过特定过滤器链运行，前置处理-后置处理

 六、什么是Gateway路由断言

什么是Gateway路由断言

Predicate 来源于Java8函数式编程，接受输入参数，返回一个布尔值结果，可根据结果判断要不要进行转发
Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则
转发的判断条件，SpringCloud Gateway支持多种方式，常见如：Path、Query、Method、Header等
支持多个Predicate请求的转发是必须满足所有的Predicate后才可以进行路由转发 也就是多个断言直接的是and关系

内置路由断言介绍 RoutePredicateFactory 接口实现类

参数编写规则 XXXRoutePredicateFactory，使用XXX作为参数配置, 例如下面
predicates:
  - Host=
  - Path=
  - Method=
  - Header=
  - Query=
  - Cookie=

 七、Gateway内置断言实现接口定时下线

需求：接口需要在指定时间进行下线，过后不可以在被访问
    使用Before ,只要当前时间小于设定时间，路由才会匹配请求
    东8区的2022-02-16T22:07:01.000+08:00后，请求不可访问
  2022-02-16T22:07:01之前都可以正常访问

  2022-02-16T22:07:02访问就开始报错了，前端可以根据相应错误码，展示对应错误页面

 八、什么是网关的过滤器

 

 过滤器生命周期
    上图左边是PRE： 这种过滤器在请求被路由之前调用,一般用于鉴权、限流等
    上图右边是POST：这种过滤器在路由到微服务以后执行，一般用于修改响应结果，比如增加header信息、打点结果日志

网关过滤器分类
    局部过滤器GatewayFilter：应用在某个路由上,每个过滤器工厂都对应一个实现类，并且这些类的名称必须以 GatewayFilterFactory 结尾
    全局过滤器：作用全部路由上 

内置很多局部过滤器，顶级接口 GatewayFilterFactory

 内置很多全局过滤器，顶级接口 GlobalFilter

 在上面这步骤有用到：

九、Gateway全局过滤器实现用户鉴权

自定义全局过滤器

package net.wnn.filter;

import org.apache.commons.lang3.StringUtils;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;


@Component
public class UserGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //写业务逻辑
        String token = exchange.getRequest().getHeaders().getFirst("token");

        //TODO 根据业务开发对应的鉴权规则, JWT

        if(StringUtils.isBlank(token)){
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete();
        }


        //继续往下执行
        return chain.filter(exchange);
    }

    //数字越小，优先级越高
    @Override
    public int getOrder() {
        return 0;
    }
}

 验证：参数未携带token的则无法访问接口

 

 注意：网关不要加太多业务逻辑，否则会影响性能，务必记住