---
title: "打造高效 API 管理平台：客製化 Kong API Gateway 套件開發 - Part 2"
description: "深入探討 Kong API Gateway 自訂套件開發，從基礎概念到實戰應用，包含 handler.lua 和 schema.lua 的完整開發流程，以及套件部署與測試的最佳實踐。"
canonical_url: "https://blog.markkulab.net/post/kong-api-gateway-part2-custom-plugin"
author: "Mark Ku"
author_url: "https://blog.markkulab.net/author/mark-ku"
site: "Mark Ku's Blog"
date_published: "2025-06-20 01:01:35 +0800"
category: "DevOps"
tags: ["kong", "api gateway", "plugin development", "lua", "docker", "custom plugin"]
language: "zh-TW"
license: "CC BY 4.0"
license_url: "https://creativecommons.org/licenses/by/4.0/"
attribution: "轉載或引用請註明作者並附上原文連結"
---

# 打造高效 API 管理平台：客製化 Kong API Gateway 套件開發 - Part 2

## 撰寫套件腳本

在 Kong 的**自訂套件開發**中，`handler.lua` 和 `schema.lua` 是兩個**核心檔案**，負責定義套件的**邏輯行為**與**設定結構**。

- **handler.lua**：寫套件的「行為邏輯」，定義套件怎麼攔截或處理 API 請求和回應
- **schema.lua**：定義套件的「設定格式」，告訴 Kong 套件需要哪些參數、型態和規則

### 撰寫 handler.lua

```lua
-- 導入必要的 Kong 模組
local kong_meta = require "kong.meta"
local cjson = require "cjson.safe"

-- 定義套件的基本資訊
-- PRIORITY: 執行優先級，數字越大優先級越高
-- VERSION: 套件版本號
local CustomHandler = {
  PRIORITY = 990,
  VERSION = "1.0",
}

-- 套件的主要處理函數
-- 在 access 階段執行，用於處理請求前的邏輯
function CustomHandler:access(plugin_conf)
  kong.log(">>>>>>>> 套件開始執行 <<<<<<<<")

  -- 從套件配置中提取參數
  kong.log(">>>>>>>>> 步驟1: 載入配置參數 <<<<<<<<<")
  local METHOD = plugin_conf.method
  local HEADERS = plugin_conf.headers
  local BODY = plugin_conf.body
  kong.log(">>>>>>>>> 配置載入完成 <<<<<<<<<")

  -- 記錄配置資訊到日誌
  kong.log(">>>>>>>>> 步驟2: 記錄配置資訊 <<<<<<<<<")
  kong.log(">>>>>>>>> 請求方法 = ", cjson.encode(METHOD), "<<<<<<<<<")
  kong.log(">>>>>>>>> 請求頭部 = ", cjson.encode(HEADERS), "<<<<<<<<<")
  kong.log(">>>>>>>>> 請求體 = ", cjson.encode(BODY), "<<<<<<<<<")
  kong.log(">>>>>>>>> 配置記錄完成 <<<<<<<<<")
  
  -- access 階段不需要返回值，請求會繼續向下處理
  -- 如果需要修改請求，可以在這裡設定 header 或其他屬性
end

return CustomHandler
```

### 撰寫 schema.lua

```lua
local typedefs = require "kong.db.schema.typedefs"

return {
  name = "log-traffic",
  fields = {
    { protocols = typedefs.protocols_http },
    { config = {
        type = "record",
        -- 此處根據 handler.lua 檔案中的配置，來新增指定欄位
        fields = {
          { method = { type = "string", default = "GET"} },
          { headers = {
            type = "map",
            keys = typedefs.header_name {
              match_none = {
                {
                  pattern = "^[Hh][Oo][Ss][Tt]$",
                  err = "cannot contain 'Host' header",
                },
                {
                  pattern = "^[Cc][Oo][Nn][Tt][Ee][Nn][Tt]%-[Ll][Ee][nn][Gg][Tt][Hh]$",
                  err = "cannot contain 'Content-Length' header",
                },
              },
            },
            values = {
              type = "string",
              referenceable = true,
            },
          }},
          { body = {
            type = "map",
            keys = {
              type = "string",
              referenceable = true,
            },
            values = {
              type = "string",
              referenceable = true,
            },
          }},
        },
      },
    },
  },
}
```
P.S. vs code emmyLua 可以加速開發

