硬核除錯實操 | 手把手帶你實作 Serverless 斷點除錯-有解無憂

導讀：在應用開發程序中，或者開發完成后，若出現執行結果不符合我們的預期時，通常需要進行一定的除錯作業，但是在 Serverless 架構下，除錯作業往往會受到一些環境因素限制，如所開發的應用在本地是比較健康的、且符合預期的運行，但是在 FaaS 平臺上，出現了一些問題；或者是在某些特殊的環境下，本地沒有辦法模擬線上環境，難以進行專案的開發和除錯怎么辦？

概述

本文將借助 Serverless Devs 工具，對函式計算 (FC）應用的斷點除錯步驟進行詳細指導，手把手帶你實作 Serverless 的斷點除錯，并從以下四個方面為你厘清“硬核除錯”的脈絡步驟，干貨滿滿：

一、概述部分介紹了除錯能力的重要性，以及當前阿里云函式計算（FC）所能提供的除錯能力；

二、除錯之旅羅列了關于 “使用 Serverless Devs 在不同 IDE 中進行斷點除錯” 的詳細步驟；

三、總結部分客觀訴說斷點除錯的待改進之處；

四、附錄則為各位開發者匯總了斷點除錯操作的詳細動圖，

在 Serverless 應用架構下，除錯能力往往是應用開發者所十分關注的問題，它決定著程式的開發效率，Hackernoon 在關于 Serverless（無服務器）的業界調研報告指出：迄今為止，Debugging（除錯）仍舊是 Serverless 落地最大的痛點與挑戰，
在這里插入圖片描述

報告《Top 5 Serverless Trends》：
https://hackernoon.com/top-5-serverless-trends-in-2020-wd1m3t8g

除錯能力主要包含兩種，一是運行程式的能力；二是斷點除錯能力，前者是除錯的基礎能力，可以判幫助開發者判斷程式能否正常運行，驗證程式運行結果的正確性；后者是除錯的高級能力，能夠幫助用戶方便定位到導致程式運行出錯或者不符合預期的位置，

目前業界已有的 Serverless 應用除錯手段，主要是在本地模擬云端執行環境進行本地除錯；或者將應用部署到云端運行后基于日志進行除錯，然而，本地除錯無法模擬云端的網路環境，云端除錯又缺乏本地的靈活性，為了能夠克服這些缺陷，將 Serverless 應用除錯做到開箱即用，阿里云函式計算團隊經過一番探索，開發出了一套業界創新的除錯工具，全方位提供本地除錯以及端云聯調能力，

? 本地除錯：基于本地環境以及網路，依賴容器化技術，對 Serverless 應用進行擬運行，從而達到除錯的目的，具體操作檔案可參考，https://github.com/devsapp/fc/blob/main/docs/zh/command/local.md

? 端云聯調：基于本地環境，突破網路限制，依賴容器化技術，對 Serverless 應用進行擬運行，運行時打通本地與云端網路的壁壘，保證與云端資源的互動，使用檔案請參考，
https://github.com/devsapp/fc/blob/main/docs/zh/command/proxied.md

本文所提到的本地除錯工具，均提供斷點除錯能力，且與 Serverless 應用程式開發規范完全兼容，下面我們一起看一下關于斷點除錯的具體操作步驟，

除錯之旅

斷點除錯步驟總結為如下流程，下面我將帶領各位圍繞這四個步驟，開啟一場斷點除錯之旅：

? 啟動 Serverless 應用
? 啟動斷點除錯器
? 開始斷點除錯
? 結束斷點除錯

1、前置操作

在開始進行除錯之前，需要進行一些前置操作，本文將前置操作分為通用前置操作以及端云聯調附加的前置操作：

? 通用前置操作：

? 安裝除錯 IDE:可選的 IDE 有 VSCode、Pycharm 以及 Intellij 三種；

? 隨后在開始使用這些功能之前，請安裝好除錯工具: 這里我們需要安裝一下 Serverless Devs，具體的安裝方式參考檔案：
https://help.aliyun.com/document_detail/195474.html；
熟悉新一代函式計算工具鏈的使用方式，可參考：
https://github.com/devsapp/fc；

? 下載安裝 Docker:除錯能力都需要依賴 Docker，因此需要本地環境中有 Docker 工具，安裝方式請參考這里:
https://docs.docker.com/get-docker/

? 最后還需要注冊一個阿里云賬號，使用 Serverless Devs 配置阿里云賬號，具體配置方式可以參考這里，
https://help.aliyun.com/document_detail/295894.html

? 端云聯調附加的前置操作：
? 準備一個阿里云賬號，由于端云聯調涉及到輔助資源的部署和洗掉，如果賬號為子賬號，需要為該子賬號添加指定的一些權限，具體權限集合可以參考，https://github.com/devsapp/fc/blob/main/docs/zh/command/proxied.md#權限與策略說明

2、引數引入

完成以上前置條件的準備后，我們先了解一下除錯指令中與斷點除錯所相關的具體引數：

-c, --config [vscode/pycharm/intellij]   [Required] Select which IDE to use when
                                       debugging and output related debug
                                       config tips for the IDE. value:
                                       vscode/pycharm/intellij
                                     
-d, --debug-port number              [Required] Specify the local function
                                       container starting in debug mode, and
                                       exposing this port on localhost
                                     
--debug-args string                  [Optional] Additional parameters that
                                       will be passed to the debugger
                                     
--debugger-path string               [Optional] The path of the debugger on
                                       the host
                                     
--tmp-dir string                     [Optional] The temp directory mounted to
                                       '/tmp' , default:
                                       './.s/tmp/invoke/serviceName/functionName/'

使用斷點除錯時，--config 引數以及 --debug-port 引數是必要的：

? --config 會指定斷點除錯的 IDE 環境，目前支持 VSCode、Pycharm 、Intellij 三種，

? --debug-port 會指定除錯的監聽埠，

另外，其余三種引數是可選的：
? --debug-args 會自定義程式啟動時的除錯引數，不指定時默認的除錯引數可以參考文末附錄部分，
? --debugger-path 會將本地指定路徑掛載到程式運行環境的 /tmp/debugger_file之中，
? --tmp-dir 會將本地指定路徑掛載到程式運行環境中的 /tmp 目錄上，在除錯時，程式寫入 /tmp 的結果檔案則會在映射到本地目錄，用于驗證結果是否符合預期，

3、實操演練

1）VSCode

使用 VSCode 進行斷點除錯時，流程十分簡單，下面我們將斷點除錯場景分為 Event 函式除錯和 Http 函式除錯兩種，分別進行介紹，

? 除錯 Event 函式：

step1：首先啟動 Serverless 應用，打開終端，進入目標專案下，輸入啟動指令:

# 本地除錯
$ s local invoke --config vscode --debug-port 3000
# 端云聯調
$ s proxied setup --config vscode --debug-port 3000

啟動指令執行后，本地的函式計算執行環境會有一定阻塞，我們需要等待呼叫；與此同時當前專案會生成 .vscode/launch.json 檔案，該檔案是基于 VSCode 進行除錯的組態檔，若該檔案已經存在，那么啟動指令會列印相應配置文本，如下圖所示，需要利用這部分內容覆寫已有 .vscode/launch.json 中的內容，

在這里插入圖片描述
.vscode/launch.json 更新內容示例

step2：啟動斷點除錯器， 打開 VSCode 界面，然后打開 s.yml 中 codeUri 所存放的源代碼，為其打上斷點，接著點擊開始除錯按鈕，具體執行如下圖所示，
在這里插入圖片描述

VSCode 啟動除錯器示意圖

對于本地除錯而言，啟動除錯器后，程式便已經啟動，此時就可以開始進行我們的斷點除錯作業了，如果是端云聯調的話，啟動除錯器后，在啟動指令終端頁面，會出現 "Debugger attached." 欄位，這時說明除錯器也已啟動成功，正在等待被呼叫，接下來我們繼續進行如下步驟即可，

step3：開始斷點除錯：打開一個新的終端頁面，輸入呼叫指令 s proxied invoke --event "hello"后，程式啟動，斷點除錯開始，

step4：結束斷點除錯：除錯結束后，主動關閉斷點除錯器，端云聯調場景下，會創建一系列輔助函式資源，因此除錯完成后，這里需要進行輔助資源釋放，防止額外的費用產生，只需執行 s proxied cleanup 即可釋放輔助資源，

? 除錯 php7.2 Event 函式

php7.2 runtime 的本地除錯 IDE 建議使用 VSCode，其斷點除錯步驟與其他語言有一定差異性，因此單獨進行介紹，目前 php7.2 runtime 不支持端云聯調斷點除錯，

step1：首先啟動 Serverless 應用，打開終端，進入目標專案下，輸入啟動指令 s local invoke --config vscode --debug-port 3000，

與之前不同的是，Event 函式啟動指令執行完成后，并不會出現阻塞的情況，而是會直接執行成功，同時在當前專案下會生成 .vscode/launch.json 檔案，如前文所述，

step2：啟動斷點除錯器，打開 VSCode 界面，然后打開 s.yml 中 codeUri 所存放的源代碼，為其打上斷點，接著點擊開始除錯按鈕，具體執行如下圖所示，
在這里插入圖片描述

step3：開始斷點除錯：打開一個新的終端頁面，再次輸入啟動指令 s local invoke --config vscode --debug-port 3000后，程式啟動，斷點除錯開始，

step4：結束斷點除錯：除錯結束后，主動關閉斷點除錯器，

? 除錯 Http 函式

端云聯調中對 Http 函式的除錯方式實際上與 Event 函式相同，因此不再贅述，本節我們主要介紹下本地除錯關于 Http 函式應該如何進行除錯，

step1：啟動 Serverless 應用，首先，打開終端，進入目標專案下，輸入啟動指令 s local start --config vscode --debug-port 3000，啟動指令執行后，本地的函式計算執行環境會阻塞等待呼叫，并列印訪問 http 函式的 url 欄位，

step2：啟動斷點除錯器：打開 VSCode 界面，然后打開 s.yml 中 codeUri 存放的源代碼，為其打上斷點，接著點擊開始除錯按鈕，如圖所示，此時在啟動指令終端頁面，會出現 "Debugger attached." 欄位，說明除錯器啟動成功，等待被呼叫，
在這里插入圖片描述

VSCode 啟動除錯器示意圖

step3：開始斷點除錯：可以通過 curl 指令、瀏覽器等方式訪問 Http 函式的 URL，此時程式啟動，斷點除錯開始，

step4：結束斷點除錯：除錯完成后，主動關閉斷點除錯器，然后在啟動指令終端頁面，執行 Ctrl+C 即可退出除錯行程，

? 除錯 php7.2 Http 函式

step1：首先啟動 Serverless 應用，打開終端，進入目標專案下，輸入啟動指令 s local start --config vscode --debug-port 3000，啟動指令執行后，會在當前專案下會生成 .vscode/launch.json 檔案，如前文所述，同時專案會阻塞住，此時需要執行 Ctrl+C 退出，

step3：開始斷點除錯： 打開一個新的終端頁面，再次輸入啟動指令 s local start --config vscode --debug-port 3000后，本地的函式計算執行環境會阻塞等待呼叫，并列印訪問 http 函式的 url 欄位，可以通過 curl 指令、瀏覽器等方式訪問 Http 函式的 URL，此時程式啟動，斷點除錯開始，

step4：結束斷點除錯： 除錯完成后，主動關閉斷點除錯器，然后在啟動指令終端頁面，執行 Ctrl+C 即可退出除錯行程，

2）Intellij

基于 Intellij 進行斷點除錯時，針對不同語言需要手動在 IDE 中配置相應地斷點除錯器，由于使用 Intellij 開發最多的語言是 Java，同時更換 IDE 后，唯一不同的步驟只有“啟動斷點除錯器”，因此接下來我們將以本地除錯 Java Event 函式為例，對“啟動斷點除錯器”步驟進行詳細說明，

step1：啟動 Serverless 應用：由于 Java 是編譯型語言，因此在開始前需要對程式進行打包，本文示例會使用 mvn package 對函式打包，然后執行啟動指令 s local invoke --config intellij --debug-port 3000，

step2：啟動斷點除錯器：打開 Intellij 界面，在選單欄依次選擇 Run -> Edit Configurations，

隨后如下圖所示，新建一個 Remote JVM Debug，

在這里插入圖片描述

新建 Remote JVM Debug

接著，自定義除錯器名稱，并將埠設定為 3000，如下圖所示，
在這里插入圖片描述

Intellij 除錯器配置

最后，打開 s.yml 中 codeUri 存放的源代碼，為其打上斷點，接著點擊開始除錯按鈕，如圖所示，

在這里插入圖片描述

Intellij 啟動斷點除錯器

3）Pycharm

當前只有本地除錯能夠在 Pycharm 中進行斷點除錯操作，支持的運行時有 python2.7 和 python3兩個版本，在 Pycharm 中進行斷點除錯時，不僅需要在 IDE 中配置斷點除錯器，還需要對使用者的原始碼進行侵入式修改，由于操作步驟內容與常規內容有所不同，接下來我們詳解一下這部分的除錯步驟，
step1：啟動 Serverless 應用：首先，打開終端，進入目標專案下，輸入啟動指令:

# event 函式
$ s local invoke --config pycharm --debug-port 3000
# http 函式
$ s local start --config pycharm --debug-port 3000

與之前不同的是，Event 函式啟動指令執行完成后，并不會出現阻塞的情況，而是會直接執行成功，此時就需要記錄 "Tips for PyCharm remote debug" 內容，具體內容示例如圖所示，記錄完成后，如果是 Http 函式，則輸入 Ctrl+C 退出啟動程式，
在這里插入圖片描述

Tips for PyCharm remote debug 內容示例

step2：接下來啟動斷點除錯器：啟動斷點除錯器主要包含 IDE 斷點除錯器配置和原始碼更新兩部分，

首先，打開 pycharm 界面，在選單欄依次選擇 Run -> Edit Configurations，
接下來如圖中所示，新建一個 Python Debug Server，
在這里插入圖片描述

新建 Python Debug Server

隨后設定自定義除錯器名稱，并基于圖五中獲取的內容配置 IDE host name、Port 以及 Path mappings 這三個除錯器配置的詳情，如圖中所示，

在這里插入圖片描述

pycharm 除錯器配置

隨后打開 s.yml 中 codeUri 存放的源代碼，將例圖中（Tips for PyCharm remote debug 內容示例）的代碼內容粘貼到代碼開頭，然后按需在原始碼指定位置打上斷點，接著點擊開始除錯按鈕，具體操作如圖（pycharm 啟動斷點除錯器）所示，

在這里插入圖片描述

Tips for PyCharm remote debug 內容示例
在這里插入圖片描述

pycharm 啟動斷點除錯器

step3：開始斷點除錯： 打開終端，并進入目標專案，執行啟動指令，p.S.此時可以不用帶上斷點除錯的相關引數，

# event 函式
$ s local invoke
# http 函式
$ s local start

Event 函式啟動指令執行后會直接進入斷點除錯階段；Http 函式啟動指令執
行后，可以先通過 curl 指令、瀏覽器等方式訪問 Http 函式的 URL，此時程式會啟動，斷點除錯就開始了，

step4：結束斷點除錯：除錯完成后，主動關閉斷點除錯器，對于 Http 函式而言，在啟動指令終端頁面，需執行 Ctrl+C 方可退出除錯行程，

結語

Serverless 應用的除錯雖然備受詬病，但是各個云廠商并沒有因此放棄在除錯方向的不斷深入探索，以阿里云函式計算為例，目前支持提供在線除錯、本地除錯、端云聯調等多種除錯方案，而 Serverless Devs 工具所提供的應用除錯能力也十分全面了，

上文是我所分享的一些實操經驗，但是在程序中也發現了一些待改進的點，如：

? 斷點除錯步驟繁瑣，需要在多個頁面來回切換，如果能將工具集成到 IDE，以插件化形態供所用戶使用，簡化流程，那么體驗感會大幅提升，
? 斷點除錯模式下的熱更能力：Http 函式的斷點除錯程序中，并不支持代碼熱更新，每次修改完代碼后，都需要重新執行一遍斷點除錯流程，體驗不太流暢，
? 斷點除錯能力目前還未全面覆寫所有 Runtime，例如 custom runtime 不支持斷點除錯，php runtime 不支持端云聯調斷點除錯等，

希望本文對你有些幫助，

附錄

默認除錯引數

在這里插入圖片描述

斷點除錯動圖

下面的動圖教程均已提前完成文中提到的“前置操作”步驟，若要參考具體動圖進行實踐，請先完成上文“前置操作”的相關流程，

1) VSCode

