C# 數據操做系列 - 4. 本身實現一個ORM

0. 前言

在以前的幾篇內容中，咱們瞭解瞭如何經過ADO.NET 訪問數據庫，如何修改、新增數據。如何經過DataSet和DataAdapter獲取數據，咱們將在這一篇試試本身實現一個簡單的ORM框架或者說ORM工具類。

涉及到的知識點：

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

1. ORM

那麼，問題來了，什麼是ORM？ORM全稱 Object Relational Mapping，翻譯過來就是對象關係映射。是一種經過描述對象與數據庫之間映射關係的數據，將對象保存到數據庫中的技術。

在C#中，曾經Entity Framework光芒萬丈，遮蓋了其餘ORM框架的光輝（甚至現在都是如此）。

後來慢慢涌現除了其餘的一些ORM框架，進一步豐富了市場。因此現有比較流行的大概有如下幾種：

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

嗯，這是我最近找到的創做組還在更新的幾個框架，固然還有其餘的不少有趣好用的ORM框架。歡迎各位補充哈。

這一篇的主要目的不是介紹這些框架（這是之後的內容），而是經過咱們本身實現一個類ORM框架來了解底層核心。

2. 設計

咱們先分析一下，若是咱們設計一個實體對象與數據庫之間轉換的工具類應該具備哪些功能？

• 一個屬性與數據庫字段的映射關係
• 增刪改查的SQL模板
• 查詢結果與對象的轉換

3. 實現

首先，聲明一個類，由於不能僅支持一種類型，因此這個類的全部與數據庫有關的方法都是泛型方法，或者這個類是泛型類，因此定義爲泛型類：

public class OrmUtil<T>
{
}

咱們事先約定類名即表名，屬性名即表的列名，因此咱們能夠快速獲得如下內容：

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

聲明一個數據庫鏈接：

public SqlConnection Connection { get; set; }

建立一個私有方法，檢查鏈接是否可用：

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

準備工做完成，而後開始編寫具體的業務方法：

Insert：

public int Insert(T entity)
{
    if (!CheckConnection()) return -1;// 檢查狀態
    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，而後執行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();
}

這裏寫法有時候根據實際業務不一樣，大多數狀況下刪除主鍵對應的元素，或者知足某一個條件的全部元素。這裏只是作了個演示，小夥伴們能夠試試本身改造一下。

Search：

先建立一個從DataTable轉成對象的工具方法：

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框架就這樣造成雛形了，固然實際上的ORM底層比這複雜，由於須要支持不一樣的數據庫，因此Connection 就不能簡簡單單的是一個SqlConnection了，或者底層不是像咱們同樣取巧使用DataTable了。

實際上的DataTable到類對象的轉換要比我寫的複雜一點，由於還要判斷這個屬性是不是可讀、可寫的。

4. 總結

在這裏我作了個拋磚引玉，帶領小夥伴們一塊兒構思了一個簡陋的ORM框架，也讓大夥對此有了必定的印象。嗯，今天就到這了。同時ADO.NET 也告一段落了，接下來就是上Entity Framework了。固然，DataSet、DataAdapter這兩個類並無講完。這部份內容可能會在後續的番外篇內補全。

更多內容煩請關注個人博客《高先生小屋》