ZuulFilter过滤器

冷不防 2023-07-23 03:56 1阅读 0赞

### 文章目录 ###

*  1、过滤器
 *   *  1.1 ZuulFilter
     *  1.2 过滤器执行生命周期
     *  1.3 使用场景
 *  2、自定义过滤器
 *   *  2.1 定义过滤器类
     *  2.2 测试

Zuul作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作我们往往是通过Zuul提供的过滤器来实现的。

# 1、过滤器 #

## 1.1 ZuulFilter ##

ZuulFilter是过滤器的顶级父类。在这里我们看一下其中定义的4个最重要的方法：

public abstract ZuulFilter implements IZuulFilter{ 
    
        abstract public String filterType();
    
        abstract public int filterOrder();
        
        boolean shouldFilter();// 来自IZuulFilter
    
        Object run() throws ZuulException;// IZuulFilter
    }

说明：

*  shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true执行，返回false不执行。
 *  run：过滤器的具体业务逻辑。
 *  filterType：返回字符串，代表过滤器的类型。包含以下4种：
    
     *  pre：请求在被路由之前执行
     *  route：在路由请求时调用
     *  post：在route和errror过滤器之后调用
     *  error：处理请求时发生错误调用
 *  filterOrder：通过返回的int值来定义过滤器的执行顺序，数字越小优先级越高。

## 1.2 过滤器执行生命周期 ##

这张是Zuul官网提供的请求生命周期图，清晰的表现了一个请求在各个过滤器的执行顺序。

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

正常流程：

*  请求到达首先会经过pre类型过滤器，而后到达route类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。

异常流程：

*  整个过程中，pre或者route过滤器出现异常，都会直接进入error过滤器，在error处理完毕后，会将请求交给POST过滤器，最后返回给用户。
 *  如果是error过滤器自己出现异常，最终也会进入POST过滤器，将最终结果返回给请求客户端。
 *  如果是POST过滤器出现异常，会跳转到error过滤器，但是与pre和route不同的是，请求不会再到达POST过滤器了。

所有内置过滤器列表：

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

## 1.3 使用场景 ##

场景非常多：

*  请求鉴权：一般放在pre类型，如果发现没有访问权限，直接就拦截了
 *  异常处理：一般会在error类型和post类型过滤器中结合来处理。
 *  服务调用时长统计：pre和post结合使用。

# 2、自定义过滤器 #

接下来我们来自定义一个过滤器，模拟一个登录的校验。基本逻辑：如果请求中有access-token参数，则认为请求有效，放行。

## 2.1 定义过滤器类 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 2]  
内容：

@Component
    public class LoginFilter extends ZuulFilter { 
        /** * 过滤器类型，前置过滤器 * @return */
        @Override
        public String filterType() { 
            return "pre";
        }
    
        /** * 过滤器的执行顺序 * @return */
        @Override
        public int filterOrder() { 
            return 1;
        }
    
        /** * 该过滤器是否生效 * @return */
        @Override
        public boolean shouldFilter() { 
            return true;
        }
    
        /** * 登陆校验逻辑 * @return * @throws ZuulException */
        @Override
        public Object run() throws ZuulException { 
            // 获取zuul提供的上下文对象
            RequestContext context = RequestContext.getCurrentContext();
            // 从上下文对象中获取请求对象
            HttpServletRequest request = context.getRequest();
            // 获取token信息
            String token = request.getParameter("access-token");
            // 判断
            if (StringUtils.isBlank(token)) { 
                // 过滤该请求，不对其进行路由
                context.setSendZuulResponse(false);
                // 设置响应状态码，401
                context.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);
                // 设置响应信息
                context.setResponseBody("{\"status\":\"401\", \"text\":\"request error!\"}");
            }
            // 校验通过，把登陆信息放入上下文信息，继续向后执行
            context.set("token", token);
            return null;
        }
    }

## 2.2 测试 ##

没有token参数时，访问失败：

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

添加token参数后：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 4]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20230528/6e0fb97e54364b369bae88873a16e727.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20230528/316ff52e278c4b2eaf0b74e5521b0778.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20230528/99b23c5b58ac4195bb20733691113826.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20230528/0e284bc9e9de43c48b0441e86ece616f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x1Y2t5c3Rhcl85OQ_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20230528/17ffd7c07c9f452b880f3850a60598c9.png