.NET Core - 自定義專案模板

chaney1992發表於2021-04-25

前言：

　前面介紹 自定義專案模板 中介紹了一種簡單的方式——通過建立專案匯出為專案模板方式實現。本次將採用dotenet cil（手腳架）來建立專案模板。

　那麼，我們首先看下當前dotnet 支援的專案模板：

　 

 　可以看到當前dotnet中已經提供了很多模板專案，那麼如何根據專案開發的積累內容通過dotnet cli建立一個自己的專案來提升開發效率呢？

1、實現自定義專案模板

　自定義模板專案模板肯定就需要模板實現，本次就使用使用之前文章中專案結構作為模板專案來實現自定義專案模板

　

　接下跟著步驟來建立模板專案

  • 建立模板配置檔案

　　　在專案根資料夾中建立資料夾：.template.config  並在目錄下建立 template.json 。如下圖：

　　　

  • 定義專案模板相關資訊

　　　修改template.json內容為以下內容：

{
    "author": "cwsheng", //必須
    "classifications": [ "Web/WebAPI" ], //必須，這個對應模板的Tags
    "name": "ApiTmp", //必須，這個對應模板的Templates
    "identity": "ApiTemplate", //可選，模板的唯一名稱
    "shortName": "apitmp", //必須，這個對應模板的Short Name
    "tags": {
      "language": "C#" ,
      "type":"project"
    },
    "sourceName": "ApiTemplate",  // 可選，要替換的名字
    "preferNameDirectory": true  // 可選，新增目錄  
}

　　　注意：shortName和sourceName

    • author：模板作者
    • classifications：模板特徵標識。上文舉例的配置是因為我自定義的模板包括了console和webapi。
    • identity：此模板的唯一名稱
    • name：使用者看到的模板名稱
    • shortName：短名稱。當使用CLI命令建立模板專案時，使用短名稱將利於使用。
    • sourceName：模板替換的關鍵文字，使用時需要注意，要選擇合適的替換文字，不然容易誤傷程式碼。
  • 專案模板安裝

　　　接下來進入專案目錄，將這個模板安裝到cli中。使用 dotnet new -i  進行模板的安裝。

dotnew new -i TempDemo

　　

　　　解除安裝專案模板：

dotnet new -u 模板目錄
  • 應用專案模板

　　　使用命令建立專案：

dotnet new apiTmp -n Test -o .

apiTmp：是模板配置檔案中指定的shortName。

-n：指定的是將專案中出現的所有文字MyJob替換為Test，因為配置中sourceName是ApiTemplate，可按需配置。

-o：指定的是生成專案輸出目錄，上述命令生成專案輸出到當前目錄。

　　　結果如下圖：　　　　

　　　　

　

　 到此通過dotnet cli建立專案模板已完成，但僅僅這樣完全不能滿足日常工作需求。
　　如：A專案需要日誌記錄，但B專案不需要日誌記錄；A專案需要制定PG資料庫作為儲存方式，B專案需要制定MySQL作為儲存方式。

　　那麼這些問題能否在專案建立時根據設定而滿足專案需求呢？

2、模板專案進階用法

  • 檔案過濾：根據引數過濾制定檔案和程式碼內容

 　　a) 定義引數：在 template.json  中新增以下內容：EnableAuditLog-引數名稱

{
  //……
  "symbols": {
    //是否使用審計日誌功能
    "EnableAuditLog": {
      "type": "parameter", //它是引數
      "dataType": "bool", //bool型別的引數
      "defaultValue": "false" //預設是不啟用
    }
  },
  "sources": [
    {
      "modifiers": [
        {
          "condition": "(!EnableAuditLog)", //條件，由EnableAuditLog引數決定
          "exclude": [ //排除下面的檔案
            "AuditLogDemo/Fliters/AuditLogActionFilter.cs"
          ]
        }
      ]
    }
  ]
}

　　b) 取消審計日誌生效位置：

　　

  　c) 重新生成模板，檢視當前模板支援的引數：

　　 

　　d) 建立專案檢查設定是否生效：

　　

  • 選擇執行：根據變數值選擇程式集引用

 　　a) 新增引數：DbType指定選項資料庫型別

  "symbols": {
    //資料來源型別"DbType": {
      "type": "parameter", //它是引數
      "datatype": "choice", //選項型別
      "choices": [ //選項取值
        {
          "choice": "MsSQL",
          "description": "MS SQL Server"
        },
        {
          "choice": "MySQL",
          "description": "MySQL"
        },
        {
          "choice": "PgSQL",
          "description": "PostgreSQL"
        },
        {
          "choice": "SQLite",
          "description": "SQLite"
        },
        {
          "choice": "None",
          "description": "None"
        }
      ],
      "defaultValue": "None",
      "description": "The type of SQL to use"
    },
    "MsSQL": {
      "type": "computed",
      "value": "(DbType == \"MsSQL\")"
    },
    "MySQL": {
      "type": "computed",
      "value": "(DbType == \"MySQL\")"
    },
    "PgSQL": {
      "type": "computed",
      "value": "(DbType == \"PgSQL\")"
    },
    "SQLite": {
      "type": "computed",
      "value": "(DbType == \"SQLite\")"
    },
    "None": {
      "type": "computed",
      "value": "(DbType == \"None\")"
    }
  }

　　　b) 修改專案檔案：根據條件選擇對應程式集

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

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup Condition="'$(None)'!='True'">
    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="3.1.8" />
  </ItemGroup>
  <ItemGroup  Condition="'$(SQLite)' == 'True'">
    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="3.1.8" />
  </ItemGroup>
  <ItemGroup  Condition="'$(MsSQL)' == 'True'">
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="3.1.8" />
  </ItemGroup>
  <ItemGroup  Condition="'$(PgSQL)' == 'True'">
    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="3.1.4" />
  </ItemGroup>
</Project>

　　　c) 使用資料庫處，同步處理

#if (!None)
            //審計日誌儲存
            services.AddDbContext<AuditLogDBContent>(options =>
            {
                string conn = Configuration.GetConnectionString("LogDB");
#if Sqlite
                options.UseSqlite(conn, options =>
                {
                    options.MigrationsAssembly("AuditLogDemo");
                });
#endif
#if PgSQL
                options.UseNpgsql(conn);
#endif

#if MsSQL
                options.UseSqlServer(conn);
#endif

            });
#endif

　　　d) 更新模板後，檢視已生成了對應引數

　　　　 

 　　　e) 建立專案檢視生效情況：　　　　

//不使用資料庫
dotnet new apiTmp -n AA -D None

//使用PG資料庫
dotnet new apiTmp -n BB -D PgSQL

　　　　

 　　　可以看到專案引用和程式程式碼都根據傳入引數生成了。　　　　

3、專案模板打包釋出

 　好東西當然不能只給自己使用，而應該怎麼將生成的模板給大家使用呢？——Nuget 包釋出

　a）在模板根目錄建立一個 nuspec檔案：apiTmp.nuspec

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
  <metadata>
    <id>apiTmp</id>
    <version>1.0.0</version>
    <description> WebApi Template </description>
    <authors>cwshegn</authors>
    <packageTypes>
      <packageType name="Template" />
    </packageTypes>
  </metadata>
</package>

　b）使用Nuget Pack 命令打包　　

 nuget pack apiTmp.nuspec -OutputDirectory .

　c)  釋出到nuget服務，給小夥伴們下載使用

總結：

　通過dotnet cli 建立的模板專案，能更方便的根據專案需求生成對應的專案結構，提升開發效率。

　可以動手把積累的好專案打包成一個模板專案給小夥伴們使用

參考：

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

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

 

相關文章