動軟代碼生成工具

 

 

動軟實戰攻略

 

 

 

 

 

手把手教你用動軟

 

 

 

文檔編號：20110421

版權所有 © 2004-2011 動軟

在線幫助:http://help.maticsoft.com

 

 

目錄

 

一．        產品介紹

二．        下載安裝

三．        注冊數據庫連接

四．        查看數據庫信息

五．        新建整個項目

六．        批量代碼生成

七．        單表代碼生成

八．        父子表代碼生成（事務生成）

九．        代碼生成規則設置

十．        自動生成存儲過程

十一．        自動生成數據庫SQL腳本

十二．        生成數據庫文檔

十三．        常用工具

1.        搜索表功能

2.        項目發布功能

3.        代碼轉換功能

十四．        代碼生成組件接口開發

常見問題（單擊以下鏈接查看內容詳細）

 

 

 

一．    產品介紹

動軟.Net代碼生成器 是一款為.Net程序員設計的自動代碼生成器，也是一個智能化軟件開發平台，它可以生成基於面向對象的思想和三層架構設計的代碼，結合了軟件開發中經典的思想和設計模式，融入了工廠模式，反射機制等等一些思想。主要實現在對應數據庫中表的基類代碼的自動生成，包括生成屬性、添加、修改、刪除、查詢、存在性、Model類構造等基礎代碼片斷,支持不同架構代碼生成，使程序員可以節省大量機械錄入的時間和重復勞動，而將精力集中於核心業務邏輯的開發。 動軟代碼生成器 同時提供便捷的開發管理功能和多項開發工作中常用到的輔助工具功能，您可以很方便輕松地進行項目開發。

動軟讓軟件開發變得輕松而快樂！讓企業不斷提升開發效率，同樣的時間創造出更大的價值。

二．    下載安裝

1. 系統要求：
   Microsoft Windows2000/XP/2003/7 或者更高。機器必須安裝.NET Framework v2.0。
2. 官方下載地址：http://www.maticsoft.com/download.aspx
3. 下載解壓后安裝包有如下文件：

 

Codematic2.msi  是動軟.NET代碼生成器的安裝文件。

Builder文件夾是代碼生成插件的源碼，動軟.NET代碼生成器支持可擴展的代碼生成插件，用戶可以定制自己的代碼生成的插件，根據接口開發自己的代碼生成方式，按自己的需求進行代碼生成。

Codematic_Data.MDF和Codematic_Log.LDF 是通過動軟新建項目中所帶管理模塊所需要的數據庫文件。后台管理員默認登錄用戶名:admin  密碼：1

 

1. 雙擊Codematic2.msi 進行直接安裝即可。

安裝動軟時，如果用戶機器360彈出警告，那僅僅是個簽名認證提示，並非木馬，選擇“繼續安裝”，然后點擊“確定”即可。

 

動軟鄭重聲明： 動軟.NET代碼生成器，絕無插件木馬，純綠色軟件。請放心安裝。

1. 安裝成功后，在開始-菜單和桌面上會有動軟.NET代碼生成器的圖標。

三．    注冊數據庫連接

安裝完成后，首先要做的就是注冊數據庫的連接，因為所有的代碼生成都將從數據庫中獲取數據結構信息進行生成。

1. 在軟件界面的左側數據庫視圖窗口，選擇【服務器】，右鍵出現菜單：

  或 點擊第1個按鈕

1. 選擇【添加服務器】，然后，出現“選擇數據庫類型”窗口

 

1. 根據自己的實際情況，選擇一個機器上有的或自己項目中在用的數據庫類型。並確保你選擇的數據庫是可以正常訪問的。然后，【下一步】。
2. 如果選擇的是SQL Server，則會出現：

 

注意事項：

（1） 輸入服務器IP地址，如果是本機也可以是：(local) 或是 . 或者 127.0.0.1。
    如果服務器並非只有一個默認實例，請采用：服務器\實例名 的方式連接。
（2）一定要選擇和實際數據庫服務器版本一致的選項，否則會導致連接數據庫錯誤。
注意：請使用SQLServer的企業版或正式版本，不能是SQL EXPRESS版，否則無法連接。
（3）身份驗證可以選擇是SQL Server認證，還是Windows認證。

（4）輸入數據庫服務器用戶名密碼。如果不知道，請聯系你的數據庫管理員。
（5）如果數據庫的表比較多，連接速度會比較慢，啟用【高效連接模式】實現快速連接。
（6）可以通過【連接/測試】，來連接服務器並獲取數據庫列表，從而可以實現只選擇連接一個庫進行操作，減少不必要的連接時間，提高工作效率。

 

1. 如果選擇的是Oracle

 

