以下文章摘錄來自InfoQ,是一篇不錯的軟問,大家細細的品味
關鍵要點:
在現代企業開發中,可采用多種方法構建數據存取層(data access layer ,DAL)。使用C#做開發時,DAL的最底層幾乎總是使用ADO.NET。但這時常會形成一個笨重的庫,所以通常會在DAL的底層之上再部署一個ORM層。為允許模擬和隱藏ORM的細節,整個DAL包裝在存儲內。
在這一系列的文章中,我們將審視三種使用不同類型ORM構建倉儲模式的方法,分別是:
本文將側重於開發人員可在典型倉儲中用到的那些基本功能。在本系列文章的第二部分,我們將著眼於那些開發人員基於實際情況而實現的高級技術。
對於任何CRUD操作集,通常會首先實現基本的插入操作,進而可用插入操作對其它的操作進行測試。
Chain使用列名和屬性名間的運行時匹配。對於在數據庫中並不存在的對象,除非啟用了嚴格模式(strict model),否則將忽略該對象上的屬性。類似地,沒有匹配屬性的列不能成為生成SQL的組成部分。
相關廠商內容
public int Insert(Employee employee) { return m_DataSource.Insert("HR.Employee", employee).ToInt32().Execute(); }
沒有第三方擴展時,Dapper需要編程人員手工指定所需的SQL,其中包括了特定於數據庫的邏輯,用於返回新創建的主鍵。
public int Insert(Employee employee) { const string sql = @"INSERT INTO HR.Employee (FirstName, MiddleName, LastName, Title, ManagerKey, OfficePhone, CellPhone ) VALUES (@FirstName, @MiddleName, @LastName, @Title, @ManagerKey, @OfficePhone, @CellPhone ); SELECT SCOPE_IDENTITY() "; using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); return con.ExecuteScalar<int>(sql, employee); } }
實體框架使用編譯階段映射在運行時生成SQL。需將任何沒有匹配列的屬性標記為NotMapped,否則將會產生錯誤。
public int Insert(Employee employee) { using (var context = new CodeFirstModels()) { context.Employees.Add(employee); context.SaveChanges(); return employee.EmployeeKey; } }
Chain缺省使用數據庫中所定義的主鍵。但是在設置了適當的插入選項後,它將在模型中使用Key屬性。
public void Update(Employee employee) { m_DataSource.Update("HR.Employee", employee).Execute(); }
與插入操作一樣,純Dapper需用戶手工編寫必要的SQL語句。
public void Update(Employee employee) { const string sql = @"UPDATE HR.Employee SET FirstName = @FirstName, MiddleName = @MiddleName, LastName = @LastName, Title = @Title, ManagerKey = @ManagerKey, OfficePhone = @OfficePhone, CellPhone = @CellPhone WHERE EmployeeKey = @EmployeeKey "; using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); con.Execute(sql, employee); } }
實體框架為UPDATE語句查找Key屬性,以生成WHERE語句。
public void Update(Employee employee) { using (var context = new CodeFirstModels()) { var entity = context.Employees.Where(e => e.EmployeeKey == employee.EmployeeKey).First(); entity.CellPhone = employee.CellPhone; entity.FirstName = employee.FirstName; entity.LastName = employee.LastName; entity.ManagerKey = employee.ManagerKey; entity.MiddleName = employee.MiddleName; entity.OfficePhone = employee.OfficePhone; entity.Title = employee.Title; context.SaveChanges(); } }
使用實體框架時,初學者常會在執行更新操作上犯錯誤。將實體添加到上下文中很容易就能實現它,而這種模式應成為中級使用者的常識。這裡給出使用實體狀態“Modified”修正後的例子。
public void Update(Employee employee) { using (var context = new CodeFirstModels()) { context.Entry(employee).State = EntityState.Modified; context.SaveChanges(); } }
讀取全部操作在實體框架和Chain中是十分相似的,不同之處在於在實體框架中實現需要編寫更多行的代碼,而在Chain中實現需要編寫更長的代碼行。
Dapper當然是最為繁瑣的,因為它需要未經加工的SQL語句。即使如此,仍可以通過使用SELECT *語句替代手工地指定列名而在一定程度上降低Dapper的開銷。這在存在返回額外數據的風險的情況下,降低了出現類與SQL語句不匹配的可能性。
在Chain中,ToObject連接生成一系列所需的列。通過匹配所需列表與可用列的列表,From連接生成SQL語句。
public IList<Employee> GetAll() { return m_DataSource.From("HR.Employee").ToCollection<Employee>().Execute(); }
Dapper是最為繁瑣的,因為它需要原始未經加工的SQL語句。雖然這令人皺眉頭,但仍可以通過使用SELECT *語句替代手工地指定列名而在一定程度上降低Dapper的開銷,這樣是不太可能漏掉列的,雖然存在返回額外數據的風險。
public IList<Employee> GetAll() { using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); return con.Query<Employee>("SELECT e.EmployeeKey, e.FirstName, e.MiddleName, e.LastName, e.Title, e.ManagerKey, e.OfficePhone, e.CellPhone, e.CreatedDate FROM HR.Employee e").AsList(); } }
像以前一樣,實體框架使用編譯期信息確定如何生成SQL語句。
public IList<Employee> GetAll() { using (var context = new CodeFirstModels()) { return context.Employees.ToList(); } }
需要注意的是,隨每個例子的語法稍作修改就可表明只返回一個對象。同樣的基本過濾技術可用於返回多個對象。
Chain嚴重依賴於“過濾對象”。這些對象直接被轉義成參數化的WHERE語句,語句中的每個屬性間具有“AND”操作符。
public Employee Get(int employeeKey) { return m_DataSource.From("HR.Employee", new { @EmployeeKey = employeeKey }).ToObject<Employee>().Execute(); }
Chain也允許用參數化的字符串表示WHERE語句,雖然這個功能很少被用到。
如果主鍵是標量,即主鍵中只有一列,那麼可使用簡化的語法。
public Employee Get(int employeeKey) { return m_DataSource.GetByKey("HR.Employee", employeeKey).ToObject<Employee>().Execute(); }
下例中,可以看到Dapper手工指定了SQL語句。該語句與Chain和實體框架所生成的SQL語句在本質上是一致的。
using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); return con.Query<Employee>("SELECT e.EmployeeKey, e.FirstName, e.MiddleName, e.LastName, e.Title, e.ManagerKey, e.OfficePhone, e.CellPhone, e.CreatedDate FROM HR.Employee e WHERE e.EmployeeKey = @EmployeeKey", new { @EmployeeKey = employeeKey }).First(); }
實體框架將表名和首個ToList或First操作間的所有內容看作為一個表達式樹。在運行時評估該樹以生成SQL語句。
public Employee Get(int employeeKey) { using (var context = new CodeFirstModels()) { return context.Employees.Where(e => e.EmployeeKey == employeeKey).First(); } }
Chain期待包括主鍵的參數對象。而參數對象中的其它特性將被忽略(該語法不支持批量刪除)。
public void Delete(int employeeKey) { m_DataSource.Delete("HR.Employee", new { @EmployeeKey = employeeKey }).Execute(); }
如果有標量主鍵,可使用簡化的語法。
public void Delete(int employeeKey) { m_DataSource.DeleteByKey("HR.Employee", employeeKey).Execute(); }
public void Delete(int employeeKey) { using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); con.Execute("DELETE FROM HR.Employee WHERE EmployeeKey = @EmployeeKey", new { @EmployeeKey = employeeKey }); } }
初學者一般會取回一個記錄然後迅速刪除,丟棄所有返回的信息。
public void Delete(int employeeKey) { using (var context = new CodeFirstModels()) { var employee = context.Employees.Where(e => e.EmployeeKey == employeeKey).First(); context.Employees.Remove(employee); context.SaveChanges(); } }
可使用內嵌SQL避免數據庫的往返交互操作。
public void Delete(int employeeKey) { using (var context = new CodeFirstModels()) { context.Database.ExecuteSqlCommand("DELETE FROM HR.Employee WHERE EmployeeKey = @p0", employeeKey); } }
投影是中間層開發中的一個重要部分。在取回了比實際所需更多的數據時,數據庫常會完全失去使用覆蓋索引或索引的能力,這將導致嚴重的性能影響。
同上,Chain將僅選取指定對象類型所需的所有列。
public IList<EmployeeOfficePhone> GetOfficePhoneNumbers() { return m_DataSource.From("HR.Employee").ToCollection<EmployeeOfficePhone>().Execute(); }
鑒於Dapper是顯式的,所以是由開發人員確保只選取必需的列。
public IList<EmployeeOfficePhone> GetOfficePhoneNumbers() { using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); return con.Query<EmployeeOfficePhone>("SELECT e.EmployeeKey, e.FirstName, e.LastName, e.OfficePhone FROM HR.Employee e").AsList(); } }
實體框架需要額外的操作步驟,這些步驟常因為有些繁瑣而被忽視。
通過在調用ToList前就包括了額外的選擇語句,實體架構可生成正確的SQL語句,並避免從數據庫返回過多的信息。
public IList<EmployeeOfficePhone> GetOfficePhoneNumbers() { using (var context = new CodeFirstModels()) { return context.Employees.Select(e => new EmployeeOfficePhone() { EmployeeKey = e.EmployeeKey, FirstName = e.FirstName, LastName = e.LastName, OfficePhone = e.OfficePhone }).ToList(); } }
固然,在存在投影對象時直接從投影對象更新數據庫是一種好的方法。該方法在Chain和Dapper的基本模式中是天然存在的。而在實體框架中,則必須要在手工拷貝屬性和編寫Dapper風格的內嵌SQL這兩種方法間做出選擇。
注意,任何未在投影類上具有匹配屬性的列將不受到影響。
public void Update(EmployeeOfficePhone employee) { return m_DataSource.Update("HR.Employee", employee).Execute(); }
public void Update(EmployeeOfficePhone employee) { const string sql = @"UPDATE HR.Employee SET FirstName = @FirstName, LastName = @LastName, OfficePhone = @OfficePhone WHERE EmployeeKey = @EmployeeKey "; using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); con.Execute(sql, employee); } }
public void Update(EmployeeOfficePhone employee) { using (var context = new CodeFirstModels()) { var entity = context.Employees.Where(e => e.EmployeeKey == employee.EmployeeKey).First(); entity.FirstName = employee.FirstName; entity.LastName = employee.LastName; entity.OfficePhone = employee.OfficePhone; context.SaveChanges(); } }
現在我們來看一些更有意思的用例。反射插入意味著返回被插入的對象。做反射插入通常是為了獲得默認的和計算的域。
注意,實體框架和Chain需要對屬性進行注釋,這樣庫才會知道該域將由數據庫予以設置。
[DatabaseGenerated(DatabaseGeneratedOption.Computed)] //Needed by EF [IgnoreOnInsert, IgnoreOnUpdate] //Needed by Chain public DateTime? CreatedDate { get; set; }
Chain允許將ToObject附加到任何插入或更新操作上。
public Employee InsertAndReturn(Employee employee) { return m_DataSource.Insert("HR.Employee", employee).ToObject<Employee>().Execute(); }
使用Dapper的反射插入,可以使用特定於數據庫的功能實現,例如OUTPUT語句。
public Employee InsertAndReturn(Employee employee) { const string sql = @"INSERT INTO HR.Employee (FirstName, MiddleName, LastName, Title, ManagerKey, OfficePhone, CellPhone ) OUTPUT Inserted.EmployeeKey, Inserted.FirstName, Inserted.MiddleName, Inserted.LastName, Inserted.Title, Inserted.ManagerKey, Inserted.OfficePhone, Inserted.CellPhone, Inserted.CreatedDate VALUES (@FirstName, @MiddleName, @LastName, @Title, @ManagerKey, @OfficePhone, @CellPhone );"; using (var con = new SqlConnection(m_ConnectionString)) { con.Open(); return con.Query<Employee>(sql, employee).First(); } }
如果一並考慮初學者級別模式,更典型的做法是僅在Get方法之後調用Insert方法。
public Employee InsertAndReturn_Novice(Employee employee) { return Get(Insert(employee)); }
使用前面提及的DatabaseGenerated屬性,你可以插入一個新的實體並讀回它的計算的和/或默認的列。
public Employee InsertAndReturn(Employee employee) { using (var context = new CodeFirstModels()) { context.Employees.Add(employee); context.SaveChanges(); return employee; } }
有時應用並沒有打算對每個列做更新,尤其是當模型是直接源自於UI並可能混合了可更新域和不可更新域時。
在Chain中,使用IgnoreOnInsert和IgnoreOnUpdate屬性去限制插入和更新操作。為允許用數據庫作為默認取值,典型的做法是將這兩個屬性都置於CreatedDate類型的列中。為避免更新操作過程中的意外改變,通常將IgnoreOnUpdate屬性置於CreatedBy之類的列上。
就顯式編寫的插入和更新語句而言,Dapper最具靈活性。
除了計算列(列值為表達式),實體框架並未給出一種簡單的方法可聲明某一列不參與插入或刪除操作,但可使用更新操作的“讀-拷貝-寫”(read-copy-write)模式模擬該行為。
經常需要作為一個單一操作完成記錄的插入或者更新,尤其是在使用自然主鍵(natural key)時。
在Chain中,Upsert操作的實現使用了與插入和刪除相同的設計。所生成的SQL隨數據庫引擎不同而各異(例如:SQL Server使用了MERGE,SQLit使用了一系列語句)。
public int Upsert(Employee employee) { return m_DataSource.Upsert("HR.Employee", employee).ToInt32().Execute(); }
在Dapper中,Upsert操作的實現需要多輪的來回交互,或是需要比較復雜的特定於數據庫的SQL語句。本文對此不作闡述。
在實體框架中,這(過程?函數?都可以用“這”指代)僅作為被改進的更新操作的一個變體。
public int Upsert(Employee employee) { using (var context = new CodeFirstModels()) { if(employee.EmployeeKey == 0) context.Entry(employee).State = EntityState.Added; else context.Entry(employee).State = EntityState.Modified; context.SaveChanges(); return employee.EmployeeKey; } }
雖然本文所采用的主要基准測試是代碼量和易用性,但是對實際性能的考慮也是非常有用的。
所有的性能基准測試中都包括了預熱過程,其後是對主循環做1000次迭代操作。每次測試中都使用了同樣的模型,模型使用實體框架的代碼優先(Code First)技術從數據庫代碼生成器產生。所有迭代都相當於共計13個基本CRUD操作,其中包括創建、讀取、更新和刪除操作。
我要澄清的是,這裡所做的僅是一些粗略的測試,使用了任何人在剛開始接觸這些庫時通常就會看到的代碼類型。當然一些高級技術可以改進每個測試的性能,有時甚至是極大地改進。
雖然可使用任何ORM框架去實現基本的倉儲模式,但是各種實現的性能和所需的代碼量具有顯著的差異。選取實現方式時需要對這些因素進行平衡,此外還需考慮數據庫可移植性、跨平台支持和開發人員經驗等。
在該系列文章的第二部分,我們將著眼於那些不僅將倉儲模式作為瘦抽象層的高級用例。
你可以在GitHub上獲取本文的代碼。
Jonathan Allen的首份工作是在上世紀九十年代末做診所的MIS項目,Allen將項目逐步由Access和Excel升級到企業級的解決方法。在從事為財政部門編寫自動交易系統代碼的工作五年之後,他成為項目顧問,參與了包括機器人倉庫UI、癌症研究軟件中間層、主要房地產保險企業的大數據需求等在內的各種行業項目。在閒暇時間,他喜歡研究源於16世紀的武術,並為其撰寫文章。
查看英文原文:Implementation Strategies for the Repository Pattern with Entity Framework, Dapper, and Chain