前言：
熟悉 Apache APISIX 的小伙伴都知道，之前在社區(qū)中我們已經(jīng)支持了 Java 和 Go 語言的 Runner，今天 Apache APISIX Python Runner 也來了，社區(qū)中的小伙伴們在開發(fā) Apache APISIX 插件時(shí)又多了一種新選擇。
Python 語言作為一個(gè)解釋型的高級編程語言，它語法簡潔易上手、代碼可讀性好 ，在跨平臺 、可移植性 、開發(fā)效率上都有很好的表現(xiàn)，同時(shí)作為一個(gè)高級編程語言它的封裝抽象程度比較高屏蔽了很多底層細(xì)節(jié)（例如：GC ）讓我們在開發(fā)的過程中可以更專注應(yīng)用邏輯的開發(fā)。
同時(shí)作為一個(gè)有 30 年歷史的老牌開發(fā)語言，它的生態(tài)以及各種模塊已經(jīng)非常完善，我們大部分的開發(fā)和應(yīng)用場景都可以從社區(qū)中找到很成熟的模塊或解決方案。
Python 其他的優(yōu)點(diǎn)就不再一一贅述，當(dāng)然它的缺點(diǎn)也比較明顯：Python 作為一門解釋性語言，相較于 C++ 和 Go 這樣的編譯型語言，在性能上的差距還是比較大的。
一、了解：項(xiàng)目架構(gòu)
apache-apisix-python-runner 這個(gè)項(xiàng)目可以理解為 Apache APISIX 和 Python 之間的一道橋梁，通過 Python Runner 可以把 Python 直接應(yīng)用到 Apache APISIX 的插件開發(fā)中，最重要的還是希望讓更多對 Apache APISIX 和 API 網(wǎng)關(guān)感興趣的 Python 開發(fā)者通過這個(gè)項(xiàng)目，更多地了解和使用 Apache APISIX，以下為 Apache APISIX 多語言支持的架構(gòu)圖。
上圖左邊是 Apache APISIX 的工作流程，右邊的 Plugin Runner 是各語言的插件運(yùn)行器，本文介紹的 apisix-python-plugin-runner 就是支持 Python 語言的 Plugin Runner。
在 Apache APISIX 中配置一個(gè) Plugin Runner 時(shí)，Apache APISIX 會啟動一個(gè)子進(jìn)程運(yùn)行 Plugin Runner，該子進(jìn)程與 Apache APISIX 進(jìn)程屬于同一個(gè)用戶，當(dāng)我們重啟或重新加載 Apache APISIX 時(shí)，Plugin Runner 也將被重啟。
如果你為一個(gè)給定的路由配置了 ext-plugin-* 插件，請求命中該路由時(shí)將觸發(fā) Apache APISIX 通過 Unix Socket 向 Plugin Runner 發(fā)起 RPC 調(diào)用。調(diào)用分為兩個(gè)階段：
-
ext-plugin-pre-req ：在執(zhí)行
Apache APISIX內(nèi)置插件（Lua 語言插件）之前 -
ext-plugin-post-req ：在執(zhí)行
Apache APISIX內(nèi)置插件（Lua 語言插件）之后
大家可以根據(jù)需要選擇并配置 Plugin Runner 的執(zhí)行時(shí)機(jī)。Plugin Runner 會處理 RPC 調(diào)用，在其內(nèi)部創(chuàng)建一個(gè)模擬請求，然后運(yùn)行多語言編寫的插件，并將結(jié)果返回給 Apache APISIX。
多語言插件的執(zhí)行順序是在 ext-plugin-* 插件配置項(xiàng)中定義的，像其他插件一樣，它們可以被啟用并在運(yùn)行中重新定義。
二、安裝：部署測試
基礎(chǔ)運(yùn)行環(huán)境：Apache APISIX 2.7、Python 3.6+
Apache APISIX 的安裝部署可參考 Apache APISIX 官方文檔：如何構(gòu)建 Apache APISIX (https://github.com/apache/api...)進(jìn)行部署。
1. 下載安裝 Python Runner
|
1
2
3
|
$ git clone https://github.com/apache/apisix-python-plugin-runner.git$ cd apisix-python-plugin-runner$ make install |
2. 配置 Python Runner
- 開發(fā)模式配置
運(yùn)行 Python Runner：
|
1
2
3
4
5
6
7
8
9
10
11
|
$ cd /path/to/apisix-python-plugin-runner$ APISIX_LISTEN_ADDRESS=unix:/tmp/runner.sock python3 apisix/main.py start修改 Apache APISIX 配置文件$ vim /path/to/apisix/conf/config.yamlapisix: admin_key: - name: "admin" key: edd1c9f034335f136f87ad84b625c8f1 role: adminext-plugin: path_for_test: /tmp/runner.sock |
- 生產(chǎn)模式配置
修改 Apache APISIX 配置文件
|
1
2
3
4
5
6
7
8
|
$ vim /path/to/apisix/conf/config.yamlapisix: admin_key: - name: "admin" key: edd1c9f034335f136f87ad84b625c8f1 role: adminext-plugin: cmd: [ "python3", "/path/to/apisix-python-plugin-runner/apisix/main.py", "start" ] |
- Python Runner 配置（可選）
如果需要對 Log Level 或 Unix Domain Socket 環(huán)境變量調(diào)整可以修改 Runner 的配置文件
|
1
2
3
4
5
6
|
$ vim /path/to/apisix-python-plugin-runner/apisix/config.yamlsocket: file: $env.APISIX_LISTEN_ADDRESS # Environment variable or absolute pathlogging: level: debug # error warn info debug |
3. 啟動 Python Runner
|
1
2
3
|
$ cd /path/to/apisix# Start or Restart$ ./bin/apisix [ start | restart ] |
啟動或重啟 Apache APISIX 即可，此時(shí) Apache APISIX 和 Python Runner 已經(jīng)完成配置并啟動。
4. 測試 Python Runner
配置 Apache APISIX 路由及插件信息：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
# 使用默認(rèn)demo插件進(jìn)行測試$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "uri": "/get", "plugins": { "ext-plugin-pre-req": { "conf": [ { "name": "stop", "value":"{\"body\":\"hello\"}"} ] } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }}' |
-
plugins.ext-plugin-pre-req.conf為Runner插件配置，conf為數(shù)組格式可以同時(shí)設(shè)置多個(gè)插件。 -
插件配置對象中
name為插件名稱，該名稱需要與插件代碼文件和對象名稱一致。 -
插件配置對象中
value為插件配置，可以為JSON字符串。
訪問驗(yàn)證：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
$ curl http://127.0.0.1:9080/get -iHTTP/1.1 200 OKDate: Fri, 13 Aug 2021 13:39:18 GMTContent-Type: text/plain; charset=utf-8Transfer-Encoding: chunkedConnection: keep-alivehost: 127.0.0.1:9080accept: */*user-agent: curl/7.64.1X-Resp-A6-Runner: PythonServer: APISIX/2.7Hello, Python Runner of APISIX |
三、實(shí)踐：插件開發(fā)
1. 插件目錄
|
1
|
/path/to/apisix-python-plugin-runner/apisix/plugins |
此目錄中的 .py 文件將會被自動加載。
2. 插件示例
|
1
2
|
/path/to/apisix-python-plugin-runner/apisix/plugins/stop.py/path/to/apisix-python-plugin-runner/apisix/plugins/rewrite.py |
3. 插件格式
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
from apisix.runner.plugin.base import Basefrom apisix.runner.http.request import Requestfrom apisix.runner.http.response import Responseclass Stop(Base): def __init__(self): """ Example of `stop` type plugin, features: This type of plugin can customize response `body`, `header`, `http_code` This type of plugin will interrupt the request """ super(Stop, self).__init__(self.__class__.__name__) def filter(self, request: Request, response: Response): """ The plugin executes the main function :param request: request parameters and information :param response: response parameters and information :return: """ # 在插件中可以通過 `self.config` 獲取配置信息，如果插件配置為JSON將自動轉(zhuǎn)換為字典結(jié)構(gòu) # print(self.config) # 設(shè)置響應(yīng)頭信息 headers = request.headers headers["X-Resp-A6-Runner"] = "Python" response.headers = headers # 設(shè)置響應(yīng)體信息 response.body = "Hello, Python Runner of APISIX" # 設(shè)置響應(yīng)狀態(tài)碼 response.status_code = 201 # 通過調(diào)用 `self.stop()` 中斷請求流程，此時(shí)將立即響應(yīng)請求給客戶端 # 如果未顯示調(diào)用 `self.stop()` 或 顯示調(diào)用 `self.rewrite()`將繼續(xù)將請求 # 默認(rèn)為 `self.rewrite()` self.stop() |
4. 插件規(guī)范及注意事項(xiàng)
-
實(shí)現(xiàn)插件對象必須繼承
Base類 - 插件必須實(shí)現(xiàn) filter 函數(shù)
-
filter函數(shù)參數(shù)只能包含Request和Response類對象作為參數(shù) -
Request對象參數(shù)可以獲取請求信息 -
Response對象參數(shù)可以設(shè)置響應(yīng)信息 -
self.config可以獲取插件配置信息 -
filter函數(shù)中調(diào)用self.stop()時(shí)將馬上中斷請求，響應(yīng)數(shù)據(jù)。 -
filter函數(shù)中調(diào)用self.rewrite()時(shí)，將會繼續(xù)請求。
到此這篇關(guān)于Python 帶你快速上手 Apache APISIX 插件開發(fā)的文章就介紹到這了,更多相關(guān)Python Apache APISIX 插件開發(fā)內(nèi)容請搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家！
原文鏈接：https://segmentfault.com/a/1190000040697299
