php断点调试runtime硬核调试实操 手把手带你实现 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#%E6%9D%83%E9%99%90%E4%B8%8E%E7%AD%96%E7%95%A5%E8%AF%B4%E6%98%8E

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 函数

php7.2 runtime 确当地调试 IDE 建议利用 VSCode，其断点调试步骤与其他措辞有一定差异性，因此单独进行先容。
目前 php7.2 runtime 不支持端云联调断点调试。

step1：首先启动 Serverless 运用，打开终端，进入目标项眼前，输入启动指令 s local start --config vscode --debug-port 3000，启动指令实行后，会在当前项眼前会天生 .vscode/launch.json 文件，如前文所述，同时项目会壅塞住，此时须要实行 Ctrl+C 退出。

step2：启动断点调试器，打开 VSCode 界面，然后打开 s.yml 中 codeUri 所存放的源代码，为其打上断点，接着点击开始调试按钮，详细实行如下图所示。

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 不支持端云联调断点调试等。

希望本文对你有些帮助。

附录

默认调试参数

Runtime

Default Debug Args

nodejs 6

--debug-brk=${debugPort}

nodejs 8/10/12/14

--inspect-brk=0.0.0.0:${debugPort}

python 2.7/3

-m ptvsd --host 0.0.0.0 --port ${debugPort} --wait

java 8/11

-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,quiet=y,address=${debugPort}

php7.2

remote_enable=1 remote_autostart=1 remote_port=${debugPort} remote_host=${ip.address()}

断点调试动图

下面的动图教程均已提前完成文中提到的“前置操作”步骤，若要参考详细动图进行实践，请先完成上文“前置操作”的干系流程。

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://developer.aliyun.com/article/880880?utm_content=g_1000335158

本文为阿里云原创内容，未经许可不得转载。