使用C#編寫自己的代碼生成器，附代碼講解(一)

使用過代碼生成器的開發人員應該知道，通過代碼生成器生成項目的代碼，可以大大的減少重復編碼的時間，提供項目開發的效率，將自己從繁雜重復的代碼中解放出來。現在網絡上也有很多的開源的代碼生成器或者使用比較廣泛的代碼生成器，如動軟代碼生成器相信不少開發人員使用過。有時候在線的代碼生成器生成的代碼未必百分之百符合我們的心意，符合項目的需要，此時我們可以考慮自己使用C#編寫一套自己的代碼生成器軟件，可以按照自己指定的規則生成相應的代碼文件以及目錄。博主在工作過程中接觸以及開發過2類代碼生成器，一類是WinForm窗體程序的代碼生成器，開發者可以安裝到自己的電腦上。另一類是Web版本的代碼生成器，整個生成器的界面是個HTML網頁，可以單獨部署成一個網站站點，Web代碼生成器有個優點就是你不需要在自己電腦上安裝軟件，只要電腦能聯網，即可通過瀏覽器訪問到代碼生成器頁面進行操作。

首先來闡述下代碼生成器制作的幾個大的步驟流程：

（1）分析項目代碼結構：此步比較關鍵，是制作開發過程中最基礎的部分。通過分析項目代碼的結構，得出每個類的共同點或者相似點，這些共同點和相似點即可抽象出來作為一個定式。如分析實體類Model結構、DAL數據層結構以及含有的公用類似方法、BLL業務邏輯層的結構以及公用類似方法、View數據展示層相同類似代碼等。

舉個例子：假設你項目代碼中的實體類Model的結構都是如下這種，那你在生成實體類的.CS類文件就得按下面方式的方式生成一個私有字段，然后對應一個共有屬性的方式。在DAL層和BLL層的代碼類似，如DAL層必須含有一個根據主鍵Id的查詢函數，則你在生成實體類對應DAL層的時候自動生成該查詢函數。
Public class Teacher

{

 Private string _Name;

Public  string Name

{

    get { return _Name}

    set {_Name=value;}

}

}

（2）設計項目實體類圖，并分析相應的數據流操作：根據步驟一的分析，設計出相應的項目實體類圖，并且畫出對應的數據流向圖，幫助你的代碼編寫。

（3）數據庫層面操作：連接數據庫，并且能夠自動展示出數據庫中的所有表Table以及視圖View等數據庫對象，支持開發者在選擇對應數據表的時候，程序自動查詢出該表含有的所有字段信息等。同時建議考慮支持多表SQL語句操作。

（4）操作界面設計層面考慮：根據上述幾個步驟的分析，結合我們最后要實現的效果，設計出界面操作圖。如博主當初在設計Web版本的代碼生成器的時候，當選擇對應的數據表后，需要添加該表對應的頁面的Title信息，表的字段分別對應數據展示列表的哪一列，該列是否需要設置格式化函數等（如設置數據表中的字段Name最終展示在HTML前端界面的列表列【姓名】列中）。

（5）代碼的生成以及保存：根據第一步分析出來的結果，結合后面幾部的操作，使用C#代碼自動生成對應的代碼格式，并將該代碼格式的字符串保存到相應的文件中，如.CS為后綴的實體類文件、.cshtml為后綴的展示層View文件等。在生成代碼保存文件的時候，建議生成對應的文件夾目錄，這樣方便在生成代碼后直接將文件夾拷貝到對應的項目中即可，省去了自己新建文件的流程。

（6）Web版本代碼生成器建議最后做一個代碼文件打包壓縮下載功能。
鑒于代碼生成器的整個流程比較繁瑣復雜，針對這套的實現，將分文章章節來記錄，此篇文章優先記錄如何從數據庫中獲取所有的表對象、視圖對象，以及選擇相應的數據表后讀取對應表的所有字段信息。

需要獲取數據庫的表對象、視圖對象以及表中的字段，需要從數據庫中的系統表中查詢。

（1）獲取選中數據庫中的用戶表，可以用以下幾種方式都可以：
Select name from sys.tables;

Select name from sys.objects where type='U';

Select name from sysobjects where type='U';

Select table_name FROM InFormAtion_Schema.tables;

這里稍微做下解釋：sys.tables是sqlserver2005版本中新增一個目錄視圖，它存儲了當前數據庫中的所有表信息。sys.objects和sysobjects都代表系統對象表。

其中type的類型有多種，分別代表不同的含義：U=用戶表、S=系統表、V=視圖、FN=標量函數、TF=表函數、P=存儲過程、TR=觸發器、D=默認值或者Default約束、PK=主鍵約束、F=外鍵約束、UQ=UNIQUE 唯一約束。

（2）獲取選中數據庫中的視圖View，可以用以下幾種方式都可以：
SELECT * FROM INFORMATION_SCHEMA.VIEWS；

SELECT * FROM sysobjects where type='V';

SELECT * FROM sys.objects where type='V';

（3）獲取選中的數據表中的所有字段信息以及字段的類型

查找出對應的字段類型后在生成實體類的時候就可以自動生成屬性的對應的C#類型，如nvarchar、varchar、ntext等類型對應C#中的String類型。

//查詢表Product下面的所有字段信息
SELECT FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = 'Product'
//查詢視圖V_Product下面的所有字段信息
SELECT FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = 'V_Product'

使用C#開發代碼生成器的流程暫時先記錄到這，后續的相關設計流程等將在下一篇的文章中記錄。

備注：此原創文章最早發表于博主個人站，原文鏈接使用C#編寫自己的代碼生成器，附代碼講解(一)_IT技術小趣屋。