使用dotnet CLI创建自定义.NET Core项目模板

0 下载量 119 浏览量 更新于2024-08-29 收藏 2.14MB PDF 举报
本文介绍了如何利用.NET Core的dotnet CLI工具创建自定义的项目模板,以提高开发效率,避免重复劳动。作者首先列举了常见的项目创建方式,包括简单粗暴型、脚本型和高大上型(VS项目模板),并指出这些方法的不足,如需要手动复制公共类和设置引用。接着,文章详细讲解了如何基于dotnet CLI构建一个自定义的.NET Core WebAPI项目模板。 首先,作者展示了dotnet CLI自带的各种模板,然后选择WebAPI作为示例开始创建模板。创建一个包含NLog、Swagger和Dapper等组件的样例项目,并配置好引用关系和公共类。运行这个样例项目,显示一个简单的Swagger界面。 关键在于使用`template.json`文件将样例项目转化为模板。在样例项目的根目录下创建`.template.config`文件夹,并在此文件夹中创建`template.json`。这个JSON文件包含了模板的元数据,如作者、分类(Tag)以及模板的参数设置。例如: ```json { "author": "CatcherWong", "classifications": ["Web/WebAPI"], "identity": "CatcherWong.WebAPI.Template", "shortName": "webapi", "name": "CatcherWong的WebAPI模板", "description": "基于.NET Core的WebAPI项目模板,包含NLog、Swagger和Dapper", "tags": { "language": "C#" }, "parameters": [ { "name": "projectName", "description": "项目名称", "prompt": "请输入项目名称", "default": "MyWebAPI" } ] } ``` 在`template.json`中,`author`表示模板作者,`classifications`定义模板的类别,`identity`是模板的唯一标识,`shortName`是创建项目时使用的命令别名,`name`和`description`描述模板的名称和详情,`tags`指定模板的语言,而`parameters`则允许用户在创建项目时自定义参数,如项目名称。 创建完`template.json`后,可以通过`dotnet new -i .`命令将当前目录注册为模板源,之后就可以使用`dotnet new webapi`命令快速创建基于此模板的新项目。如果需要分享这个模板,可以将其打包并发布到NuGet,以便其他开发者安装和使用。 通过这种方法,开发者可以根据自己的开发习惯和团队需求,定制个性化的项目模板,提高开发效率,减少重复工作,使新项目的初始化过程更加便捷。