微服务Zuul中添加过滤器

待我称王封你为后i 2023-07-02 06:29 16阅读 0赞

#### 1、项目搭建 ####

所需依赖及项目的搭建请参考上一篇博客 [微服务中网关的作用及搭建][Link 1]

#### 2、添加过滤器 ####

添加一个类，并继承 `ZuulFilter` 类

package com.ebook.zuul.filter;
    
    import com.netflix.zuul.ZuulFilter;
    import com.netflix.zuul.context.RequestContext;
    import com.netflix.zuul.exception.ZuulException;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    import javax.servlet.http.HttpServletRequest;
    
    /**
     * 日志过滤器
     *
     * @author:JZ
     * @date:2020/1/27
     */
    
    @Component
    public class LogFilter extends ZuulFilter {
    
    	private static final Logger log =LoggerFactory.getLogger(LogFilter.class);
    
        /**
         * 过滤器类型
         * @return
         */
        @Override
        public String filterType() {
            return "pre";
        }
    
        /**
         * 执行的顺序，数值越小，优先级越高
         * @return
         */
        @Override
        public int filterOrder() {
            return 0;
        }
    
        /**
         * 是否开启过滤器，默认是false 不开启
         * @return
         */
        @Override
        public boolean shouldFilter() {
            return true;
        }
    
        /**
         * 过滤器需要执行的代码
         * 打印请求的信息
         * @return
         * @throws ZuulException
         */
        @Override
        public Object run() throws ZuulException {
            RequestContext rc = RequestContext.getCurrentContext();
            HttpServletRequest request = rc.getRequest();
            log.info("method={},url={}", request.getMethod(), request.getRequestURL().toString());
            return null;
        }
    }

#### 3、四个实现的方法详解 ####

**（1）filterType 方法**

过滤器的类型，用字符串来表示。在Zuul中默认定义了四种不同生命周期的过滤器类型，具体如下：

*  pre：可以在请求被路由之前调用。一般用于身份权限验证、记录调用日志等等。
 *  routing：在路由执行之后被调用。
 *  post：在routing和error过滤器之后被调用。可用于信息收集、统计信息例如性能指标，对response的结构做些特殊处理。
 *  error：处理请求时发生错误时被调用。用于 **异常处理** 封装。

**（2）filterOrder 方法**

用int值来定义过滤器的执行顺序，数值 **越小优先级越高**。

**（3）shouldFilter 方法**

返回一个boolean类型来判断该过滤器 **是否要执行**。

**（4）run 方法**

逻辑处理。一般2个用途：

1、请求前拦截，对请求进行验证判断，如果请求无效就直接断路；如果有效可再加工处理。

2、请求结果后处理，即对结果做一些加工处理。

#### 4、Zuul请求的生命周期 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qei0yMDE3LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70]

[Link 1]: https://blog.csdn.net/k_young1997/article/details/104091704
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9qei0yMDE3LmJsb2cuY3Nkbi5uZXQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200127174151534.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9qei0yMDE3LmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70