用Visual Studio2019自定義項目模板


項目模板簡介

眾所周知,在我們使用VS新建項目時,都需要選擇一個項目模板,如下圖:

我們選擇完項目模板進行創建,創建完成之后,可以發現項目中已經包含了一些基礎的文件。例如MVC:

可以看到,MVC項目下,這么多的文件、類都給我們自動生成了,我們並不需要敲任何代碼。

所以,項目模板,就是在我們創建新項目界面中,給我們列出來的模板文件。

這些文件都是VS自帶的,但在實際工作中,很多時候我們需要的是一個跟我們項目的業務更加契合的、可復用的項目模板,這時候就需要我們自己去創建一個自定義的項目模板了。

項目模板創建步驟

創建自定義的項目模板,有以下幾個步驟:

  1. 創建一個原始的項目,我們稱之為模板源;
  2. 替換模板參數
  3. 導出模板源項目, 給模板項目設置名稱、說明、圖標等內容
  4. 給項目模板添加語言、平台和項目類型等標簽
  5. 使用自定義的項目模板
創建模板源項目

首先我們創建一個原始的項目。
以下是我創建的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標簽里添加上項目使用語言、平台、項目類型的信息。
語言、平台、項目類型的標簽分別為LanguageTagPlatformTagProjectTypeTag
同時,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項目模板,可以看到我們的標簽已經加上去了。

 

 

至此,就是自定義項目模板的全部步驟。

總結

自定義的項目模板作用非常大,在大型的項目中,如果使用好的話會大大提升我們的開發效率。

以上就是本文章的全部內容。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM