關於 Visual Studio 支援 IWizard 的範本套件開發

關於支援 IWizard 的範本套件開發

Visual Studio 擴充功能開發歷史

關於 Visual Studio 範本

以下提及的 Project Templates = 範本

小弟蠻多文章、線上課程、或者在社團分享許多關於 Visual Studio 範本開發的相關資源，也成立裡書社團【台灣 Visual Studio Extensions 套件開發俱樂部】。

事實上、Visual Studio 如果是單純的 範本開發 也就是 C# Project Templates 最簡單的方式就是（匯入/匯出）範本，但是這完全沒什麼彈性 與 擴充性可言，更不用說你想做出像互動式精靈甚至 Generate Code產生專案程式碼骨架等等，這就不是單存範本能夠做到，這就得透過 VS IDE/envdte/IWizardTemplates 才能夠做到，也就是得使用一些 Visual Studio IDE 的一部分功能才能夠做到。

為 Project Templates 加入 Code Generate 的功能

整潔架構 CQRS 精靈範本

在我最早期的 MyORM 裡即提供一種動態入 Entities/DbContext 的功能、甚至我能 Generate 自己框架的 Source Code 進來。

IWizard

很多人都知道 IWizard，這裡就不多談，它只是進入互動 Project Templates 的一張門票而已，它讓你的 Templates 跟 IDE 建立互動的機制 + 取用 IDE 的功能，它的功能也不只如此，不過若您不清楚如何建立支援 IWizard 的 Project Templates 可以參考我的線上課程：團隊開發系列-設計符合團隊的範本精靈 (Project Template) 課程連結：https://hiskio.com/courses/192/about?hi=MNJ7EJRV3Z4L&s=tc。

.NET 6 中的範本開發

由於 .csproj 專案格式的改變間接影響到 Project Templates 的開發，怎麼說呢？因為 Project Templates 為 Visual Studio 擴充性的一部份，這其實從 VS2010 開始，Logo 圖其實就有說明這一點了。

安裝了 Visual Studio 擴充功能後，你可以找到『延伸模組』

且會有【VSIX Project】、【C# Project Templates】等專案類型、而由於所謂的範本開發其實是用 Project 來開發 Projct 的概念，也就是說 Project Templates 自己也有『專案描述檔』 + Target Framework，且開發時，我可以將 cs 設為［內容］不編譯，因為我是在開發範本，等於設計階段，不是要這時候編譯。所以開發時、觀念要稍微轉一下。

以及剛提到範本本身也是透過 MSBuild + target Framework + Roslyn Compile 編譯出來的，目前並未有支援 .NET Core 新版專案格式的 C# Project Templates，官方並未對此繼續發展，我猜是 VS 即便到 2022 也是 windows Only 所以發展為跨平台並沒有意義，再者，他只是協助編譯出擴充功能的 Assembly，注意，所有擴充功能全都仰賴 VSIX 來進行散佈，這包括 Project Templates，每一個包含 VsPackage/IWizard 的 VSIX 都會輸出一個 DLL/Assembly，也就是這個 DLL 目前還是 .NET Framework Only 喔!

x64 與 x86 的問題

接續前面的 .NET Core 議題，由於從 VS2022 開始，支援 x64 架構，也就是整個 IDE 都以 x64 來啟動，這意味原先以 VS2019 編譯出來的套件均無法執行在 VS2022 喔，因為 (Process Model 不同/CPU) 架構不同，所以在 VS2022 裡新增了一個屬性『Product Architecture』。

也就是說，如果你想讓你的 (範本/套件) 支援 VS2022 這個 x64 版本你最少要使用 VS2022 來編譯，並加上 amd64 這個 Tag，如果你想同時支援舊版 VS2019 以前的版本你得重複增加 x86 的 Product Architecture。

若未加上此 Tag 你將無法安裝或向下相容將套件安裝在 VS2019 以前的舊版本。




後記： 

下次再分享關於精靈開發的進階內容，並聊聊我怎麼將 CleanArchitectureCQRSTemplate 開發出來的。

關於 C# Project Templates 開發可參考我的線上課程：

課程：團隊開發系列-設計符合團隊的範本精靈 (Project Template)

https://hiskio.com/courses/192/about?hi=MNJ7EJRV3Z4L&s=tc

留言

張貼留言

這個網誌中的熱門文章

什麼是 gRPC ？

圖片
圖片取自： https://grpc.io/docs/guides/ gRPC 是什麼？能吃嗎？ 在安裝了 .NET Core 3.0 之後，眼尖的朋友應該會發現，在新增 ASP.NET Core 網頁類型專案裡，會看見一個 gRPC Service 類型的專案，其實它也不是什麼很新的東西，早在十多年前 Google 就使用這樣的 RPC 協定進行一些大量的可靠性微服務的存取，聽到這，難道現有的 Web API 不可靠嗎？其實不是的，它主要用在移動設備等提供高效簡單且跨平台的通訊與熱插拔的驗證機制。 gRPC 的運作原理 gRPC 顧名思義，是種基於 RPC 的通訊協定，不同於 Web API 走的傳統 HTTP 基礎協定，它有點像是 Socket ，但應該說是基於 Socket， 或精確地來說它是基於 HTTP/2 的協定 ，gRPC 是種協議緩衝協定，它必須事先定義 IDL (Interface Definition Language) 描述檔，看到 IDL 對於一些熟悉 COM／DCOM 的朋友一定非常的熟悉，對！沒錯！就是類似的東西！但，這邊的 IDL 是用一種副檔名為 .proto 檔案來是先定義在分散式環境中，要傳輸的序列化結構資訊，當然它也可以跟 JSON 一起使用。 也就是說，要使用 gRPC 您必須先定義 .proto 協議，然後透過 Compile 的支援，編譯成特定語言框架。而很高興的是，C# 也支援了，然而其實根據官方的資料顯示，C# 應該在 .NET Core 2.1 開始就支援了，只是到了 .NET Core 3.0 才有樣版的支援。 而使用 gRPC 的協議緩衝區的服務可以做到 Stub 的機制，也就是說，它就像是許多 RPC 一樣，Client 在呼叫 Server 端時，其實是對 Stub 進行叫用，Stub 在這就像個緩衝區一般，但更細部的說，應該是一個遠程服務的替身，這應該又讓許多熟悉 COM／RPC 通訊的朋友覺得熟悉了起來，是的！沒有錯。 在 .NET Core 3.0 裡使用 gRPC 目前支援 .proto 擴展為 gRPC 協議緩衝區的編譯器只有 .NET Core 了 ， 根據 Github 上的說明 .NET Framework 4.5+ 以上或 Mono 4+ 以上也可支援，而 gRPC 也完全的跨平台。要在 .
閱讀完整內容

什麼是 gRPC（二）- 來撰寫第一個 Hello World 吧！

圖片
前言 上一篇 什麼是 gRPC ，筆者大致介紹了 gRPC Service 的基本概念，這一次，我們就來小試一下身手，撰寫一個 Hello World （迷之音：嘗試新技術時，總是得先來一個 Hello World ～我不想違背這良好傳統阿阿阿阿） 使用環境 Visual Studio 2019 .NET Core 3.0.100-preview3-010431 開始進行 撰寫 gRPC 除了先準備好基礎環境、選定一種 作業系統／ 程式語言 Language 外、（Framework／SDK／Runtime）等環境備妥後，就可以開始撰寫， (1). 開始撰寫 gRPC 第一步就是先定義 .proto 協議了 上一篇筆者提到，gRPC 的 Server 與 Client 必須使用相同的協議才可進行溝通，一般來說，你應該使用 protoc.exe 編譯器先行編譯過 greet.proto 協議檔，並產出 C# 程式碼檔案後才可繼續，而在 Visual Studio 2019 裡，拜 MSBuild 之賜，已經有人預先寫好 .Target 檔案了 （什麼是 MSBuild ？什麼是附檔名 .Target 檔案可參考： MSBuild .targets 檔案 ） 筆者先撰寫一個 SayHelloWorld 方法如下： 在協議裡，除了在 service Class 撰寫要公開存取的方法外， 必須在提供『傳入訊息型態』、『回傳訊息型態』 ，這邊我先定義兩個 message，一個是『 HelloMyFirstgRPC 』、另一個是『 HelloMyReply 』 在撰寫 proto 協議檔時，建議先決定 message 回傳型態與傳入的型態，那麼 Visual Studio 2019 會有 InteillSense 的完整支援。不得不說 Visual Studio 2019 在 .proto 協議編輯上的支援已經算不錯了。 注意： 一般來說，Visual Studio 2019 會在背景裡自動編譯 .proto 協議檔案，但始有可能不會有任何提示，所以您也可以自行使用命令列工具進行手動編譯，如下圖，若編譯失敗會出現錯誤訊息，如下圖顯示 return 關鍵字錯誤： protoc.exe 編譯器 & 相關 MSBuild Tools 會隨著 NuGet 套件在 Vis
閱讀完整內容

常見的程式碼壞味道（Code Smell or Bad Smell）

圖片
常見的程式碼壞味道（Code Smell or Bad Smell） 圖片取自：https://www.slideshare.net/ElMahdiBenzekri/art-of-refactoring-code-smells-and-microservices-antipatterns 前言 究竟重複的程式碼要不要共用它？傳統的軟體開發上，重複的程式碼幾乎被視為罪惡的來源，但是它真的有多可怕？ 常見的 Code Smells The Dispensable （一些可有可無的） Lazy Class (冗員類別） 如果一個類很少使用它會增加代碼庫的複雜性，從而阻礙開發。這樣的類可能是不必要的，它的功能可以成為另一個類的一部分。 Data Class (只有資料的類別） 一個類別只有包含『資料』未包含Methods，也就是說並未包含行為，不具行為模式的類別代表該『實例』容易被【其他類別所操控】。 Duplicate Code (重複的程式碼) 如描述，這也是上次有分享在我的 FB 社團 軟體開發之路［德國資深架構師給新手的建議］ 中有產生非常熱烈討論，這在社團朋友提醒下想起 Refactor 重構一書裡曾提過 rule of three 法則， 這個法則的定義是這樣的，有時部分程式碼重複其實是允許的（不是說重複一定是是被允許的）而是在某些 Context 情境下，該程式碼有一段時間不會衍伸別的功能 或 需求一段時間不會異動、且如要將它 DRY 會產生的『複雜度』或『花費時間』遠高於預估的時間 或 不值得在目前這個專案的節骨眼上花費這個時間來做這件事，加上它 DRY 產生的複雜度偶後產生的維護成本【遠高於】不 DRY 的情況下的維護本，那麼，在這個時候，這個異動頻率【極低】的程式碼就不需要花費這個時間來 DRY 了！！ 因為重點在於，重構是需要『成本』的。(迷之音：DRY 是種抽象化阿~😎) 這讓我想起之前，大約在 2016 年左右，在 101 的樓上某金融業客戶，曾經做過一個專案，這個專案就是因為客戶 DMZ 環境的因素，我讓內網的 Webside 與 DMZ 的網站保留了部分重複的程式碼，因為這段程式碼終年不需要異動，我也懶得花這個時間，而我居然也忘了這記件事情了.. 哈哈 Orz 不過原歸正傳，我個人還是認為，其實適當
閱讀完整內容