使用 .NET CORE 建立 項目模板，模板項目，Template

場景：平常工做中，你可能會碰到須要新建一個全新的解決方案的狀況（如公司新起了一個新項目，須要有全新配套的後臺程序），若是公司內部基礎框架較多、解決方案須要DDD模式等，那麼重新起項目到各類依賴引用到能實際可用，一大堆的配置都須要從新設定、測試，耗時耗力，根據項目的大小，每每可能須要 1-2 小時甚至更久。

在 .net core 以前，雖然有相關的解決方法能夠實現「項目模板」這個需求，但在具體操做時很不方便，從 .net core 1.0 開始，提供了「模板引擎」，增長了 dotnet new --install（-i） 命令和選項，經過該命令，可讓你方便的建立屬於你本身的項目模板。

本文原始地址：https://blog.zhuliang.ltd/2019/07/net-core/custom-template-using-dotnetcore.html

經過本文你能夠了解和掌握：

1. 掌握如何將一個現有解決方案中的項目做爲項目模板。
   1. 掌握如何在本地建立項目模板並安裝和使用。
   2. 掌握如何將本地模板打包成 nuget 包，並經過包 id 進行安裝使用該模板。
2. 瞭解、掌握簡單的 dotnet 和 nuget 命令及其配置。（windows 和 mac 會作差別說明）

準備工做

本次項目結構以下（DDD）：

你能夠在個人 github 庫：
https://github.com/ArtechChu/Template 直接下載該模板源碼

• 用於發佈的項目一共兩個，Template.Console 和 Template.WebApi
  • 其中 Console 項目就是簡單的引用了下其餘項目進行輸出。
  • WebApi 項目簡單配置了下依賴注入，你能夠將此項目做爲 api 模板項目來講

Console 項目概要:

WebApi 項目概要：

將本地項目做爲本地模板，經過命令進行安裝和使用

1. 本次示例以 Console 爲例，將控制檯項目涉及到的項目拷貝一份到以下文件夾中：

2. 手動建立一個名爲「.template.config」的文件夾，並在該文件夾內建立文件：template.json

   {
     "$schema": "http://json.schemastore.org/template",
     "author": "Artech",
     "classifications": [ "Console" ],
     "name": "Custom Console",
     "identity": "Custom Console", //模板惟一標識
     "groupIdentity": "Custom Console", 
     "shortName": "CustomConsole", //【修改】短名稱，使用 dotnet new <shortName> 安裝模板時的名稱
     "tags": {
       "language": "C#", 
       "type": "project" 
     },
     "sourceName": "Template", //【修改】在使用 -n 選項時，會替換模板中項目的名字
     "preferNameDirectory": true
   }

   • 這裏主要說明下 shortName 和 sourceName 這 2 個屬性。
     • shortName：短名稱，用於在使用「dotnet new -l」命令時顯示，安裝時也可直接根據該短名稱進行安裝。
     • sourceName：當咱們在使用"dotnet new" 命令進行安裝時，若是指定了 -n 或者 -o 選項，那麼選項後面的名字會自動替換 sourceName 中指定的名字，由於咱們的項目命名規則是 "Template.XXXX"，因此這裏設定爲「Template」，若是你的項目命名規則是「公司.項目.XXX」，那麼這裏請設定爲「公司.項目」。

3. 安裝該模板到本地模板庫

   # 經過以下命令查看當前本機已安裝模板：
   dotnet  new  -l

   # 模板安裝命令：dotnet  new  i <path | nugetId>
   # 這裏由於是安裝本地模板，直接使用路徑（絕對和相對都可）
   dotnet  new  -i  .

4. 安裝該短名稱爲 CustomConsole 的模板

   假定安裝路徑爲 D:\TestTemplate
   假定新起的項目名爲「Company.Group」

   # 這裏使用 -n 和 -o 選項來分別指定新項目的名字以及輸出目錄
   # 設定新項目的名字爲「Company.Group」，由於當前定位已經在 TestTemplate 文件夾內，因此直接用「.」，以下：
    dotnet   new   CustomConsole   -n   Company.Group   -o   .

   文件夾內容以下：

   • 使用模板新建的項目文件夾自動爲「Company.Group.XXXX」

   測試：

   更多關於 template.json 的說明請參考：http://json.schemastore.org/template

   • 在 template.json 中，你還能夠指定 symbols 等，來實現更多的自定義功能，如聯動預編譯指令等等。

