如何搭建自己的.NET Core項目模板

這篇文章主要介紹了如何搭建自己的.NET Core項目模板，具有一定借鑒價值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

前言

基于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
  "tags": {
   "language": "C#" ,
   "type":"project"
  },
  "sourceName": "TplDemo", // 可選，要替換的名字
  "preferNameDirectory": true // 可選，添加目錄 
}

在這里，有幾個比較重要的東西，一個是shortName，一個是sourceName。

• shortName，簡寫，偷懶必備，好比能寫 -h 就絕對不寫 --help

• sourceName，這是個可選的字段，它的值會替換指定的項目名，正常是把項目名賦值在這里。如果不指定，創建的項目就和樣例項目保持一致。

在寫完template.json之后，還需要安裝一下這個模板到我們的cli中。

使用 dotnet new -i進行模板的安裝。

下面是安裝示例。

dotnet new -i ./content/TplDemo

這里要注意的是，與.template.config文件夾同級的目錄，都會被打包進模板中。

在執行安裝命令之后，就可以看到我們的模板已經安裝好了。

這個時候已經迫不及待的想來試試這個模板了。

先來看看這個模板的幫助信息。

dotnet new tpl -h

因為我們目前還沒有設置參數，所以這里顯示的是還沒有參數。

下面來創建一個項目試試。

從創建一個項目，到運行起來，很簡單，效果也是我們預期的。

下面來看看，新建的這個HelloTpl這個項目的目錄結構和我們的模板是否一樣。

可以看到，除了名字，其他的內容都是一樣的。

是不是感覺又可以少復制粘貼好多代碼了。

雖說，現在建項目，已經能把一個大的模板完整的copy出來了，但是始終不是很靈活！

可能有小伙伴會問，明明已經很方便了呀，為什么還會說它不靈活呢？

且聽我慢慢道來。

如果說這個模板是個大而全的模板，包含了中間件A，中間件B，中間件C等N個中間件！

而在建新項目的時候，已經明確了只用中間件A，那么其他的中間件對我們來說，可能就沒有太大的存在意義！

很多時候，不會想讓這些多余的文件出現在代碼中，有沒有辦法來控制呢？

答案是肯定的！可以把不需要的文件排除掉就可以了。

文件過濾

模板項目中有一個RequestLogMiddleware，就用它來做例子。

我們只需要做下面幾件事就可以了。

第一步，在template.json中添加過濾

加入一個名字為EnableRequestLog的symbol。同時指定源文件

{
  "author": "Catcher Wong",
  //others...
  "symbols":{
   //是否啟用RequestLog這個Middleware
   "EnableRequestLog": {
    "type": "parameter", //它是參數
    "dataType":"bool", //bool類型的參數
    "defaultValue": "false" //默認是不啟用
   }
  },
  "sources": [
   {
     "modifiers": [
       {
         "condition": "(!EnableRequestLog)", //條件，由EnableRequestLog參數決定
         "exclude": [ //排除下面的文件
          "src/TplDemo/Middlewares/RequestLogMiddleware.cs",
          "src/TplDemo/Middlewares/RequestLogServiceCollectionExtensions.cs" 
         ]
       }
     ]
   }
  ]  
 }

第二步，在模板的代碼中做一下處理

主要是Startup.cs，因為Middleware就是在這里啟用的。

  using System;
  //other using...
  using TplDemo.Core;
#if (EnableRequestLog)  
  using TplDemo.Middlewares;
#endif

  /// <summary>
  /// 
  /// </summary>
  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，那么就可以包含這兩段代碼了。

下面更新一下已經安裝的模板。

這個時候再去看它的幫助信息，已經可以看到我們加的參數了。

下面先建一個默認的(不啟用RequestLog)

dotnet new tpl -n NoLog

這個命令等價于

dotnet new tpl -n WithLog -E false

下面是建好之后的目錄結構和Startup.cs

可以看到RequestLog相關的東西都已經不見了。

再建一個啟用RequestLog的，看看是不是真的起作用了。

dotnet new tpl -n WithLog -E true

可以看到，效果已經出來了。

下面在介紹一個比較有用的特性。動態切換，這個其實和上面介紹的內容相似。

動態切換

直接舉個例子來說明吧。

假設我們的模板支持MSSQL, MySQL, PgSQL和SQLite四種數據庫操作

在新建一個項目的時候，只需要其中一種，好比說要建一個PgSQL的，肯定就不想看到其他三種。

這里不想看到，有兩個地方，一個是nuget包的引用，一個是代碼。

上一小節是對某個具體的功能進行了開關的操作，這里有了4個，我們要怎么處理呢？

我們可以用類型是choice的參數來完成這個操作。

修改template.json，加入下面的內容

{
 "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內容之后，相信大家也知道個所以然了。有一個名為sqlType的參數，它有幾中數據庫選擇，默認是MsSQL。

還另外定義了幾個計算型的參數，它的取值是和sqlType的值息息相關的。

MsSQL,MySQL,PgSQL和SQLite這4個參數也是我們在代碼里要用到的??！

修改csproj文件，讓它可以根據sqlType來動態引用nuget包，我們加入下面的內容

<ItemGroup Condition="'$(MySQL)' == 'True' "> 
  <PackageReference Include="MySqlConnector" Version="0.47.1" />
</ItemGroup>

<ItemGroup Condition="'$(PgSQL)' == 'True' "> 
  <PackageReference Include="Npgsql" Version="4.0.3" />
</ItemGroup>

<ItemGroup Condition="'$(SQLite)' == 'True' "> 
  <PackageReference Include="Microsoft.Data.Sqlite" Version="2.1.0" />
</ItemGroup>

同樣的，代碼也要做相應的處理

#if (MsSQL)
  using System.Data.SqlClient;
#elif (MySQL)
  using MySql.Data.MySqlClient;
#elif (PgSQL)
  using Npgsql;
#else 
  using Microsoft.Data.Sqlite;
#endif

  protected DbConnection GetDbConnection()
  {
#if (MsSQL)      
    return new SqlConnection(_connStr);
#elif (MySQL)      
    return new MySqlConnection(_connStr);
#elif (PgSQL)       
    return new NpgsqlConnection(_connStr);
#else       
    return new SqliteConnection(_connStr);
#endif       
  }

修改好之后，同樣要去重新安裝這個模板，安裝好之后，就可以看到sqlType這個參數了。

下面分別創建一個MsSQL和PgSQL的項目，用來對比和驗證。

先后執行

dotnet new tpl -n MsSQLTest -s MsSQL 
dotnet new tpl -n PgSQLTest -s PgSQL

然后打開對應的csproj

可以看到，PgSQL的，添加多了NPgsql這個包。而MsSQL的卻沒有。

同樣的，DapperRepositoryBase也是一樣的效果。在創建Connection對象的時候，都根據模板來生成了。

當然這個是在我們自己本地安裝的模板，其他人是沒有辦法使用的。

如果想公開，可以發布到nuget上面去。如果是在公司內部共享，可以搭建一個內部的nuget服務，將模板上傳到內部服務器里面去。

感謝你能夠認真閱讀完這篇文章，希望小編分享的“如何搭建自己的.NET Core項目模板”這篇文章對大家有幫助，同時也希望大家多多支持億速云，關注億速云行業資訊頻道，更多相關知識等著你來學習!