背景
kong的插件開發是基于lua開發的，原理是基于lua-nginx-module的機制。kong的機制其實同openresty一樣，都是利用lua腳本動態控制路由規則。
所以增加kong自定義插件需要兩個位置：
插件目錄位置：/usr/local/share/lua/5.1/kong/plugins/
kong配置文件位置：/etc/kong/
開發HelloWorld
首先在插件目錄里增加一個文件夾：hello-world
然后在文件夾里創建兩個文件：handler.lua和schema.lua
handler.lua 是插件邏輯文件，里面放具體的過濾規則
local?BasePlugin?=?require?"kong.plugins.base_plugin"
local?http?=?require("socket.http")
local?ltn12?=?require("ltn12")
local?CustomHandler?=?BasePlugin:extend()
local?resultAns?=?">>插件開始運行了\n"
CustomHandler.VERSION??=?"1.0.0"
--設置執行的優先級，Kong?將按照插件的優先級來確定其執行順序（越大越優先）
CustomHandler.PRIORITY?=?10
--?你插件handler的構造函數。
--?如果要擴展Base?Plugin?handler，它的唯一作用就是用名稱實例化自己。
--?該名稱是您的插件名稱，同時它將打印在日志中
function?CustomHandler:new()?
? CustomHandler.super.new(self,?"hello-world")
end
function?CustomHandler:init_worker()???--?最終執行父實現?(并將記錄您的插件正在進入此上下文)?
? CustomHandler.super.init_worker(self)??--?實現任何自定義邏輯
end
function?CustomHandler:preread(config)??
?CustomHandler.super.preread(self)???--?Implement?any?custom?logic?here
end
function?CustomHandler:certificate(config)??
? CustomHandler.super.certificate(self)?????--?Implement?any?custom?logic?here
end
function?CustomHandler:rewrite(config)??
? CustomHandler.super.rewrite(self)??--?Implement?any?custom?logic?here
end
function?CustomHandler:access(config)??
? CustomHandler.super.access(self)???--?Implement?any?custom?logic?here?
? resultAns?=?resultAns?..?">>>>>>>執行：access階段開始\n輸出嵌入的內容(請求在還未到達上游服務器)：\n"?
? resultAns?=?resultAns?..?"kong.version：\t"?..?kong.version?..?"\n"?
? resultAns?=?resultAns?..?"kong.client.get_ip()：\t"?..?kong.client.get_ip()?..?"\n"??
? resultAns?=?resultAns?..?"kong.request.get_scheme()：\t"?..?kong.request.get_scheme()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_host()：\t"?..?kong.request.get_host()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_port()\t："?..?kong.request.get_port()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_http_version()：\t"?..?kong.request.get_http_version()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_method()：\t"?..?kong.request.get_method()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_path()：\t"?..?kong.request.get_path()?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_header()：\t"?..?kong.request.get_header("token")?..?"\n"?
? resultAns?=?resultAns?..?"kong.request.get_raw_body()：\t"?..?kong.request.get_raw_body()?..?"\n"?
? resultAns?=?resultAns?..?"<<<<<<<執行httprequest?\n"??resultAns?=?resultAns?..?"<<<<<<<執行access階段結束?\n"??
? local?u?=?"http://www.baidu.com"?
? local?t?=?{}?
? local?r,?c,?h?=?http.request{url?=?u, sink?=?ltn12.sink.table(t)}?
? kong.log("responsebody:",?table.concat(t))?
? return?kong.response.exit(200, resultAns, {["Content-Type"]?=?"application/json", ["WWW-Authenticate"]?=?"Basic"})
end
function?CustomHandler:header_filter(config)??
? CustomHandler.super.header_filter(self)???--?Implement?any?custom?logic?here
end
function?CustomHandler:body_filter(config)??
? CustomHandler.super.body_filter(self)???--?Implement?any?custom?logic?here
end
function?CustomHandler:log(config)??
? CustomHandler.super.log(self)???--?Implement?any?custom?logic?here
end
--?該模塊需要返回創建的表以便讓Kong?可以執行這些功能。
return?CustomHandler
schema.lua 是插件聲明文件，里面放插件的參數等申明
local?typedefs?=?require?"kong.db.schema.typedefs"
return?{?
? name?=?"hello-world",?
? fields?=?{
??? {consumer?=?typedefs.no_consumer},?
??? {config?=?{type?=?"record",
?????? fields?=?{?? --?這里的username,?會顯示在插件配置頁???????????????? {
????????????? username?=?{?????????????????????????
????????????????? type?=?"array",
????????????????? elements?=?{type?=?"string"},
????????????????? default?=?{}
? }}}}}}}
編輯kong.conf，增加plugins = bundled,hello-world。一般情況下/etc/kong里是沒有kong.conf，只有kong.conf.default和kong.logrotate，可以把kong.conf.default拷貝成kong.conf即可
測試運行
重啟服務：docker container restart 24d3ec1fa160
配置服務：
添加路由：
配置插件：
發送命令測試：curl -i 10.10.30.70:8000/index -H 'token:test' -H 'Content-Type: application/json' -d '{data:test}'
獲得測試結果：HTTP/1.1 200 OK Date: Mon, 26 Jul 2021 10:11:51 GMT Content-Type: application/json Connection: keep-alive WWW-Authenticate: Basic Content-Length: 1032 X-Kong-Response-Latency: 47 Server: kong/2.3.3 >>插件開始運行了 >>>>>>>執行：access階段開始 輸出嵌入的內容(請求在還未到達上游服務器)： kong.version： 2.3.3 kong.client.get_ip()： 10.10.30.69 kong.request.get_scheme()： http kong.request.get_host()： 10.10.30.70 kong.request.get_port() ：8000 kong.request.get_http_version()： 1.1 kong.request.get_method()： POST kong.request.get_path()： /index kong.request.get_header()： test kong.request.get_raw_body()： {data:test} <<<<<<<執行httprequest <<<<<<<執行access階段結束 >>>>>>>執行：access階段開始 輸出嵌入的內容(請求在還未到達上游服務器)：