將本地項目打包爲 nuget 包，並經過命令進行安裝和使用

本次示例以 Console +WebApi 爲例，在 Templates\Nuget 文件夾中，創建 Content 文件夾用於存放 nuget 包內容，具體以下：

• ConsoleTemplate 中的 .template.config\template.json 內容同上方 Console 示例。

• WebApiTemplate 中的 .template.config\template.json 內容以下：

  {
    "$schema": "http://json.schemastore.org/template",
    "author": "Artech",
    "classifications": [ "WebApi" ],
    "name": "Custom WebApi",
    "identity": "Custom WebApi",
    "groupIdentity": "Custom WebApi",
    "shortName": "CustomWebApi",
    "tags": {
      "language": "C#",
      "type": "project"
    },
    "sourceName": "Template",
    "preferNameDirectory": true
  }

1. 在 content 目錄內建立一個 nuspec 文件：Custom.Template.NetCore.nuspec，內容以下：

   <?xml version="1.0" encoding="utf-8"?>
   <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
     <metadata>
       <id>Custom.Template.NetCore</id>
       <version>1.0.1</version>
       <description>
         Custom Template, including WebApi, Console
       </description>
       <authors>Artech</authors>
       <packageTypes>
         <packageType name="Template" />
       </packageTypes>
     </metadata>
   </package>

   • 須要注意，packageType 爲 Template，metadata.id 必須保證惟一，其餘按需設置便可。
   • 必須是在 content 文件夾內。nuget 在打包的時候，是根據 content 文件夾來進行的。

2. 使用 nuget pack 命令打包

   # 注意路徑的相對位置
   nuget   pack   Custom.Template.NetCore.nuspec   -OutputDirectory   .

• 打包後的內容爲：

3. 發佈該 nuget 包到 nuget server

   這裏用的是自建 nuget server，你能夠按自身狀況打包上傳。

   • 你能夠直接使用 Nuget Package Explorer 進行發佈包
   • 也可使用 nuget push 來發布，以下：

   nuget push Custom.Template.NetCore.1.0.1.nupkg -Source "你的nuget 服務 url" -ApiKey "你的nuget api key"

4. 經過 nuget 安裝模板到本地

• 安裝前本地已經安裝的模板以下：
  

• 安裝

  dotnet new -i Custom.Template.NetCore::*

5. 經過模板安裝 CustomWebApi

   安裝路徑爲：D:\TestWebApiTemplate

   dotnet  new  CustomWebApi  -n  Company.Group  -o  .

6. 建立一個解決方案，並將全部的項目添加到解決方案 Company.Group.sln 中

   dotnet new sln -n Company.Group
   # windows 下沒法使用 glob pattern 只能逐個添加
   dotnet sln Company.Group.sln add Company.Group.Application\Company.Group.Application.csproj
   dotnet sln Company.Group.sln add Company.Group.Domain\Company.Group.Domain.csproj
   dotnet sln Company.Group.sln add Company.Group.DomainService\Company.Group.DomainService.csproj
   dotnet sln Company.Group.sln add Company.Group.IApplication\Company.Group.IApplication.csproj
   dotnet sln Company.Group.sln add Company.Group.IDomainService\Company.Group.IDomainService.csproj
   dotnet sln Company.Group.sln add Company.Group.Infrastructure.CrossCutting\Company.Group.Infrastructure.CrossCutting.csproj
   dotnet sln Company.Group.sln add Company.Group.Repository\Company.Group.Repository.csproj
   dotnet sln Company.Group.sln add Company.Group.WebApi\Company.Group.WebApi.csproj

   若是你用的是 mac / linux ，則能夠直接用 globbing pattern 來添加，以下：

   dotnet sln Company.Group.sln add **/*.csproj

參考

https://devblogs.microsoft.com/dotnet/how-to-create-your-own-templates-for-dotnet-new/

https://github.com/dotnet/dotnet-template-samples

https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new?tabs=netcore22

https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools