這篇文章主要介紹了如何搭建自己的.NET Core項(xiàng)目模板，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。
創(chuàng)新互聯(lián)公司是一家集網(wǎng)站建設(shè),峨山縣企業(yè)網(wǎng)站建設(shè),峨山縣品牌網(wǎng)站建設(shè),網(wǎng)站定制,峨山縣網(wǎng)站建設(shè)報(bào)價(jià),網(wǎng)絡(luò)營(yíng)銷,網(wǎng)絡(luò)優(yōu)化,峨山縣網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè)，幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競(jìng)爭(zhēng)力。可充分滿足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時(shí)我們時(shí)刻保持專業(yè)、時(shí)尚、前沿，時(shí)刻以成就客戶成長(zhǎng)自我，堅(jiān)持不斷學(xué)習(xí)、思考、沉淀、凈化自己，讓我們?yōu)楦嗟钠髽I(yè)打造出實(shí)用型網(wǎng)站。前言
基于dotnet cli創(chuàng)建自己的項(xiàng)目模板，也就是大家常說(shuō)的腳手架。
dotnet cli項(xiàng)目模板預(yù)熱
開(kāi)始正題之前，我們先看一下dotnet cli自帶的一些模板。
可以看到種類還是很多的，由于工作大部分時(shí)間都是在寫(xiě)WebAPI，所以這里就用WebAPI來(lái)寫(xiě)個(gè)簡(jiǎn)單的模板。
下面我們就基于dotnet cli寫(xiě)一個(gè)自己的模板。
編寫(xiě)自己的模板
既然是模板，就肯定會(huì)有一個(gè)樣例項(xiàng)目。
下面我們建一個(gè)樣例項(xiàng)目，大致成這樣，大家完全可以按照自己習(xí)慣來(lái)。
這其實(shí)就是一個(gè)普通的項(xiàng)目，里面添加了NLog,Swagger,Dapper等組件，各個(gè)項(xiàng)目的引用關(guān)系是建好的。
該有的公共類，里面也都包含了，好比宇內(nèi)分享的那個(gè)WebHostBuilderJexusExtensions。
下面是這個(gè)模板跑起來(lái)的效果。
就是一個(gè)簡(jiǎn)單的Swagger頁(yè)面。
現(xiàn)在樣例已經(jīng)有了，要怎么把這個(gè)樣例變成一個(gè)模板呢？
答案就是template.json！
在樣例的根目錄創(chuàng)建一個(gè)文件夾.template.config，同時(shí)在這個(gè)文件夾下面創(chuàng)建template.json。
示例如下：
重慶分公司
重慶分公司
{
"author": "Catcher Wong", //必須
"classifications": [ "Web/WebAPI" ], //必須，這個(gè)對(duì)應(yīng)模板的Tags
"name": "TplDemo", //必須，這個(gè)對(duì)應(yīng)模板的Templates
"identity": "TplDemoTemplate", //可選，模板的名稱
"shortName": "tpl", //必須，這個(gè)對(duì)應(yīng)模板的Short Name
"tags": {
"language": "C#" ,
"type":"project"
},
"sourceName": "TplDemo", // 可選，要替換的名字
"preferNameDirectory": true // 可選，添加目錄
}在這里，有幾個(gè)比較重要的東西，一個(gè)是shortName，一個(gè)是sourceName。
shortName，簡(jiǎn)寫(xiě)，偷懶必備，好比能寫(xiě)-h 就絕對(duì)不寫(xiě)--help
sourceName，這是個(gè)可選的字段，它的值會(huì)替換指定的項(xiàng)目名，正常是把項(xiàng)目名賦值在這里。如果不指定，創(chuàng)建的項(xiàng)目就和樣例項(xiàng)目保持一致。
在寫(xiě)完template.json之后，還需要安裝一下這個(gè)模板到我們的cli中。
使用dotnet new -i進(jìn)行模板的安裝。
下面是安裝示例。
dotnet new -i ./content/TplDemo
這里要注意的是，與.template.config文件夾同級(jí)的目錄，都會(huì)被打包進(jìn)模板中。
在執(zhí)行安裝命令之后，就可以看到我們的模板已經(jīng)安裝好了。
這個(gè)時(shí)候已經(jīng)迫不及待的想來(lái)試試這個(gè)模板了。
先來(lái)看看這個(gè)模板的幫助信息。
dotnet new tpl -h
因?yàn)槲覀兡壳斑€沒(méi)有設(shè)置參數(shù)，所以這里顯示的是還沒(méi)有參數(shù)。
下面來(lái)創(chuàng)建一個(gè)項(xiàng)目試試。
從創(chuàng)建一個(gè)項(xiàng)目，到運(yùn)行起來(lái)，很簡(jiǎn)單，效果也是我們預(yù)期的。
下面來(lái)看看，新建的這個(gè)HelloTpl這個(gè)項(xiàng)目的目錄結(jié)構(gòu)和我們的模板是否一樣。
可以看到，除了名字，其他的內(nèi)容都是一樣的。
是不是感覺(jué)又可以少?gòu)?fù)制粘貼好多代碼了。
雖說(shuō)，現(xiàn)在建項(xiàng)目，已經(jīng)能把一個(gè)大的模板完整的copy出來(lái)了，但是始終不是很靈活！
可能有小伙伴會(huì)問(wèn)，明明已經(jīng)很方便了呀，為什么還會(huì)說(shuō)它不靈活呢？
且聽(tīng)我慢慢道來(lái)。
如果說(shuō)這個(gè)模板是個(gè)大而全的模板，包含了中間件A，中間件B，中間件C等N個(gè)中間件！
而在建新項(xiàng)目的時(shí)候，已經(jīng)明確了只用中間件A，那么其他的中間件對(duì)我們來(lái)說(shuō)，可能就沒(méi)有太大的存在意義！
很多時(shí)候，不會(huì)想讓這些多余的文件出現(xiàn)在代碼中，有沒(méi)有辦法來(lái)控制呢？
答案是肯定的！可以把不需要的文件排除掉就可以了。
文件過(guò)濾
模板項(xiàng)目中有一個(gè)RequestLogMiddleware，就用它來(lái)做例子。
我們只需要做下面幾件事就可以了。
第一步，在template.json中添加過(guò)濾
加入一個(gè)名字為EnableRequestLog的symbol。同時(shí)指定源文件
{
"author": "Catcher Wong",
//others...
"symbols":{
//是否啟用RequestLog這個(gè)Middleware
"EnableRequestLog": {
"type": "parameter", //它是參數(shù)
"dataType":"bool", //bool類型的參數(shù)
"defaultValue": "false" //默認(rèn)是不啟用
}
},
"sources": [
{
"modifiers": [
{
"condition": "(!EnableRequestLog)", //條件，由EnableRequestLog參數(shù)決定
"exclude": [ //排除下面的文件
"src/TplDemo/Middlewares/RequestLogMiddleware.cs",
"src/TplDemo/Middlewares/RequestLogServiceCollectionExtensions.cs"
]
}
]
}
]
}第二步，在模板的代碼中做一下處理
主要是Startup.cs，因?yàn)镸iddleware就是在這里啟用的。
using System; //other using... using TplDemo.Core; #if (EnableRequestLog) using TplDemo.Middlewares; #endif ////// /// public class Startup { public void Configure(IApplicationBuilder app, IHostingEnvironment env) { //other code.... #if (EnableRequestLog) //request Log app.UseRequestLog(); #endif app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); } }
這樣的話，只要EnableRequestLog是true，那么就可以包含這兩段代碼了。
下面更新一下已經(jīng)安裝的模板。
這個(gè)時(shí)候再去看它的幫助信息，已經(jīng)可以看到我們加的參數(shù)了。
下面先建一個(gè)默認(rèn)的(不啟用RequestLog)
dotnet new tpl -n NoLog
這個(gè)命令等價(jià)于
dotnet new tpl -n WithLog -E false
下面是建好之后的目錄結(jié)構(gòu)和Startup.cs
可以看到RequestLog相關(guān)的東西都已經(jīng)不見(jiàn)了。
再建一個(gè)啟用RequestLog的，看看是不是真的起作用了。
dotnet new tpl -n WithLog -E true
可以看到，效果已經(jīng)出來(lái)了。
下面在介紹一個(gè)比較有用的特性。動(dòng)態(tài)切換，這個(gè)其實(shí)和上面介紹的內(nèi)容相似。
動(dòng)態(tài)切換
直接舉個(gè)例子來(lái)說(shuō)明吧。
假設(shè)我們的模板支持MSSQL, MySQL, PgSQL和SQLite四種數(shù)據(jù)庫(kù)操作
在新建一個(gè)項(xiàng)目的時(shí)候，只需要其中一種，好比說(shuō)要建一個(gè)PgSQL的，肯定就不想看到其他三種。
這里不想看到，有兩個(gè)地方，一個(gè)是nuget包的引用，一個(gè)是代碼。
上一小節(jié)是對(duì)某個(gè)具體的功能進(jìn)行了開(kāi)關(guān)的操作，這里有了4個(gè)，我們要怎么處理呢？
我們可以用類型是choice的參數(shù)來(lái)完成這個(gè)操作。
修改template.json，加入下面的內(nèi)容
{
"author": "Catcher Wong",
//others
"symbols":{
"sqlType": {
"type": "parameter",
"datatype": "choice",
"choices": [
{
"choice": "MsSQL",
"description": "MS SQL Server"
},
{
"choice": "MySQL",
"description": "MySQL"
},
{
"choice": "PgSQL",
"description": "PostgreSQL"
},
{
"choice": "SQLite",
"description": "SQLite"
}
],
"defaultValue": "MsSQL",
"description": "The type of SQL to use"
},
"MsSQL": {
"type": "computed",
"value": "(sqlType == \"MsSQL\")"
},
"MySQL": {
"type": "computed",
"value": "(sqlType == \"MySQL\")"
},
"PgSQL": {
"type": "computed",
"value": "(sqlType == \"PgSQL\")"
},
"SQLite": {
"type": "computed",
"value": "(sqlType == \"SQLite\")"
}
}
}看了上面的JSON內(nèi)容之后，相信大家也知道個(gè)所以然了。有一個(gè)名為sqlType的參數(shù)，它有幾中數(shù)據(jù)庫(kù)選擇，默認(rèn)是MsSQL。
還另外定義了幾個(gè)計(jì)算型的參數(shù)，它的取值是和sqlType的值息息相關(guān)的。
MsSQL,MySQL,PgSQL和SQLite這4個(gè)參數(shù)也是我們?cè)诖a里要用到的??！
修改csproj文件，讓它可以根據(jù)sqlType來(lái)動(dòng)態(tài)引用nuget包，我們加入下面的內(nèi)容
