用Visual Studio2019自定義專案模板
專案模板簡介
眾所周知，在我們使用VS新建專案時，都需要選擇一個專案模板，如下圖：
我們選擇完專案模板進行建立，建立完成之後，可以發現專案中已經包含了一些基礎的檔案。例如MVC：
可以看到，MVC專案下，這麼多的檔案、類都給我們自動生成了，我們並不需要敲任何程式碼。
所以，專案模板，就是在我們建立新專案介面中，給我們列出來的模板檔案。
這些檔案都是VS自帶的，但在實際工作中，很多時候我們需要的是一個跟我們專案的業務更加契合的、可複用的專案模板，這時候就需要我們自己去建立一個自定義的專案模板了。
專案模板建立步驟
建立自定義的專案模板，有以下幾個步驟：
- 建立一個原始的專案，我們稱之為模板源；
- 替換模板引數
- 匯出模板源專案， 給模板專案設定名稱、說明、圖示等內容
- 給專案模板新增語言、平臺和專案型別等標籤
- 使用自定義的專案模板
建立模板源專案
首先我們建立一個原始的專案。
以下是我建立的Demo，添加了幾個檔案，只是用來做一個簡單的例子，實際開發中可能比這複雜的多。
模板中的引數
我們創建出來的模板源專案，有很多內容在建立專案之前是不確定的，比如名稱空間、類名稱等，這怎麼辦呢？
VS也給了我們解決辦法，我們可以在源專案中，使用模板引數來代替這些不確定的資訊，在實際建立專案時，VS會將這些模板引數替換為實際的內容。
以HomeController.cs檔案為例，使用模板引數代替名稱空間名稱：
模板引數以 $引數$ 的格式進行宣告 。$safeprojectname$表示的
就是名稱空間的模板引數。
VS完整的模板引數如下：
| 引數 | 描述 |
|---|---|
| clrversion | 公共語言執行時 (CLR) 的當前版本。 |
| ext_* | 將 ext_ 字首新增到任何引數，以引用父模板的變數。 例如 ext_safeprojectname。 |
| guid[1-10] | 一個用於替換專案檔案中的專案 GUID 的 GUID。 可指定最多 10 個唯一的 GUID（例如，guid1）。 |
| itemname | 在其中使用引數的檔案的名稱。 |
| machinename | 當前的計算機名稱（例如，Computer01）。 |
| projectname | 建立專案時由使用者提供的名稱。 |
| registeredorganization | 來自 HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 的登錄檔項值。 |
| rootnamespace | 當前專案的根名稱空間。 此引數僅適用於項模板。 |
| safeitemname | 與 itemname 相同，但所有不安全字元和空格替換為了下劃線。 |
| safeitemrootname | 與 safeitemname 相同。 |
| safeprojectname | 使用者在建立專案時提供的名稱，但名稱中刪除了所有不安全字元和空格。 |
| time | 以 DD/MM/YYYY 00:00:00 格式表示的當前時間。 |
| specifiedsolutionname | 解決方案的名稱。 在選中“建立解決方案目錄”時，specifiedsolutionname 具有解決方案名稱。 在未選中“建立解決方案目錄”時，specifiedsolutionname 為空。 |
| userdomain | 當前的使用者域。 |
| username | 當前的使用者名稱稱。 |
| webnamespace | 當前網站的名稱。 此引數在 Web 窗體模板中用於保證類名是唯一的。 如果網站在 Web 伺服器的根目錄下，則此模板引數解析為 Web 伺服器的根目錄。 |
| year | 以 YYYY 格式表示的當前年份。 |
除了VS自帶的模板引數外，使用者還可以自定義模板引數，但實際用到的不多，在此就不擴充套件贅述了。
匯出模板
原始檔中的模板引數替換好之後，我們就可以匯出模板了，操作步驟如下：
開啟工具欄中的專案->選擇匯出模板
彈出【匯出模板嚮導】介面，選擇專案模板即可，下方選擇的是要匯出的專案。
接下來，在模板選項中，填入模板的名稱，說明，圖示等資訊：
注意這個輸出位置，這是自定義專案模板存放的路徑。
下面的【自動將模板匯入 Visual Studio】選項，選中後會將專案模板複製一份，放入到特定的資料夾中，下次建立新專案就可以搜尋到了。
點選完成，VS會把專案模板壓縮為.zip檔案，分別匯入到以下兩個資料夾中：C:\Users\Lenovo\Documents\Visual Studio 2019\My Exported Templates
C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates
這時候不需要任何其他的操作，開啟VS的啟動視窗，點開建立新專案，就可以找到ProjectTemplateDemo這個專案模板了。
下面使用這個模板建立一個專案
可以看到，專案的結構與我們專案模板一模一樣，名稱空間名稱也被替換為Demo1了。
給專案模板新增標籤
其實到這一步，我們的專案模板就可以正常使用了，但我們會發現一個問題，我們的專案模板沒有這樣的標籤：
雖然不影響使用，但當查詢專案模板時，也不是很方便，所以我們需要給建立的專案模板新增幾個對應的標籤。方法如下：
首先開啟這個模板匯入到的資料夾，路徑：C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates
解壓ProjectTemplateDemo這個壓縮包。
在解壓好的ProjectTemplateDemo資料夾裡，用VS開啟MyTemplate.vstemplate這個檔案。
這是一個XML檔案，我們需要在TemplateData標籤裡新增上專案使用語言、平臺、專案型別的資訊。
語言、平臺、專案型別的標籤分別為LanguageTag、PlatformTag、ProjectTypeTag。
同時，Visual Studio 提供了一系列內建標籤。以下列表是 Visual Studio 中可用的內建標籤，對應的值顯示在括號中。
| 語言標籤 | 平臺標籤 | 專案型別標籤 |
|---|---|---|
| C (cpp) | Android (android) | 雲 (cloud) |
| 單元格 | 單元格 | 單元格 |
| C# (csharp) | Azure (azure) | 控制檯 (console) |
| F# (fsharp) | iOS (ios) | 桌面 (desktop) |
| Java (java) | Linux (linux) | 擴充套件 (extension) |
| JavaScript (javascript) | macOS (macos) | 遊戲 (games) |
| Python (python) | tvOS (tvos) | IoT (iot) |
| 查詢語言 (querylanguage) | Windows (windows) | 庫 (library) |
| TypeScript (typescript) | Xbox (xbox) | 機器學習 (machinelearning) |
| Visual Basic (visualbasic) | 移動 (mobile) | |
| Office (office) | ||
| 其他 (other) | ||
| 服務 (service) | ||
| 測試 (test) | ||
| UWP (uwp) | ||
| Web (web) |
我們修改這個檔案，新增幾個對應的標籤：
我們把這個檔案儲存一下，儲存之後，跳到資料夾下，全選檔案，重新壓縮一遍修改好的ProjectTemplateDemo檔案：
注意，壓縮包必須是.zip檔案。
壓縮完成後，把這個壓縮包拷貝到C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates目錄下，並覆蓋掉舊的壓縮包。
然後刪除解壓後的檔案。
這時候重新建立新專案，選擇ProjectTemplateDemo專案模板，可以看到我們的標籤已經加上去了。
至此，就是自定義專案模板的全部步驟。
總結
自定義的專案模板作用非常大，在大型的專案中，如果使用好的話會大大提升我們的開發效率。
以上就是本文章的全部內容。更多內容可訪問我的部落格：http://www.yunc.top/