打造自己的打造自己的.NET Core项目模板项目模板
MS SQL Server" }, { "choice": "MySQL
前言前言
每个人都有自己习惯的项目结构,有人的喜欢在项目里面建解决方案文件夹;有的人喜欢传统的三层命名;有的人喜欢单一,
简单的项目一个csproj就搞定。。
反正就是萝卜青菜,各有所爱。
可能不同的公司对这些会有特定的要求,也可能会随开发自己的想法去实践。
那么,问题就来了。如果有一个新项目,你会怎么去创建?
可能比较多的方式会是下面三种:
简单粗暴型,打开VS就是右键添加,然后引入一堆包,每个项目添加引用。
脚本型,基于dotnet cli,创建解决方案,创建项目,添加包,添加项目引用。
高大上型,VS项目模板,直接集成到VS上面了。
以前我也是基于dotnet cli写好了sh或ps的脚本,然后用这些脚本来生成新项目。
但是呢,这三种方式,始终都有不尽人意的地方。
因为建好的都是空模板,还要做一堆复杂的操作才可以让项目“正常”的跑起来。比如,这个公共类要抄过来,那个公共类要抄
过来。。。这不是明摆着浪费时间嘛。。。
下面介绍一个小办法来帮大家省点时间。
基于dotnet cli创建自己的项目模板,也就是大家常说的脚手架。
dotnet cli项目模板预热项目模板预热
开始正题之前,我们先看一下dotnet cli自带的一些模板。
可以看到种类还是很多的,由于工作大部分时间都是在写WebAPI,所以这里就用WebAPI来写个简单的模板。
下面我们就基于dotnet cli写一个自己的模板。
编写自己的模板编写自己的模板
既然是模板,就肯定会有一个样例项目。
下面我们建一个样例项目,大致成这样,大家完全可以按照自己习惯来。
这其实就是一个普通的项目,里面添加了NLog,Swagger,Dapper等组件,各个项目的引用关系是建好的。
该有的公共类,里面也都包含了,好比宇内分享的那个WebHostBuilderJexusExtensions。
下面是这个模板跑起来的效果。
就是一个简单的Swagger页面。
现在样例已经有了,要怎么把这个样例变成一个模板呢?
答案就是template.json!
在样例的根目录创建一个文件夹.template.config,同时在这个文件夹下面创建template.json。
示例如下:
{
"author": "Catcher Wong", //必须
"classifications": [ "Web/WebAPI" ], //必须,这个对应模板的Tags
"name": "TplDemo", //必须,这个对应模板的Templates
"identity": "TplDemoTemplate", //可选,模板的唯一名称
"shortName": "tpl", //必须,这个对应模板的Short Name