快捷導(dǎo)航

c# 如何自己實現(xiàn)一個ORM框架

更新時間：2021年03月18日 12:01:22 作者：月影西下

這篇文章主要介紹了c# 如何自己實現(xiàn)一個ORM，幫助大家更好的理解和學(xué)習(xí)使用c#，感興趣的朋友可以了解下

0. 前言

在之前的幾篇內(nèi)容中，我們了解了如何通過ADO.NET 訪問數(shù)據(jù)庫，如何修改、新增數(shù)據(jù)。如何通過DataSet和DataAdapter獲取數(shù)據(jù)，我們將在這一篇試試自己實現(xiàn)一個簡單的ORM框架或者說ORM工具類。

涉及到的知識點：

反射（初級）
ADO.NET 已有知識

1. ORM

那么，問題來了，什么是ORM？ORM全稱 Object Relational Mapping，翻譯過來就是對象關(guān)系映射。是一種通過描述對象與數(shù)據(jù)庫之間映射關(guān)系的數(shù)據(jù)，將對象保存到數(shù)據(jù)庫中的技術(shù)。

在C#中，曾經(jīng)Entity Framework光芒萬丈，遮蓋了其他ORM框架的光輝（甚至如今都是如此）。

后來慢慢涌現(xiàn)除了其他的一些ORM框架，進(jìn)一步豐富了市場。所以現(xiàn)有比較流行的大概有以下幾種：

Dapper 一個輕量的ORM框架
Entity Framework/Entity Framework Core 功能完備的框架
Nhibernate Java平臺上著名的Hibernate的.net版
等等

嗯，這是我最近找到的創(chuàng)作組還在更新的幾個框架，當(dāng)然還有其他的很多有趣好用的ORM框架。歡迎各位補充哈。

這一篇的主要目的不是介紹這些框架（這是以后的內(nèi)容），而是通過我們自己實現(xiàn)一個類ORM框架來了解底層核心。

2. 設(shè)計

我們先分析一下，如果我們設(shè)計一個實體對象與數(shù)據(jù)庫之間轉(zhuǎn)換的工具類應(yīng)該具有哪些功能？

一個屬性與數(shù)據(jù)庫字段的映射關(guān)系
增刪改查的SQL模板
查詢結(jié)果與對象的轉(zhuǎn)換

3. 實現(xiàn)

首先，聲明一個類，因為不能僅支持一種類型，所以這個類的所有與數(shù)據(jù)庫有關(guān)的方法都是泛型方法，或者這個類是泛型類，所以定義為泛型類：

public class OrmUtil<T>
{
}

我們事先約定類名即表名，屬性名即表的列名，所以我們可以快速得到以下內(nèi)容：

/// <summary>
/// T的類型實例
/// </summary>
private Type dType;
/// <summary>
/// T的屬性表
/// </summary>
private PropertyInfo[] properties;
public OrmUtil()
{
 dType = typeof(T);
 properties = dType.GetProperties();
}

聲明一個數(shù)據(jù)庫連接：

public SqlConnection Connection { get; set; }

創(chuàng)建一個私有方法，檢查連接是否可用：

/// <summary>
/// 檢查連接是否可用
/// </summary>
/// <returns></returns>
private bool CheckConnection()
{
 return Connection?.State == ConnectionState.Open;
}

準(zhǔn)備工作完成，然后開始編寫具體的業(yè)務(wù)方法：

Insert：

public int Insert(T entity)
{
 if (!CheckConnection()) return -1;// 檢查狀態(tài)
 var insert = $"insert into {dType.Name}({string.Join(",", properties.Select(t => t.Name))})";
 var values = properties.Select(p => p.GetValue(entity));
 var commandText = $"{insert} values('{string.Join("','", values)}')";

 var command = Connection.CreateCommand();
 command.CommandText = commandText;
 var result = command.ExecuteNonQuery();
 return result;
}

首先按照屬性名與列名之間的映射拼接 SQL，然后執(zhí)行SQL命令。

Update：

public int Update(T entity,string keyName,object keyValue)
{
 if (!CheckConnection()) return -1;
 var setValues = properties.ToDictionary(p => p.Name, p => $"'{p.GetValue(entity)}'");
 var setSql = string.Join(",", setValues.Select(pair=>$"{pair.Key}='{pair.Value}'"));
 var sql = $"update {dType.Name} set {setSql} where {keyName} = '{keyValue}'";
 var command = Connection.CreateCommand();
 command.CommandText = sql;
 return command.ExecuteNonQuery();
}

Update需要注意的就是如何正確拼接賦值sql。

Delete：

刪除滿足條件的對象：

public int Delete(T entity)
{
 if (!CheckConnection()) return -1;
 var querySet = properties.Select(p => $"{p.Name} = '{p.GetValue(entity)}'");
 var sql = $"delete from {dType.Name} where {string.Join(" and ", querySet)}";
 var command = Connection.CreateCommand();
 command.CommandText = sql;
 return command.ExecuteNonQuery();
}

這里寫法有時候根據(jù)實際業(yè)務(wù)不同，大多數(shù)情況下刪除主鍵對應(yīng)的元素，或者滿足某一個條件的所有元素。這里只是做了個演示，小伙伴們可以試試自己改造一下。

Search：

先創(chuàng)建一個從DataTable轉(zhuǎn)成對象的工具方法：

private List<T> Convert(DataTable table)
{
 var list = new List<T>(table.Rows.Count);//事先聲明一下容量
 foreach(DataRow row in table.AsEnumerable())
 {
  T entity = Activator.CreateInstance<T>();
  foreach(var p in properties)
  {
   if (!table.Columns.Contains(p.Name)) continue;// 如果屬性名不在表格中，則忽略
   p.SetValue(entity, row[p.Name]);
  }
  list.Add(entity);
 }
 return list;
}

好，我們寫一個查詢方法：

public List<T> SearchAll()
{
 var adapter = new SqlDataAdapter($"select * from {dType.Name}", Connection);
 var set = new DataSet();
 adapter.Fill(set);
 return Convert(set.Tables[0]);
}

這樣一個簡單的ORM框架就這樣形成雛形了，當(dāng)然實際上的ORM底層比這復(fù)雜，因為需要支持不同的數(shù)據(jù)庫，所以Connection 就不能簡簡單單的是一個SqlConnection了，或者底層不是像我們一樣取巧使用DataTable了。

實際上的DataTable到類對象的轉(zhuǎn)換要比我寫的復(fù)雜一點，因為還要判斷這個屬性是否是可讀、可寫的。

4. 總結(jié)

在這里我做了個拋磚引玉，帶領(lǐng)小伙伴們一起構(gòu)思了一個簡陋的ORM框架，也讓大伙對此有了一定的印象。嗯，今天就到這了。同時ADO.NET 也告一段落了，接下來就是上Entity Framework了。當(dāng)然，DataSet、DataAdapter這兩個類并沒有講完。這部分內(nèi)容可能會在后續(xù)的番外篇內(nèi)補全。

以上就是c# 如何自己實現(xiàn)一個ORM的詳細(xì)內(nèi)容，更多關(guān)于c# 自己實現(xiàn)一個ORM的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: