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

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

  • 轻量级配置,所有路由规则都定义在文件中,不需要后端DB。
  • 除了服务于产品环境,它还支持测试场景,提供Mock机制,让前后端的接口通过配置文件得以固化。

本文将对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还有这些特性:

  • 支持按HTTP Method进行Mock
  • statusCode和payload都支持闭包,以其返回值为最终结果,支持动态Mock。

灵活的上游请求

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

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

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

其他值得一提的特性

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

  • 支持URL Path Parameters
  • 支持JWT,token获取和token刷新
  • 支持CORS
  • 灵活的login配置
  • 支持断路器,对于每个发往后端的请求,dgate会将其包裹在一个断路器中。可视为对于后端API的decorator。

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

限制

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

  • 前端请求经过dgate之后,都会变成【HTTP METHOD + Request BODY】的形式,Form请求也不例外。
  • 虽然支持JWT,但整个验证过程仍需结合外部。因为,我们相信这里并没有一刀切的方式。
  • 上游服务的地址时硬编码,这在未来将会改进
  • 仅支持HTTP方式的调用,未来会考虑支持gRPC

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

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

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,494评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,047评论 25 707
  • 高效的秘诀:对事讲效率,对人讲效果 001 对事 做事想高效,有一狠招:放权。 比如说,你想...
    熊师娘阅读 399评论 0 2
  • 有人说谈谈理想吧!我想说理想很丰满,现实很骨感。曾经那个为理想跳动的心如今却被打磨圆滑有些麻木了,我只知道每天为了...
    上善若水任方圆0000阅读 262评论 1 0
  • 你要学会一个人和自己相处。 因为你来到这个世界时是一个人。你走时也同样是一个人的影子。 世界很大。你要...
    会飞的玉婷酱阅读 315评论 0 0