.NET .NET Aspire 模板

项目
12/13/2024

有许多 .NET.NET Aspire 项目模板可供你使用。可以使用这些模板创建完整的 .NET Aspire 解决方案，或将单个项目添加到现有 .NET Aspire 解决方案。

.NET .NET Aspire 模板在 📦Aspire.ProjectTemplates NuGet 包中提供。

安装 .NET.NET Aspire 模板

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

打开 Visual Studio。
转到工具>NuGet 包管理器>包管理器控制台。
运行以下命令以安装模板：

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.0.0

提示

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

列出 .NET.NET Aspire 模板

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

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

然后，在搜索栏中搜索“Aspire”以查看可用的 .NET 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 Aspire 模板，可以使用 .NET Aspire 解决方案结构和默认设置来预配置新应用。这些项目还提供跨应用的不同资源的统一调试体验。

.NET .NET Aspire 模板分为两类：解决方案模板和项目模板。解决方案模板使用多个项目创建新的 .NET Aspire 解决方案，而项目模板创建可添加到现有 .NET Aspire 解决方案的各个项目。

解决方案模板

以下解决方案模板可用，假设解决方案名为 aspireSample：

.NET .NET Aspire 空白应用：包含以下内容的简约 .NET.NET Aspire 项目：
- AspireSample.AppHost：一个业务流程协调程序项目，旨在连接和配置应用的不同项目和服务。
- AspireSample.ServiceDefaults：一个 .NET.NET Aspire 共享项目，用于管理解决方案中与复原能力、服务发现以及遥测相关的配置。

.NET .NET Aspire Starter App：除了 .AppHost 和 .ServiceDefaults 项目，.NET.NET Aspire Starter App 还包括以下内容：
- AspireSample.ApiService：ASP.NET Core 最小 API 项目用于向前端提供数据。此项目依赖于共同使用的 AspireSample.ServiceDefaults 项目。
- AspireSample.Web：具有默认 .NET.NET Aspire 服务配置的 ASP.NET CoreBlazor 应用项目，此项目取决于 AspireSample.ServiceDefaults 项目。
- AspireSample.Test：MSTest、NUnit，或 xUnit 测试项目，其中项目引用了 AspireSample.AppHost 和演示集成测试的示例 WebTests.cs 文件。

项目模板

以下 .NET.NET Aspire 项目模板可用：

.NET .NET Aspire 应用主机：独立 AppHost 项目，可用于统筹和管理您应用程序的不同项目和服务。

.NET .NET Aspire 测试项目：这些项目模板用于为 .NET.NET Aspire 应用创建测试项目，它们旨在表示功能和集成测试。测试项目包括以下模板：
- MSTest：包含 .NET.NET Aspire AppHost 项目的 MSTest 集成的项目。
- NUnit：包含 NUnit 集成的 .NET.NET Aspire AppHost 项目的项目。
- xUnit：一个包含 xUnit.net 集成的 .NET.NET Aspire AppHost 项目。
有关测试模板的详细信息，请参阅中的测试。

.NET .NET Aspire 服务默认值：一个独立的 ServiceDefaults 项目，可用于管理解决方案中与复原能力、服务发现以及遥测相关，且在跨项目中重复使用的配置。

重要

服务默认项目模板对 FrameworkReference 具备 Microsoft.AspNetCore.App的依赖关系。这可能不适合某些项目类型。有关详细信息，请参阅 .NET.NET Aspire 服务默认值。

使用模板创建解决方案和项目

若要创建 .NET Aspire 解决方案或项目，请使用 Visual Studio、Visual Studio Code或 .NET CLI，并将其基于可用的模板。浏览 .NET.NET Aspire 示例存储库中的其他 .NET.NET Aspire 模板。

若要使用 Visual Studio创建 .NET Aspire 项目，请在 Visual Studio 新项目窗口中搜索 Aspire 并选择所需的模板。

按照提示配置项目或解决方案的模板，然后选择创建。

若要使用 Visual Studio Code创建 .NET Aspire 项目，请在 Visual Studio Code 新项目窗口中搜索 Aspire 并选择所需的模板。

选择所需位置，输入名称，然后选择创建。

若要使用 .NET CLI 创建 .NET Aspire 解决方案或项目，请使用 dotnet new 命令并指定要创建的模板。请考虑以下示例：

若要创建面向最新 .NET 版本的基本 .NET.NET Aspire 应用主机项目：

dotnet new aspire-apphost

若要创建一个 .NET.NET Aspire 初学者应用，这是一个包含示例 UI 和支持 API 的完整解决方案：

dotnet new aspire-starter

提示

.NET Aspire 模板默认使用最新的 .NET 版本，即使使用早期版本的 .NET CLI 也是如此。若要手动指定 .NET 版本，请使用 --framework <tfm> 选项，例如创建面向 .NET 8 的基本 .NET.NET Aspire 应用主机项目：

dotnet new aspire-apphost --framework net8.0

通过