DTeam 团队日志

Doer、Delivery、Dream

dgate:基于Vert.x的轻量级API Gateway

胡键 Posted at — Jan 28, 2017 阅读

dgate是一款基于Vert.x的 API Gateway,它不同于大多数其他 API Gateway,主要表现在两个地方:

本文将对 dgate 的主要特性一一进行简要的说明,方便读者对 dgate 有进一步的了解。

基于 Groovy 的配置 DSL

以下是一个简单的配置文件的例子:

import io.vertx.core.http.HttpMethod

apiGateway {
    port = 7000
    host = 'localhost'
    urls {
        "/url1" {
            required = ['param1', 'param2']
            methods = ['GET', 'POST']
            upstreamURLs = [
                [host: 'localhost', port: 8080, url: '/test']
            ]
        }
        "/url2" {
            required = ['param1', 'param2']
            methods = ['GET', 'POST']
            upstreamURLs = [
                [host: 'localhost', port: 8080, url: '/test1'],
                [host: 'localhost', port: 8080, url: '/test2']
            ]
        }
    }
}

语法非常简单,基本无需做过多的解释。将其应用到 dgate 的命令如下(其中的 conf 为文件名):

java -jar dgate-版本号-fat.jar -Dconf=conf

支持测试的 Mock URL

Mock URL 主要是为了简化前后端分离(包括 Mobile 和后台)环境下的开发和测试。还是通过例子来看看:

"/mock" {
    expected {
        statusCode = 200
        payload = [test: true]
    }
}

跟前面的例子一样,这个语法也是不言自明,其中 expected 部分只需放入前后端开发人员商量好的接口即可。这样完全避免了前端等后端的情形,开发时采用 Mock 配置,产品环境下采用真实配置即可。

同时,为了更好地支持测试,dgate 还有这些特性:

灵活的上游请求

一般来讲,一个前端页面在加载过程中会向后端发起多个请求,dgate 完全支持这种场景。参见上面的“/url2”,对于前端只是暴露统一的/url2,但它对应后端的两个请求。

dgate 会同时发起多个请求,并将结果汇总,统一返还给前端。这样不仅仅降低了前端页面面对的后端 URL 数,而且通过引入中间层,让接口和实现得到分离。

并且,对于某些有特殊需要的场景,dgate 提供了 before 和 after 闭包,允许开发者在前端请求转发到后端和后端结果发往前端之前“为所欲为”。具体使用可以参见相应的文档

其他值得一提的特性

除了上面的主要功能,dgate 还具备以下特性:

各位可以从用户指南中了解进一步的细节。

限制

作为一篇介绍工具的短文,不讲限制和缺陷是不完整的,这里我就说说 dgate 的不足:

dgate 虽然已经用于我们的开发和产品环境,但离完美还有相当的一段距离。这里的所有功能都是首先为了满足我们自己的需要而开发的。因此,很难说 dgate 是否能完全适用于你的产品环境。

但是,我对 dgate 会促进和简化你的开发和测试很有信心,为何不尝试一下,;)?

参考