Spring cloud Zuul Filter 使用小经验

##前言
Filter 我们用的比较多，大部分是Servlet中的Filter,通常我们用来做一些拦截，权限验证之类的工作。

今天介绍的Filter是Zuul中提供的，跟我们之前使用的Servlet Filter不太一样。

Zuul中提供Filter的作用有哪些，我觉得分为如下几点：

• 网关是暴露在外面的，必须要进行权限控制
• 可以针对服务做控制，在路由的时候处理，比如服务降级
• 防止爬虫，利用Filter对请求进行过滤
• 流量控制，只允许最高的并发量，保护后端的服务
• 灰度发布，可以针对不用的用户进行路由来实现灰度

##Filter种类

• pre：可以在请求被路由之前调用
• route：在路由请求时候被调用
• post：在route和error过滤器之后被调用
• error：处理请求时发生错误时被调用

关于zuul的Filter的生命周期，见下图

##使用
下面我们以一个IP黑名单过滤器来进行讲解

**
 * IP黑名单限制过滤器
 *
 * @author yinjihuan
 * @create 2017-11-15 18:14
 **/
public class IpFilter extends ZuulFilter {

    @Autowired
    private BasicConf basicConf;

    public IpFilter() {
        super();
    }

    @Override
    public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        Object success = ctx.get("isSuccess");
        return success == null ? true : Boolean.parseBoolean(success.toString());
    }

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 1;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        String ip = IpUtils.getIpAddr(ctx.getRequest());
        // 在黑名单中禁用
        if (StringUtils.isNotBlank(ip) && basicConf != null && basicConf.getIpStr().contains(ip)) {
            ctx.set("isSuccess", false);
            ctx.setSendZuulResponse(false);
            ResponseData data = ResponseData.fail("非法请求", ResponseCode.NO_AUTH_CODE.getCode());
            ctx.setResponseBody(JsonUtils.toJson(data));
            ctx.getResponse().setContentType("application/json; charset=utf-8");
            return null;
        }
        return null;
    }
}

最开始注入了一个BasicConf，这个是IP黑名单的配置信息，可以通过配置中心进行修改，动态生效的，详情请参考：
https://github.com/yinjihuan/smconf

shouldFilter是决定这个过滤器需不需要执行，返回false则不执行，这个也可以利用配置中心来做，达到动态的开启关闭效果,
这边是通过上下文对象，获取一个isSuccess的值来决定要不要执行的，就是说由上个过滤器告诉你要不要执行，因为上面的流程没通过，所以下面也没必要继续执行了。

filterType就是过滤器的类型了，取值分别为pre，route，post，error

filterOrder是表示过滤器执行的顺序，数字越小，优先级越高

run里面就是我们自己要执行的业务逻辑了，可以直接返回null,这个值没啥用

上面如果说当前请求的IP在黑名单中，就进行拦截操作，首先告诉下个Filter不需要执行了，通过ctx.set("isSuccess", false);

告诉zuul不需要将当前请求转发到后端的服务了，通过设置ctx.setSendZuulResponse(false);

然后组装统一的返回格式告诉调用方，这个是非法请求

上面我们就是利用pre过滤器在执行转发前进行非法IP的判断，其余的过滤器使用方法和上面一样，这是不同的类型执行的时期不一样

最后别忘了配置过滤器，不然是不会生效的

@Configuration
public class FilterConfig {

    @Bean
    public IpFilter ipFilter() {
        return new IpFilter();
    }

}

具体代码可以参考我的github:

https://github.com/yinjihuan/spring-cloud

欢迎加入我的知识星球，一起交流技术，免费学习猿天地的课程（http://cxytiandi.com/course）

PS：目前星球中正在星主的带领下组队学习Sentinel，等你哦！