将 Node.js 应用程序发布到 Azure（Linux 应用服务）

项目
11/06/2023

本教程指导你完成创建简单 Node.js 应用程序并将其发布到 Azure 的任务。

将 Node.js 应用程序发布到 Azure 时，提供几个选项。其中包括 Azure 应用服务、运行所选 OS 的 VM、用于 Kubernetes 管理的 Azure 容器服务 (AKS)、使用 Docker 的容器实例等等。有关各选项的详细信息，请参阅计算。

对于本教程，将应用部署到 Linux 应用服务。 Linux 应用服务部署 Linux Docker 容器来运行 Node.js 应用程序（不同于 Windows 应用服务，后者在 Windows 上 IIS 后运行 Node.js 应用程序）。

本教程从随针对 Visual Studio 的 Node.js 工具安装的一个模板开始，演示如何创建 Node.js 应用程序，并将代码推动到 GitHub 上的存储库，然后通过 Azure Web 门户预配 Azure 应用服务，以便可以从 GitHub 存储库进行部署。若要使用命令行来预配 Azure 应用服务并从本地 Git 存储库推送代码，请参阅创建 Node.js 应用。

重要

本文中的信息仅适用于 Node.js 项目类型 (.njsproj)。从 Visual Studio 2022 版本 17.8 预览版 2 开始，本文中使用的模板不再可用。

本教程介绍如何执行下列操作：

创建 Node.js 项目
为代码创建 GitHub 存储库
创建 Azure 上的 Linux 应用服务
部署到 Linux

先决条件

须安装 Visual Studio 且具有 Node.js 开发工作负载。

如果尚未安装 Visual Studio 2019，请转到 Visual Studio 下载页免费安装。

如果需要安装工作负载但已有 Visual Studio，请转到“工具” >“获取工具和功能...” ，这会打开 Visual Studio 安装程序。选择“Node.js 开发”工作负载，然后选择“修改” 。
须安装 Node.js 运行时。

如果未安装，请从 Node.js 网站安装 LTS 版本。一般情况下，Visual Studio 会自动检测已安装的 Node.js 运行时。如果系统未检测到已安装运行时，则可以将项目配置为引用属性页中已安装的运行时（创建项目后，右键单击项目节点并选择“属性”）。

创建要在 Azure 中运行的 Node.js 项目

打开 Visual Studio。
创建新的 TypeScript Express 应用。

按 Esc 关闭启动窗口。键入 Ctrl+Q 以打开搜索框，键入“Node.js”，然后选择“创建新的基本 Azure Node.js Express 4 应用程序”(TypeScript) 。在出现的对话框中，选择“创建” 。

如果未看到“基本 Azure Node.js Express 4 应用程序”项目模板，必须添加 Node.js 开发工作负载。有关详细说明，请参阅先决条件。

Visual Studio 将创建项目并在解决方案资源管理器（右窗格）中将其打开。
按 F5 来生成并运行应用，确保一切按预期运行。
选择“文件”>“添加到源代码管理”，创建项目的本地 Git 存储库。

此时，采用 Express 框架且以 TypeScript 编写的 Node.js 应用正常工作并签入到本地源代码管理。
根据需要编辑项目，再继续到下一步骤。

将代码从 Visual Studio 推送到 GitHub

设置用于 Visual Studio 的 GitHub：

使用“工具”>“扩展和更新”，确保安装和启用适用于 Visual Studio 的 GitHub 扩展。
从菜单中选择“视图”>“其他窗口”>“GitHub”。

GitHub 窗口随即打开。
如果在 GitHub 窗口中没有看到“开始操作”按钮，请单击“文件”>“添加到源代码管理”并等待 UI 更新。
单击“开始操作”。

如果已连接到 GitHub，工具箱将显示，类似于下图。
填写字段使新存储库得以发布，然后单击“发布”。

几分钟后会显示一个横幅，指出“已成功创建存储库”。

下一步部分中，将学习如何从此存储库发布到 Linux 上 Azure 应用服务。

创建 Azure 中的 Linux 应用服务

登录 Azure 门户。
从左侧服务列表中选择“应用服务”，然后单击“添加”。
如果要求，请创建新的资源组和应用服务计划来托管新应用。
确保将“OS”设为“Linux”，将“运行时堆栈”设为所需 Node.js 版本，如图所示。
单击“创建”以创建应用服务。

部署可能需要几分钟时间。
部署后，请转到“应用程序设置”部分，添加一个名为 SCM_SCRIPT_GENERATOR_ARGS、值为 --node 的设置。

警告

应用服务部署过程使用一组试探法来确定要尝试和运行哪种类型的应用程序。如果在已部署的内容中检测到 .sln 文件，则假设正在部署基于 MSBuild 的项目。上面添加的设置将覆盖此逻辑，并显式指定这是 Node.js 应用程序。如果没有此设置，当 .sln 文件属于正部署到应用服务的存储库时，Node.js 应用程序将部署失败。
在“应用程序设置”下，添加另一个名称为 WEBSITE_NODE_DEFAULT_VERSION 且值为 8.9.0 的设置。
部署后，打开应用服务，并选择“部署选项”。
单击“选择源”，选择“GitHub”，然后配置任何所需的权限。
选择要发布的存储库和分支，并选择“确定”。

同步时“部署选项”页将出现。

完成同步后，将出现一个复选标记。

站点现在运行来自 GitHub 存储库的 Node.js 应用程序，可通过为 Azure 应用服务创建的 URL 进行访问（默认情况下为 Azure 应用服务提供的名称后跟“.azurewebsites.net”）。

修改应用并推送更改

在 app.use('/users', users); 行之后，将此处显示的代码添加到 app.ts。这会在 URL /api 处添加 REST API。
```
app.use('/api', (req, res, next) => {
    res.json({"result": "success"});
});
```
生成代码并进行本地测试，然后将其签入并推送到 GitHub。

在 Azure 门户中，需要一些时间来检测 GitHub 存储库中的更改，然后开始再次同步部署。它看上去类似于下图。
部署完成后，导航到公共站点并向 URL 追加 /api。返回 JSON 响应。

疑难解答

如果 node.exe 进程发生故障（也就是说出现未处理的异常），容器将重新启动。
容器启动时，它通过各种试探法来找出如何启动 Node.js 进程。可在 generateStartupCommand.js 看到实现的详细信息。
可以通过 SSH 连接到正在运行的容器进行调查。这可以通过 Azure 门户轻松实现。选择应用服务，向下滚动工具列表直至“开发工具”部分下的“SSH” 。
若要帮助进行故障排除，请转到应用服务的“诊断日志”设置，并将“Docker 容器日志记录”设置从“关”改为“文件系统” 。日志创建在 /home/LogFiles/_docker.log* 中，并且可以通过 SSH 或 FTP 在框上进行访问。
可向站点分配自定义域名，而不是默认分配的 *.azurewebsites.net URL。有关更多详细信息，请参阅主题映射自定义域。
最好先部署到过渡站点进行进一步测试，再移动到生产环节。有关如何配置此项的详细信息，请参阅主题创建过渡环境。
有关更多常问问题，请参阅 Linux 上应用服务的常见问题解答。

后续步骤

本教程中，你学习了如何创建 Linux 应用服务并将 Node.js 应用程序部署到该服务。你可以详细了解 Linux 应用服务。

Linux 应用服务