在上一篇我們已經(jīng)用PowerDesigner創(chuàng)建好了需要的測試數(shù)據(jù)庫,下面就可以開始用它完成批量代碼生成的工作啦.

下面我會一步步的解釋如何用CodeSmith實現(xiàn)預期的結(jié)果的,事先聲明一下,在此只做一個簡單的Demo,并不詳細的講解CodeSmith各個強大的功能,有興趣的朋友可以打開CodeSmith的幫助文檔了解.我只做個拋磚引玉,希望能激起大家更多思想的火花~

先看看CodeSmith的工作原理:

簡單的說:CodeSmith首先會去數(shù)據(jù)庫獲取數(shù)據(jù)庫的結(jié)構(gòu),如各個表的名稱,表的字段,表間的關(guān)系等等,之后再根據(jù)用戶自定義好的模板文件,用數(shù)據(jù)庫結(jié)構(gòu)中的關(guān)鍵字替代模板的動態(tài)變量,最終輸出并保存為我們需要的目標文件.好,原理清楚了,就開始實踐吧:

1.　運行CodeSmith,可以看到如下界面:

2.　CodeSmith是創(chuàng)建模板的地方,首先當然是創(chuàng)建一個模板啦,點擊工具欄最左邊的New Document—C# Template,如圖所示:

?

3.　點擊運行按鈕,運行結(jié)果如下:

好,我們來分析為什么會得到這樣的運行結(jié)果吧,點擊運行窗口左下角的Template按鈕返回模板設(shè)計窗口,可以發(fā)現(xiàn),只要是沒有被<%%>或者<scriptrunat="template"></script>包含的文字均被直接輸出了,這些以后就要被換成我們分層架構(gòu)中一些一成不變的模板代碼:

4.　好了,簡單了解啦一些CodeSmith的代碼結(jié)構(gòu),下面就開始用它來生成我們的分層代碼吧,在此我就不介紹分層架構(gòu)的概念了,不然就偏離主題了.為了能更簡單明了的說明,我們在此就只用CodeSmith生成分層架構(gòu)的實體層吧.先看看如果我們不使用CodeSmith需要手動敲出哪些代碼:

Major.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Entity
{
publicpartialclass Major
{
publicInt32 MajorID{ get;set; }
publicString Name{ get;set; }
publicString Remark{ get;set; }
}
}

Student.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Entity
{
publicpartialclass Student
{
publicString StudentID{ get;set; }
publicInt32 MajorID{ get;set; }
publicString Name{ get;set; }
publicBoolean Sex{ get;set; }
publicInt32 Age{ get;set; }
publicString Remark{ get;set; }
}
}

我將兩個文件中重復的代碼使用黃色背景色加深了,我們可以發(fā)現(xiàn),如果每個表都要通過手動創(chuàng)建,那么將有大量的代碼(黃色背景)需要復制粘貼操作,這些操作是繁瑣而沒有任何意義的.因此,我們會希望將黃色背景部分的代碼做成模板,而其他變化的代碼由數(shù)據(jù)庫的結(jié)構(gòu)動態(tài)生成,如此一來,我們就不用再為這些煩人的復制粘貼操作懊惱了.

5.　那么就開始我們的實踐吧,就在剛剛創(chuàng)建好的文件開始吧,先隨意保存到一個目錄下,命名為test.cst,接著刪除多余的代碼,只保留第一行,該行表明我們的模板使用何種語言,這里我們使用C#.

<%@ CodeTemplateLanguage="C#" TargetLanguage="Text" Src="" Inherits=""Debug="False" CompilerVersion="v3.5"Description="Template description here."%>

6.　參照CodeSmith的工作原理,我們首先要為CodeSmith提供一個數(shù)據(jù)庫,要怎么使它和SQL Server 2005關(guān)聯(lián)起來呢?只要加上下面的代碼就行了:

<%-- 加載訪問數(shù)據(jù)庫的組件SchemaExplorer,并聲明其使用的命名空間 --%>
<%@ AssemblyName="SchemaExplorer"%>
<%@ ImportNamespace="SchemaExplorer"%>

<%-- 數(shù)據(jù)庫 --%>
<%@ PropertyName="SourceDatabase"DeepLoad="True" Optional="False" Category="01. GettingStarted - Required" Description="Database that the tables views, and storedprocedures should be based on. IMPORTANT!!! If SourceTables and SourceViews areleft blank, the Entire Database will then be generated."%>

