Spring Cloud 之 Zuul网关Filter过滤器应用（十五）

参考1：https://blog.csdn.net/forezp/article/details/76211680

参考2：https://www.pianshen.com/article/92501046155/

上一篇我们搭建了一个基本的Zuul网关，并实现了统一访问，同时提到Zuul网关有四种过滤器：前置（Pre），路由（Route），后置（Post），错误（Error）。

知道每一种过滤器都是干什么用的，对于我们搭建一个网关非常重要。

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

在开始之前有必要说明几个关键的类：

• ServletWrappingController ：该类的是Spring MVC中的请求封装控制器，负责将请求转给指定的servlet处理。
• ZuulController：Zuul中提供的继承ServletWrappingController的子类，用将请求转到ZuulServlet处理
• ZuulServlet：Zuul网关中网络请求处理器
• ZuulRunner：将HttpServletRequest添加到请求的上下文中
• FilterProcessor：集中处理各生命周期的过滤器
• FilterLoader：存储和加载过滤器的地方

ZuulServlet源码（删减版），从源码中可以看出过滤器的调用顺序。

    @Override
    public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws ServletException, IOException {
        try {
            init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);

            // Marks this request as having passed through the "Zuul engine", as opposed to servlets
            // explicitly bound in web.xml, for which requests will not have the same data attached
            RequestContext context = RequestContext.getCurrentContext();
            context.setZuulEngineRan();

            try {
                preRoute();
            } catch (ZuulException e) {
                error(e);
                postRoute();
                return;
            }
            try {
                route();
            } catch (ZuulException e) {
                error(e);
                postRoute();
                return;
            }
            try {
                postRoute();
            } catch (ZuulException e) {
                error(e);
                return;
            }

        } catch (Throwable e) {
            error(new ZuulException(e, 500, "UNHANDLED_EXCEPTION_" + e.getClass().getName()));
        } finally {
            RequestContext.getCurrentContext().unset();
        }
    }

Zuul Request请求处理流程：

 

下面通过例子演示。

1、创建一个前置过滤器，源码如下：

前置过滤器判断请求参数里是否有token字段，如果token为空则过滤掉该请求，并且返回401，Unauthorized。

/**
 * @author Leo
 */
@Component
public class PreFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(PreFilter.class);

    /**
     * 过滤器的类型，它决定过滤器在请求的哪个生命周期中执行。这里定义为 pre，代表会在请求被路由之前执行
     *
     * @return
     */
    @Override
    public String filterType() {
        return PRE_TYPE;
    }

    /**
     * 过滤器的执行顺序。当请求在一个阶段中存在多个过滤器时，需要根据该方法返回值来依次执行。
     *
     * @return
     */
    @Override
    public int filterOrder() {
        //过滤器执行顺序，数字越小，优先级越高
        return PRE_DECORATION_FILTER_ORDER - 5;
    }

    /**
     * 判断该过滤器是否需要被执行。这里直接返回了 true，因此该过滤器对所有请求都会生效。实际运用中可以利用该函数来指定过滤器的有效范围。
     *
     * @return
     */
    @Override
    public boolean shouldFilter() {
        //返回 true，拦截所有 URL
        return true;
    }

    /**
     * 过滤器的具体逻辑。
     * 这里通过设置requestContext.setSendZuulResponse(false)过滤该请求，不对其进行路由，
     * 然后通过requestContext.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value()) 设置了其返回的错误码。
     * 当然也可以对返回的结果进行优化，比如，通过requestContext.setResponseBody(body) 对返回的 body 内容进行编辑等。
     *
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletRequest request = requestContext.getRequest();

        log.info("send {} request to {}", request.getMethod(), request.getRequestURL().toString());

        String token = request.getParameter("token");
        if (StringUtils.isEmpty(token)) {
            log.warn("token is empty");
            requestContext.setSendZuulResponse(false);
            requestContext.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
            return null;
        }
        log.info("token is ok");
        return null;
    }
}

2、重启网关，验证前置过滤器是否生效

访问URL：http://localhost:9001/x-demo-service-ribbon/ribbon/service，返回401说明前置过滤器生效

网关后台日志输出：

2021-02-26 16:41:11.711  INFO 66924 --- [nio-9001-exec-1] com.x.gateway.zuul.filter.PreFilter      : send GET request to http://localhost:9001/x-demo-service-ribbon/ribbon/service
2021-02-26 16:41:11.712  WARN 66924 --- [nio-9001-exec-1] com.x.gateway.zuul.filter.PreFilter      : token is empty
2021-02-26 16:41:15.571  INFO 66924 --- [nio-9001-exec-2] com.x.gateway.zuul.filter.PreFilter      : send GET request to http://localhost:9001/x-demo-service-ribbon/ribbon/service
2021-02-26 16:41:15.571  WARN 66924 --- [nio-9001-exec-2] com.x.gateway.zuul.filter.PreFilter      : token is empty

请求参数加上token再试一次：http://localhost:9001/x-demo-service-ribbon/ribbon/service?token=123

可以看到可以正常访问了，过滤器生效。

 关于其它类型的过滤器，大家可以自己试试。原理一样，都是继承ZuulFilter类。