輸入您自己安裝過的Oracle的管理員用戶名和密碼，服務就是安裝的Oracle服務名，一般默認是Oracle所在的機器名，如果不確定，請聯系您的數據庫管理員。

1. 如果選擇的是MySQL

 

1. 如果選擇的是Oledb

 

在地址文本框，可以直接輸入Access庫的文件地址，注意：庫文件盡量不要放在桌面，並且確保你的文件地址正確。如果你的Access並沒有設置密碼，下面的密碼可以不用管。

1. 如果選擇的是SQLite

 

1. 在以上步驟確定后，動軟.NET代碼生成器的數據庫視圖就出現了數據庫服務器的信息。

 

四．    查看數據庫信息

1. 在數據庫上右鍵，【瀏覽數據庫】，通過選擇庫和表可以查看表和字段的信息。

 

 

1. 選擇【新建查詢】菜單，即出現SQL的查詢分析器窗口，可以輸入SQL語句進行查詢。
2. 在表上，右鍵選擇【瀏覽表數據】，可以查看表的數據內容。

 

 

五．    新建整個項目

在看過了基本的數據庫管理功能之外，下面我們就可以開始生成代碼了。

首先，一般第一次生成，我們要生成的是整個項目框架。

1. 選中數據庫，然后右鍵：【新建NET項目】，或者直接點工具欄上的快捷圖標均可。

 

1. 然后，選擇項目類型和版本：

 

l  簡單三層結構：生成標准的三層架構項目。

l  工廠模式結構：生成基於工廠模式的項目架構，適合一個項目多數據庫類型的情況。

l  簡單三層結構（管理）：生成標准的三層架構項目，並且帶有基本的系統管理功能和界面，這些通用的功能主要是節省開發人員的時間，可以在此基礎上直接去開發自身業務模塊。

這里暫以“簡單三層結構（管理）”為例進行說明。

1. 點擊【下一步】，選擇要生成的表和配置：

 

雙擊選擇要生成的表，選到右側列表框。然后點擊【開始生成】即可。

如果需要修改一些配置可以修改你自己的命名空間名字，是否去掉表的前綴。

代碼模板組件類型，一般初學者建議默認即可。

相關組件說明：

BuilderDALParam        數據訪問層（DAL）基於Parameter方式的代碼生成組件(推薦)

BuilderDALProc     數據訪問層（DAL）基於存儲過程方式的代碼生成組件

BuilderDALSQL      數據訪問層（DAL）基於SQL拼接方式的代碼生成組件

BuilderDALTranParam    數據訪問層（DAL）帶有事務的代碼生成組件

DAL由於不同項目要求不同，根據項目需求，選擇其中一種方式即可。

BuilderBLLComm    基於標准的業務邏輯層代碼（BLL）

BuilderModel  Model層的代碼生成組件

BuilderWeb    表示層的代碼生成組件

備注：代碼還有一些生成規則，是在菜單【工具】-【選項】-【代碼生成設置】中進行設置。

 

1. 點擊【開始生成】，則開始進行代碼的生成

 

直到出現“項目工程生成成功”提示，項目生成完畢。

1. 打開生成的文件夾

 

1. 雙擊解決方案文件，打開整個項目如圖：

 

注：“簡單三層結構” 目前暫時是VS2005版本，是為了兼容當前還在用2005的朋友。如果你使用的是VS2008，生成項目后，請先打開VS2008,選擇【菜單-文件-打開項目】的方式打開該項目，此時會提示升級項目版本，選擇升級一下項目版本到VS2008或VS2010即可，對代碼沒有任何影響。

1. 打開Web項目，選中剛才選擇生成的那幾個表的頁面文件夾，右鍵【包括在項目中】

 

 

1. 打開web項目下web.config修改數據庫連接字符串。

注意：新建項目后，請記得先將安裝包里附帶的數據庫文件Codematic_Data.MDF 附加到SQLServer中。

如果需要加密，可以使用安裝包里的加解密工具（官方下載該工具）。

 

 

1. 然后，選擇解決方案進行重新生成整個解決方案。整個創建項目過程即全部完成。

 

 

1. 如果編譯沒有錯誤， 直接按F5鍵運行即可。整個創建項目過程即全部完成。

運行啟動登錄頁面login.aspx，輸入用戶名：admin，密碼：1  

即登錄動軟系統框架的后台，界面如下

 

 

六．    批量代碼生成

新建項目功能只適合於第一次，因為不可能每次都新建項目，特別是項目已經在開發中。所以，以后的項目開發中更多的應用的是【批量代碼生成】功能。批量代碼生成特別適合項目后期追加代碼時使用。

