创建多项目模板

项目
04/30/2024

多项目模板用作两个或多个 Visual Studio 项目的容器。创建基于多项目模板的项目时，模板中的每个项目都会添加到解决方案中。

注意

本文中讨论的模板是在 Visual Studio 中创建项目时使用的模板，而不是 dotnet new 创建的模板。

多项目模板包含两个或多个项目模板，以及一个 ProjectGroup 类型的根模板。

多项目模板的行为不同于单项目模板。多项目模板具有以下独特特征：

使用多项目模板创建新项目时，无法向此模板中的各个项目分配名称。请改用 vstemplate 文件中 ProjectTemplateLink 元素上的 ProjectName 属性为每个项目指定名称。
多项目模板可能包含不同语言的项目，但仅可将整个模板本身放置在一个类别中。在 vstemplate 文件的 ProjectType 元素中指定模板类别。

多项目模板必须包括以下各项，并压缩为 .zip 文件：

整个多项目模板的根 vstemplate 文件。此 vstemplate 根文件包含在创建新项目的对话框中显示的元数据。它还指定在何处查找模板中项目的 vstemplate 文件。此文件必须位于 .zip 文件的根目录中。
两个或多个文件夹，其中包含完整的项目模板所需的文件。文件夹包含项目的所有代码文件，以及项目的 vstemplate 文件。

例如，具有两个项目的多项目模板 .zip 文件包含以下文件和目录：

MultiProjectTemplate.vstemplate
\Project1\MyTemplate.vstemplate
\Project1\Project1.vbproj
\Project1\Class.vb
\Project2\MyTemplate.vstemplate
\Project2\Project2.vbproj
\Project2\Class.vb

多项目模板的根 vstemplate 文件不同于单项目模板，表现在以下方面：

VSTemplate 元素的 Type 属性有 ProjectGroup 而没有 Project 值。例如：

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">

TemplateContent 元素包含 ProjectCollection 元素，它有一个或多个 ProjectTemplateLink 元素，这些元素定义了所包含项目的 vstemplate 文件的路径。例如：

<TemplateContent>
    <ProjectCollection>
        <ProjectTemplateLink>
            Project1\MyTemplate.vstemplate
        </ProjectTemplateLink>
        <ProjectTemplateLink>
            Project2\MyTemplate.vstemplate
        </ProjectTemplateLink>
    </ProjectCollection>
</TemplateContent>

提示

如果只需在“新建项目”对话框中显示多项目模板（而不是所包含的各个项目），请将内部模板标记为隐藏。例如：

<VSTemplate Type="Project" ... >
    <TemplateData>
        ...
        <Hidden>true</Hidden>
    </TemplateData>
    ...
</VSTemplate>

从现有解决方案中创建多项目模板

创建一个解决方案，并添加两个或多个项目。
自定义项目，直到可将其导出到模板。
提示

如果使用的是模板参数并且想要引用父模板中的变量，请在参数名称前加上前缀 ext_。例如 $ext_safeprojectname$ 。此外，将“ProjectTemplateLink”元素的“CopyParameters”属性设置为“true”。
```
<ProjectTemplateLink ProjectName="MyProject" CopyParameters="true">...</ProjectTemplateLink>
```
在“项目”菜单上，选择“导出模板” 。

“导出模板向导”随即打开。
在“选择模板类型”页上，选择“项目模板” 。选择要导出到模板的一个项目，然后选择“下一步”。（你将针对解决方案中的每个项目重复这些步骤。）
在“选择模板选项”页面上，输入模板的名称和可选说明、图标和预览图像。选择“完成”。

项目会导出到一个 .zip 文件中，并放在指定的输出位置。

备注

每个项目都必须单独导出到一个模板，因此请为解决方案中的每个项目重复上述步骤。
为模板创建一个目录，并为每个项目提供一个子目录。
将每个项目的 .zip 文件的内容提取到创建的相应子目录中。
在基目录中，创建扩展名为“.vstemplate”的 XML 文件。此文件包含多项目模板的元数据。有关文件结构，请参阅以下示例。确保为每个项目的 vstemplate 文件指定相对路径。
选择基目录中的所有文件，然后通过右键单击或从上下文菜单中选择“发送至”>“压缩的文件夹（zip 格式）” 。

这些文件和文件夹会压缩到一个 .zip 文件中。
将 .zip 文件复制到用户项目模板目录中。默认情况下，此目录为 %USERPROFILE%\Documents\Visual Studio <version>\Templates\ProjectTemplates。
在 Visual Studio 中，选择“文件”>“新建”>“项目”，并验证是否显示了模板。

两个项目的示例

此示例演示一个基本的多项目根 vstemplate 文件。在此示例中，模板有两个项目：“我的 Windows 应用程序”和“我的类库” 。 ProjectTemplateLink 元素上的 ProjectName 属性指定提供给项目的名称。