7.　好了,有了數(shù)據(jù)庫連接,接著還需要一個模板,為了便于管理,我們新建一個文件用于設(shè)計模板,File—New—Blank? Template,并添加如下代碼,最好保存到test.cst所在的文件夾內(nèi),命名為Entity.cst:

<%@ CodeTemplateInherits="CodeTemplate"TargetLanguage="Text" Description="NetTiers main template."Debug="True" ResponseEncoding="UTF-8"%>

<%@ AssemblyName="SchemaExplorer" %>
<%@ ImportNamespace="SchemaExplorer" %>

<%-- 要打印的表 --%>
<%@ PropertyName="Table" DeepLoad="True"Optional="False" Category="01. Getting Started - Required"Description="Database that the tables views, and stored procedures shouldbe based on. IMPORTANT!!! If SourceTables and SourceViews are left blank, theEntire Database will then be generated." %>

接著繼續(xù)添加如下代碼:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Entity
{
publicpartialclass<%= Table.Name%>
{
<%foreach(ColumnSchema col inTable.Columns){ %>
public<%= col.DataType %><%=col.Name %>{ get;set; }
<% } %>
}
}

<%=Table.Name%>????????? 表示在此處輸出表的名稱

<%foreach(ColumnSchema col in Table.Columns){ %> <% } %>?????? 為循環(huán)語句,在{}循環(huán)輸出列信息.

<%=col.DataType %>?????? 表示在此處輸出列的類型

<%=col.Name %>???????????? 表示在此處輸出列的名稱

如圖所示:

8.　模板創(chuàng)建好后,要在test.cst文件中注冊一下,不然人家怎么知道有你這么一個模板存在呀,在test.cst文件繼續(xù)輸入如下代碼:

<%-- 注冊實體層Entity模板 --%>
<%@ RegisterName="EntityTemplate" Template=" Entity.cst"MergeProperties="Flase" ExcludeProperties=""%>

9.　好了,模板注冊好了,根據(jù)CodeSmith工作原理,我們要結(jié)合模板和數(shù)據(jù)庫結(jié)構(gòu)來批量生成代碼啦,但是我們生成的目標文件要輸出到哪里呢?這時我們會需要一個用戶自定義屬性,用于設(shè)置目標文件的輸出目錄,在test.cst文件的末尾輸入如下代碼:

代碼 <script runat="template">
//解決方案輸出路徑
privatestring Directory = String.Empty;

[Editor(typeof(System.Windows.Forms.Design.FolderNameEditor), typeof(System.Drawing.Design.UITypeEditor))]
[Optional, NotChecked]
[DefaultValue("")]
publicstring OutputDirectory
{
get
{
return Directory;
}
set
{
if (value.EndsWith("\\")) value = value.Substring(0, value.Length -1);
Directory = value;
}
}
</script>

10.　現(xiàn)在連輸出目錄也有了,該想辦法寫些函數(shù)來完成將數(shù)據(jù)庫架構(gòu)傳遞給模板的工作啦,在test.cst文件的末尾輸入如下代碼:

代碼 <script runat="template">
//生成實體Entity類
privatevoid GenerateEntityClasses()
{
CodeTemplate Template =new EntityTemplate();
foreach(TableSchema table inthis.SourceDatabase.Tables)
{
string FileDirectory = OutputDirectory +"\\"+ table.Name +".cs";
//生成模板
Template.SetProperty("Table",table);
//文件輸出
Template.RenderToFile(FileDirectory,true);
Debug.WriteLine(FileDirectory +" 創(chuàng)建成功.");
}
}
</script>

CodeTemplateTemplate = new EntityTemplate();　 就是創(chuàng)建了一個新的模板

foreach(TableSchematable in this. SourceDatabase.Tables){}??? 表示循環(huán)輸出數(shù)據(jù)庫中的表

Template.SetProperty("Table",table);???????????????????????? 就是向模板設(shè)置屬性,還記得我們在Entity.cst里面設(shè)置了一個Table屬性嗎,我們就是通過這個方法給這個屬性設(shè)值的.

Template.RenderToFile(FileDirectory,true);??????????? ?? 表示將Temlate里的內(nèi)容全部輸出到FileDirectory目錄中,true表示如果文件存在直接覆蓋.

11.　函數(shù)寫好了,離成功不遠啦,我們在test.cst的最后再添加如下代碼,用于調(diào)用剛剛寫好的函數(shù).至此,模板文件的制作已經(jīng)完成.

<%
//創(chuàng)建實體層Entity類
this.GenerateEntityClasses();

Debug.WriteLine("OK");
%>

