教程：创建项模板

使用 .NET，可以创建和部署可生成项目、文件甚至资源的模板。 本教程是系列教程的第一部分，介绍如何创建、安装和卸载用于 dotnet new 命令的模板。

在本系列的这一部分中，你将了解如何：

为项模板创建类

创建模板配置文件夹和文件

从文件路径安装模板

测试项模板

卸载项模板

先决条件

.NET 5.0 SDK 或更高版本。

阅读参考文章为 dotnet new 自定义模板。

参考文章介绍了有关模板的基础知识，以及如何将它们组合在一起。 其中一些信息将在本文中重复出现。

打开终端并导航到 working\templates 文件夹。

创建所需的文件夹

本系列使用包含模板源的“working 文件夹”和用于测试模板的“testing 文件夹”。 working 文件夹和 testing 文件夹应位于同一父文件夹下。

首先，创建父文件夹，名称无关紧要。 然后，创建一个名为“working” 的子文件夹。 在 working 文件夹内，创建一个名为“templates” 的子文件夹。

接下来，在名为“test” 的父文件夹下创建一个文件夹。 文件夹结构应如下所示。

parent_folder

├───test

└───working

└───templates

创建项模板

项模板是包含一个或多个文件的特定类型的模板。 当你想要生成类似于配置、代码或解决方案文件的内容时，这些类型的模板非常有用。 在本例中，你将创建一个类，该类将扩展方法添加到字符串类型中。

在终端中，导航到 working\templates 文件夹，并创建一个名为“extensions” 的新子文件夹。 进入文件夹。

working

└───templates

└───extensions

创建一个名为“CommonExtensions.cs” 的新文件，并使用你喜爱的文本编辑器打开它。 此类将提供一个用于反转字符串内容的名为 Reverse 的扩展方法。 粘贴以下代码并保存文件：

using System;

namespace System

{

public static class StringExtensions

{

public static string Reverse(this string value)

{

var tempArray = value.ToCharArray();

Array.Reverse(tempArray);

return new string(tempArray);

}

}

}

现在你已经创建了模板的内容，需要在模板的根文件夹中创建模板配置。

创建模板配置

模板通过模板根目录中的特殊文件夹和配置文件进行识别。 在本教程中，你的模板文件夹位于 working\templates\extensions 。

创建模板时，除特殊配置文件夹外，模板文件夹中的所有文件和文件夹都作为模板的一部分包含在内。 此配置文件夹名为“.template.config” 。

首先，创建一个名为“.template.config” 的新子文件夹，然后进入该文件夹。 然后，创建一个名为“template.json” 的新文件。 文件夹结构应如下所示：

working

└───templates

└───extensions

└───.template.config

template.json

使用你喜爱的文本编辑器打开 template.json 并粘贴以下 JSON 代码，然后保存。

{

"