提示

如果未指定 ProjectName 属性，则将 vstemplate 文件的名称用作项目名称。

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>Multi-Project Template Sample</Name>
        <Description>An example of a multi-project template</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>VisualBasic</ProjectType>
    </TemplateData>
    <TemplateContent>
        <ProjectCollection>
            <ProjectTemplateLink ProjectName="My Windows Application">
                WindowsApp\MyTemplate.vstemplate
            </ProjectTemplateLink>
            <ProjectTemplateLink ProjectName="My Class Library">
                ClassLib\MyTemplate.vstemplate
            </ProjectTemplateLink>
        </ProjectCollection>
    </TemplateContent>
</VSTemplate>

解决方案文件夹示例

此示例使用 SolutionFolder 元素将项目分为两组：“数学类”和“图形类” 。该模板包含四个项目，其中两个位于每个解决方案文件夹中。

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
    <TemplateData>
        <Name>Multi-Project Template Sample</Name>
        <Description>An example of a multi-project template</Description>
        <Icon>Icon.ico</Icon>
        <ProjectType>VisualBasic</ProjectType>
    </TemplateData>
    <TemplateContent>
        <ProjectCollection>
            <SolutionFolder Name="Math Classes">
                <ProjectTemplateLink ProjectName="MathClassLib1">
                    MathClassLib1\MyTemplate.vstemplate
                </ProjectTemplateLink>
                <ProjectTemplateLink ProjectName="MathClassLib2">
                    MathClassLib2\MyTemplate.vstemplate
                </ProjectTemplateLink>
            </SolutionFolder>
            <SolutionFolder Name="Graphics Classes">
                <ProjectTemplateLink ProjectName="GraphicsClassLib1">
                    GraphicsClassLib1\MyTemplate.vstemplate
                </ProjectTemplateLink>
                <ProjectTemplateLink ProjectName="GraphicsClassLib2">
                    GraphicsClassLib2\MyTemplate.vstemplate
                </ProjectTemplateLink>
            </SolutionFolder>
        </ProjectCollection>
    </TemplateContent>
</VSTemplate>

带有项目引用的示例

此示例演示了如何向多项目模板添加项目引用，并且本质上是多项目模板示例的扩展。

在此示例中，解决方案包含两个项目：MultiProject.Client 和 MultiProject.Shared。项目 MultiProject.Client 引用 MultiProject.Shared。

文件夹结构如下所示：

MultiProjectTemplate.vstemplate
\MultiProject.Client\MultiProject.Client.csproj
\MultiProject.Client\MyTemplate.vstemplate
\MultiProject.Shared\MultiProject.Shared.csproj
\MultiProject.Shared\MyTemplate.vstemplate

使用模板时，MultiProject 部分将替换为用户输入的项目名称。

MultiProjectTemplate.vstemplate 如下所示。请注意，ProjectTemplateLink 的属性 CopyParameters 设置为 true，ProjectName 属性使用模板变量 $safeprojectname$。

<VSTemplate Version="2.0.0" Type="ProjectGroup"
    xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
...
<TemplateContent>
    <ProjectCollection>
        <ProjectTemplateLink ProjectName="$safeprojectname$.Client" CopyParameters="true">
            MultiProject.Client\MyTemplate.vstemplate
        </ProjectTemplateLink>
        <ProjectTemplateLink ProjectName="$safeprojectname$.Shared" CopyParameters="true">
            MultiProject.Shared\MyTemplate.vstemplate
        </ProjectTemplateLink>
    </ProjectCollection>
</TemplateContent>
</VSTemplate>

MultiProject.Client\MyTemplate.vstemplate 可能如下所示。请注意，Project 标记的属性 ReplaceParameters 设置为 true。

<VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Project">
	...
	<TemplateContent>
		<Project TargetFileName="MultiProject.Client.csproj" File="MultiProject.Client.csproj" ReplaceParameters="true">
            ...
		</Project>
	</TemplateContent>
</VSTemplate>

MultiProject.Client\MultiProject.Client.csproj 可能如下所示。请注意，ProjectReference 的属性 Include 使用模板变量 $ext_safeprojectname$

<Project>
    ...
	<ItemGroup>
	  <ProjectReference Include="..\$ext_safeprojectname$.Shared\$ext_safeprojectname$.Shared.csproj" />
	</ItemGroup>
</Project>

通过

创建多项目模板

从现有解决方案中创建多项目模板

两个项目的示例

解决方案文件夹示例

带有项目引用的示例

反馈

其他资源

通过

创建多项目模板

从现有解决方案中创建多项目模板

两个项目的示例

解决方案文件夹示例

带有项目引用的示例

相关内容

反馈

其他资源