專案模板簡介
眾所周知,在我們使用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/
轉載請註明出處,本文鏈接:https://www.uj5u.com/net/108.html
