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

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

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

（1）分析項(xiàng)目代碼結(jié)構(gòu)：此步比較關(guān)鍵，是制作開發(fā)過程中最基礎(chǔ)的部分。通過分析項(xiàng)目代碼的結(jié)構(gòu)，得出每個類的共同點(diǎn)或者相似點(diǎn)，這些共同點(diǎn)和相似點(diǎn)即可抽象出來作為一個定式。如分析實(shí)體類Model結(jié)構(gòu)、DAL數(shù)據(jù)層結(jié)構(gòu)以及含有的公用類似方法、BLL業(yè)務(wù)邏輯層的結(jié)構(gòu)以及公用類似方法、View數(shù)據(jù)展示層相同類似代碼等。

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

{

 Private string _Name;

Public  string Name

{

    get { return _Name}

    set {_Name=value;}

}

}

（2）設(shè)計(jì)項(xiàng)目實(shí)體類圖，并分析相應(yīng)的數(shù)據(jù)流操作：根據(jù)步驟一的分析，設(shè)計(jì)出相應(yīng)的項(xiàng)目實(shí)體類圖，并且畫出對應(yīng)的數(shù)據(jù)流向圖，幫助你的代碼編寫。

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

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

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

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

需要獲取數(shù)據(jù)庫的表對象、視圖對象以及表中的字段，需要從數(shù)據(jù)庫中的系統(tǒng)表中查詢。

（1）獲取選中數(shù)據(jù)庫中的用戶表，可以用以下幾種方式都可以：
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版本中新增一個目錄視圖，它存儲了當(dāng)前數(shù)據(jù)庫中的所有表信息。sys.objects和sysobjects都代表系統(tǒng)對象表。

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

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

SELECT * FROM sysobjects where type='V';

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

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

查找出對應(yīng)的字段類型后在生成實(shí)體類的時候就可以自動生成屬性的對應(yīng)的C#類型，如nvarchar、varchar、ntext等類型對應(yīng)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#開發(fā)代碼生成器的流程暫時先記錄到這，后續(xù)的相關(guān)設(shè)計(jì)流程等將在下一篇的文章中記錄。

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