12.　好啦,現(xiàn)在只要設(shè)置我們要導出的數(shù)據(jù)庫和輸出目錄就可以運行看結(jié)果啦,點擊CodeSmith主窗體右下角Properities面板中SourceDatabase屬性欄右側(cè)的…按鈕,彈出數(shù)據(jù)庫設(shè)置對話框,我們要在此添加一個新的數(shù)據(jù)庫連接:

13.　點擊Add按鈕,屬性設(shè)置如圖,我們選擇的是在前一章用PowerDesigner創(chuàng)建好的PD_test數(shù)據(jù)庫:

14.　點擊OK,回到數(shù)據(jù)庫選擇對話框,選擇剛剛創(chuàng)建好的數(shù)據(jù)庫連接:

15.　接著是設(shè)置目標文件輸出目錄,我在這里設(shè)置為桌面的一個新建文件夾:

16.　OK,萬事俱備,可以點擊運行按鈕讓CodeSmith為我們批量生成代碼啦:

打開生成的文件,就可以看到我們期待看到的代碼啦:

好了,這些是基礎(chǔ),但是只要你掌握了這些就可以開始自己的CodeSmith之旅啦,我也只能送大家到此咯~其他更多的知識點希望大家能自行查看幫助文章或者上網(wǎng)查詢,很高興又和大家分享了自己的一點心得,接下來想再回頭復習一下設(shè)計模式,也打算寫一些文章,歡迎大家關(guān)注~

上述實踐中的文件源代碼:

test.cst <%--
作者:黃聰
網(wǎng)址:http://www.cnblogs.com/huangcong
--%>
<%@ CodeTemplate Inherits="CodeTemplate" Language="C#" TargetLanguage="Text" Description="NetTiers main template." Debug="True" ResponseEncoding="UTF-8"%>


<%-- 注冊實體層Entity模板 --%>
<%@ Register Name="EntityTemplate" Template="WinformTier\Entity.cst" MergeProperties="Flase" ExcludeProperties=""%>


<%-- 數(shù)據(jù)庫 --%>
<%@ Property Name="SourceDatabase" Type="SchemaExplorer.DatabaseSchema" DeepLoad="True" Optional="False" Category="01. Getting Started - Required" Description="Database that the tables views, and stored procedures should be based on. IMPORTANT!!! If SourceTables and SourceViews are left blank, the Entire Database will then be generated."%>


<%
//創(chuàng)建實體層Entity類
this.GenerateEntityClasses();

Debug.WriteLine("OK");
%>

<script runat="template">
//生成實體Entity類
privatevoid GenerateEntityClasses()
{
CodeTemplate Template =new EntityTemplate();
foreach(TableSchema table inthis.SourceDatabase.Tables)
{
string FileDirectory = OutputDirectory +"\\"+ table.Name +".cs";
//生成模板
Template.SetProperty("Table",table);
//文件輸出
Template.RenderToFile(FileDirectory,true);
Debug.WriteLine(FileDirectory +" 創(chuàng)建成功.");
}
}
</script>


<script runat="template">
//解決方案輸出路徑
privatestring Directory = String.Empty;

[Editor(typeof(System.Windows.Forms.Design.FolderNameEditor), typeof(System.Drawing.Design.UITypeEditor))]
[Optional, NotChecked]
[DefaultValue("")]
publicstring OutputDirectory
{
get
{
return Directory;
}
set
{
if (value.EndsWith("\\")) value = value.Substring(0, value.Length -1);
Directory = value;
}
}
</script>

Entity.cst <%--
作者:黃聰
網(wǎng)址:http://www.cnblogs.com/huangcong
--%>
<%@ CodeTemplate Inherits="CodeTemplate" Language="C#" TargetLanguage="Text" Description="NetTiers main template." Debug="True" ResponseEncoding="UTF-8"%>

<%@ Assembly Name="SchemaExplorer"%>
<%@ Import Namespace="SchemaExplorer"%>

<%@ Property Name="Table" Type="TableSchema" DeepLoad="True" Optional="False" Category="01. Getting Started - Required" Description="Database that the tables views, and stored procedures should be based on. IMPORTANT!!! If SourceTables and SourceViews are left blank, the Entire Database will then be generated."%>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Entity
{
publicpartialclass<%= Table.Name%>
{
<%foreach(ColumnSchema col in Table.Columns){ %>
public<%= col.DataType %><%= col.Name %>{ get;set; }
<% } %>
}
}

哇,期考啦,怎么那么多考試啊~~~~快看書才行了~~~~

總結(jié)

以上是生活随笔為你收集整理的黄聪：如何使用CodeSmith批量生成代码(原创系列教程)的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。