从 Web 客户端中打开 Visual Studio Code

已完成

针对特定的客户生产或沙盒环境,您可以直接从 Web 客户端中打开新的 Visual Studio Code 会话。 这样可以执行故障排除,例如调试、检查变量、设置断点和查看源代码。

根据上下文,打开 Visual Studio Code 以允许检查对象和源,允许附加到调试或快照调试并分析当前 Web 客户端会话。 是否可以访问源代码取决于每个扩展的资源公开配置文件设置。

从 Business Central Web client 中,您可以通过以下方式打开 Visual Studio Code:

从 Page Inspector 中打开页面

从 Business Central Web client 的页面中,您可以打开“页面检查”页面并在 Visual Studio Code 中浏览其背后的代码。

若要从 Page Inspector 中打开并浏览页面,请按照以下步骤操作:

  1. 找到您要检查的页面。

  2. 从该页面中,使用 Ctrl+Alt+F1 运行页面检查

  3. 选择在 Visual Studio Code 中浏览页面链接。

  4. 接下来,若要打开 Visual Studio Code 实例,您必须在允许扩展以打开此 URI?对话框中选择打开按钮。 如果您已在运行 Visual Studio Code,则打开该实例。

  5. 然后,您必须指定是要创建新项目还是使用现有项目。 系统仅在第一次时询问您,之后,将使用上次活动的 Visual Studio Code 窗口。

  6. 接下来,您必须决定是否要下载符号。

    如果指定为是,将使用页面的依赖项扩展更新 app.json 文件,这些扩展显示在页面检查页面中的扩展选项卡上,并且符号会自动下载。 如果您正在处理特定的源代码文件,则可以指定为否。

    如果您拒绝,并且没有下载正确的符号,则无法导航到对象源代码。

  7. 现在,系统会提示您是要进行快照或常规调试会话,还是不进行调试,但仅查看源代码。

    对于生产环境,不支持常规调试。

  8. 如果要进行调试,则设置断点并返回到 Web 客户端以运行任务。 当命中断点时,您可以在 Visual Studio Code 中检查代码。

还可以选择检查页面上的特定字段。

  1. 找到您要检查的页面。

  2. 从该页面中,使用 Ctrl+Alt+F1 运行“页面检查”。

  3. 选择要检查的字段,选择下拉菜单,然后选择在 VS Code 中浏览字段。 页面字段后面的表字段定义的源代码现已打开。

从“帮助和支持”页面中进行故障排除

在 Business Central Web client 中,您可以打开帮助和支持页面并在 Visual Studio Code 中浏览其背后的代码。

若要将调试程序附加到会话,请按照以下步骤操作:

  1. 转到帮助和支持页面,然后在故障排除部分下选择将调试程序附加到此会话链接。

  2. 接下来,若要打开 Visual Studio Code 实例,您必须在允许扩展以打开此 URI?对话框中选择打开按钮。 如果您已在运行 Visual Studio Code,则打开该实例。

  3. 然后,您必须指定是要创建新项目还是使用现有项目。 系统仅在第一次时询问您,之后,将使用上次活动的 Visual Studio Code 窗口。

  4. 如果要进行调试,则设置断点并返回到 Web 客户端以运行任务。 当命中断点时,您可以在 Visual Studio Code 中检查代码。

对于生产环境,不支持常规调试。

在 Visual Studio Code 中打开源代码

通过在 VS Code 中打开源代码选项,您可以从扩展中获取最新的源代码并直接在 Visual Studio Code 中打开它。 打开源代码功能使用生成扩展时包括在扩展中的存储库元数据。 在扩展(即 app.json 文件)的清单中,您可以使用版本和源设置指定用于查找相关 GitHub 存储库和特定版本的元数据。 有关详细信息,请参阅 JSON 文件

打开源代码有助于调查问题或基于现有扩展开发新功能。 您必须具有通过 GitHub 访问代码的权限,才能通过 Visual Studio Code 打开源代码。

请按照以下步骤操作:

  1. 打开扩展管理页面并激活所选扩展的上下文菜单。

  2. 选择在 VS Code 中打开源代码选项。 在 Visual Studio Code 中,现在系统会询问您是否要克隆或打开扩展的 GitHub 存储库。 如果您选择克隆存储库,则必须指定要将存储库克隆到本地计算机上的位置。

  3. 克隆存储库后,您可以使用其他选项来使用源代码。 例如,您可以继续使用当前的主分支,也可以针对您的修改创建一个新分支。 如果您选择创建新分支,则必须为其命名。

  4. 通过访问本地计算机上的源代码,例如,您可以使用 Page Inspector,使用在 Visual Studio Code 中探索页面功能帮助您导航到源代码。 有关详细信息,请参阅从 Page Inspector 中打开页面

应了解的事项

  • 如果 Visual Studio Code 已打开,将使用上次活动的会话;否则,打开一个新的 Visual Studio Code 会话。 如果未安装 AL 语言扩展,系统会要求用户安装它,该流程将结束。

  • 调用时,将创建一个新项目,并创建匹配的启动配置,具体取决于当前环境是生产环境还是沙盒环境。

  • 如果用户选择调试,Visual Studio Code 将附加到 Web 客户端流程,该流程将从中调用并等待出错时中断。

  • 如果重用项目并且源文件与服务器上的版本不同步,则在调试时将无法正确命中断点。 有关详细信息,请参阅快照调试

  • 当您选择生成新项目时,请记住偶尔删除项目,以免积累许多未使用的项目。

  • 在浏览器中运行 Web 客户端时,您通常不会以管理员身份运行浏览器,这意味着 Visual Studio Code 也不会在管理员模式下打开。 举例来说,如果 Visual Studio Code 提示您进行更新,当您选择“是”时,您会收到一个错误,因为您没有更新权限。 您需要关闭 Visual Studio Code,然后以管理员身份重新打开并更新它。 然后,您即可继续调试。