手寫ORM入門篇（一）

物件關係對映（英語：(Object Relational Mapping，簡稱ORM，或O/RM，或O/R mapping），是一種程式技術，用於實現物件導向程式語言裡不同型別系統的資料之間的轉換 [1]  。從效果上說，它其實是建立了一個可在程式語言裡使用的--“虛擬物件資料庫”。

物件導向是從軟體工程基本原則（如耦合、聚合、封裝）的基礎上發展起來的，而關聯式資料庫則是從數學理論發展而來的，兩套理論存在顯著的區別。為了解決這個不匹配的現象，物件關係對映技術應運而生。

物件關係對映（Object-Relational Mapping）提供了概念性的、易於理解的模型化資料的方法。ORM方法論基於三個核心原則： 簡單：以最基本的形式建模資料。 傳達性：資料庫結構被任何人都能理解的語言文件化。 精確性：基於資料模型建立正確標準化的結構。 典型地，建模者通過收集來自那些熟悉應用程式但不熟練的資料建模者的人的資訊開發資訊模型。建模者必須能夠用非技術企業專家可以理解的術語在概念層次上與資料結構進行通訊。建模者也必須能以簡單的單元分析資訊，對樣本資料進行處理。ORM專門被設計為改進這種聯絡。

簡單的說：ORM相當於中繼資料。具體到產品上，例如ADO.NET Entity Framework。DLINQ中實體類的屬性[Table]就算是一種中繼資料。

BaseModel示例程式碼：

    public class BaseModel
    {
        /// <summary>
        /// 描述所有表的非自動主鍵GUID
        /// </summary>
        public string Id { set; get; }
    }

User示例程式碼：

    public class User : BaseModel
    {
        public string Account { get; set; }

        public string Password { get; set; }

        public string Name { get; set; }

        public int Sex { get; set; }

        public int Status { get; set; }

        public string BizCode { get; set; }

        public DateTime CreateTime { get; set; }

        public string CrateId { get; set; }

        public string TypeName { get; set; }

        public string TypeId { get; set; }

    }

IBaseDAL示例程式碼：

 public interface IBaseDAL
    {
        T Find<T>(string id) where T : BaseModel;
        List<T> FindAll<T>() where T : BaseModel;
        bool Add<T>(T t) where T : BaseModel;
        bool Update<T>(T t) where T : BaseModel;
        bool Delete<T>(T t) where T : BaseModel;
    }

BaseDAL示例程式碼

    /// <summary>
    /// 泛型方法新增BaseModel約束，所有實體類必須有一個非自增的主鍵Id，Id的值為隨機的GUID,
    /// </summary>
    public class BaseDAL : IBaseDAL
    {
        /// <summary>
        /// 資料庫連線字串
        /// </summary>
        private static string ConnectionString = ConfigurationManager.ConnectionStrings["OpenAuthDB"].ConnectionString;

        public bool Add<T>(T t) where T : BaseModel
        {
            Type type = t.GetType();
            string columnStr = string.Join(",", type.GetProperties(BindingFlags.Instance | BindingFlags.Public).Select(p => $"[{p.Name}]"));
            string valueStr = string.Join(",", type.GetProperties(BindingFlags.Instance | BindingFlags.Public).Select(p => $"@{p.Name}"));
            var parameterList = type.GetProperties(BindingFlags.Instance | BindingFlags.Public).Select(p => new SqlParameter($"@{p.Name}", p.GetValue(t) ?? DBNull.Value));
            string sqlStr = $"Insert Into [{type.Name}] ({columnStr}) values ({valueStr})";
            using (SqlConnection conn = new SqlConnection(ConnectionString))
            {
                SqlCommand command = new SqlCommand(sqlStr, conn);
                command.Parameters.AddRange(parameterList.ToArray());
                conn.Open();
                //如果Id是自增的，在sql後面增加個 Select @@Identity; command.ExecuteScalar，新增後把Id拿出來.
                return command.ExecuteNonQuery() > 0;
            }
        }

        public bool Delete<T>(T t) where T : BaseModel
        {
            //獲取T的型別
            Type type = typeof(T);
            var parameter = new SqlParameter("Id", type.GetProperty("Id").GetValue(t) ?? DBNull.Value);
            string strSql = $"DELETE FROM [{type.Name}] WHERE Id = @Id";
            using (SqlConnection conn = new SqlConnection(ConnectionString))
            {
                SqlCommand command = new SqlCommand(strSql, conn);
                command.Parameters.Add(parameter);
                conn.Open();
                var iRes = command.ExecuteNonQuery();
                return iRes > 0 ? true : false;
            }
        }

        public List<T> FindAll<T>() where T : BaseModel
        {
            Type type = typeof(T);
            string sqlStr = $"SELECT {string.Join(",", type.GetProperties().Select(p => $"[{p.Name}]"))} FROM [{type.Name}]";
            List<T> list = new List<T>();
            using (SqlConnection conn = new SqlConnection(ConnectionString))
            {
                SqlCommand command = new SqlCommand(sqlStr, conn);
                conn.Open();
                var reader = command.ExecuteReader();
                while (reader.Read())
                {
                    list.Add(this.Trans<T>(type, reader));
                }
            }
            return list;
        }

        public T Find<T>(string id) where T : BaseModel
        {
            Type type = typeof(T);
            string sql = $"SELECT {string.Join(",", type.GetProperties().Select(p => $"[{p.Name}]"))} FROM [{type.Name}] WHERE ID = '{id}' ";
            object oObject = Activator.CreateInstance(type);
            using (SqlConnection conn = new SqlConnection(ConnectionString))
            {
                SqlCommand command = new SqlCommand(sql, conn);
                conn.Open();
                var reader = command.ExecuteReader();
                if (reader.Read())
                    return this.Trans<T>(type, reader);
                else
                    return default(T);
            }
        }

        public bool Update<T>(T t) where T : BaseModel
        {
            Type type = typeof(T);
            StringBuilder sb = new StringBuilder();
            sb.Append($"UPDATE [{type.Name}] SET ");
            var propArray = type.GetProperties(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public);
            var propArrayLen = propArray.Count();
            for (int i = 0; i < propArrayLen; i++)
            {
                var propertiesName = propArray[i].Name;
                if (i != propArrayLen - 1)
                    sb.Append($"{propertiesName} = @{propertiesName}, ");
                else
                    sb.Append($" {propertiesName} = @{propertiesName} ");
            }
            #region 使用foreach的寫法
            //foreach (var properties in propArray)
            //{
            //    var propertiesName = properties.Name;
            //    if (i != propArrayLen)
            //        sb.Append($"{propertiesName} = @{propertiesName}, ");
            //    else
            //        sb.Append($" {propertiesName} = @{propertiesName} ");
            //    i++;
            //}
            #endregion
            sb.Append($" Where Id = @Id;");
            var parameterList = type.GetProperties(BindingFlags.Instance | BindingFlags.Public).Select(p => new SqlParameter($"@{p.Name}", p.GetValue(t) ?? DBNull.Value));
            using (SqlConnection conn = new SqlConnection(ConnectionString))
            {
                SqlCommand command = new SqlCommand(sb.ToString(), conn);
                command.Parameters.AddRange(parameterList.ToArray());
                conn.Open();
                return command.ExecuteNonQuery() > 0;
            }
        }

        #region Private Method
        private T Trans<T>(Type type, SqlDataReader reader)
        {
            object oObject = Activator.CreateInstance(type);
            foreach (var properties in type.GetProperties())
            {
                properties.SetValue(oObject, reader[properties.Name] ?? DBNull.Value);
            }
            return (T)oObject;
        }
        #endregion
    }