1. 選中數據庫或者表，然后單擊右鍵菜單【代碼批量生成】

 

1. 出現的窗口和新建項目基本相似，只是多了一個選中架構的選項。

 

備注：代碼還有一些生成規則，是在菜單【工具】-【選項】-【代碼生成設置】中進行設置。

 

1. 選則要生成的表，然后點擊【導出】
2. 在生成的文件夾中，我們可以看到：

 

批量生成代碼只生成業務表的代碼，不再有解決方案文件和項目文件，以及其它類庫等。我們可以將生成的這些文件直接拖到現有的解決方案中即可。

 

七．    單表代碼生成

除了新建項目和批量代碼生成，偶爾我們希望更個性化自定義一些代碼生成的字段，而不是全部的自動生成，這是我們可以考慮針對單表的代碼生成。

1. 在左側【數據庫視圖】，選中表，右鍵菜單【單表代碼生成器】

 

 

1. 然后，出現單表的代碼生成器界面，我們設置自己需要更改的信息。

 

選項說明：

• 項目名稱：主要用在生成DB腳本中。
• 二級命名空間：指的是這個類放在某一個二級文件夾下，從而命名空間中應該帶這個文件夾的名字。
• 頂級命名空間：就是項目的命名空間名稱。
• 類名：可以自己根據表名定義自己需要的名字。
• 類型：主要是生成什么代碼，DB腳本主要生成表的存儲過程和表的創建腳本及數據腳本。
• 架構選擇：目前僅支持這3種最常用的架構。
• 代碼類型：指生成指定架構中具體某一個項目中的代碼。
• 代碼模板組件類型：指生成代碼的方式，因為即使同一個代碼有很多的寫法，組件主要實現的是不同的寫法，但每種寫法實現的功能都是一樣的。主要看項目需要和個人習慣進行選擇。
• 方法選擇：指生成最基本的增刪改查的方法代碼，后續版本將支持用戶自定義這些方法。

 

備注：代碼還有一些生成規則，是在菜單【工具】-【選項】-【代碼生成設置】中進行設置。

 

1. 然后，點擊【生成代碼】按鈕，即可生成該類的代碼：

 

生成的代碼，可以直接復制到項目文件中，也可以右鍵保存成CS文件。

通過窗體下面的Tab按鈕可以來回切換設計視圖和代碼。

八．    父子表代碼生成（事務生成）

日常開發中，經常會遇到父子表的情況，同時需要父子表的記錄保存需要在事務中實現，以保證數據的一致性。動軟也在功能上做了這方面的考慮。

1. 在表上，右鍵，選擇【父子表代碼生成（事務）】：

 

 

父子表的代碼生成分3步窗體：1，2，3，當前第一個窗體主要設置父表和子表，以及二者主外鍵關聯的字段。

1. 然后，選擇【繼續設置】

 

 

1. 點擊【生成類代碼】：

 

這里的所有插入語句都將放在一個事務里完成。

 

九．    代碼生成規則設置

打開菜單【工具】-【選項】-【代碼生成設置】

 

 

 

這些配置保存后，在生成代碼的時候將按照這個規則進行生成。

代碼生成的規則設置范圍還在不斷增加中。

 

另外，不同數據庫類型的數據類型各有不同，這里提供了字段類型和C#中的類型建立映射關系，生成代碼時將按映射關系來生成代碼字段屬性的類型。

 

十．    自動生成存儲過程

對於習慣使用存儲過程的用戶，手寫表的增、刪、改、查的存儲過程也是非常頭大的事情，動軟提供了可以自動生成數據表增刪改查的存儲過程腳本生成。

主要通過以下幾個地方進行生成：

1. 單表的存儲過程生成：

在表上，右鍵選擇【生成存儲過程】

 

 

或者：在表上右鍵，選擇【單表代碼生成器】，可以更靈活的定義生成存儲過程。

 

 

1. 批量表的存儲過程生成。

在數據庫上，右鍵，選擇【生成存儲過程】，或者選擇【導出文件】-【存儲過程】。都將生成整個數據庫中所有表的存儲過程。

 

 

十一．     自動生成數據庫SQL腳本

有時候需要遷移數據庫，或者生成表結構腳本，導出數據腳本到別的數據庫，日常開發中也比較常見，這個可以通過動軟自動生成SQL腳本功能來幫您節省大量的時間。

主要通過以下幾個地方進行生成：

1. 單表的數據腳本生成

在表上右鍵，選擇【生成數據腳本】

 

或者，在表上右鍵，選擇【單表代碼生成器】，可以更靈活的定義生成存儲過程

 

 

生成后：

 

 

1. 批量表的數據腳本生成。

 

 

