隨筆背景:在很多時候,很多入門不久的朋友都會問我:我是從其他語言轉(zhuǎn)到C#開發(fā)的,有沒有一些基礎(chǔ)性的資料給我們學(xué)習(xí)學(xué)習(xí)呢,你的框架感覺一下太大了,希望有個循序漸進(jìn)的教程或者視頻來學(xué)習(xí)就好了。
其實(shí)也許我們每天面對的太多東西了,覺得很多都稀松平常了,即使很細(xì)微的地方,可能我們都已經(jīng)形成習(xí)慣了。反過來,如果我們切換到其他領(lǐng)域,如IOS、android,那么開始我們可能對里面很多設(shè)計的規(guī)則不甚了解,開始可能也是一頭霧水。
本篇想作為我的《循序漸進(jìn)開發(fā)WinForm項(xiàng)目》系列的開篇,主要介紹數(shù)據(jù)庫設(shè)計方面注意的一些事項(xiàng),從而方便項(xiàng)目框架的搭建和開發(fā)過程。
1、數(shù)據(jù)庫表設(shè)計
俗話說萬層高樓從底起,開發(fā)應(yīng)用項(xiàng)目,數(shù)據(jù)庫的設(shè)計很重要,它可能是業(yè)務(wù)對象,業(yè)務(wù)流程的綜合設(shè)計,好的數(shù)據(jù)庫設(shè)計可以減少后期的重復(fù)返工,提高開發(fā)效率。
我們以一個簡單的數(shù)據(jù)庫表進(jìn)行設(shè)計討論,一步步分析其中的關(guān)系。
1)表和字段名稱
一般表名稱,根據(jù)不同的業(yè)務(wù)關(guān)系,我們可以使用不同的前綴進(jìn)行區(qū)分,使用前綴,可以非常方便區(qū)分不同的業(yè)務(wù)表,如我自己一般基礎(chǔ)表使用 “TB_” 定義前綴,權(quán)限系統(tǒng)表使用"T_ACL_"定義前綴,工作流表使用“TBAPP_”,業(yè)務(wù)表使用"T_"等,這樣對于區(qū)分不同的業(yè)務(wù),方便管理很有好處。
字段名稱方面,我們可以約定一些規(guī)則,如約定主鍵使用ID;一般來說,ID作為主鍵,可以使用自增長的整形字段,也可以使用GUID的字符型字段,如果為了方便兼容不同的數(shù)據(jù)庫且方便遷移或者開發(fā)基于網(wǎng)絡(luò)方面的應(yīng)用,我建議還是使用GUID的字符型字段,使用這種類型的字段,我們從創(chuàng)建數(shù)據(jù)的時候,就可以知道這個記錄的主鍵,對于我們維護(hù)父子表等關(guān)系非常有利。
字段的命名,建議一簡單為主,如客戶名稱,直接使用Name來命名即可,不需要使用CustomerName這樣啰嗦的名稱。
由于如果采用字符型的ID主鍵,那么我們?nèi)绻枰_排序的時候,可能需要增加一個CreateTime的日期類型,方便我們根據(jù)日期進(jìn)行排序。
如果這個表還有一個外鍵的引用,建議統(tǒng)一命名標(biāo)準(zhǔn),我一般使用“表名稱_ID這樣的名稱,如User_ID、Contact_ID等相似的名稱作為外鍵,不需要表的前綴。
2)數(shù)據(jù)庫的模型設(shè)計
數(shù)據(jù)庫的模型設(shè)計,我們建議在第三方的數(shù)據(jù)庫設(shè)計工具上進(jìn)行設(shè)計,如PowerDesigner這樣的設(shè)計工具,使用工具設(shè)計數(shù)據(jù)庫有很多好處,一個是可以高效率進(jìn)行調(diào)整,二是根據(jù)需要生成不同的數(shù)據(jù)庫類型Sql語句,三是可以全局了解各個表之間的關(guān)系等等。
使用PowerDesigner這樣的數(shù)據(jù)庫設(shè)計工具,能夠在很大程度上提高我們數(shù)據(jù)庫的設(shè)計效率。
2、項(xiàng)目框架的生成
設(shè)計好數(shù)據(jù)庫后,我們通過代碼生成工具進(jìn)行整個項(xiàng)目框架的生成,這樣對于我們在開發(fā)新項(xiàng)目上有很好的好處,里面的項(xiàng)目層級、DLL的 引用關(guān)系,已經(jīng)處理好了,這樣對我們非常方便。不過大多數(shù)情況下,我們都是增量開發(fā)較多,也就是我們可能前面已經(jīng)完成了一些其他業(yè)務(wù)的開發(fā),可能新增一個兩個表,或者一批業(yè)務(wù)表的處理,這樣也沒關(guān)系,我們把新生成的代碼復(fù)制到項(xiàng)目即可,由于項(xiàng)目生成的時候,指定了主命名空間和相關(guān)的表前綴,這樣我們生成后的代碼就方便閱讀很多,減少累贅和出錯的機(jī)會。
WInform開發(fā)框架,常見的分層模式,可以分為UI層、BLL層、DAL層、IDAL層、Entity層、公用類庫層等等
這個分層,在Web項(xiàng)目或者WInform項(xiàng)目(包括WPF項(xiàng)目)這些分層都是可以重用的,這樣我們就不用重復(fù)處理界面一下的邏輯,針對性的開發(fā)我們需要的界面層即可。
DAL層根據(jù)不同的需要,擴(kuò)展支持不同的數(shù)據(jù)庫類型,每個數(shù)據(jù)庫類型,對應(yīng)一個數(shù)據(jù)庫訪問實(shí)現(xiàn)層即可,它們實(shí)現(xiàn)IDAL層的接口,稱之為數(shù)據(jù)庫訪問接口實(shí)現(xiàn)層。
如果我們選擇開發(fā)混合型開發(fā)應(yīng)用,我們可能還會有一些WCF的服務(wù)邏輯層、WCF服務(wù)層、客戶端調(diào)用層、界面層(后面再介紹)等方面,如下的項(xiàng)目結(jié)構(gòu)所示。
3、項(xiàng)目代碼分析
通過代碼工具,我們已經(jīng)可以完整生成基礎(chǔ)的項(xiàng)目框架了,下面我們來分析下項(xiàng)目的源碼,從而知道整個框架的架構(gòu)和代碼的層次是如何的。
剛才我們看到,生成的項(xiàng)目里面,已經(jīng)包含了實(shí)體類,我們以開篇介紹的一個表生成的代碼來進(jìn)行研究分析。
生成的實(shí)體類代碼如下所示
/// <summary>
/// 客戶信息
/// </summary>
[DataContract]
public class CustomerInfo : BaseEntity
{
#region Field Members
private string m_ID = System.Guid.NewGuid().ToString(); //編號
private string m_Name; //姓名
private int m_Age = 0; //年齡
private string m_Creator; //創(chuàng)建人
private DateTime m_CreateTime; //創(chuàng)建時間
#endregion
#region Property Members
/// <summary>
/// 編號
/// </summary>
[DataMember]
public virtual string ID
{
get
{
return this.m_ID;
}
set
{
this.m_ID = value;
}
}
/// <summary>
/// 姓名
/// </summary>
[DataMember]
public virtual string Name
{
get
{
return this.m_Name;
}
set
{
this.m_Name = value;
}
}
/// <summary>
/// 年齡
/// </summary>
[DataMember]
public virtual int Age
{
get
{
return this.m_Age;
}
set
{
this.m_Age = value;
}
}
/// <summary>
/// 創(chuàng)建人
/// </summary>
[DataMember]
public virtual string Creator
{
get
{
return this.m_Creator;
}
set
{
this.m_Creator = value;
}
}
/// <summary>
/// 創(chuàng)建時間
/// </summary>
[DataMember]
public virtual DateTime CreateTime
{
get
{
return this.m_CreateTime;
}
set
{
this.m_CreateTime = value;
}
}
#endregion
}
其中我們看到下面的代碼,里面使用了基類 BaseEntity,這個是所有生成的實(shí)體類的基類,基類BaseEntity只是一個實(shí)體類的聲明,沒有什么屬性,使用這個實(shí)體類基類,只是為了整個框架更好管理和控制。BaseEntity來源于公用類庫,已經(jīng)封裝在里面了。
/// <summary>
/// 客戶信息
/// </summary>
[DataContract]
public class CustomerInfo : BaseEntity
{
另外,我們看到,實(shí)體類有注釋,這些注釋來自數(shù)據(jù)庫的備注信息,包括字段的注釋也是來自數(shù)據(jù)庫的備注說明信息。
還有類的定義里面,還看到了[DataContract] 的標(biāo)簽,以及類的屬性[DataMember],這個是WCF技術(shù)里面?zhèn)鬏敂?shù)據(jù)的協(xié)議聲明,我們目前開發(fā)的應(yīng)用,一般都是基于.NET4.0的了,因此包含這個屬性方便我們在開發(fā)網(wǎng)絡(luò)版項(xiàng)目的時候用到,一般情況下忽略即可。
我們繼續(xù)看看實(shí)體類的其他部分代碼:
#region Field Members
private string m_ID = System.Guid.NewGuid().ToString(); //編號
private string m_Name; //姓名
private int m_Age = 0; //年齡
private string m_Creator; //創(chuàng)建人
private DateTime m_CreateTime; //創(chuàng)建時間
#endregion
我們看到,對于字符型的ID主鍵字段,代碼生成的時候,已經(jīng)自動添加默認(rèn)屬性值(GUID:System.Guid.NewGuid().ToString() )的了,這樣我們創(chuàng)建實(shí)體類的時候,這個ID的值就已經(jīng)生成了。
好了,基于篇幅的原因,下次繼續(xù)介紹項(xiàng)目框架代碼的各部分組成,以及他們之間的關(guān)系,注意的實(shí)現(xiàn)和內(nèi)在約定等內(nèi)容。
循序漸進(jìn)開發(fā)WInform項(xiàng)目--系列文章導(dǎo)引:
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(6)--開發(fā)使用混合式Winform模塊
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(5)--Excel數(shù)據(jù)的導(dǎo)入導(dǎo)出操作
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(4)--Winform界面模塊的集成使用
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(3)--Winform界面層的項(xiàng)目設(shè)計
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(2)--項(xiàng)目代碼的分析
循序漸進(jìn)開發(fā)WinForm項(xiàng)目(1) --數(shù)據(jù)庫設(shè)計和項(xiàng)目框架的生成