詳解ASP.NET MVC 2中的新ADO.NET實(shí)體框架
.NET框架4.0的發(fā)行推出了許多優(yōu)秀的增強(qiáng)功能,其中當(dāng)首推ADO.NET實(shí)體框架。該框架已經(jīng)克服了以前的許多錯(cuò)誤,并提供了一組增強(qiáng)的API,其中包括許多新的LINQ to SQL框架方面的改善。在本文中,我們將使用這些API的功能來(lái)創(chuàng)建一個(gè)通用版本的數(shù)據(jù)倉(cāng)庫(kù)。
一、實(shí)體框架概述
實(shí)體框架針對(duì)數(shù)據(jù)模型提供了一些更方便的操作方法。默認(rèn)情況下,設(shè)計(jì)器可以生成一個(gè)描述數(shù)據(jù)庫(kù)的模型。
盡管表格間的映射未必都是1:1的映射。每個(gè)表格使用一個(gè)ObjectSet加以描述,進(jìn)而ObjectSet對(duì)象又提供了相應(yīng)的方法來(lái)創(chuàng)建、更新或反射實(shí)體和實(shí)體間的關(guān)系。實(shí)體框架使用一個(gè)實(shí)體鍵(這是一個(gè)看上去像EntitySet=Customers;CustomerID=4的值)來(lái)唯一標(biāo)識(shí)模型內(nèi)的一個(gè)實(shí)體及其標(biāo)識(shí)符。使用實(shí)體鍵,我們就有了一個(gè)方法來(lái)更新對(duì)象、從數(shù)據(jù)庫(kù)中查詢的對(duì)象,等等。
二、創(chuàng)建和更新
讓我們首先來(lái)看一個(gè)基類示例倉(cāng)庫(kù)的實(shí)現(xiàn)。我想分別地討論CRUD操作,首先來(lái)學(xué)習(xí)創(chuàng)建和更新操作。
清單1:創(chuàng)建/更新操作
- public abstract class BaseRepository<T> : IRepository<T>
- where T : EntityObject
- {
- public virtual bool CreateNew(T entity)
- {
- if (entity == null)
- throw new ArgumentNullException("entity");
- var ctx = CreateContext();
- try
- {
- ctx.AddObject(this.GetFullEntitySetName(ctx), entity);
- ctx.SaveChanges();
- return true;
- }
- catch (Exception ex) { .. }
- }
- protected abstract string GetEntitySetName(AdventureWorksObjectContext context);
- public virtual bool Update(T entity)
- {
- if (entity == null)
- throw new ArgumentNullException("entity");
- var ctx = CreateContext();
- entity.EntityKey = ctx.CreateEntityKey(this.GetFullEntitySetName(ctx),
- entity);
- try
- {
- T oldEntity = (T)ctx.GetObjectByKey(entity.EntityKey);
- if (oldEntity == null) return false;
- ctx.ApplyCurrentValues(this.GetFullEntitySetName(ctx), entity);
- ctx.SaveChanges();
- return true;
- }
- catch (Exception ex) { .. }
- }
- }
上述代碼中,我們的BaseRepository類使用ObjectContext類(需要使用CreateContext方法創(chuàng)建每一個(gè)請(qǐng)求)和AddObject方法實(shí)現(xiàn)添加新的對(duì)象,而通過(guò)使用ObjectContext類和AttachTo方法實(shí)現(xiàn)更新現(xiàn)有的對(duì)象。對(duì)于創(chuàng)建對(duì)象而言,我們需要知道要更新哪種類型的方法。使用我們的助理GetFullEntitySetName方法可以很好地處理這個(gè)問(wèn)題。這個(gè)方法能夠返回要添加的標(biāo)識(shí)實(shí)體的對(duì)象(一個(gè)如DotNetSamplesObjectContext.Customers的值)的標(biāo)識(shí)。
對(duì)于更新一個(gè)對(duì)象而言,我們遇到了與上下文有關(guān)的問(wèn)題。每個(gè)從數(shù)據(jù)庫(kù)中查詢的對(duì)象都使用ObjectStateManager類中的ObjectContext成員進(jìn)行跟蹤。MVC綁定過(guò)程實(shí)際上已經(jīng)構(gòu)建了它自己的對(duì)象副本,并通過(guò)反射把這些值注入到此對(duì)象中。這意味著我們有一個(gè)新的對(duì)象,而不是附加到ObjectContext上的對(duì)象。
這不是一個(gè)大問(wèn)題,我們首先需要查詢舊記錄。這將為我們的實(shí)體生成一個(gè)ObjectStateEntry,并且我們可以成功地執(zhí)行更新(因?yàn)樗枰琅f記錄是什么)。該實(shí)體還需要使用一個(gè)EntityKey實(shí)體,提供適當(dāng)?shù)闹麈I信息(記住,EntityKey是確定出已存在的實(shí)體的唯一的方式)。
***,調(diào)用ApplyCurrentValues能夠把MVC框架所創(chuàng)建的新的實(shí)體值應(yīng)用到舊實(shí)體上。在這里,我們?nèi)匀恍枰褂脤?shí)體集的名稱來(lái)唯一標(biāo)識(shí)它。
三、元數(shù)據(jù)
在上面代碼中,我們看到了實(shí)體集名稱的使用方法,用來(lái)確定ADO.NET實(shí)體框架中的實(shí)體的類型。例如,它可以用于描述Products表和Product實(shí)體之間的一個(gè)映射。還例如,對(duì)于我們的產(chǎn)品信息庫(kù)來(lái)說(shuō),它可以執(zhí)行下列操作以獲取實(shí)體集。
清單2—返回產(chǎn)品實(shí)體集名稱
- protected override Expression<Func<DA.Product, object>> GetDefaultSortingExpression()
- {
- return j => j.ProductID;
- }
- protected override string GetEntitySetName(AdventureWorksObjectContext context)
- {
- return context.Products.EntitySet.Name;
- }
我們很快將會(huì)看到GetDefaultSortingExpression的使用。請(qǐng)注意,這里的GetFullEntitySetName方法把對(duì)象的上下文名稱追加到實(shí)體集名稱的后面,以取得添加,更新等操作對(duì)應(yīng)對(duì)象的正確名稱?!?/p>
四、數(shù)據(jù)檢索
一般地,我們還可以執(zhí)行一些讀取操作,如下所示。
清單3—從數(shù)據(jù)庫(kù)讀取數(shù)據(jù)
- protected virtual string GetKeyProperty()
- {
- PropertyInfo[] properties = typeof(T).GetProperties();
- foreach (PropertyInfo property in properties)
- {
- EdmScalarPropertyAttribute attrib = property.GetCustomAttributes
- (typeof(EdmScalarPropertyAttribute), false).FirstOrDefault() as EdmScalarPropertyAttribute;
- if (attrib != null && attrib.EntityKeyProperty)
- return property.Name;
- }
- return null;
- }
- public virtual T Get(int key)
- {
- string prop = this.GetKeyProperty();
- if (string.IsNullOrEmpty(prop))
- return null;
- var ctx = CreateContext();
- return (T)ctx.GetObjectByKey(new EntityKey(this.GetFullEntitySetName(ctx),
- prop, key));
- }
- public virtual IQueryable<T> GetAll(int pageIndex, int pageSize)
- {
- var ctx = CreateContext();
- return ctx.CreateObjectSet<T>(this.GetFullEntitySetName(ctx)).OrderBy(this.GetDefaultSortingExpression())
- .Skip(pageIndex * pageSize).Take(pageSize);
- }
默認(rèn)設(shè)計(jì)器生成的每個(gè)實(shí)體類都將把一組屬性添加到它對(duì)應(yīng)的每一個(gè)字段屬性上。其中,EdmScalarPropertyAttribute擁有EntityKeyProperty設(shè)置,被設(shè)置為true,對(duì)應(yīng)于實(shí)體的鍵字段。這就提供了一種靈活的方式來(lái)確定主鍵列而不需要使用一個(gè)lambda表達(dá)式手動(dòng)指定。
跟蹤分析到ObjectContext方法內(nèi)部,你會(huì)發(fā)現(xiàn)通過(guò)使用實(shí)體集名稱構(gòu)造一個(gè)對(duì)象集合可以取得一個(gè)數(shù)據(jù)實(shí)體的所有結(jié)果。對(duì)象集可以使用LINQ擴(kuò)展方法來(lái)按索引頁(yè)和大小加以過(guò)濾,例如只取得一個(gè)包含20個(gè)對(duì)象的結(jié)果集。不幸的是,調(diào)用Skip和Take方法需要先對(duì)對(duì)象進(jìn)行排序。同樣,你需要使用一個(gè)自定義Lambda表達(dá)式來(lái)執(zhí)行這個(gè)排序操作。
GetObjectByKey方法實(shí)際上使用它的鍵從它的數(shù)據(jù)庫(kù)中檢索對(duì)象。我們可以利用我們的新的GetKeyProperty反射方法來(lái)獲取主鍵屬性的名稱。正如你所看到的,我們不能直接使用這個(gè)鍵而需要使用一個(gè)EntityKey對(duì)象來(lái)檢索它。
五、最終實(shí)現(xiàn)
我可以利用一個(gè)類似下面的信息庫(kù),并且已經(jīng)在基類中實(shí)現(xiàn)了Create、Delete、Update、Get和GetAll方法。我們只需要關(guān)心的是,實(shí)現(xiàn)其他的查詢操作。
清單4—最終版本的數(shù)據(jù)倉(cāng)庫(kù)類(其他其他前面已列舉的內(nèi)容)
- public class ProductsRepository : BaseRepository<DA.Product>
- {
- protected override Expression<Func<DA.Product, object>> GetDefaultSortingExpression()
- {
- return j => j.ProductID;
- }
- protected override string GetEntitySetName(DA.DotNetSamplesObjectContext context)
- {
- return context.Products.EntitySet.Name;
- }
- }
在大多數(shù)情況下,代碼生成將是***的選擇,有助于減少重復(fù)代碼,但是,實(shí)體框架做了大量的內(nèi)部基礎(chǔ)工作(實(shí)現(xiàn)基礎(chǔ)代碼的自動(dòng)生成)來(lái)實(shí)現(xiàn)這些特征支持而無(wú)需我們編寫任何代碼。
六、結(jié)論
ADO.NET實(shí)體框架提供了大量基礎(chǔ)功能,節(jié)省了開發(fā)人員大量的代碼編寫時(shí)間。在本文中,我們討論了ObjectContext類提供給我們的許多方法,其中包括從后端數(shù)據(jù)庫(kù)獲取和存入數(shù)據(jù),等等。
***,我們有理由相信,ADO.NET實(shí)體框架必將在ASP.NET MVC框架應(yīng)用程序開發(fā)的數(shù)據(jù)管理模型開發(fā)中發(fā)揮越來(lái)越大的作用。
【編輯推薦】