Kong 使用第三方的go插件

本文將針對Kong使用第三方的go插件進行詳細闡述。首先，我們解答下標題的問題：如何使用第三方的go插件？我們可以通過編寫插件來達到此目的。

一、插件架構介紹

Kong的插件系統採用基於OpenResty的Lua語言編寫的插件，但是Lua語言對於部分開發人員可能不是十分熟悉，因此我們可以使用go語言來編寫插件。在這種情況下，我們需要使用Kong提供的插件開發工具（PDK）來進行操作。

Kong插件的架構主要由三個部分構成：處理階段、插件邏輯和PDK。

處理階段：Kong處理請求時，按照預定義的流程將幾個處理階段串聯起來。Kong提供了幾個處理階段，例如：SSL、身份驗證和HTTP，我們可以根據需要將插件放置在相應的處理階段。
插件邏輯：這是我們編寫的插件代碼，可以是OpenResty的Lua語言或者是go語言。這部分代碼將在處理階段執行。
PDK：PDK是Kong提供的插件開發工具。它是一組API接口，可以在插件中提供更為強大的功能。例如：訪問請求頭部信息、獲取客戶端IP地址或者直接向客戶端發送請求響應等操作。

二、插件編寫流程

接下來我們將介紹如何編寫一個基於go語言的Kong插件。假設我們需要編寫一個簡單的插件來記錄每個請求的HTTP頭信息和IP地址。

1. 執行環境配置

首先，我們需要配置和安裝Go開發環境和Kong。確保Go版本高於或等於1.14，並且您已經安裝了Kong。

2. 生成插件模板

我們可以使用kong-go-plugin-toolkit工具來生成Go插件模板，它提供了插件框架的核心代碼結構。在命令行中輸入以下命令：

$ go get github.com/kong/go-plugin-toolkit/v2/cmd/kong-go-plugin-toolkit
$ kong-go-plugin-toolkit init --type go --name header-logger --description "Log HTTP headers and IP address of the request"

這將生成一個名為header-logger的文件夾，其中包含“Empty.go”、“Main.go”和“Module.hcl”文件。

3. 實現插件邏輯

在“Main.go”文件中，我們實現插件的邏輯。首先，我們需要在文件頭部添加導入聲明：

package main

import (
	"context"
	"github.com/kong/go-plugin-toolkit/v2/kong"
	"net/http"
)

然後，在`Handler`函數中，我們編寫請求處理邏輯來記錄請求頭信息和IP地址：

func (pl *Plugin) Handler(ctx context.Context, req *http.Request) (*http.Response, error) {
	headers := req.Header
	ip := kong.GetIP(req)

	log.Printf("Request headers: %v", headers)
	log.Printf("Request IP address: %s", ip)

	return pl.Next(ctx, req)
}

這裡我們使用了`log`包記錄請求頭和IP地址。`kong.GetIP`函數可以獲取請求的IP地址。

4. 安裝插件

完成插件的編寫之後，我們需要安裝並配置插件。在命令行中輸入以下命令：

$ make install-dev

這將構建和安裝插件。接下來，在“Module.hcl”文件中進行配置，定義插件的名稱、版本和處理階段：

package = "kong.plugins.header-logger"
version = "0.1.0"

server {
    plugins = {
        "header-logger" = true
    }

    # Put the plugin at the beginning of the plugins list
    plugins_config = {
        "header-logger" = {
            path = "/usr/local/lib/kong/plugins/header-logger.so"
        }
    }
}

service {
    name = "mock"
    path = "/mock"
    routes = {
        {
            name = "mock"
            paths = ["/mock"]
            plugins = {
                "header-logger" = {
                    config = {
                        foo = "bar"
                    }
                }
            }
        }
    }
}

consumer {

}

`Plugin`的`package`和`version`是必須的，`server.plugins`和`service.routes.plugins`中的插件名稱將與插件的文件夾名稱相同。注意，`server.plugins_config`是一個可選配置項，指定了插件的位置和額外的配置信息。

5. 測試插件

最後，我們可以啟動Kong並測試插件。在命令行中輸入以下命令：

$ kong start -c /path/to/Module.hcl

使用curl命令發送請求來測試插件：

curl -i -X GET http://localhost:8000/mock --header "Authorization: Bearer foobar"

現在，您應該能夠在Kong日誌中看到請求頭信息和IP地址的記錄。

三、插件開發最佳實踐

在插件開發過程中，以下是一些最佳實踐：

按需使用PDK：PDK是Kong提供的插件開發工具，使用它可以提供更為強大的功能。但是，在需要時才使用PDK，因為這將增加插件的複雜性和執行時間。
合理使用日誌：日誌是插件開發中必不可少的工具，但是過多的日誌輸出將影響Kong的性能。因此，建議使用合理的日誌級別，並定期清除過時的日誌文件。
嘗試使用插件板：插件板是一種通用的插件模板，我們可以在此基礎上構建自己的插件。使用插件板可以減少代碼編寫和測試的時間。

四、總結

在本文中，我們詳細闡述了如何使用Kong的第三方go插件。通過安裝開發環境、生成插件模板、編寫插件邏輯、配置和安裝插件以及測試插件，我們順利完成了一個簡單的Kong插件，並介紹了插件開發的最佳實踐。希望本文能夠對您的Kong插件開發工作有所幫助。

原創文章，作者：NKQTM，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/374854.html