基于Spring cloud gateway定制的微服务网关

在构建微服务的架构体系过程中,API网关是一个非常重要的组件。那我们应该怎样实现一个微服务API网关,本文主要介绍Spring Cloud Gateway的功能,以及如何基于Spring Cloud Gateway定制自己的网关。

Spring Cloud

Spring Cloud Gateway

Spring Cloud Gateway提供的是一个用于在Spring MVC之上构建API网关的library,它的目标是提供一种简单而有效的方式路由API请求,它提供了一个切面,主要关注:安全、监控/metrics、弹性伸缩。

Spring Cloud Gateway 特性:

  • 使用Spring Framework 5, Project Reactor 和 Spring Boot 2.0实现;
  • 可以在请求的任何属性上匹配路由;
  • 通过Predicate 和 filter 指定路由;
  • 集成了Hystrix 的熔断机制;
  • 集成了Spring Cloud 的服务发现机制;
  • 易于编写 Predicate 和 Filter;
  • 请求限流;
  • 重定向;

定制API网关的目标

从Spring cloud gateway的官方文档中可以查到,它主要关注于安全、监控、弹性伸缩,但是它只是提供了开发这些功能的基础,直接用于生产的话,用起来体验不是很好。各种配置都是写在application.yaml的配置文件中,修改起来不是很方便,每次修改都需要重启服务,有一种不需要重启服务的方法是使用配置中心;但是这些配置(路由策略、熔断机制、限流策略等)配置不是很好记,不满足国内软件的要求(漂亮的配置后台)。

安全:关于安全其实Spring cloud gateway本身并没有任何实现,要想实现网关的安全控制,一般有两种方式:依赖Spring boot security实现基于JWT(或者OAuth2) token的认证;另一种就是直接使用网关分配appId,来识别事先配置的权限。以上是API权限的控制,还有一种安全是参数防篡改的方法:对请求参数做签名验签名。

API网关的安全目标是,支持多种安全方式自由选择和组合,并且可以在管理后台配置,实时生效。

动态路由:意思是在线修改路由配置,并实时生效。Spring cloud gateway自身提供的路由配置方式有两种:编写代码和application.yaml中配置,在Spring cloud gateway启动的时候加载到内存中,所以要修改路由的话也是需要重启网关。但Spring cloud gateway提供了自定义路由RouteDefinitionRepository类的入口,并且还监听了刷新路由事件RefreshRoutesEvent

API网关的动态路由的目标是,支持在管理后台配置和修改服务路由,并且实时生效。具体实现方式可以参考 动态路由的实现方式详解

熔断、降级:在分布式系统中这两个特性一般是同时出现,代表了系统容错性。Spring cloud gateway中依赖Hystrix来实现,目前支持的是在application.yaml中配置熔断和降级策略,这种配置方式,修改的话需要重启网关。

API网关的熔断降级配置目标是,支持在管理后台操作:是否开启断路器、熔断策略、调整降级方案,并且实时生效。

限流:API网关上一般会有大量请求,为了提供整体服务的可用性和稳定性,经常会对指定服务限流。当请求量达到限流上限的时候,可以选择拒绝服务、排队或者降级;Spring cloud gateway中依赖了redis来实现限流,通过KeyResolver来配置限流策略。它也存在同样的问题,就是修改配置需要重启服务。

API网关的限流目标是,支持管理后台配置限流策略,以及速率调整,并且实时生效。

弹性伸缩:这一般是有基础设施平台提供的特性,一般的容器云平台都是支持,实时监控API网关的压力和健康状态,自动做出相应的伸缩容处理。整个Spring cloud体系都是基于云原生的指导思想建设的,所以还是比较容易实现这一点的。

API网关的弹性伸缩目标是,支持标准的容器云平台的部署,并且能提供平台监控指标。

监控:监控是一个高可用系统必不可少的功能,Spring cloud gateway是通过Spring boot actuator实现可监控的,它可以输出全方位的监控数据,并且还支持定制监控指标。还通过micrometer提供了多种监控数据格式的输出,最常用的就是prometheus

API网关的监控目标是,通过Actuator+Prometheus+Grafana三个工具组合来实现API网关的可视化监控,并且配置相应的报警。

API文档:一个完美的API文档是API网关脸面,因为接入API网关的应用(也就是API的用户)最先看到的就是API文档,作为程序员大家都不喜欢写这种文档,因此API网关必须能提供一种方法,方便输出漂亮的API文档。目前swagger ui早已在Spring cloud的后端微服务中流行开来,因此API网关需要将它们聚合起来。

API网关的API文档目标是,通过聚合后端服务的swagger ui来实现API文档的输出,当然还需要结合安全特性来控制API文档的权限。

实现一个API网关

上面设定了要实现一个API网关的各种目标(要求),并且论证了基于Spring cloud gateway实现它们的可行性,下面就需要依依实现它们了,最终你会发现,实现了一个阿里云的API网关。

以后的文章会继续介绍每一个功能特性的详细设计与实现方案。

推荐阅读更多精彩内容