zuul执行顺序

zuul架构图

zuul详解

ZuulServlet类

1. 初始化zuulRunner对象。
   
2. 执行zuulFilter。

   @Override
   public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws ServletException, IOException {
       try {
           init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);
   
           // Marks this request as having passed through the "Zuul engine", as opposed to servlets
           // explicitly bound in web.xml, for which requests will not have the same data attached
           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();
       }
   }
   

3. filter执行顺序。
   • 【pre】–>【error】–>【post】
   • 【pre】–>【route】–>【error】–>【post】
   • 【pre】–>【route】–>【post】–>【error】
   • 【error】

zuulRunner类

1. 将HttpServletRequest和HttpServletResponse初始化放在上下文RequestContext中。RequestContext在整个请求期间有效，并且是线程本地的。
   
2. 包装了FilterProcessor类。包含它的preRoute(), route(), postRoute(), and error()方法。

    /**
    * executes "post" filterType  ZuulFilters
    *
    * @throws ZuulException
    */
   public void postRoute() throws ZuulException {
       FilterProcessor.getInstance().postRoute();
   }
   
   /**
    * executes "route" filterType  ZuulFilters
    *
    * @throws ZuulException
    */
   public void route() throws ZuulException {
       FilterProcessor.getInstance().route();
   }
   
   /**
    * executes "pre" filterType  ZuulFilters
    *
    * @throws ZuulException
    */
   public void preRoute() throws ZuulException {
       FilterProcessor.getInstance().preRoute();
   }
   
   /**
    * executes "error" filterType  ZuulFilters
    */
   public void error() {
       FilterProcessor.getInstance().error();
   }
   

FilterProcessor类

1. 真正去执行过滤器的类。

   public void postRoute() throws ZuulException {
       try {
           runFilters("post");
       } catch (ZuulException e) {
           throw e;
       } catch (Throwable e) {
           throw new ZuulException(e, 500, "UNCAUGHT_EXCEPTION_IN_POST_FILTER_" + e.getClass().getName());
       }
   }
   
   public void error() {
       try {
           runFilters("error");
       } catch (Throwable e) {
           logger.error(e.getMessage(), e);
       }
   }
   
   public void route() throws ZuulException {
       try {
           runFilters("route");
       } catch (ZuulException e) {
           throw e;
       } catch (Throwable e) {
           throw new ZuulException(e, 500, "UNCAUGHT_EXCEPTION_IN_ROUTE_FILTER_" + e.getClass().getName());
       }
   }
    public void preRoute() throws ZuulException {
       try {
           runFilters("pre");
       } catch (ZuulException e) {
           throw e;
       } catch (Throwable e) {
           throw new ZuulException(e, 500, "UNCAUGHT_EXCEPTION_IN_PRE_FILTER_" + e.getClass().getName());
       }
   }
   

2. runFilters(String sType)方法做了什么？

   public Object runFilters(String sType) throws Throwable {
       if (RequestContext.getCurrentContext().debugRouting()) {
           Debug.addRoutingDebug("Invoking {" + sType + "} type filters");
       }
       boolean bResult = false;
       List<ZuulFilter> list = FilterLoader.getInstance().getFiltersByType(sType);
       if (list != null) {
           for (int i = 0; i < list.size(); i++) {
               ZuulFilter zuulFilter = list.get(i);
               Object result = processZuulFilter(zuulFilter);
               if (result != null && result instanceof Boolean) {
                   bResult |= ((Boolean) result);
               }
           }
       }
       return bResult;
   }
   

   FilterLoader.getInstance().getFiltersByType(sType);这个方法是拿到所有sType这个类型的过滤器，并且按照priority排序(从小到大，小的先执行)。
   processZuulFilter(zuulFilter);这个方法是执行过滤器，并返回结果【true】or【false】。

3. processZuulFilter(ZuulFilter filter)方法做了什么？

    public Object processZuulFilter(ZuulFilter filter) throws ZuulException {
   
       RequestContext ctx = RequestContext.getCurrentContext();
       boolean bDebug = ctx.debugRouting();
       final String metricPrefix = "zuul.filter-";
       long execTime = 0;
       String filterName = "";
       try {
           long ltime = System.currentTimeMillis();
           filterName = filter.getClass().getSimpleName();
           
           RequestContext copy = null;
           Object o = null;
           Throwable t = null;
   
           if (bDebug) {
               Debug.addRoutingDebug("Filter " + filter.filterType() + " " + filter.filterOrder() + " " + filterName);
               copy = ctx.copy();
           }
           
           ZuulFilterResult result = filter.runFilter();
           ExecutionStatus s = result.getStatus();
           execTime = System.currentTimeMillis() - ltime;
   
           switch (s) {
               case FAILED:
                   t = result.getException();
                   ctx.addFilterExecutionSummary(filterName, ExecutionStatus.FAILED.name(), execTime);
                   break;
               case SUCCESS:
                   o = result.getResult();
                   ctx.addFilterExecutionSummary(filterName, ExecutionStatus.SUCCESS.name(), execTime);
                   if (bDebug) {
                       Debug.addRoutingDebug("Filter {" + filterName + " TYPE:" + filter.filterType() + " ORDER:" + filter.filterOrder() + "} Execution time = " + execTime + "ms");
                       Debug.compareContextState(filterName, copy);
                   }
                   break;
               default:
                   break;
           }
           
           if (t != null) throw t;
   
           usageNotifier.notify(filter, s);
           return o;
   
       } catch (Throwable e) {
           if (bDebug) {
               Debug.addRoutingDebug("Running Filter failed " + filterName + " type:" + filter.filterType() + " order:" + filter.filterOrder() + " " + e.getMessage());
           }
           usageNotifier.notify(filter, ExecutionStatus.FAILED);
           if (e instanceof ZuulException) {
               throw (ZuulException) e;
           } else {
               ZuulException ex = new ZuulException(e, "Filter threw Exception", 500, filter.filterType() + ":" + filterName);
               ctx.addFilterExecutionSummary(filterName, ExecutionStatus.FAILED.name(), execTime);
               throw ex;
           }
       }
   }
   

   执行filter,拿到返回结果。有异常，抛出zuulException。

ZuulFilter类

属性名	说明
filterType	pre，route，post，error
filterOrder	filter优先级

public ZuulFilterResult runFilter() {
        ZuulFilterResult zr = new ZuulFilterResult();
        if (!isFilterDisabled()) {
            if (shouldFilter()) {
                Tracer t = TracerFactory.instance().startMicroTracer("ZUUL::" + this.getClass().getSimpleName());
                try {
                    Object res = run();
                    zr = new ZuulFilterResult(res, ExecutionStatus.SUCCESS);
                } catch (Throwable e) {
                    t.setName("ZUUL::" + this.getClass().getSimpleName() + " failed");
                    zr = new ZuulFilterResult(ExecutionStatus.FAILED);
                    zr.setException(e);
                } finally {
                    t.stopAndLog();
                }
            } else {
                zr = new ZuulFilterResult(ExecutionStatus.SKIPPED);
            }
        }
        return zr;
    }

执行filter的run()方法，得到返回值。用ZuulFilterResult包装。