Kong[nginx]-10 插件开发体验

KONG专题目录

0x00 TL;DR

通过学习本文, 可以了解Kong插件的基本信息:

目录规则

文件名称规则

您还可以看到插件代码的手动发布流程

但是, 本文不涉及插件开发内容.

0x01 插件目录结构

一个标准的Kong插件的目录结构是:
kong.plugins.<plugin_name>.<module_name>

比如有这样一个目录:
/opt/share/kong/plugins/hello-plugin

目录参考

我们来分解说明一下上面的目录:

/opt/share 插件的工作目录, 类似于java的工程目录下的 src ,用户可以随意指定到其他位置.
kong/plugins 插件的标准目录树.可以理解为java中的标准父包名,用户不可修改
hello-plugin, 代表插件名称包路径. 学名: plugin_name.
*.lua, 插件文件
- 重点: handler.lua,schema.lua
  这两个固定名称的lua文件是我们需要开发的核心部分,这两个文件必需存在.

0x02 关于`handler.lua,schema.lua`

handler.lua : the core of your plugin. It is an interface to implement, in which each function will be run at the desired moment in the lifecycle of a request / connection.
schema.lua: your plugin probably has to retain some configuration entered by the user. This module holds the schema of that configuration and defines rules on it, so that the user can only enter valid configuration values.
handler.lua : 此文件是插件核心功能. 此文件是继承了一个通用接口, 实现了一些具体业务方法.
在具体的http请求的生命周期中, 这些方法会被调用, 从而实现插件的功能.
schema.lua : 用于接收和维护管理员对此插件的自定义参数设置信息.

0x03 如何发布一个插件

假设我们已经有一个套插件代码,需要如何部署呢?

官方文档介绍了两种:

通过 luarocks包管理的方式部署

纯手动部署

本着够用的原则(其实就是懒),这里重点介绍手动部署流程:
大概分以下几步:

创建插件工作目录,复制代码
配置/etc/kong/kong.conf文件, 让kong加载插件
重启kong服务

0x04 代码准备

创建目录,并从Kong以有的插件中,复制一份插件源码到工作目录下

# 创建目录
mkdir -p /opt/share/kong/plugins/hello-plugin
cd /opt/share/kong/plugins/hello-plugin
# 从kong的标准库插件中,复制一份插件源码出来
cp /usr/local/share/lua/5.1/kong/plugins/response-transformer/*.lua .

完成后的目录效果如下图:

目录参考

到此, 我们的插件代码已经准备OK

0x05 配置文件修改

配置文件修改很方便, 只需要增加插件目录, 并启用插件名称即可:

vim /etc/kong/kong.conf

修改内容:

# 添加自定义插件工作目录
lua_package_path = /opt/share/?.lua;;

# 启用插件: hello-plugin
#  bundled: 表示Kong, 自带插件
plugins = bundled, hello-plugin

0x06 重启服务并验证

执行命令:kong restart
接下来, 打开 kong的WebUI, 查看一下首页底部信息:
如果能看到我们的新插件名称,则表示插件部署成功.

成功加载hello插件

恩,感觉很好, 就像真的写好一个插件似的 _{_}

0x07 What's next

今天体验了一波插件部署过程, 感觉过程还是比较简单的.
接下来,当然是编写插件啦...

PS. `利奇马`今晚强势过境, 我是不是应该屯点什么了...