通过

.NET .NET Aspire 安装与工具配置

.NET .NET Aspire 包括有助于创建和配置云原生应用的工具。 该工具包括有用的初学者项目模板和其他功能，可以简化 .NET Aspire 在 Visual Studio、Visual Studio Code和 CLI 工作流中的应用入门。 在后续的部分中，你将了解如何使用 .NET.NET Aspire 工具并探索以下任务：

  • 安装 .NET.NET Aspire 及其依赖项
  • 使用 Visual Studio、Visual Studio Code或 .NET CLI 创建初学者项目模板
  • 安装 .NET.NET Aspire 集成方案
  • 使用 .NET.NET Aspire 仪表盘

安装 .NET.NET Aspire 先决条件

若要使用 .NET.NET Aspire，需要在本地安装以下各项：

小提示

或者，可以使用 .NET 或 .NET Aspire开发 GitHub 解决方案。

Visual Studio 2022 17.9 或更高版本在安装 Web & 云工作负载时默认包括最新的 .NET.NET Aspire SDK。 如果你有早期版本的 Visual Studio 2022，则可以升级到 Visual Studio 2022 17.9，也可以使用以下步骤安装 .NET Aspire SDK：

若要在 .NET Aspire 2022 中安装 Visual Studio 工作负荷，请使用 Visual Studio 安装程序。

  1. 打开 Visual Studio 安装程序。

  2. 选择 修改 在 Visual Studio 2022 旁边。

  3. 选择 ASP.NET 和网页开发 工作负荷。

  4. 在 安装详细信息 面板中，选择 .NET.NET Aspire SDK。

  5. 选择 ，修改，以安装 .NET.NET Aspire 集成。

    显示如何使用 .NET Aspire 安装程序安装 Visual Studio 工作负荷的屏幕截图。

.NET .NET Aspire 模板

.NET .NET Aspire 提供了一组解决方案和项目模板。 这些模板可在你最喜欢的 .NET 开发人员集成环境中使用。 可以使用这些模板创建完整的 .NET Aspire 解决方案，或将单个项目添加到现有 .NET Aspire 解决方案。

安装 .NET.NET Aspire 模板

若要在 .NET Aspire中安装 Visual Studio 模板，需要手动安装模板，除非使用的是 Visual Studio 17.12 或更高版本。 对于 Visual Studio 17.9 到 17.11，请执行以下步骤：

  1. 打开 Visual Studio。
  2. 转到 工具>NuGet 包管理器>包管理器控制台。
  3. 运行以下命令以安装模板：
dotnet new install Aspire.ProjectTemplates

对于 Visual Studio 17.12 或更高版本，会自动安装 .NET Aspire 模板。

若要安装这些模板，请使用 dotnet new install 命令，传入 Aspire.ProjectTemplates NuGet 标识符。

dotnet new install Aspire.ProjectTemplates

若要安装特定版本，请将版本号追加到包名称：

dotnet new install Aspire.ProjectTemplates::9.3.0

小提示

如果你已经安装了 .NET.NET Aspire 工作负载，你需要传递 --force 标志以覆盖现有模板。 可以随意卸载 .NET.NET Aspire 负载。

列出 .NET.NET Aspire 模板

安装 .NET Aspire 17.9 或更高版本时，会自动安装 Visual Studio 模板。 若要查看可用的 .NET.NET Aspire 模板，请在 中选择 >>Visual Studio，并在搜索栏中搜索“Aspire”（Alt+S）。 可以看到可用 .NET.NET Aspire 项目模板的列表：

Visual Studio：创建新项目并搜索“Aspire”。

若要查看已安装 C# DevKit 的 Visual Studio Code 中的可用模板，请在 .NET 视图中未打开文件夹时，选择“创建 项目”按钮。

Visual Studio Code：“创建 .NET 项目”按钮。

然后，在搜索栏中搜索“Aspire”以查看可用的 .NET Aspire 项目模板：

Visual Studio Code：创建新项目并搜索“Aspire”。