## 部署自訂套件

Kong 官方建議將自訂 Plugin 放在 Kong 的 Lua 路徑下，或是 Docker 映像檔的 `/usr/local/share/lua/5.1/kong/plugins/` 目錄。不過，在開發階段，放在專案資料夾內管理即可，部署時再複製到正確位置或用 Docker volume 掛載。

### 複製套件到容器

```bash
docker cp log-traffic kong:/usr/local/share/lua/5.1/kong/plugins
```

### 進入 Kong 容器

```bash
docker exec -it -u root kong /bin/sh
```

### 安裝編輯器

```bash
apt update && apt install -y vim
```

### 編輯套件清單

```bash
vim /usr/local/share/lua/5.1/kong/constants.lua
```

在 plugin 清單裡加上自己的套件名稱 `"log-traffic"`

![編輯配置](https://blog.markkulab.net/content/markku/posts/kong-api-gateway-part2-custom-plugin/images/edit-config.png)

### 設定 Kong 配置

| 檔案位置 | 說明 |
|---------|------|
| `/etc/kong/kong.conf.default` | 預設範本，不能直接修改 |
| `/etc/kong/kong.conf` | 正式用的設定檔（自己從 default 複製來的） |

新建/修改 `/etc/kong/kong.conf`：

```bash
vim /etc/kong/kong.conf
```

加入以下設定：

```bash
plugins = bundled,log-traffic  # 指定了要載入的套件 
# lua_package_path = /kong/plugins/?.lua;; # 指定了自訂套件的目錄
```

## 重啟 Docker 容器

```bash
docker restart kong
```

### 檢查客製套件是否載入成功

重啟後，檢查客製的套件是不是有在支援清單中：

<http://localhost:8001/plugins/enabled>

### 將套件套用在服務或路由上

套用到服務：

```bash
POST http://localhost:8001/services/{service}/plugins
Content-Type: application/json

{
  "name": "log-traffic"
}
```

套用到路由：

```bash
POST http://localhost:8001/routes/{route}/plugins
Content-Type: application/json

{
  "name": "log-traffic"
}
```

查看已套用的套件：<http://localhost:8001/plugins/>

### 驗證功能

查看 Docker 日誌來確認套件是否正常運作：

```bash
docker logs kong
```

![Docker log 輸出](https://blog.markkulab.net/content/markku/posts/kong-api-gateway-part2-custom-plugin/images/docker-logs.png)

## 常見開發與除錯技巧

### 1. Plugin 熱重載（Hot Reload）技巧

Kong 本身不支援 Lua Plugin 的熱重載，每次修改 Plugin 內容後都需要重啟 Kong 容器。開發時建議：

- 使用 Docker volume 掛載 plugin 目錄，這樣只要重啟容器就能載入新程式碼。
- 可以寫一個簡單的 shell script，自動重啟 Kong 並 tail log，提升開發效率。

### 2. Plugin 日誌與除錯

- 使用 `kong.log.inspect()` 可以更方便地輸出 table 結構，便於除錯。
- 也可以用 `print()`，但建議還是用 `kong.log` 相關 API，這樣 log 會出現在 Kong 的標準日誌中。

範例：
```lua
kong.log.inspect(plugin_conf)
```

### 3. Plugin 生命週期（Lifecycle）

Kong Plugin 支援多個執行階段（phase），常見有：

- `access`：處理請求前
- `header_filter`：處理回應 header
- `body_filter`：處理回應 body
- `log`：請求結束後

你可以根據需求實作不同階段的函數，例如：

```lua
function CustomHandler:header_filter(conf)
  kong.response.set_header("X-My-Plugin", "active")
end
```

### 4. Plugin 測試

- 建議用 Postman 或 curl 測試 API，觀察 plugin 是否正確攔截與處理請求。
- 可以用 Kong 的 Admin API 查詢 plugin 狀態與日誌。

### 5. Plugin 配置參數驗證

- schema.lua 可以設定參數的預設值、必填、型態、正則驗證等，減少錯誤發生。
- 若參數驗證失敗，Kong 會自動回傳 400 錯誤。

## 進階應用

### 1. 與資料庫互動

如果 plugin 需要存取資料庫，可以使用 Kong 提供的 DAO（Data Access Object）API，例如存取 Postgres：

```lua
local dao = kong.db.your_custom_table
local row, err = dao:select({ id = some_id })
```

### 2. 外部 API 呼叫

可以用 Lua 的 http client（如 `resty.http`）在 plugin 內呼叫外部 API：

```lua
local http = require "resty.http"
local httpc = http.new()
local res, err = httpc:request_uri("https://api.example.com", { method = "GET" })
```
## 本地除錯小計巧

* docker ymal 用到db host 或redis host 都得寫靜態 ip 不能寫docker network 的name ，不然除會斷掉。

```bash
    host = os.getenv("KONG_PG_HOST") or "192.168.201.101",
```

* 本地deubg 是抓不到docker yaml 的環境變數的，因此要給預設

```bash
 return {
    host = os.getenv("KONG_PG_HOST") or "192.168.201.101",
    port = tonumber(os.getenv("KONG_PG_PORT")) or 5432,
    database = os.getenv("KONG_PG_DATABASE") or "kong",
    user = os.getenv("KONG_PG_USER") or "kong",
    password = os.getenv("KONG_PG_PASSWORD") or "kong",
    pool_size = 10,
    pool_name = "custom_acl_pool"
  }
```
* try catch 

在 Lua（包括 Kong 插件開發）中，pcall(function) 是「protected call」的縮寫，用來安全執行一段可能會出錯的程式碼，避免錯誤直接中斷整個請求流程。

主要用途 捕捉執行時錯誤：如果 function 內部有錯誤（例如資料庫連線失敗、語法錯誤等），pcall 會捕捉這個錯誤，不會讓 Lua 腳本直接崩潰。 回傳錯誤資訊：pcall 會回傳兩個值：success（布林值，表示有無錯誤）和 result（成功時是回傳值，失敗時是錯誤訊息）。 範例



## 常見問題 FAQ

**Q: Plugin 沒有生效怎麼辦？**  
A:  
- 檢查 plugin 是否有加到 `/usr/local/share/lua/5.1/kong/plugins/` 目錄
- 檢查 `/etc/kong/kong.conf` 是否有加到 plugins 列表
- 檢查 schema.lua 與 handler.lua 是否語法正確
- 查看 Kong 日誌，尋找錯誤訊息

**Q: 如何管理多個自訂 Plugin？**  
A:  
- 建議每個 plugin 一個資料夾，方便維護
- 可以寫 Makefile 或 shell script 自動部署到 Docker

## 相關資源
* [官方範例客製套件範本](https://github.com/Kong/kong-plugin.git)
* [開源的套件網站 - Lua Rock](https://luarocks.org/)

---

## 關於本文與作者

本文出自 [Mark Ku's Blog](https://blog.markkulab.net/post/kong-api-gateway-part2-custom-plugin)

授權條款： [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — 轉載或引用請註明作者並附上原文連結

### 關於作者

**[Mark Ku](https://blog.markkulab.net/author/mark-ku)** — Software Solution Provider

- 10+ 年資深軟體工程師，現為 AI 應用 Builder
- 專注大型平台架構設計，從北美電商到AI SaaS訂閱收費系統
- 結合 AI Agent 與自動化，打造高效可演進的產品技術基礎

### 作者開發的免費工具

以下工具皆可免費使用：

- [免費 PDF 簽名工具](https://blog.markkulab.net/tools/pdf-sign): 線上 PDF 簽名工具，瀏覽器內完成手繪、打字、上傳簽名，可拖曳放置、縮放、下載。所有處理都在你的裝置完成，檔案不會上傳。
- [VS Code Refactory](https://blog.markkulab.net/tools/refactory): Refactory 是一款 VS Code 重構擴充套件：34 個重構動作、37 條 code smell 檢查、Code Health 儀表板、18 種語言、534 支測試。懂你的專案慣例：介面放哪、DI 註冊寫在哪、'use client' 該不該加；還會用 git 修改頻率 × 複雜度排出「該先修哪個檔案」，並一鍵把壞味道交給你自己電腦上的 Claude Code 修。免費使用，原始碼不離開你的機器。
- [DB-Kit 資料庫管理工具](https://blog.markkulab.net/tools/db-kit): DB-Kit 是一個用 Tauri + Rust + React 打造的輕量跨平台資料庫管理工具，用單一一致的介面同時管理 MySQL、MariaDB、PostgreSQL、SQL Server、Oracle、SQLite、MongoDB、Redis、Kafka、Elasticsearch 與 RabbitMQ 十一種資料來源：連線密碼以 OS keychain 加密、SSH Tunnel、完整 CRUD、視覺化查詢建構器、多結果集同時顯示、跨連線資料傳輸與比對同步、Excel / CSV 匯入匯出、執行計畫視覺化、ER 圖、排程備份、SQL 壓力測試（p50～p99 延遲百分位）、15 條規則的 SQL 審查、Kafka 訊息瀏覽與監控告警；繁中 / 英文雙語介面，內建 AI 助手（自然語言生成 SQL、AI 審查與調校建議）與命令列工具 dbk。免費開源（MIT），提供 Windows / macOS / Linux 安裝檔。
- [VS Code Super Mermaid](https://blog.markkulab.net/tools/super-mermaid): Super Mermaid 是一款 VS Code 擴充套件：開箱即用的漂亮 Mermaid 圖表，自動上色、即時預覽、滑鼠平移縮放、PNG / SVG 高解析匯出，內建 21 種範本與多種主題。免費開源（MIT）。
- [React Super Mermaid](https://blog.markkulab.net/tools/react-super-mermaid): react-super-mermaid 是一個開源 React 元件庫：一行 <MermaidViewer> 即可渲染漂亮的 Mermaid 圖表，內建 colorful / sketch 主題、平移縮放、圖內搜尋、SVG / PNG 高解析匯出。輕量、SSR 安全、完整 TypeScript 型別。免費開源（MIT）。
- [Jira / Confluence Super Mermaid](https://blog.markkulab.net/tools/jira-super-mermaid): Atlassian Forge app：在 Jira issue 與 Confluence 內文直接寫 Mermaid 語法，畫流程圖、時序圖、狀態機與甘特圖。11 種圖表、SVG / PNG 匯出、明暗主題、完整中日韓文字支援。取得 Runs on Atlassian 資格：圖表存在你自己的站台，app 不呼叫任何第三方服務。免費，即將上架 Atlassian Marketplace。
- [Mermaid 線上預覽](https://blog.markkulab.net/tools/mermaid-preview): 在瀏覽器裡寫 Mermaid、即時看圖，整張圖表壓進網址就能分享。免註冊、不上傳伺服器，相容 mermaid.live 的分享連結。
- [React Intl Phone Number](https://blog.markkulab.net/tools/react-intl-phone-number): react-intl-phone-number 是一個開源 React 元件：framework-agnostic、不依賴 antd，提供 E.164 進出、可搜尋國旗 / 國碼下拉、可配置驗證等級（strict / mobile-strict / loose）、可主題化 CSS 與 i18n，電話邏輯由 google-libphonenumber 驅動。輕量、完整 TypeScript 型別。免費開源（MIT）。
- [Uptime Kuma Cluster](https://blog.markkulab.net/tools/uptime-kuma-cluster): 把單機版 Uptime Kuma 改造成高可用叢集：OpenResty + Lua 智慧負載平衡、MariaDB 共享狀態、健康檢查與自動 Failover，附叢集管理 REST API，一行 Docker Compose 啟動。免費開源（MIT）。
- [特教專案](https://blog.markkulab.net/education): 為特殊教育學生製作的學習教材

### 每日 Podcast

- [科技新鮮事](https://blog.markkulab.net/category/tech-news): 每日精選 AI 與科技趨勢，透過語音摘要快速掌握最新技術動態，涵蓋 AI 應用、軟體架構、DevOps 與工程實戰。 — RSS: https://blog.markkulab.net/feed.xml
- [AI股市蝦聊](https://blog.markkulab.net/category/ai-stock-chat): 每個交易日用 AI 分析台股盤勢，以雙人對話聊當天的盤中觀察與隔日預測。 — RSS: https://blog.markkulab.net/ai-stock-chat/feed.xml

### 電子報

[訂閱電子報](https://blog.markkulab.net/subscribe) — 第一時間收到新文章通知，無垃圾信、隨時可取消訂閱。