?2016-2026 Matools All rights reserved,
粵ICP備17059708號
場景：日常工作中，你可能會碰到需要新建一個全新的解決方案的情況（如公司新起了一個新項目，需要有全新配套的后臺程序），如果公司內(nèi)部基礎(chǔ)框架較多、解決方案需要DDD模式等，那么從新起項目到各種依賴引用到能實際可用，一大堆的配置都需要重新設(shè)定、測試，耗時耗力，根據(jù)項目的大小，往往可能需要
1-2 小時甚至更久。
在 .net core 之前，雖然有相關(guān)的解決方法可以實現(xiàn)“項目模板”這個需求，但在具體操作時很不方便，從 .net core 1.0
開始，提供了“模板引擎”，增加了 dotnet new --install（-i） 命令和選項，通過該命令，可以讓你方便的創(chuàng)建屬于你自己的項目模板。
通過本文你可以了解和掌握：
* 掌握如何將一個現(xiàn)有解決方案中的項目作為項目模板。
* 掌握如何在本地創(chuàng)建項目模板并安裝和使用。
* 掌握如何將本地模板打包成 nuget 包，并通過包 id 進行安裝使用該模板。
* 了解、掌握簡單的 dotnet 和 nuget 命令及其配置。（windows 和 mac 會做差異說明）
準備工作
本次項目結(jié)構(gòu)如下（DDD）：
你可以在我的 github 庫：
https://github.com/ArtechChu/Template <https://github.com/ArtechChu/Template>
直接下載該模板源碼
* 用于發(fā)布的項目一共兩個，Template.Console 和 Template.WebApi
* 其中 Console 項目就是簡單的引用了下其他項目進行輸出。
* WebApi 項目簡單配置了下依賴注入，你可以將此項目作為 api 模板項目來說
Console 項目概要:
WebApi 項目概要：
將本地項目作為本地模板，通過命令進行安裝和使用
*
本次示例以 Console 為例，將控制臺項目涉及到的項目拷貝一份到如下文件夾中：
*
手動創(chuàng)建一個名為“.template.config”的文件夾，并在該文件夾內(nèi)創(chuàng)建文件：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”命令時顯示，安裝時也可直接根據(jù)該短名稱進行安裝。
* sourceName：當我們在使用"dotnet new" 命令進行安裝時，如果指定了 -n 或者 -o 選項，那么選項后面的名字會自動替換
sourceName 中指定的名字，因為我們的項目命名規(guī)則是
"Template.XXXX"，所以這里設(shè)定為“Template”，如果你的項目命名規(guī)則是“公司.項目.XXX”，那么這里請設(shè)定為“公司.項目”。
*
安裝該模板到本地模板庫
# 通過如下命令查看當前本機已安裝模板： dotnet new -l
# 模板安裝命令：dotnet new i <path | nugetId> # 這里因為是安裝本地模板，直接使用路徑（絕對和相對均可） dotnet
new -i .
*
安裝該短名稱為 CustomConsole 的模板
假定安裝路徑為 D:\TestTemplate
假定新起的項目名為“Company.Group”
# 這里使用 -n 和 -o 選項來分別指定新項目的名字以及輸出目錄 # 設(shè)定新項目的名字為“Company.Group”，因為當前定位已經(jīng)在
TestTemplate 文件夾內(nèi)，所以直接用“.”，如下： dotnet new CustomConsole -n Company.Group -o .
文件夾內(nèi)容如下：
* 使用模板新建的項目文件夾自動為“Company.Group.XXXX”
測試：
更多關(guān)于 template.json 的說明請參考：http://json.schemastore.org/template
<http://json.schemastore.org/template>
* 在 template.json 中，你還可以指定 symbols 等，來實現(xiàn)更多的自定義功能，如聯(lián)動預(yù)編譯指令等等。
將本地項目打包為 nuget 包，并通過命令進行安裝和使用
本次示例以 Console +WebApi 為例，在 Templates\Nuget 文件夾中，建立 Content 文件夾用于存放 nuget
包內(nèi)容，具體如下：
* ConsoleTemplate 中的 .template.config\template.json 內(nèi)容同上方 Console 示例。
*
WebApiTemplate 中的 .template.config\template.json 內(nèi)容如下：
{ "$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 }
*
在 content 目錄內(nèi)創(chuàng)建一個 nuspec 文件：Custom.Template.NetCore.nuspec，內(nèi)容如下：
<?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 必須保證唯一，其他按需設(shè)置即可。
* 必須是在 content 文件夾內(nèi)。nuget 在打包的時候，是根據(jù) content 文件夾來進行的。
*
使用 nuget pack 命令打包
# 注意路徑的相對位置 nuget pack Custom.Template.NetCore.nuspec -OutputDirectory .
*
打包后的內(nèi)容為：
*
發(fā)布該 nuget 包到 nuget server
這里用的是自建 nuget server，你可以按自身情況打包上傳。
* 你可以直接使用 Nuget Package Explorer 進行發(fā)布包
* 也可以使用 nuget push 來發(fā)布，如下： nuget push Custom.Template.NetCore.1.0.1.nupkg
-Source "你的nuget 服務(wù) url" -ApiKey "你的nuget api key"
*
通過 nuget 安裝模板到本地
*
安裝前本地已經(jīng)安裝的模板如下：
*
安裝
dotnet new -i Custom.Template.NetCore::*
*
通過模板安裝 CustomWebApi
安裝路徑為：D:\TestWebApiTemplate
dotnet new CustomWebApi -n Company.Group -o .
*
創(chuàng)建一個解決方案，并將所有的項目添加到解決方案 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://devblogs.microsoft.com/dotnet/how-to-create-your-own-templates-for-dotnet-new/>
https://github.com/dotnet/dotnet-template-samples
<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/dotnet/core/tools/dotnet-new?tabs=netcore22>
https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools
<https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools>
熱門工具 換一換