GatewayFilter

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

GatewayFilter Factories有30几个。

eg:
给所有进入userservice的请求添加一个请求头:Truth=NO.1

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

server:
  port: 10010 #网关端口
spring:
  application:
    name: geteway #服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 #nacos地址
    gateway:
      routes: #网关路由配置
        - id: user-service #网关路由配置
          # uri: http://127.0.0.1:8081 #路由的目标地址http是固定地址,写死。一般不去使用
          uri: lb://userservice #路由的目标地址,lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 路径断言,这个是按照路径匹配,只要以/user/开头就符合要求
          filters: #添加过滤器
            - AddRequestHeader=Truth,No.1 #AddRequestHeader就是其中一个过滤器名称,Truth是key,No.1是value
        - id: order-service #网关路由配置
          # uri: http://127.0.0.1:8081 #路由的目标地址http是固定地址,写死。一般不去使用
          uri: lb://orderservice #路由的目标地址,lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/order/** # 路径断言,这个是按照路径匹配,只要以/user/开头就符合要求

在userservice的Controller中打印头信息中添加的Truth值

package com.yy.user.controller;

import com.yy.user.config.PatternProperties;
import com.yy.user.pojo.User;
import com.yy.user.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@RestController
@RequestMapping("/user")
//@RefreshScope
public class UserController {

//    @Value("${pattern.dateformat}")
//    private String dateformat;

    @Autowired
    private UserService userService;

    @Autowired
    private PatternProperties patternProperties;

    @GetMapping("now")
    public String now(){
//        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
    }

    @GetMapping("prop")
    public PatternProperties patternProperties(){
//        return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
        return patternProperties;
    }

    @GetMapping("/{id}")
    public User findById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false) String truth){
    //从RequestHeader中获取,key是Truth的值
        System.out.println("truth:" + truth);
        return userService.queryById(id);
    }
}

启动后访问,日志中打印
在这里插入图片描述

默认过滤器
对所有路由器都生效

server:
  port: 10010 #网关端口
spring:
  application:
    name: geteway #服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 #nacos地址
    gateway:
      routes: #网关路由配置
        - id: user-service #网关路由配置
          # uri: http://127.0.0.1:8081 #路由的目标地址http是固定地址,写死。一般不去使用
          uri: lb://userservice #路由的目标地址,lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 路径断言,这个是按照路径匹配,只要以/user/开头就符合要求
#          filters:
#            - AddRequestHeader=Truth,No.1 #AddRequestHeader就是其中一个过滤器名称,Truth是key,No.1是value
        - id: order-service #网关路由配置
          # uri: http://127.0.0.1:8081 #路由的目标地址http是固定地址,写死。一般不去使用
          uri: lb://orderservice #路由的目标地址,lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/order/** # 路径断言,这个是按照路径匹配,只要以/user/开头就符合要求
      default-filters: #对所有路由生效,与routes是同一级别
        - AddRequestHeader=Truth,No.1 #AddRequestHeader就是其中一个过滤器名称,Truth是key,No.1是value

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

定义方式
实现GlobalFilter接口

public interface GlobalFilter{
	Mono<Void> filter(ServerWebExchange exchange,GatewayFitlerChain chain)
// exchanger请求上下文,里面可以获取Request、Response等信息,也就是用来编写整个过滤器的业务逻辑
// chain用来把请求委托给下一下过滤器,也就是放行后将给第二个过滤器处理
// Mono返回值
}

eg:
定义全局过滤器,拦截并判断用户身份(判断请求的参数是否满足下面条件)

  1. 参数中是否有authorization
  2. authorization参数值是否为admin
    同时满足旅行,否则拦截

先定义一个Filter类
不满足就返回401

package com.yy.gateway;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
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;

@Order(-1)
//定义过滤器顺序,越小优先级越高.或是实现Ordered接口中的getOrder是一样的
@Component
//定义组件,注入到Spring中
public class AuthrizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        //2. 获取参数中的authorization参数
        String authoriztion = queryParams.getFirst("authoriztion");
        //3. 判断参数值是否
        if("admin".equals(authoriztion)){
            // 4.是,放行
            return chain.filter(exchange);
        }
        // 5. 否.拦截
        // 5.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 5.2 拦截请求
        return exchange.getResponse().setComplete();
    }
}

重启Gateway后,访问
在这里插入图片描述
url添加参数?authoriztion=admin后再访问,正常访问

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

路由的过滤器和DefaultFilter都是用AddRequestHeaderGatewayFilterFactory类,返回的都是GatewayFilter,而GlobalFitler也会因为GatewayFilterAdapter类中的GatewayFilterAdapter适配器,返回GatewayFilter,所以能放到一个集合中进行排序。

GlobalFilter通过实现Ordered接口或添加@Order注解来指定order值。而路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增;当过滤器的order值一样时,会按照defaultFilter>路由过滤器>GlobalFilter的顺序执行。


版权声明:本文为u012700515原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。