您现在的位置是:LG博客 > 大数据 >

Spring Cloud Zuul过滤器介绍及使用(传递数据、拦截请求和异常处理)

2021-05-03 13:10:3163人已围观

在教程《Zuul网关的介绍及使用》中一开始就介绍过,Zuul 可以实现很多高级的功能,比如限流、认证等。想要实现这些功能,必须要基于 Zuul 给我们提供的核心组件“过滤器”。下面我们一起来了解一下 Zuul 的过滤器。
过滤器类型 Zuul 中的过滤器跟我们之前使用的 javax.servlet.Filter 不一样,javax.servlet.Filter 只有一种类型,可以通过配置 urlPatterns 来拦截对应的请求。

而 Zuul 中的过滤器总共有 4 种类型,且每种类型都有对应的使用场景。 1)pre 可以在请求被路由之前调用。适用于身份认证的场景,认证通过后再继续执行下面的流程。
2)route 在路由请求时被调用。适用于灰度发布场景,在将要路由的时候可以做一些自定义的逻辑。
3)post 在 route 和 error 过滤器之后被调用。这种过滤器将请求路由到达具体的服务之后执行。适用于需要添加响应头,记录响应日志等应用场景。
4)error 处理请求时发生错误时被调用。在执行过程中发送错误时会进入 error 过滤器,可以用来统一记录错误信息。 请求生命周期 可以通过图 1 看出整个过滤器的执行生命周期,此图来自 Zuul GitHub wiki 主页。

过滤器生命周期


图 1  过滤器生命周期


通过上面的图可以清楚地知道整个执行的顺序,请求发过来首先到 pre 过滤器,再到 routing 过滤器,最后到 post 过滤器,任何一个过滤器有异常都会进入 error 过滤器。

通过 com.netflix.zuul.http.ZuulServlet 也可以看出完整执行顺序,ZuulServlet 类似 Spring-Mvc 的 DispatcherServlet,所有的 Request 都要经过 ZuulServlet 的处理。

ZuulServlet 源码如下所示: @Override public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws ServletException, IOException { try { init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse); RequestContext context = RequestContext.getCurrentContext(); context.setZuulEngineRan(); try { preRoute(); } catch (ZuulException e) { error(e); postRoute(); return; } try { route(); } catch (ZuulException e) { error(e); postRoute(); return; } try { postRoute(); } catch (ZuulException e) { error(e); return; } } catch (Throwable e) { error(new ZuulException(e, 500, "UNHANDLED_EXCEPTION_" + e.getClass().getName())); } finally { RequestContext.getCurrentContext().unset(); } } 使用过滤器 我们创建一个 pre 过滤器,来实现 IP 黑名单的过滤操作,代码如下所示。 public class IpFilter extends ZuulFilter { // IP黑名单列表 private List<String> blackIpList = Arrays.asList("127.0.0.1"); public IpFilter() { super(); } @Override public boolean shouldFilter() { return true } @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) && blackIpList.contains(ip)) { 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; } } 由代码可知,自定义过滤器需要继承 ZuulFilter,并且需要实现下面几个方法: 1)shouldFilter 是否执行该过滤器,true 为执行,false 为不执行,这个也可以利用配置中心来实现,达到动态的开启和关闭过滤器。
2)filterType 过滤器类型,可选值有 pre、route、post、error。
3)filterOrder 过滤器的执行顺序,数值越小,优先级越高。
4)run 执行自己的业务逻辑,本段代码中是通过判断请求的 IP 是否在黑名单中,决定是否进行拦截。blackIpList 字段是 IP 的黑名单,判断条件成立之后,通过设置 ctx.setSendZuulResponse(false),告诉 Zuul 不需要将当前请求转发到后端的服务了。通过 setResponseBody 返回数据给客户端。

过滤器定义完成之后我们需要配置过滤器才能生效,IP 过滤器配置代码如下所示。 @Configuration public class FilterConfig { @Bean public IpFilter ipFilter() { return new IpFilter(); } } 过滤器禁用 有的场景下,我们需要禁用过滤器,此时可以采取下面的两种方式来实现:

利用 shouldFilter 方法中的 return false 让过滤器不再执行

通过配置方式来禁用过滤器,格式为“zuul. 过滤器的类名.过滤器类型 .disable=true”。如果我们需要禁用“使用过滤器”部分中的 IpFilter,可以用下面的配置:

-