mrkt 的程式學習筆記: 初探 Entity Framework 6 的 Async/Await 功能

2013年10月29日星期二

初探 Entity Framework 6 的 Async/Await 功能

Entity Framework 6 其中一個新的功能就是有支援 Async/Await 功能，EF6 加入了許多非同步的方法，這些新的非同步方法會在方法名稱加上「Async」後綴詞，例如：FirstAsync, FirstOrDefaultAsync, SumAsync, MinAsync, MaxAsync 等等。

這一篇文章只是看看 EF6 所提供的 Async.Await 功能要如何使用，先以讀取資料的操作來說明，而新增、刪除、修改等操作就留待下一篇再做說明。

2013-10-29 更正：

有關使用非同步處理的執行結果會快於沒有使用非同步處理，再重新對程式做檢查之後發現到一個問題點，因為這個問題而導致執行結果產生這麼大的出入，對於未經再三檢查而產生錯誤的結果，在此向各位致歉，並且將錯誤內容做出更正。

開發環境：Windows 8.1

開發工具：Visual Studio 2013

資料庫：MS SQL Server 2008 R2

建立一個新的 ASP.NET MVC 5 網站（不加入驗證）

新建立好的 ASP.NET MVC 網站並不會加入 EntityFramework 的參考，所以要使用 NuGet 加入 EntityFramework 6 的參考，

這次不用 LocalDB 而是直接連結 MS SQL Server 2008 R2 的 Northwind 資料庫，

完成以上的基礎建設之後，現在要來增加程式實做的部份，我這邊並不會在某個 Controller 裡直接對 DbContext 做資料存取操作，而是如同我之前的範例程式（ex: 分層架構系列）先建立 IRepository 以及實做的 GenericRepository，

這一篇文章暫時只會說明讀取資料的操作，所以就先不建立其餘的新增刪除修改方法，

Async 不支援 IQueryable<T> 所以這邊只有先對取得一筆資料的 GetAsync 方法做非同步操作，該方法所傳的類別為 Task<TEntity>，Task<T> 其命名空間為「System.Threading.Tasks」。

接著看 GetAsync 實作的程式內容，

在上面可以看到 GetAsync 方法特別標示的幾個地方，在方法的簽名中要加上 async 關鍵字，方法的回傳值簽名為 Task<TEntity>，然後在最後傳回值前加上 await 關鍵字。

MSDN – async

使用 async 修飾詞，您可以指定方法、Lambda 運算式或匿名方法是非同步的。如果您在方法或運算式上使用這個修飾詞，就稱為非同步方法。

MSDN - await

await 使用的非同步方法必須以 async 關鍵字修改。這種方法，透過使用 async 修飾詞來定義和通常包含一或多個 await 運算式，稱為「非同步方法」(async method)。

完整的 GenericRepository 內容如下：

using System;using System.Collections.Generic;using System.Data.Entity;using System.Diagnostics;using System.Linq;using System.Linq.Expressions;using System.Threading.Tasks;using System.Web;using BlogSample.Models; namespace BlogSample.Repository{    public class GenericRepository<TEntity> : IRepository<TEntity>        where TEntity : class     {        private DbContext _context        {            get;            set;        }         private DbSet<TEntity> dbSet        {            get            {                return this._context.Set<TEntity>();            }        }         public GenericRepository()            : this(new NorthwindEntities())        {        }         public GenericRepository(DbContext context)        {            if (context == null)            {                throw new ArgumentNullException("context");            }            this._context = context;        }           public async Task<TEntity> GetAsync(Expression<Func<TEntity, bool>> predicate)        {            return await this.dbSet.FirstOrDefaultAsync(predicate);        }         public IQueryable<TEntity> GetAll()        {            return this.dbSet.AsQueryable();        }         public IQueryable<TEntity> GetAllWithInclude(params Expression<Func<TEntity, object>>[] includes)        {            var query = this.dbSet.AsQueryable();             if (includes != null)            {                query = includes.Aggregate(                    query,                    (current, include) => current.Include(include));            }             return query;        }          public void Dispose()        {            this.Dispose(true);            GC.SuppressFinalize(this);        }         protected virtual void Dispose(bool disposing)        {            if (disposing)            {                if (this._context != null)                {                    this._context.Dispose();                    this._context = null;                }            }        }    }}

接著在 Controllers 目錄下新建立一個 OrderController，這邊所選擇的是「MVC 5 控制器 - 空白」，

然後在 OrderController 加入程式，取得顯示全部 Order 資料的內容，

新增檢視

執行結果

回到 OrderController，在這裡我們加入一個使用 async 方法的 Action 方法，我們檢視單筆 Order 資料時，可以透過已經建立好的 GenericRepository 的 GetAsync() 方法來取得資料，不過 Controller 的 Action 要使用非同步的方法就必須也要在方法簽名加上 async 關鍵字，而透過非同步方法取得資料也需要加上 await 關鍵字，而且原本 ActionResult 也需要修改為 Task<ActionResult>，實作的程式內容如下：

新增 Details 檢視

執行結果

Collection 的非同步處理

上面是取得單一筆資料時的非同步操作處理方式，但如果我們想要對一堆資料也做非同步處理時應該怎麼做呢？前面有講過非同步處理無法對 IQueryable<T> 進行處理，但我們可以對 List<T> 來做非同步操作，而 EntityFramework 的 QureryableExtensions 也有 ToListAsync() 的擴充方法，