出現生成SQL數據庫腳本窗口，選擇保存的文件名，點擊【生成】即可。

 

 

1. 根據查詢結果生成數據腳本。

有時候我們並不像生成整個表的數據腳本，也許表很大，或者其他數據並不需要，只是需要一部分我們需要的數據，生成腳本后，執行導入到其他庫，這時候我們可以使用動軟代碼生成器的這個功能。

在數據庫上，右鍵【新建查詢】，或者選擇菜單【工具】-【查詢分析器】，打開查詢語句窗口，輸入我們的查詢語句，然后單擊右鍵，選擇【生成當前查詢結果的數據腳本】：

 

則生成的腳本僅僅包括語句查詢結果的數據腳本：

 

   如此方便的功能，不得不說很貼心哦。

 

    除此之外，我們可以看到，還有一個非常貼心的功能，就是如果數據訪問層使用的是基於SQL拼接的方式的DAL，有時候為了拼寫一段長長的SQL語句，眼都看花了，看看動軟這個功能吧：

在查詢分析器中，測試我們的查詢語句，然后，右鍵選擇【生成當前查詢SQL語句的拼接代碼】

 

 

生成后，這些代碼我們直接就可以復制到數據訪問層，不用再用手一個個敲了，省出來的時間我們可以去喝咖啡嘍。

 

 

 

十二．     生成數據庫文檔

日常開發，表一多，是不是就頭疼每個字段什么意思，以及數據庫總是變，文檔維護起來很麻煩。特別是新人加入項目團隊時，如果沒有數據庫文檔，那么更是雲里霧里的搞不清各種數據的意思。動軟.NET代碼生成器，可以幫你解決這個問題，它可以根據選定的數據庫和表批量生成所有表的字段詳細信息,包括默認值,描述等表結構信息。免去手工寫文檔和維護的麻煩，真的不用加班熬夜，可以早回家了。

1. 選中要生成的數據庫，然后選中工具欄【生成數據庫文檔】按鈕。

 

 

1. 然后，選中需要生成的表

 

這里提供了兩種格式的文檔，一種是Word格式的，但需要本機安裝Office2003或2007。另一種是網頁格式，可以生成兩種界面風格的網頁格式數據庫文檔。

 

十三．     常用工具

1. 1.  搜索表功能

 

 

 

 

1. 2.  項目發布功能

當Web項目開發完畢，我們一般需要把項目發布到一個測試服務器或者生產環境去，但發布的時候，只想發布我們需要發布的文件，或者不想發布一些我們不需要的文件。雖然VS.NET自帶的有發布功能，但有時候覺得使用起來還不是那么靈活方便，動軟提供了此功能，讓你更靈活，簡捷的發布網站文件。

選擇菜單【工具】-【web項目發布】

 

 

點擊【設置】按鈕，我們可以設置發布的規則。

 

 

1. 3.  代碼轉換功能

這是早期版本留下了的一個代碼轉換工具，可以支持C#代碼到VB代碼的轉換。

 

十四．     代碼生成組件接口開發

動軟.NET代碼生成器支持可擴展的代碼生成插件，用戶可以根據接口定制自己的代碼生成插件，開發自己的代碼生成方式，按需求進行代碼生成。

該組件源碼可以在下載的安裝包里面看到或者去官方網站下載。

 

開發步驟：

1．  引用
Lib文件夾下提供了接口類庫，添加4個dll的引用：
LTP.CodeHelper.dll
LTP.IBuilder.dll
LTP.IDBO.dll
LTP.Utility.dll

2．  並在類中using

using LTP.Utility;
using LTP.IDBO;
using LTP.CodeHelper;

3．  繼承

DAL數據訪問層模板組件：public class BuilderDAL : LTP.IBuilder.IBuilderDAL
BLL業務邏輯層模板組件：public class BuilderBLL : LTP.IBuilder.IBuilderBLL

4．  接口方法

具體參考插件源碼項目。安裝包中提供了插件的源碼。

5．  使用配置

【工具】-【選項】-【組件管理】 


在【代碼參數】或代碼生成器窗口，即可以看到如下插件列表：

 

 

常見問題（單擊以下鏈接查看內容詳細）

§  通過partial關鍵字擴展代碼生成器生成的代碼 

§  動軟左側樹菜單導航，無法正常顯示？ 

§  動軟新建項目（示例項目）如何登錄？ 

§  Access用OleDbParameter無法更新數據解決方案 

§  動軟DBUtility類庫DbHelperSQL實現多數據庫連接 

§  動軟.net代碼生成器 啟動報錯退出解決方法 

§  Asp.net1.0升級ASP.NET 2.0的幾個問題總結 

§  示例項目源碼無法創建對象實例的常見錯誤說明