API Gateway——KONG插件开发(官网译文)

该文为Kong官网文档译文,译者在Kong的学习中,未找到合适的中文资料。故翻译一下官方文档,供参考。译者水平有限,望多多指点。

原文地址请参见官网:https://getkong.org/docs/0.9.x/plugin-development/

一、插件开发介绍

什么是插件,它们如何与kong集成?

在进一步深入学习之前,有必要简要解释下kong是如何构建的?特别是它是如何与Nginx集成的,还有Lua如果处理它。

lua-nginx-module使Nginx具有了执行Lua脚本的功能。kong没有使用Nginx和lua-nginx-module,而是使用了已经包含了lua-nginx-module模块的OpenResty。OpenResty不是从Nginx的一个分支,但是它提供了一系列模块来扩展Nginx的功能。

因此,kong是一个被设计用来加载并执行Lua模块的应用程序(我们通常称为“插件”),而且提供了一个完整的开发环境,包括数据库抽象、迁移、助手和更多…

你的插件由lua模块组成,它们能被Kong载并执行,得益于以下两个api:

1、lua-nginx-moduleAPI:允许与进行Nginx交互,例如,举个例子,检索请求/响应,或访问Nginx的共享内存区域。

2、Kong's plugin environment:允许与数据存储交互以操作你的配置(apis、消费者、插件…),而且提供多种工具以实现各插件间交互。并和各种助手允许插件彼此之间进行互动。这个环境接下来会进行描述。

提示:本指南假定你已了解Lua和lua-nginx-moduleAPI,该指南只描述kong的插件环境。


二、插件开发--文件结构

注:此章节假定你熟悉Lua

你的插件是一些lua模块的集合。本章描述的每个文件都被认为一个独立的模块。如果你按以下约定命名你的插件模块,kong会发现并加载他们。

"kong.plugins.<plugin_name>.<module_name>"

当然,你的模块需要通过package.path 变量被访问,关于这个变量,你可以通过 nginx配置中lua-package-path进行调整。然而,更推荐的方式是通过luarocks安装插件。更多内容见以后章节。

为了让kong意识到他需要查找你的插件模块,你必须把他加入到配置中的 custom_plugins 属性上,例如:

custom_plugins:

        -my-custom-plugin       # your plugin name here

现在,kong将尝试自加载本章描述的模块。其中一些儿模块是必须的,其中一些将被忽略,kong认为你不会用到他们。比如,kong加载 "kong.plugins.my-custom-plugin.handler" 以查找并执行你的插件逻辑。

现在让我们看下,你能实现什么模块以及他们的目标是什么?

1、基础插件模块

以下示例,是一个有两个必须模块组成的插件:

simple-plugin

├── handler.lua

└── schema.lua

handle.lua:插件的核心。它是一个待实现的接口,其中的每个方法会运行在请求生命周期的期望的时刻。

schema.lua:你的插件很可能必须获取用户输入的配置。这个模块配置schema以及相关约束,所以,用户只能输入有效的配置值。

2、高级插件模块

一些插件可能必须跟Kong深度集成:拥有他们自己的数据库,在Admin API中暴露接口,等等...以上每个功能都可以通过增加一个新的模块到你的插件来实现。如果想要实现所有的可选模块,请参见以下插件结构:

complete-plugin

├── api.lua

├── daos.lua

├── handler.lua

├── hooks.lua

├── migrations

│  ├── cassandra.lua

│  └── postgres.lua

└── schema.lua

这里是一个完整的模块列表以及们功能的简单描述。这个指导文档将会详细的让你掌握他们中的每一部分。

未完,待续.....

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

推荐阅读更多精彩内容