本地除錯 Event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1Ba41147wq?spm_id_from=333.999.0.0

本地除錯 php7.2 event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1dL4y1L7HZ?spm_id_from=333.999.0.0

端云聯調 Event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV15S4y117Kz?spm_id_from=333.999.0.0

本地除錯 Http 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1gi4y1X7g4?spm_id_from=333.999.0.0

本地除錯 php7.2 Http 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1nY411772A?spm_id_from=333.999.0.0

端云聯調 Http 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1A44y1P7yg?spm_id_from=333.999.0.0

2) Intellij

本地除錯 Event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1S34y147Zf?spm_id_from=333.999.0.0

端云聯調 Event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV19L4y1L7AF?spm_id_from=333.999.0.0

3) Pycharm

本地除錯 Event 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1GF41137x5?spm_id_from=333.999.0.0

本地除錯 Http 函式

具體操作請前往下方鏈接查看：
https://www.bilibili.com/video/BV1HF41137dQ?spm_id_from=333.999.0.0

Serverlesss Devs 社區官網：
http://www.serverless-devs.com/
發布云原生技術最新資訊、匯集云原生技術最全內容，定期舉辦云原生活動、直播，阿里產品及用戶最佳實踐發布，與你并肩探索云原生技術點滴，分享你需要的云原生內容，

關注【阿里巴巴云原生】公眾號，獲取更多云原生實時資訊！

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/455408.html

標籤：其他

上一篇：開源函式計算平臺 OpenFunction 保姆級入門教程

下一篇：對 API 平臺的再思考【eolink翻譯】