路由过滤器 GatewayFilter

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

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

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量
...

路由过滤器

给所有进入userservice的请求添加一个请求头：- AddRequestHeader=info, AddRequestHeader!

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

spring:
  cloud:
    gateway:
      routes: # 网关路由配置
        - id: user-service
          uri: lb://userservice
          predicates:
            - Path=/user/**
          filters: # 过滤器
            - AddRequestHeader=info, AddRequestHeader! # 添加请求头

userservice项目中controller中的请求方法上获取Info的内容

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User queryByid(@PathVariable("id") Long id,
                          @RequestHeader(value = "Info",required = false) String info) {
        System.out.println(info);
        return userService.queryById(id);
    }
}

默认过滤器

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

spring:
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
          #filters: # 过滤器
          #  - AddRequestHeader=info, AddRequestHeader! # 添加请求头
        - id: feign-order-service
          uri: lb://feignorderservice
          predicates:
            - Path=/order/**
      default-filters: # 默认过滤器，会对所有的路由请求都生效
        - AddRequestHeader=Info,'default filers request header!' # 添加请求头

全局过滤器GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，和默认过滤器处理一样，那为什么还要全局过滤器呢？

默认过滤器通过配置设定过滤器，过滤器的逻辑时固定的，无法根据项目需求随意调整。

GlobalFilter的逻辑需要自己写代码实现

定义方式是实现GlobalFilter接口

public interface GlobalFilter {

    /**
     * Process the Web request and (optionally) delegate to the next {@code WebFilter}
     * through the given {@link GatewayFilterChain}.
     * @param exchange 请求上下文，可以获取request、response等信息
     * @param chain 过滤器链，下一个过滤器
     * @return {@code Mono<Void>} to indicate when request processing is complete
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);

}

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

• 参数中是否有authorization，
• authorization参数值是否为admin
• 如果同时满足则放行，否则拦截

//@Order(-1) //过滤器执行顺序
@Component //spring容器管理
public class AuthorizationFilter implements GlobalFilter, Ordered {
    @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();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

注意：Order注解和implements Ordered作用是完全一样的，二选一即可。

gateway项目结构

访问：http://localhost:10018/user/1

访问：http://localhost:10018/user/1?authorization=admin

过滤器执行顺序

过滤器链那就会有过滤器执行顺序

过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。

GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值

路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增

 

当过滤器的order值一样时，会按照 defaultFilter 、 路由过滤器、 GlobalFilter的顺序执行

 

 

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链