Zuul过滤器

最新推荐文章于 2024-08-24 17:42:36 发布

原创最新推荐文章于 2024-08-24 17:42:36 发布 · 828 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring

微服务-Netflix 专栏收录该内容

19 篇文章

订阅专栏

Zuul过滤器是Spring Cloud Zuul的核心组件，主要分为PRE、ROUTING、POST和ERROR四种类型，分别在请求路由的不同阶段执行。PRE过滤器用于身份验证和日志记录，ROUTING负责请求路由，POST处理响应，ERROR处理错误。自定义过滤器需要继承ZuulFilter，实现filterType、filterOrder、shouldFilter和run方法。若需禁用过滤器，可在application.properties中设置`zuul.LogFilter.route.disable=true`。

限流、权限验证、记录日志

过滤器 (filter) 是zuul的核心组件，zuul大部分功能都是通过过滤器来实现的。 zuul中定义了4种标准过滤器类型，这些过滤器类型对应于请求的典型生命周期。

PRE：这种过滤器在请求被路由之前调用。可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用 Apache HttpClient或
Netfilx Ribbon请求微服务
POST:这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP
Header、收集统计信息和指标、将响应从微服务发送给客户端等。
ERROR：在其他阶段发生错误时执行该过滤器。

过滤器的实现

如果要编写一个过滤器，则需继承ZuulFilter类实现其中的方法:

@Component
public class LogFilter extends ZuulFilter {

    @Override
    public String filterType() {
        return FilterConstants.ROUTE_TYPE;
    }

    @Override
    public int filterOrder() {
        return FilterConstants.PRE_DECORATION_FILTER_ORDER;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        String remoteAddr = request.getServerName();
        System.out.println("访问地址:"+request.getRequestURI());
        return null;
    }
}

由代码可知，自定义的 zuul Filter需实现以下几个方法。

filterType: 返回过滤器的类型。有 pre、 route、 post、 error等几种取值，分别对应上文的几种过滤器。

详细可以参考 com.netflix.zuul.ZuulFilter.filterType()中的注释；

filter0rder: 返回一个 int值来指定过滤器的执行顺序，不同的过滤器允许返回相同的数字。

shouldFilter：返回一个 boolean值来判断该过滤器是否要执行， true表示执行， false表示不执行。

run：过滤器的具体逻辑；

zuul过滤器的禁用

Spring Cloud默认为Zuul编写并启用了一些过滤器，例如DebugFilter、 FormBodyWrapperFilter等，这些过滤器都存放在spring-cloud-netflix-zuul这个jar包里，一些场景下，想要禁用掉部分过滤器，该怎么办呢？只需在application.properties里设置zuul...disable=true 例如，要禁用上面我们写的过滤器，这样配置就行了：

zuul.LogFilter.route.disable=true