使用 .NET CLI 構建項目腳手架

2021 年 3 月 9 日
筆記

前言

在微服務場景中，開發人員分配到不同的小組，系統會拆分為很多個微服務，有一點是，每個項目都需要單元測試，介面文檔，WebAPI介面等，創建新項目這些都是重複的工作，而且還要保證各個項目結構的大體一致，這時就需要一個適用於企業內部的框架模板，類似於前端的腳手架，可以做到開箱即用，注重業務功能開發，提升工作效率。

簡介

NET 命令行介面 (CLI) 工具是用於開發、生成、運行和發布 .NET 應用程式的跨平台工具鏈。

本次主要介紹的是 dotnet new 命令，可以通過這個命令創建我們的自定義模板，我們安裝完.NET SDK後，本身自帶了一些項目模板，可以通過 dotnet new --list 查看已經安裝的模板。

接下來，我會介紹如何構建自定義的項目模板。

準備工作

首先，我們需要準備一個簡單的項目模板，我們希望以後可以通過腳手架，自動為我們生成這些項目和文件，這裡面可能包含了單元測試項目，WebAPI項目等。

你也可以在這裡找到項目源程式碼，//github.com/SpringLeee/Dy.Template

在本地創建 Dy.Template 文件夾，並在文件夾內創建 templates 文件夾（後邊所有的模板文件都在這裡）, 這裡我創建了一個解決方案，裡面包含了3個項目，WebAPI，Test 和 Task，項目結構如下：

構建模板

在 templates 文件夾內，創建一個名為 “.template.config” 的文件夾（可以通過命令 mkdir .template.config 創建, 然後進入該文件夾，再創建一個名為 “template.json” 的新文件, 文件夾結構應如下所示：

然後修改配置文件如下：

{
  "$schema": "//json.schemastore.org/template",
  "author": "SpringLee",
  "classifications": [ "Template" ],
  "name": "Dy.Template",
  "identity": "Dy.Template", 
  "shortName": "dy-template",
  "tags": {
    "language": "C#" 
  },
  "sourceName": "Template" 
}

上面是一些基本的描述資訊，需要注意的是 “sourceName” 屬性，它相當於一個變數，我們通過這個屬性，可以創建 Dy.Order.WebAPI, Dy.User.WebAPI 這樣的項目，後邊我會進行詳細介紹。

打包模板

基礎工作已經準備完成，我們還需要把項目打包，發布到Nuget.org 或者是公司的內部 Nuget Server，這樣其他人才可以下載和安裝這個模板。

你可能很熟悉在.NET 中對單個項目進行打包，比如類庫，可以在VS中直接對項目使用右鍵打包，也可以使用dotnet pack命令，不一樣的是，我們需要打包的是整個項目結構，而不是單個項目。

我們在 Dy.Template 文件夾下，創建 template-pack.csproj 文件

修改內容如下：

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <PackageType>Template</PackageType>
    <PackageVersion>1.0.0</PackageVersion>
    <PackageId>Dy.Template</PackageId>
    <Title>Dy.Template</Title>
    <Authors>SpringLee</Authors>
    <Description>Dy.Template</Description>
    <PackageTags>dotnet-new;templates;Dy.Template</PackageTags>

    <TargetFramework>netstandard2.0</TargetFramework>

    <IncludeContentInPack>true</IncludeContentInPack>
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <ContentTargetFolders>content</ContentTargetFolders>
    <NoWarn>$(NoWarn);NU5128</NoWarn>
  </PropertyGroup>

  <ItemGroup>
    <Content Include="templates\**\*" Exclude="templates\**\bin\**;templates\**\obj\**" />
    <Compile Remove="**\*" />
  </ItemGroup>

</Project>

我們指定了程式包的基礎資訊，版本ID, 描述資訊，包含了 templates 文件夾下的所有文件，然後排除了 bin\ obj\ 文件夾的dll文件。

然後，運行 dotnet pack 命令進行打包, 你可以在 /bin/nuget/ 文件夾找到生成的 nupkg 文件