若要验证是否已安装 .NET.NET Aspire 模板，请使用 dotnet new list 命令，传入 aspire 模板名称：

dotnet new list aspire

控制台输出应如下所示：

dotnet new list aspire
These templates matched your input: 'aspire'

Template Name                      Short Name              Language  Tags
---------------------------------  ----------------------  --------  -------------------------------------------------------
.NET Aspire App Host               aspire-apphost          [C#]      Common/.NET Aspire/Cloud
.NET Aspire Empty App              aspire                  [C#]      Common/.NET Aspire/Cloud/Web/Web API/API/Service
.NET Aspire Service Defaults       aspire-servicedefaults  [C#]      Common/.NET Aspire/Cloud/Web/Web API/API/Service
.NET Aspire Starter App            aspire-starter          [C#]      Common/.NET Aspire/Blazor/Web/Web API/API/Service/Cloud
.NET Aspire Test Project (MSTest)  aspire-mstest           [C#]      Common/.NET Aspire/Cloud/Web/Web API/API/Service/Test
.NET Aspire Test Project (NUnit)   aspire-nunit            [C#]      Common/.NET Aspire/Cloud/Web/Web API/API/Service/Test
.NET Aspire Test Project (xUnit)   aspire-xunit            [C#]      Common/.NET Aspire/Cloud/Web/Web API/API/Service/Test

有关详细信息，请参阅 .NET.NET Aspire 模板。

容器运行时

.NET Aspire 可以使用多个兼容 OCI 的运行时运行容器，包括 Docker 桌面和 Podman。 虽然某些用户报告了使用 Rancher Desktop 的成功（尤其是在配置为使用 Docker CLI 时），但这不是正式支持或定期测试的方案。 可以将 Rancher Desktop 与默认安装配合使用，但这不是正式支持或已验证的方法。 如果遇到 Rancher Desktop 问题，请告知我们，但请注意，修复可能不是优先级的。

  • Docker Desktop 是最受 .NET.NET Aspire 开发人员欢迎的容器运行时，提供了一个用于构建和运行容器的熟悉且广泛支持的环境。
  • Podman 是开源的、无守护进程的 Docker 替代方案。 它支持构建和运行开放容器计划（OCI）容器，使其成为首选轻型解决方案的开发人员的灵活选择。

如果主机环境已安装Docker和Podman，则.NET Aspire默认使用Docker。 可以通过将 .NET Aspire 环境变量设置为 Podman来指示 DOTNET_ASPIRE_CONTAINER_RUNTIME 改用 podman：

export ASPIRE_CONTAINER_RUNTIME=podman

有关详细信息，请参阅在 Podman 上安装 Linux。

.NET .NET Aspire 仪表板

公开.NET项目的.NET Aspire模板还包括一个功能强大的开发人员仪表板，用于监控和检查应用程序的各个方面，例如日志、跟踪和环境配置。 此仪表板旨在改进本地开发体验，并概述应用的整体状态和结构。

.NET .NET Aspire 仪表板仅在应用正在运行时可见，并在您启动 *.AppHost 项目时自动启动。 Visual Studio 和 Visual Studio Code 会在浏览器中自动为您启动您的应用和 .NET Aspire 仪表板。 如果使用 .NET CLI 启动应用，请将输出中的仪表板 URL 复制并粘贴到浏览器中，或按住 Ctrl 并选择链接（如果终端支持超链接）。

显示如何使用 CLI 启动仪表板的屏幕截图。

左侧导航提供了指向仪表板不同部分的链接，并且每个部分将在以下部分中查看。

.NET.NET Aspire 仪表板项目页面的屏幕截图。

.NET .NET Aspire 仪表板也可以在独立模式下使用。 有关详细信息，请参阅 独立 .NET.NET Aspire 仪表板。

Visual Studio 模具

Visual Studio 提供用于处理 .NET Aspire 集成系统和应用主机协调器项目的额外功能。 并非所有这些功能目前在 Visual Studio Code 或通过 CLI 提供。

添加集成包

你可以使用 .NET Aspire将 Visual Studio 集成添加到你的应用程序中，就像添加其他 NuGet 包一样。 但是，Visual Studio 还提供用于直接添加 .NET Aspire 集成的 UI 选项。

  1. 在 Visual Studio中，右键单击想要添加 .NET Aspire 集成的项目，然后选择 添加>.NET.NET Aspire 包...。

    显示“添加 Visual Studio 组件”选项的 .NET Aspire 上下文菜单。

  2. 包管理器将打开，并预配置了用于 .NET.NET Aspire 集成的搜索结果（填充了筛选条件），使您能够轻松浏览和选择所需的集成。

    Visual Studio 上下文菜单显示“添加 .NET Aspire 集成选项”。

有关 .NET.NET Aspire 集成的详细信息，请参阅 .NET.NET Aspire 集成概述。

添加托管包

.NET .NET Aspire 托管包用于配置应用可能依赖或使用的各种资源和依赖项。 托管包不同于其他集成包，因为它们已添加到 *.AppHost 项目中。 若要将托管包添加到应用，请执行以下步骤：

  1. 在 Visual Studio中，右键单击 *.AppHost 项目并选择 添加>.NET.NET Aspire 包...。

    显示“添加 Visual Studio 托管资源”选项的 .NET Aspire 上下文菜单。

  2. 包管理器将打开，其中预配置了 .NET.NET Aspire 托管包的搜索结果（填充筛选器条件），使你能够轻松浏览并选择所需的包。

    显示 Visual Studio 上下文菜单，其中包含添加 .NET Aspire 资源的选项。

添加编排项目

可以使用以下步骤将 .NET.NET Aspire 业务流程项目添加到现有应用：

  1. 在 Visual Studio中，右键选择现有项目，然后选择 添加>.NET.NET Aspire Orchestrator Support。。

    显示“添加 Visual Studio 编排器支持”选项的 .NET Aspire 上下文菜单。

  2. 此时会打开一个对话框窗口，其中包含添加到您解决方案中的 *.AppHost 和 *.ServiceDefaults 项目的摘要。

    显示 Visual Studio 添加 .NET Aspire 编排摘要的屏幕截图。

  3. 选择 确定 并应用以下更改：

    • *.AppHost 和 *.ServiceDefaults 业务流程项目已添加到解决方案中。
    • 对 builder.AddServiceDefaults 的调用将添加到原始项目的 Program.cs 文件中。
    • 对原始项目的引用将被添加到 Program.cs 文件的 *.AppHost 项目中。

有关 .NET.NET Aspire 业务流程的详细信息，请参阅 .NET.NET Aspire 业务流程概述。

加入编排

Visual Studio 提供了在新项目工作流期间 加入 Aspire 管理编排 的选项。 选择此选项可以 Visual Studio 创建 *.AppHost 和 *.ServiceDefaults 项目，与所选项目模板一起。

显示如何登记在 .NET.NET Aspire 编排中的屏幕截图。

创建测试项目

当您使用 Visual Studio时，选择 .NET.NET Aspire 启动应用程序 模板后，可以选择是否包含测试项目。 此测试项目是一个 xUnit 项目，其中包含一个示例测试，可用于测试的起点。

显示用于创建测试项目的选项的 Visual Studio 屏幕截图。

有关详细信息，请参阅 编写第一个 .NET.NET Aspire 测试。

Visual Studio Code 模具

可以将 Visual Studio Code与 C# Dev Kit 扩展配合使用来创建和开发 .NET.NET Aspire 项目。 若要在 .NET Aspire中创建新的 Visual Studio Code 项目，请在 .NET 视图中 选择“创建 项目”按钮，然后选择其中一个 .NET.NET Aspire 模板：

显示如何在 .NET Aspire中创建新的 Visual Studio Code 项目的屏幕截图。

创建新的 .NET Aspire 项目后，您可以运行并调试应用程序，逐步执行断点，并使用 Visual Studio Code 调试器检查变量。

显示如何在 .NET Aspire中调试 Visual Studio Code 项目的屏幕截图。

另请参阅