Spring CloudGateWay和过滤器学习

网关GateWay

搭建网关微服务，实现服务路由分发。

http://访问网关的服务/user/findById?id=11 ==> http://127.0.0.1:9091/user/findById?id=11

实现步骤：

1. 创建SpringBoot工程gateway_server
2. 勾选starter：网关、Eureka客户端
3. 编写基础配置：端口，应用名称，注册中心地址
4. 编写路由规则：唯一表示id，路由url地址，路由限定规则
5. 启动网关服务进行测试

实现过程：

1. 创建SpringBoot工程gateway_server

2. 勾选Starter：网关、Eureka客户端

3. 启动引导类开启注册中心Eureka客户端发现

   @SpringBootApplication
   @EnableDiscoveryClient// 开启Eureka客户端发现功能
   public class GatewayApplication {
       public static void main(String[] args) {
           SpringApplication.run(GatewayApplication.class,args);
       }
   }
   

4. 编写基础配置

   • 在gateway_server中创建application.yml文件，配置

     # 端口
     server.port: 10010
     # 应用名
     spring.application.name: api-gateway 
     # 注册中心地址
     eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka
     

5. 编写路由规则

   • 需要用网关来路由user_service服务，查看服务ip和端口

   • 修改gateway_server的配置文件application.yml，配置网关内容

     spring:
       cloud:
         gateway:
           # 路由si(集合)
           routes:
               # id唯一标识
             - id: user-service-route
               # 路由服务地址
               uri: http://127.0.0.1:9091
               # 断言
               predicates:
                 - Path=/user/**
     

   • 将符合path规则的请求，路由到uri参数指定地址。

   • 举例：http://localhost:10010/user/findById?id=1 路由转发到http://localhost:9091/user/findById?id=1

6. 启动GatewayApplication进行测试

   • 访问路径中，必须包含路由规则的映射路径/user才会被路由转发
     

动态路由

其实就是负载均衡

spring:
  cloud:
    gateway:
      # 路由si(集合)
      routes:
        # 当前路由的唯一标识
        - id: user-service-route
          # 转发到的路由服务地址
#          uri: http://127.0.0.1:9091
           # 采用lb协议，会从Eureka注册中心获取服务请求地址
           # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
           # 规则：lb协议+服务名称
          uri: lb://user-service
          # 断言，当前路由的转发（拦截）规则
          predicates:
            - Path=/user/**

添加前缀和去除前缀

添加前缀

• 不直接暴露自己的url

spring:
  cloud:
    gateway:
      # 路由si(集合)
      routes:
        # 当前路由的唯一标识
        - id: user-service-route
          # 转发到的路由服务地址
#          uri: http://127.0.0.1:9091
           # 采用lb协议，会从Eureka注册中心获取服务请求地址
           # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
           # 规则：lb协议+服务名称
          uri: lb://user-service
          # 断言，当前路由的转发（拦截）规则
          predicates:
#            - Path=/user/**
            - Path=/**
          filters:
            - PrefixPath=/user

去除前缀

spring:
  cloud:
    gateway:
      # 路由si(集合)
      routes:
        # 当前路由的唯一标识
        - id: user-service-route
          # 转发到的路由服务地址
#          uri: http://127.0.0.1:9091
           # 采用lb协议，会从Eureka注册中心获取服务请求地址
           # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
           # 规则：lb协议+服务名称
          uri: lb://user-service
          # 断言，当前路由的转发（拦截）规则
          predicates:
#            - Path=/api/user/**
             - Path=/**
          filters:
#            - PrefixPath=/user
            - StripPrefix=1

随便多加一个前缀

过滤器

过滤器作为网关的其中一个重要功能，就是实现请求的鉴权。前面的路由前缀中的功能也是使用过滤器实现的。

Gateway自带过滤器有几十个，常见自带过滤器有：

过滤器名称	说明
AddRequestHeader	对匹配上的请求加上Header
AddRequestParameters	对匹配上的请求路由
AddResponseHeader	对从网关返回的响应添加Header
StripPrefix	对匹配上的请求路径去除前缀
PrefixPath	对匹配上的请求路径添加前缀

详细说明官方链接

使用场景：

• 请求鉴权：如果没有访问权限，直接进行拦截
• 异常处理：记录异常日志
• 服务调用时长统计

加上默认路由

spring:
  cloud:
    gateway:
      default-filters:
        - AddResponseHeader=i-love,java
      # 路由si(集合)
      routes:
        # 当前路由的唯一标识
        - id: user-service-route
          # 转发到的路由服务地址
#          uri: http://127.0.0.1:9091
           # 采用lb协议，会从Eureka注册中心获取服务请求地址
           # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
           # 规则：lb协议+服务名称
          uri: lb://user-service
          # 断言，当前路由的转发（拦截）规则
          predicates:
            - Path=/user/**
#            - Path=/**
#局部过滤器
#          filters:
#            - PrefixPath=/user
#            - StripPrefix=1

自定义全局过滤器

过滤器配置文件

spring:
  cloud:
    gateway:
      default-filters:
        - AddResponseHeader=i-love,java
      # 路由si(集合)
      routes:
        # 当前路由的唯一标识
        - id: user-service-route
          # 转发到的路由服务地址
#          uri: http://127.0.0.1:9091
           # 采用lb协议，会从Eureka注册中心获取服务请求地址
           # 路由地址如果通过lb协议加服务名称时，会自动使用负载均衡访问对应服务
           # 规则：lb协议+服务名称
          uri: lb://user-service
          # 断言，当前路由的转发（拦截）规则
          predicates:
            - Path=/user/**

**需求：**模拟登录校验

拦截器，业务逻辑完全一样

鉴权的过程：

实现步骤：

1. 在gateway_server中，全局过滤器类MyGlobalFilter，实现GlobalFilter和 Ordered接口
2. 编写业务逻辑代码判断：【过滤器必须注入SpringIOC容器中】
   • 如果请求中有token参数，则认为请求有效，放行，
   • 如果没有则拦截提示未授权。
3. 访问接口测试，加token和不加token。

实现过程：

1. 在gateway_server中，全局过滤器类MyGlobalFilter，实现GlobalFilter和 Ordered接口

2. 编写业务逻辑代码判断：

   1. 如果请求中有token参数，则认为请求有效，放行

   2. 如果没有则拦截提示未授权

      @Component
      public class MyGlobalFilter implements GlobalFilter, Ordered {
      
          @Override
          public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
              System.out.println("-----------------全局过滤器MyGlobalFilter---------------------");
              //1、获取参数中的token，以及token的值
              String token = exchange.getRequest().getQueryParams().getFirst("token");
              //2、如果token的值为空，则拦截
              if (StringUtils.isBlank(token)) {
                  exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                  return exchange.getResponse().setComplete();
              }
              return chain.filter(exchange);
          }
          /**
           * 定义过滤器执行顺序
           * 返回值越小，越靠前执行
           * @return
           */
          @Override
          public int getOrder() {
              return 0;//
          }
      }
      

3. 访问被拦截
   

4.加入token之后可以正常访问(restFul风格的访问路径还是可以后面加?传入参数的)