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.."

当然，你的模块需要通过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

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

未完，待续.....