微服务之ZuulFilter

我们在写微服务的时候每一个请求都是走的微服务的网关，再由网关找到对应的服务，然后传递参数请求数据返回数据，我们通常会在网关对于我们的请求做一些操作，包括请求前以及响应前，这里主要说一下微服务中常用的ZuulFilter过滤器

@Component
public class MyFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return  FilterConstants.POST_TYPE;
    }
    @Override
    public int filterOrder() {
        return 1;
    }
    @Override
    public boolean shouldFilter() {
        return true;
    }
    @Override
    public Object run() throws ZuulException {
}

我们手动去继承ZuulFilter这个类，然后需要我们重写几个方法

filterType（）：

这个方法的作用是用来标识这个过滤器在哪个阶段发挥作用,在ZuulFilter源码中是这样描述的

 /**
     * to classify a filter by type. Standard types in Zuul are "pre" for pre-routing filtering,
     * "route" for routing to an origin, "post" for post-routing filters, "error" for error handling.
     * We also support a "static" type for static responses see  StaticResponseFilter.
     * Any filterType made be created or added and run by calling FilterProcessor.runFilters(type)
     *
     * @return A String representing that type
     */
    abstract public String filterType();

我们这里常用的就是pre，route，post，error，当然还有"static"还有一些自定义的，

pre：

这是最开始生效的,这是服务器接收到请求，还没有到达网关的时候生效，我们常用于过滤请求，身份验证什么的，在集群中选择具体的微服务，记录日志之类的信息。

1.2 route

当我们把fifter type设置为route的时候就表示我们的过滤器的生效时间是在我们网关接收到请求但是还没有转发到具体的微服务的时候过滤器生效，用来构建新的请求，比如我们将一些数值信息从token中解析出来存放到我们的请求中，再Apache HttpClient或Netfilx Ribbon请求具体问服务。

post

这是我们的具体微服务将请求的数据存返回的时候经过的过滤器，比如我们将响应的参数进行加密。

1.2 error

当我们的服务器在接收到请求报错的情况下

filterOrder()

/**
     *
     * @return
     */
    @Override
    public int filterOrder() {
        return FilterConstants.SEND_RESPONSE_FILTER_ORDER - 4;
    }

这个方法主要是我们在注册过滤器的时候形成过滤链的时候排序使用，这是设置的过滤器的使用顺序

shouldFilter()

    @Override
    public boolean shouldFilter() {
        return true;
    }

这个方法的功能是用来过滤请求是否需要走下面的具体的run方法，主要是为了区分不同过滤器针对不同的url

run()

 @Override
    public Object run() throws ZuulException {
}

这是我们的过滤器的方法主题在这里写我们主要的方法，（解密，token验证，权限验证，重构请求或者响应，解密）

以上就是我们的ZuulFilter的主要的几个方法的讲解，当然别忘了一定要将过滤器放入到spring容器中。

备注 ：

RequestContext context = RequestContext.getCurrentContext():使用这个获取上下文内容主体,
context.setSendZuulResponse(false):用这个方法是设置不在走接下来的过滤器和微服务，直接返回

eg:

@Override
    public Object run() throws ZuulException {
        RequestContext context = RequestContext.getCurrentContext();
        try {
            InputStream stream = context.getResponseDataStream();
            if(stream!=null){
                String body = StreamUtils.copyToString(stream, StandardCharsets.UTF_8);
                JSONObject jsonObject = JSONObject.parseObject(body);
                Object code = jsonObject.get("code");
                String msg = (String)jsonObject.get("msg");
                //不是返回成功并且返回的状态码有参数但是msg没有参数信息
                if (code != null && ErrorCodeEnum.SUCCESS.getCode() != (int) code&&(ErrorCodeEnum.SUCCESS.getMsg().equals(msg)||StringUtils.isEmpty(msg))&&null!=ErrorCodeEnum.getByCode((int)code)) {
                    jsonObject.put("msg",ErrorCodeEnum.getByCode((int)code).getMsg());
                }
                //操作完成之后再将数据转化为流，下一步加密使用
                String s = JSONObject.toJSONString(jsonObject);
                context.setResponseDataStream(IOUtils.toInputStream(s, StandardCharsets.UTF_8));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }