【SpringCloud深入浅出系列】SpringCloud组件之集成Zuul实现过滤器

---

一、Zuul 路由和过滤

路由和过滤是 Zuul 的两大核心功能：

路由功能负责将外部请求转发到具体的服务实例上去，是实现统一访问入口的基础。
过滤功能负责对请求过程进行额外的处理，是请求校验过滤及服务聚合的基础。

本博之前发布的 SpringCloud 组件之集成Zuul实现服务网关 一文搭建了 Zuul 服务网关，并实现了路由功能，本文在此基础上对项目进一步修改，实现过滤器功能。

二、Zuul 过滤器类型

Zuul 大部分功能都是通过过滤器来实现的。Zuul 中定义了四种标准过滤器类型，这些过滤器类型对应于请求的典型生命周期。

（一）标准过滤器

1.pre

在请求被路由到目标服务前执行。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

2.routing

在请求被路由到目标服务时执行。这是使用 Apache HttpClient 或 Netflix Ribbon 构建和发送原始 HTTP 请求的地方。

3.post

在请求被路由到目标服务后执行。比如给目标服务的响应添加头信息、收集统计数据、将响应从目标服务发送给客户端等功能。

4.error

请求在其他阶段发生错误时执行。

（二）特殊过滤器

Zuul 还提供了一类特殊的过滤器：StaticResponseFilter 和 SurgicalDebugFilter

1.StaticResponseFilter

StaticResponseFilter 允许从 Zuul 本身生成响应，而不是将请求转发到源。

2.SurgicalDebugFilter

SurgicalDebugFilter允许将特定请求路由到分隔的调试集群或主机。

（三）自定义过滤器

Zuul 还允许创建自定义的过滤器类型。比如我们可以定制一种 STATIC 类型的过滤器，直接在 Zuul 中生成响应，而不将请求转发到后端的微服务。

三、创建项目实现过滤器

（一）项目说明

本项目在 SpringCloud 组件之集成Zuul实现服务网关 一文中创建的项目 feign 的基础上进行修改，实现过滤器功能。

（二）创建过滤器

主要是对 zuul-proxy 模块的修改。

1.新建 LoggerFilter 类

新建 LoggerFilter 类：
package com.chaoyue.zuulproxy.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.http.protocol.RequestContent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

@Component
public class LoggerFilter extends ZuulFilter {

    private static final Logger logger = LoggerFactory.getLogger(LoggerFilter.class);

    /**
     * 过滤器类型：
     * pre 前置过滤
     * route 路由后过滤
     * error 异常过滤
     * post 远程服务调用后过滤
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 同类型过滤器执行顺序
     * 数值越小优先级越高
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 当前filter是否生效，默认为false
     * @return
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * run方法实现过滤器的具体逻辑
     * return可返回任意对象
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        // 获取请求上下文
        RequestContext rc = RequestContext.getCurrentContext();
        HttpServletRequest request = rc.getRequest();
        logger.info("remote host={}， method={}, url={}", request.getRemoteHost(), request.getMethod(), request.getRequestURL());
        // 可以记录日志、鉴权等信息
        return null;
    }
}

2.运行测试

运行后浏览器输入：http://localhost:8085/proxy/service-provider/sayHi，在控制台可看到如下信息：