【SpringCloud】了解Zuul的过滤器，如何自定义一个过滤器

一、ZuulFilter的最重要的方法

ZuulFilter是过滤器的顶级父类

public abstract ZuulFilter implements IZuulFilter{

    abstract public String filterType();

    abstract public int filterOrder();
    
    boolean shouldFilter();// 来自IZuulFilter

    Object run() throws ZuulException;// IZuulFilter
}

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

二、Zuul提供的过滤器可以实现的功能

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

三、过滤器执行的生命周期

一个请求在各个过滤器的执行顺序

正常流程：

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

异常流程：

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

四、自定义过滤器

自定义一个过滤器，模拟一个登录的校验，如果请求中有access-token参数，则认为请求有效，放行。
新建一个过滤器LoginFilter

@Component
public class LoginFilter extends ZuulFilter {
    @Override
    public String filterType() {
        // 登录校验，座椅是前置拦截
        return "pre";
    }

    @Override
    public int filterOrder() {
        // 顺序设置为1
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        // 返回true，代表过滤器生效。
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        // 登录校验逻辑
        // 1 获取Zuul提供的请求上下文对象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2 从上下文中获取request对象
        HttpServletRequest req = ctx.getRequest();
        // 3 从请求中获取token
        String token = req.getParameter("access-token");
        // 4 判断
        if(token==null || "".equals(token.trim())){
            // 没有token，登录校验失败，拦截
            ctx.setSendZuulResponse(false);
            // 返回401状态码。也可以考虑重定向到登录页
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校验通过，可以考虑把用户信息放入上下文，继续向后执行
        return null;
    }
}

运行结果