4、Gateway全局过滤器GlobalFilter

1、全局过滤器

上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。

2、全局过滤器作用

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

定义方式是实现GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中编写自定义逻辑,可以实现下列功能:

  • 登录状态判断
  • 权限校验
  • 请求限流等

3、自定义全局过滤器

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

  • 参数中是否有authorization,

  • authorization参数值是否为admin

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

实现:

在gateway中定义一个过滤器:

package cn.itcast.gateway.filters;

import org.apache.http.HttpStatus;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
@Order(-1)
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1、获取请求参数
        
        // 1.1、从url参数中取值
        // MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        //String authorization = params.getFirst("authorization");
        
        // 1.2、从header中检查authorization
        HttpHeaders headers = exchange.getRequest().getHeaders();
        String authorization = headers.getFirst("authorization");
        
        // 2、校验
        if ("admin".equals(authorization)){
            // 放行
            return chain.filter(exchange);
        }
        // 拦截
        // 禁止访问,设置状态码
        exchange.getResponse().setRawStatusCode(HttpStatus.SC_FORBIDDEN);

        return exchange.getResponse().setComplete();
    }
}

4、过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:

default-filter > user-service  > global-filter

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-d8l6aFSz-1670561748630)(assets/image-20210714214228409.png)]

排序的规则是什么呢?

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

GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
例如:

  • 实现Ordered 接口
public class AuthorizeFilter implements GlobalFilter, Ordered {
	// 业务逻辑...

    @Override
    public int getOrder() {
        return -1;
    }
}
  • 或者添加@Order注解
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
	// 业务逻辑...
}

详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链

测试运行一下

header不携带authorization 或值不正确,被拦截在这里插入图片描述
如果携带了参数,就能查到
在这里插入图片描述

### 关于Spring Cloud Gateway全局过滤器的配置和使用 #### 自定义全局过滤器实现 为了创建自定义全局过滤器,在`@Component`类中标记实现了`GlobalFilter`接口的方法。下面是一个简单的例子,展示了如何编写一个基本的日志记录过滤器: ```java import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import reactor.core.publisher.Mono; @Configuration public class MyGlobalFilterConfig { @Bean public GlobalFilter myCustomGlobalFilter() { return (exchange, chain) -> { System.out.println("Pre-request processing"); // 执行一些前置操作 Mono<Void> responseMono = chain.filter(exchange).then(Mono.fromRunnable(() -> { System.out.println("Post-response processing"); // 执行一些后置操作 })); return responseMono.onErrorResume(error -> { System.err.println("Error occurred during request/response handling."); return Mono.error(error); }); }; } } ``` 此代码片段中的日志消息可以替换为任何实际的应用逻辑,例如身份验证检查或性能监控[^2]。 #### 引入必要的依赖项 要在项目中启用这些特性,需确保已添加了适当版本的Spring Cloud Gateway依赖到项目的构建文件里(对于Maven而言是在pom.xml)。这通常意味着要加入如下所示的内容: ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> ``` 一旦完成了上述设置并重启应用程序之后,所定义的所有全局过滤器将会自动生效,并按照它们被加载顺序依次执行[^3]。 #### 过滤器工作流程概述 当HTTP请求到达网关时,会先经过一系列预先设定好的全局过滤器来进行初步处理;接着才会根据路由规则转发给对应的服务实例继续后续处理;最后返回的数据也会再次流经相同的全局过滤器链路完成最终加工后再发送回客户端。这种设计模式使得开发者能够方便地在整个系统的入口处实施统一的安全策略或其他通用型的功能增强措施[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值