.Net項(xiàng)目模板(Project Template)

你有沒有這樣的感覺，開啟一個新項(xiàng)目時，總是做一堆體力活——項(xiàng)目的結(jié)構(gòu)層次，常用日志庫，OpenAPI庫，ORM庫，的引入，權(quán)限認(rèn)證方式選擇添加，配置文件重新歸置存放等等。公共框架的部分總是不變的，如果有個常用項(xiàng)目的模板就好了，可以一鍵創(chuàng)建，接下來直接寫業(yè)務(wù)就ok了。

這種場景還適合一些公司對源碼，項(xiàng)目，技術(shù)都有嚴(yán)格的要求，這時模板也能帶來便利性。

Project Template在.Net中是很好的支持的，并且實(shí)現(xiàn)自己的模板也不是那么困難。

先來個開胃菜吧，安裝完.net(core)的sdk后，可以在命令行上查看自己的現(xiàn)有項(xiàng)目模板。

我們的目標(biāo)是把自己的項(xiàng)目模板添加到這個列表里，然后用dotnet new 命令可以創(chuàng)建我們的項(xiàng)目了。

具體步驟：

1、創(chuàng)建一個控件臺項(xiàng)目，命名GSWCon，這時，就可以整理自己的項(xiàng)目層次和添加自己想的三方庫了。這里為了區(qū)分官方，只對輸出作了少許改變。

using System;using Newtonsoft;using Newtonsoft.Json;using static System.Console;
namespace GSWCon{    class Program    {        static void Main(string[] args)        {            var template = new Template            {                Name = "GSWCon",                Author = "桂素偉",                Description = "第一個項(xiàng)目模板，控制臺項(xiàng)目，引入了Newtonsoft庫！",                CreateTime = DateTime.Parse("2021-04-06 08:00:00")            };            WriteLine(JsonConvert.SerializeObject(template, Formatting.Indented));        }    }
    class Template    {        public string Name { get; set; }        public string Author { get; set; }        public string Description { get; set; }        public DateTime CreateTime { get; set; }    }}

2、添加Template文件，在項(xiàng)目目錄下(與csproj在一個目錄下)創(chuàng)建.template.config文件夾，并且在這個文件夾中添加template.json文件，內(nèi)容如下：

{  "$schema": "http://json.schemastore.org/template",  "author": "GuiSuWei",  "classifications": [ "Common", "Console","GuiSuWei"],  "identity": "GSW Console",  "name": "GSW Console",  "shortName": "GSWCon",  "tags": {    "language": "C#",    "type": "project"  },  "sourceName":"GSWCon"}

關(guān)于template.json文件的描述詳情，可參考http://json.schemastore.org/template，基本名稱就代碼了它的含義。

template.json文件就是對項(xiàng)目模板的配置，其中的sourceName就是項(xiàng)目名稱，當(dāng)我用這個項(xiàng)目生成自己的項(xiàng)目時，這個名稱會換成自己定義的項(xiàng)目名稱。

3、生成項(xiàng)目模板，用cmd(終端)，進(jìn)入項(xiàng)目文件，刪除bin,obj文件夾(如果存在)，然后執(zhí)行命令：dotnet new -i ./，這里就會看到自己的模板添加到了本地模板庫里了，結(jié)果如下：

4、測試模板，創(chuàng)建自己的項(xiàng)目，假如項(xiàng)目名稱叫ABC，那就創(chuàng)建一個文件夾ABC，cmd(終端)進(jìn)入該文件夾，執(zhí)行命令：dotnet new GSWCon，就會看到創(chuàng)建一個新的控制臺項(xiàng)目，打開項(xiàng)目，項(xiàng)目里所有的GSWCon都會替換成ABC，代碼和模板中的Program.js里的代碼是一樣的(GSWCon會被換成ABC)。

四步就完成了一個項(xiàng)目模板的創(chuàng)建和測試，這里只是一個極簡的例子，真正的模板項(xiàng)目要復(fù)雜的多，后續(xù)慢慢加大難度。