在本系列的第一篇隨筆《Entity Framework 實(shí)體框架的形成之旅--基于泛型的倉儲(chǔ)模式的實(shí)體框架(1)》中介紹了Entity Framework 實(shí)體框架的一些基礎(chǔ)知識(shí)赃绊,以及構(gòu)建了一個(gè)簡(jiǎn)單的基于泛型的倉儲(chǔ)模式的框架;在隨筆《Entity Framework 實(shí)體框架的形成之旅--利用Unity對(duì)象依賴注入優(yōu)化實(shí)體框架(2)》則持續(xù)優(yōu)化這個(gè)倉儲(chǔ)模式的實(shí)體框架,主要介紹業(yè)務(wù)邏輯層的構(gòu)建膀钠,以及利用Unity和反射進(jìn)行動(dòng)態(tài)的對(duì)象注冊(cè)想诅。本篇主要介紹基類接口的統(tǒng)一和異步操作的實(shí)現(xiàn)等方面铣减,逐步把我框架接口命名的方式進(jìn)行統(tǒng)一呼伸,并增加所有必要用到的增刪改查墨技、分頁役拴、lambda表達(dá)式條件處理糊探,以及異步操作等特性,這樣能夠盡可能的符合基類這個(gè)特殊類的定義河闰,實(shí)現(xiàn)功能接口的最大化重用和統(tǒng)一科平。
1、基類接口的統(tǒng)一命名和擴(kuò)展
在我以前的基于Enterprise Library的框架里面姜性,定義了一個(gè)超級(jí)的數(shù)據(jù)訪問基類瞪慧,是特定數(shù)據(jù)訪問類基類的基類,AbstractBaseDAL的數(shù)據(jù)訪問層基類定義了很多通用的接口部念,具有非常強(qiáng)大的操作功能弃酌,如下所示。
這里面的很多接口命名我都經(jīng)過了一些推敲印机,或者我基于我或者我客戶群體的使用習(xí)慣和理解考慮矢腻,也是想沿承這些命名規(guī)則,擴(kuò)充我這個(gè)基于泛型的倉儲(chǔ)模式的實(shí)體框架基類接口射赛。
下面是各類不同接口的定義內(nèi)容多柑。
1)增加操作
/// <summary>
/// 插入指定對(duì)象到數(shù)據(jù)庫中
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <returns>執(zhí)行成功返回<c>true</c>,否則為<c>false</c></returns>
bool Insert(T t);
2)刪除操作
/// <summary>
/// 根據(jù)指定對(duì)象的ID,從數(shù)據(jù)庫中刪除指定對(duì)象
/// </summary>
/// <param name="id">對(duì)象的ID</param>
/// <returns>執(zhí)行成功返回<c>true</c>楣责,否則為<c>false</c>竣灌。</returns>
bool Delete(object id);
/// <summary>
/// 從數(shù)據(jù)庫中刪除指定對(duì)象
/// </summary>
/// <param name="id">指定對(duì)象</param>
/// <returns>執(zhí)行成功返回<c>true</c>聂沙,否則為<c>false</c>。</returns>
bool Delete(T t);
3)修改操作
/// <summary>
/// 更新對(duì)象屬性到數(shù)據(jù)庫中
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <param name="key">主鍵的值</param>
/// <returns>執(zhí)行成功返回<c>true</c>初嘹,否則為<c>false</c></returns>
bool Update(T t, object key);
4)主鍵查詢以及條件查詢操作
/// <summary>
/// 查詢數(shù)據(jù)庫,返回指定ID的對(duì)象
/// </summary>
/// <param name="id">ID主鍵的值</param>
/// <returns>存在則返回指定的對(duì)象,否則返回Null</returns>
T FindByID(object id);
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,如果存在返回第一個(gè)對(duì)象
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <returns>存在則返回指定的第一個(gè)對(duì)象,否則返回默認(rèn)值</returns>
T FindSingle(Expression<Func<T, bool>> match);
5)集合查詢(分返回IQueryable和ICollection<T>兩種方式)
/// <summary>
/// 返回可查詢的記錄源
/// </summary>
/// <returns></returns>
IQueryable<T> GetQueryable();
/// <summary>
/// 根據(jù)條件表達(dá)式返回可查詢的記錄源
/// </summary>
/// <param name="match">查詢條件</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序及汉,否則為升序</param>
/// <returns></returns>
IQueryable<T> GetQueryable(Expression<Func<T, bool>> match, string sortPropertyName, bool isDescending = true);
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對(duì)象集合
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <returns></returns>
ICollection<T> Find(Expression<Func<T, bool>> match);
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對(duì)象集合
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序,否則為升序</param>
/// <returns></returns>
ICollection<T> Find<TKey>(Expression<Func<T, bool>> match, Expression<Func<T, TKey>> orderByProperty, bool isDescending = true);
6)分頁查詢操作
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對(duì)象集合(用于分頁數(shù)據(jù)顯示)
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <param name="info">分頁實(shí)體</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序屯烦,否則為升序</param>
/// <returns>指定對(duì)象的集合</returns>
ICollection<T> FindWithPager(Expression<Func<T, bool>> match, PagerInfo info);
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對(duì)象集合(用于分頁數(shù)據(jù)顯示)
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <param name="info">分頁實(shí)體</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序坷随,否則為升序</param>
/// <returns>指定對(duì)象的集合</returns>
ICollection<T> FindWithPager<TKey>(Expression<Func<T, bool>> match, PagerInfo info, Expression<Func<T, TKey>> orderByProperty, bool isDescending = true);
這樣我們?cè)贐aseDAL里面,把這些接口全部實(shí)現(xiàn)了驻龟,那么所有繼承這個(gè)基類對(duì)象的數(shù)據(jù)訪問對(duì)象温眉,就具有這些標(biāo)準(zhǔn)的接口了,也給我們開發(fā)實(shí)現(xiàn)了整體性的統(tǒng)一翁狐。
首先我們來看看這個(gè)基類BaseDAL的初始化定義代碼类溢。
/// <summary>
/// 數(shù)據(jù)訪問層基類
/// </summary>
/// <typeparam name="T">實(shí)體對(duì)象類型</typeparam>
public abstract class BaseDAL<T> : IBaseDAL<T> where T : class
{
#region 變量及構(gòu)造函數(shù)
/// <summary>
/// DbContext對(duì)象
/// </summary>
protected DbContext baseContext;
/// <summary>
/// 指定類型的實(shí)體對(duì)象集合
/// </summary>
protected DbSet<T> objectSet;
/// <summary>
/// 是否為降序
/// </summary>
public bool IsDescending { get; set; }
/// <summary>
/// 排序?qū)傩? /// </summary>
public string SortPropertyName { get; set; }
/// <summary>
/// 參數(shù)化構(gòu)造函數(shù)
/// </summary>
/// <param name="context">DbContext對(duì)象</param>
public BaseDAL(DbContext context)
{
this.baseContext = context;
this.objectSet = this.baseContext.Set<T>();
this.IsDescending = true;
this.SortPropertyName = "ID";
}
#endregion
有了這些DbContext對(duì)象以及DbSet<T>對(duì)象,具體的接口實(shí)現(xiàn)就很容易了露懒,下面我抽幾個(gè)代表性的函數(shù)來介紹實(shí)現(xiàn)闯冷。
1)增加對(duì)象
/// <summary>
/// 插入指定對(duì)象到數(shù)據(jù)庫中
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <returns>執(zhí)行成功返回<c>true</c>,否則為<c>false</c></returns>
public virtual bool Insert(T t)
{
ArgumentValidation.CheckForNullReference(t, "傳入的對(duì)象t為空");
objectSet.Add(t);
return baseContext.SaveChanges() > 0;
}
2)刪除對(duì)象
/// <summary>
/// 根據(jù)指定對(duì)象的ID,從數(shù)據(jù)庫中刪除指定對(duì)象
/// </summary>
/// <param name="id">對(duì)象的ID</param>
/// <returns>執(zhí)行成功返回<c>true</c>懈词,否則為<c>false</c>蛇耀。</returns>
public virtual bool Delete(object id)
{
T obj = objectSet.Find(id);
objectSet.Remove(obj);
return baseContext.SaveChanges() > 0;
}
3)修改對(duì)象
/// <summary>
/// 更新對(duì)象屬性到數(shù)據(jù)庫中
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <param name="key">主鍵的值</param>
/// <returns>執(zhí)行成功返回<c>true</c>,否則為<c>false</c></returns>
public virtual bool Update(T t, object key)
{
ArgumentValidation.CheckForNullReference(t, "傳入的對(duì)象t為空");
bool result = false;
T existing = objectSet.Find(key);
if (existing != null)
{
baseContext.Entry(existing).CurrentValues.SetValues(t);
result = baseContext.SaveChanges() > 0;
}
return result;
}
4)根據(jù)條件查詢
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,如果存在返回第一個(gè)對(duì)象
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <returns>存在則返回指定的第一個(gè)對(duì)象,否則返回默認(rèn)值</returns>
public virtual T FindSingle(Expression<Func<T, bool>> match)
{
return objectSet.FirstOrDefault(match);
}
/// <summary>
/// 根據(jù)條件表達(dá)式返回可查詢的記錄源
/// </summary>
/// <param name="match">查詢條件</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序钦睡,否則為升序</param>
/// <returns></returns>
public virtual IQueryable<T> GetQueryable(Expression<Func<T, bool>> match, string sortPropertyName, bool isDescending = true)
{
IQueryable<T> query = this.objectSet;
if (match != null)
{
query = query.Where(match);
}
return query.OrderBy(sortPropertyName, isDescending);
}
5)分頁查詢
/// <summary>
/// 根據(jù)條件查詢數(shù)據(jù)庫,并返回對(duì)象集合(用于分頁數(shù)據(jù)顯示)
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <param name="info">分頁實(shí)體</param>
/// <param name="orderByProperty">排序表達(dá)式</param>
/// <param name="isDescending">如果為true則為降序蒂窒,否則為升序</param>
/// <returns>指定對(duì)象的集合</returns>
public virtual ICollection<T> FindWithPager(Expression<Func<T, bool>> match, PagerInfo info)
{
int pageindex = (info.CurrenetPageIndex < 1) ? 1 : info.CurrenetPageIndex;
int pageSize = (info.PageSize <= 0) ? 20 : info.PageSize;
int excludedRows = (pageindex - 1) * pageSize;
IQueryable<T> query = GetQueryable().Where(match);
info.RecordCount = query.Count();
return query.Skip(excludedRows).Take(pageSize).ToList();
}
更多的代碼就不一一貼出,反正我們?nèi)繉?shí)現(xiàn)自己所需的各種操作就可以了荞怒,這里要提的是洒琢,我們盡可能利用Lambda表達(dá)式進(jìn)行條件處理,包括查詢褐桌、刪除等條件處理衰抑。
對(duì)上面的這些常規(guī)接口,我們調(diào)用代碼處理的例子如下所示荧嵌。
private void btnProvince_Click(object sender, EventArgs e)
{
DateTime dt = DateTime.Now;
var list = BLLFactory<ProvinceBLL>.Instance.GetAll(s=>s.ProvinceName);
this.dataGridView1.DataSource = list;
Console.WriteLine("花費(fèi)時(shí)間:{0}", DateTime.Now.Subtract(dt).TotalMilliseconds);
}
private void btnCity_Click(object sender, EventArgs e)
{
DateTime dt = DateTime.Now;
CityBLL bll = new CityBLL();
var result = bll.GetAll();
this.dataGridView1.DataSource = result;
Console.WriteLine("花費(fèi)時(shí)間:{0}", DateTime.Now.Subtract(dt).TotalMilliseconds);
}
如果需要考慮分頁呛踊,以上接口已經(jīng)定義了分頁處理的接口和實(shí)現(xiàn)了,我們?cè)跇I(yè)務(wù)對(duì)象里面直接調(diào)用接口就可以了啦撮,具體代碼如下所示谭网。
CityBLL bll = new CityBLL();
PagerInfo info = new PagerInfo();
info.PageSize = 30;
info.CurrenetPageIndex =1 ;
ICollection<City> list;
if (i++ % 2 == 0)
{
sortType = "自定義排序";
//使用自定義排序
list = bll.FindWithPager(s => s.CityName.Contains("南"), info, o => o.ID, true);
}
else
{
sortType = "默認(rèn)字段排序";
//使用默認(rèn)字段排序
list = bll.FindWithPager(s => s.CityName.Contains("南"), info);
}
this.dataGridView1.DataSource = list;
2、異步操作的定義和調(diào)用
在EF里面實(shí)現(xiàn)異步(并行)非常容易赃春,在.NET 4.5里由于async/await關(guān)鍵字的出現(xiàn)愉择,使得實(shí)現(xiàn)異步變得更加容易。
使用await關(guān)鍵字后,.NET會(huì)自動(dòng)把返回結(jié)果包裝在一個(gè)Task類型的對(duì)象中锥涕。使用await表達(dá)式時(shí)衷戈,控制會(huì)返回到調(diào)用此方法的線程中;在await等待的方法執(zhí)行完畢后层坠,控制會(huì)自動(dòng)返回到下面的語句中锨苏。發(fā)生異常時(shí)婆赠,異常會(huì)在await表達(dá)式中拋出榕堰。
我們基本上所有的增刪改查玉控、分頁等接口,都可以使用異步操作來定義這些新接口座每,代碼如下所示蔚润。
1)增加對(duì)象異步實(shí)現(xiàn)
異步定義的接口如下所示
/// <summary>
/// 插入指定對(duì)象到數(shù)據(jù)庫中(異步)
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <returns>執(zhí)行成功返回<c>true</c>,否則為<c>false</c></returns>
Task<bool> InsertAsync(T t);
接口的實(shí)現(xiàn)如下所示
/// <summary>
/// 插入指定對(duì)象到數(shù)據(jù)庫中(異步)
/// </summary>
/// <param name="t">指定的對(duì)象</param>
/// <returns>執(zhí)行成功返回<c>true</c>尺栖,否則為<c>false</c></returns>
public virtual async Task<bool> InsertAsync(T t)
{
ArgumentValidation.CheckForNullReference(t, "傳入的對(duì)象t為空");
objectSet.Add(t);
return await baseContext.SaveChangesAsync() > 0;
}
和普通的接口定義不一樣的地方,我們看到異步的接口都是以Async結(jié)尾烦租,并且返回值使用Task<T>進(jìn)行包裝延赌,另外實(shí)現(xiàn)里面,增加了async的定義叉橱,方法體里面增加 await 的關(guān)鍵字挫以,這些就構(gòu)成了異步操作的接口定義和接口實(shí)現(xiàn)了。
2)條件刪除異步實(shí)現(xiàn)
我們?cè)賮砜匆粋€(gè)復(fù)雜一點(diǎn)的條件刪除操作窃祝,代碼如下所示掐松。
定義接口
/// <summary>
/// 根據(jù)指定條件,從數(shù)據(jù)庫中刪除指定對(duì)象(異步)
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <returns>執(zhí)行成功返回<c>true</c>,否則為<c>false</c>粪小。</returns>
Task<bool> DeleteByConditionAsync(Expression<Func<T, bool>> match);
接口實(shí)現(xiàn)
/// <summary>
/// 根據(jù)指定條件,從數(shù)據(jù)庫中刪除指定對(duì)象(異步)
/// </summary>
/// <param name="match">條件表達(dá)式</param>
/// <returns>執(zhí)行成功返回<c>true</c>大磺,否則為<c>false</c>。</returns>
public virtual async Task<bool> DeleteByConditionAsync(Expression<Func<T, bool>> match)
{
objectSet.Where<T>(match).ToList<T>().ForEach(d => baseContext.Entry<T>(d).State = EntityState.Deleted);
return await baseContext.SaveChangesAsync() > 0;
}
我們定義的這些異步接口探膊,基本上都是類似的操作杠愧,但是我們應(yīng)該如何調(diào)用異步的處理呢?
好像有兩個(gè)調(diào)用代碼方式逞壁。
1)使用async和await關(guān)鍵字處理
private async void btnCity_Click(object sender, EventArgs e)
{
DateTime dt = DateTime.Now;
CityBLL bll = new CityBLL();
var result = await bll.GetAllAsync();
this.dataGridView1.DataSource = result;
Console.WriteLine("花費(fèi)時(shí)間:{0}", DateTime.Now.Subtract(dt).TotalMilliseconds);
}
2)使用 await Task.Run的處理方式
private async void btnCity_Click(object sender, EventArgs e)
{
DateTime dt = DateTime.Now;
CityBLL bll = new CityBLL();
var result = await Task.Run(() =>
{
var list = bll.GetAllAsync();
return list;
});
this.dataGridView1.DataSource = result;
Console.WriteLine("花費(fèi)時(shí)間:{0}", DateTime.Now.Subtract(dt).TotalMilliseconds);
}
兩種方式都能正常運(yùn)行流济,并得到所要的效果。
本篇主要介紹了基類接口的統(tǒng)一封裝腌闯、并增加所有必要的增刪改查绳瘟、分頁查詢、Lambda條件等處理方式姿骏,還有就是增加了相關(guān)的異步操作接口和實(shí)現(xiàn)糖声,隨著我們對(duì)通用功能的進(jìn)一步要求,可以為基類增加更多的接口函數(shù)。