SpringCloud API网关-Zuul-低调大师

SpringCloud API网关-Zuul

2018-12-17 519

如果所有的微服务系统都对外提供服务，那么这些微服务系统都需要实现诸如数据验证、安全校验、接口权限等功能，这对于系统的维护非常不利，这也就是api网关存在的原因。在SpringCloud的大家庭中，使用的是zuul组件来搭建api网关。zuul是一个能够实现动态路由、监控、弹性扩展并且安全的API网关组件。

在之前的一篇博客《API网关系统架构》中，有讨论过一个成熟的网关系统应该具备注入：统一接入、安全防护、流量管控、协议转换、安全、高可用、高并发、方便扩展、方便运维等能力，所以这里不过多讨论api网关应该如何设计，本文重点从源码的角度分析Zuul的实现。

一请求路由

路由的功能其实比较简单，代码层面只需要能够实现将用户的请求路径和服务提供者相对应即可，所以这一部分没有附带源码，仅简单的列举了其主要的路由规则。

1 传统路由方式

配置规则

zuul.routes.<路由名称>.path=<路径映射>

zuul.routes.<路由名称>.url=<服务提供者地址>

示例如下：

zuul.routes.api-a-url.path=/test/**

zuul.routes.api-a-url.url=http://localhost:8080/test

此规则表示所有/test/**请求都会使用 http://localhost:8080/test对应的微服务上。

2 面向服务的路由方式

配置规则：

zuul.routes.<路由名称>.path=<路径映射>

zuul.routes.<路由名称>.serviceId=<服务名>

示例如下：

zuul.routes.api-a.path=/testa/**

zuul.routes.api-a.serviceId=testa-service

zuul.routes.api-b.path=/testb/** 

zuul.routes.api-b.serviceid=testb- service

此规则表示所有/testa/**请求都会使用testa-service的微服务，所有/testb/**请求都会使用testb-service的微服务，当然这需要配合Eureka来使用。

二过滤器

如果想让底层的业务系统收到的请求都是经过安全验证的，返回结果具有统一格式等，在zuul中可以通过过滤器实现，

1 请求生命周期

1) zuul 1.0结构

https://github.com/Netflix/zuul/wiki/How-it-Works，如下所示：

2) zuul 2.0结构

https://github.com/Netflix/zuul/wiki/How-It-Works-2.0，如下所示：

Inbound Filters是前置过滤器，Outbound Fileter是后置过滤器

2 过滤器

可以继承ZuulFilter创建过滤器，示例如下：

public class TestFilter extends ZuulFilter  {
    @Override
    public String filterType() {
        //pre、post、error

        return "pre";
    }

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

    @Override
    public boolean shouldFilter() {
        // 需要使用此过滤器拦截，则需要返回true

        return true;
    }

    @Override
    public Object run() {
        // 过滤的逻辑

}

}

filterType: 过滤器的类型，取值包括：

pre：可以在请求被路由之前调用。

routing：在路由请求时被调用。

post: 在routing和error过滤器之后被调用。

error: 处理请求时发生错误时被调用。

filterOrder：过滤器的执行顺序。当请求在一个阶段中存在多个过滤器时，需要根据该方法返回的值来依次执行，数字越小越先执行。

shouldFilter：判断该过滤器是否需要被执行，可以利用该函数来指定过滤器的有效范围。

run：过滤器的具体逻辑

3 Zuul提供的过滤器

1) 处理过程

默认情况下，zuul提供的filter会按照以下顺序执行。

2) Pre过滤器

a) ServletDetectionFilter

用来检测当前请求是通过Spring的DispatcherServlet处理运行的，还是通过Zuu1Servlet来处理运行的。可以通过一下代码获取检测结果：

RequestContext ctx = RequestContext.getCurrentContext();
boolean isDetectionRequest = ctx.get(RequestUtils.IS_DISPATCHERSERVLETREQUEST);

一般情况下，发送到API网关的外部请求都会被Spring的DispatcherServlet处理，除了通过/zuul/路径访问的请求外，因为此种请求会被Zuu1Servlet处理，主要用来应对处理大文件上传的情况。可以通过zuul.servletPath参数来进行修改。

b) Servlet30WrapperFilter

主要为了将HttpServletRequest包装成Servlet30RequestWrapper对象。

c) FormBodyWrapperFilter

该过滤器仅对contentType为application/x-www-form-urlencoded或者multipart/form-data的请求有效。作用是将HttpServletRequest包装成FormBodyRequestWrapper对象。

d) DebugFilter

根据配置参数zuul.debug.requet和请求中的debug参数来决定是否执行过滤器中的操作，其代码如下：

@Override
public boolean shouldFilter() {
   HttpServletRequest request = RequestContext.getCurrentContext().getRequest();
   if ("true".equals(request.getParameter(DEBUG_PARAMETER.get()))) {
      return true;
   }
   return ROUTING_DEBUG.get();
}

@Override
public Object run() {
   RequestContext ctx = RequestContext.getCurrentContext();
   ctx.setDebugRouting(true);
   ctx.setDebugRequest(true);
   return null;
}

e) PreDecorationFilter

该过滤器会判断当前请求上下文中是否存在forward.to和serviceId参数，如果都不存在，那么会执行过滤器的操作。

此过滤器的内容是为当前请求做一些预处理，比如，进行路由规则的匹配、在请求上下文中设置该请求的基本信息以及将路由匹配结果等一些设置信息等，这些信息将是后续过滤器进行处理的重要依据，我们可以通过RequestContext.getCurrentContext ()来访问这些信息。

3) Routing过滤器

a) RibbonRoutingFilter

该过滤器只对请求上下文中存在serviceid参数的请求进行处理，即只对通过service工d配置路由规则的请求生效。而该过滤器的执行逻辑就是面向服务路由的核心，它通过使用Ribbon和Hystrix来向服务实例发起请求，并将服务实例的请求结果返回。

b) SimpleHostRoutingFilter

该过滤器只对通过url配置路由规则的请求生效。而该过滤器的执行逻辑就是直接向routeHost参数的物理地址发起请求。

public Object run() {
   RequestContext context = RequestContext.getCurrentContext();
   HttpServletRequest request = context.getRequest();
   MultiValueMap<String, String> headers = this.helper
        .buildZuulRequestHeaders(request);
   MultiValueMap<String, String> params = this.helper
        .buildZuulRequestQueryParams(request);
   String verb = getVerb(request);
   InputStream requestEntity = getRequestBody(request);
   if (request.getContentLength() < 0) {
      context.setChunkedRequestBody();
   }
   String uri = this.helper.buildZuulRequestURI(request);
   this.helper.addIgnoredHeaders();
   try {
      HttpResponse response = forward(this.httpClient, verb, uri, request, headers,
            params, requestEntity);
      setResponse(response);
   }
   catch (Exception ex) {
      context.set(ERROR_STATUS_CODE,
           HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
     context.set("error.exception", ex);
   }
   return null;
}

c) SendForwardFilter

仅仅对forward请求有效，该过滤器只对请求上下文中存在forward.to参数的请求进行处理。

@Override
public boolean shouldFilter() {
   RequestContext ctx = RequestContext.getCurrentContext();
   return ctx.containsKey("forward.to")
         && !ctx.getBoolean(SEND_FORWARD_FILTER_RAN, false);
}

@Override
public Object run() {
   try {
      RequestContext ctx = RequestContext.getCurrentContext();
      String path = (String) ctx.get("forward.to");
      RequestDispatcher dispatcher = ctx.getRequest().getRequestDispatcher(path);
      if (dispatcher != null) {
        ctx.set(SEND_FORWARD_FILTER_RAN, true);
         if (!ctx.getResponse().isCommitted()) {
           dispatcher.forward(ctx.getRequest(), ctx.getResponse());
           ctx.getResponse().flushBuffer();
         }
      }
   }
   catch (Exception ex) {
     ReflectionUtils.rethrowRuntimeException(ex);
   }
   return null;
}

4) post过滤器

a) SendErrorFilter

该过滤器仅在请求上下文中包含error.status_code参数并且还没有被该过滤器处理过的时候执行。该过滤器逻辑就是forward到API网关/error来影响错误信息。

@Override
public boolean shouldFilter() {
   RequestContext ctx = RequestContext.getCurrentContext();
   // only forward to errorPath if it hasn't been forwarded to already
   return ctx.containsKey("error.status_code")
         && !ctx.getBoolean(SEND_ERROR_FILTER_RAN, false);
}

@Override
public Object run() {
   try {
      RequestContext ctx = RequestContext.getCurrentContext();
      HttpServletRequest request = ctx.getRequest();

      int statusCode = (Integer) ctx.get("error.status_code");
     request.setAttribute("javax.servlet.error.status_code", statusCode);

      if (ctx.containsKey("error.exception")) {
         Object e = ctx.get("error.exception");
         log.warn("Error during filtering", Throwable.class.cast(e));
        request.setAttribute("javax.servlet.error.exception", e);
      }

      if (ctx.containsKey("error.message")) {
         String message = (String) ctx.get("error.message");
        request.setAttribute("javax.servlet.error.message", message);
      }

      RequestDispatcher dispatcher = request.getRequestDispatcher(
            this.errorPath);
      if (dispatcher != null) {
         ctx.set(SEND_ERROR_FILTER_RAN, true);
         if (!ctx.getResponse().isCommitted()) {
            dispatcher.forward(request, ctx.getResponse());
         }
      }
   }
   catch (Exception ex) {
     ReflectionUtils.rethrowRuntimeException(ex);
   }
   return null;
}

b) SendResponseFilter

该过滤器会检查请求上下文中是否包含请求响应相关的头信息、响应数据流或是响应体，只要包含其中一个的时候执行处理逻辑。

该过滤器的处理逻辑是利用请求上下文的响应信息来组织需要发送回客户端的响应内容。

@Override
public boolean shouldFilter() {
return !RequestContext.getCurrentContext().getZuulResponseHeaders().isEmpty()
         || RequestContext.getCurrentContext().getResponseDataStream() != null
         || RequestContext.getCurrentContext().getResponseBody() != null;
}

@Override
public Object run() {
   try {
      addResponseHeaders();
      writeResponse();
   }
   catch (Exception ex) {
     ReflectionUtils.rethrowRuntimeException(ex);
   }
   return null;
}

4 禁用过滤器

默认情况下，过滤器都是启用状态的。那么有哪些方式来禁用过滤器呢？

1) shouldFilter返回false

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

这种方式对于自定义过滤器来说，可以实现禁用的功能，但是不太方便，因为每次修改都要重新修改代码，重新打包。

2) 配置项

Zuul中特别提供了配置项来禁用过滤器，该配置格式如下:

zuul.<SimpleClassName>.<filterType>.disable=true

<SimpleClassName>代表过滤器的类名，< filterType >代表过滤器类型。如果自定义了一个前置过滤器类AccessFilter，当希望禁用此过滤器类时，可以这样配置：

zuul.AccessFilter.pre.disable=true

三参考文档

1 博客

zuul wiki

How It Works 2.0

2 书籍

《Spring Cloud微服务实战》

代码：https://github.com/dyc87112/SpringCloudBook.git

微信关注我们

原文链接：https://yq.aliyun.com/articles/680349

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

深入 Java Timer 定时任务调度器实现原理

使用 Java 来调度定时任务时，我们经常会使用 Timer 类搞定。Timer 简单易用，其源码阅读起来也非常清晰，本节我们来仔细分析一下 Timer 类，来看看 JDK 源码的编写者是如何实现一个稳定可靠的简单调度器。 Timer 使用 Timer 调度任务有一次性调度和循环调度，循环调度有分为固定速率调度(fixRate)和固定时延调度(fixDelay)。固定速率就好比你今天加班到很晚，但是到了第二天还必须准点到公司上班，如果你一不小心加班到了第二天早上 9 点，你就连休息的时间都没有了。而固定时延的意思是你必须睡够 8 个小时再过来上班，如果你加班到凌晨 6 点，那就可以下午过来上班了。固定速率强调准点，固定时延强调间隔。如果你有一个任务必须每天准点调度，那就应该使用固定速率调度，并且要确保每个任务执行时间不要太长，千万别超过了第二天这个点。如果你有一个任务需要每隔几分钟跑一次，那就使用固定时延调度，它不是很在乎你的单个任务要跑多长时间。内部结构 Timer 类里包含一个任务队列和一个异步轮训线程。任务队列里容纳了所有待执行的任务，所有的任务将会在这一个异步线程里执行，切...

2018-12-18

498

盛夏的杭州我们在讲SQL 初秋的北京我们在谈OB 2.0 天气慢慢转凉，仿佛一夜之间就入冬了这个冬天我们来到了上海想与你们聊聊 OceanBase支撑蚂蚁双11背后的关键技术和实战分享三位双11背后的男人将为大家带来大促背后核心技术的全揭秘点击文末链接即可报名活动活动时间：12月23日，13:30-17:30 活动地点：上海市杨浦区政学路77号INNOSPACE旗舰一楼IPOclub（地铁10号线江湾体育场站7口出）报名通道已经开启：https://tech.antfin.com/activities/41 强势阵容梅庆（花名：庆涛）现任蚂蚁金服OceanBase团队技术专家，曾经支持过阿里云数据库和天猫双11大促业务，在分布式数据库的开发和架构上有着丰富的经验。目前主要从事OceanBas

2018-12-18

693

资源下载

更多资源

优质分享App

近一个月的开发和优化，本站点的第一个app全新上线。该app采用极致压缩，本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题，腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构，目前腾讯云软件源站支持公网访问和内网访问。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。