C#.Net如何手写ORM

快速认识ORM

对象-关系映射，即Object/Relation Mapping，主要实现程序对象到关系数据库的映射。现在.Net比较流行的ORM框架有：EF、SqlSugar、Dapper、FreeSql、Nhibernate、IBatis.Net等。
O/RM只是一层代码的封装，底层还是基于ADO.NET完成对数据库的访问。
一般写法

如果我们要写一个查询，用ADO.NET就会如下这样写。

1. private static string ConnectionStringCustomers = "Data Source=.;Database=Customers;" +
2.     "User ID=sa;Password=123456;MultipleActiveResultSets=True";
4. public Company FindCompany(int id)
5. {
6.     string sql = $@"
7.         SELECT [Id],[Name],[CreateTime],[CreatorId],
8.                [LastModifierId],[LastModifyTime]
9.         FROM [dbo].[Company]
10.         WHERE ID = {id}";
11.     using (SqlConnection conn = new SqlConnection(ConnectionStringCustomers))
12.     {
13.         SqlCommand command = new SqlCommand(sql, conn);
14.         conn.Open();
15.         var reader = command.ExecuteReader();
16.         if (reader.Read())
17.         {
18.             Company company = new Company()
19.             {
20.                 Id = (int)reader["Id"],
21.                 Name = reader["Name"].ToString()
22.             };
23.             return company;
24.         }
25.         else
26.         {
27.             return null;
28.         }
29.     }
30. }

复制代码

1. public abstract class BaseModel
2. {
3.     public int Id { set; get; }
4. }   
5. public class Company : BaseModel
6. {
7.     public string Name { get; set; }
9.     public DateTime CreateTime { get; set; }
11.     public int CreatorId { get; set; }
13.     public int? LastModifierId { get; set; }
15.     public DateTime? LastModifyTime { get; set; }
16. }

复制代码

但这样的写法是写死了的，我们能不能写一个通用查询，不管他是哪张表。
通用写法

既然要通用，那就不能写死类型，我们想到了使用泛型。泛型是任何类型都可以用，为了保证类型正确，我们再加泛型约束。
为了得到属性，我们要使用反射获取。

1. public T Find<T>(int id) where T : BaseModel // 泛型约束，必须继承自BaseModel
2. {
3.     string colums = string.Join(",", typeof(T).GetProperties().Select(p => $"[{p.Name}]").ToArray());
4.     string sql = $"SELECT {colums} FROM [{typeof(T).Name}] WHERE Id={id}";
6.     using (SqlConnection conn = new SqlConnection(ConnectionStringCustomers))
7.     {
8.         SqlCommand command = new SqlCommand(sql, conn);
9.         conn.Open();
10.         var reader = command.ExecuteReader();
11.         if (reader.Read())
12.         {
13.             // 反射实例化
14.             T t = Activator.CreateInstance<T>();
15.             foreach (var property in typeof(T).GetProperties())
16.             {
17.                 property.SetValue(t, reader[property.Name] is DBNull ? null : reader[property.Name]);
18.             }
19.             return t;
20.         }
21.         else
22.         {
23.             return null;
24.         }
25.     }
26.     return default(T);
27. }

复制代码

上述的方法，使用泛型和反射使我们的查询可以通用。
然后使用Company Company = sqlHelper.Find(1);来调用得到实体。
但是，我们还有一个问题，如果我们的表名和实体类名称不一样，或字段名不一样，比如：表名为Sys_Company而实体名为Company，那我们该如何映射？
这里我们打算用C#的特性来解决这一问题。
首先，创建用来映射的特性类。

1. public class AbstractMappingAttribute : Attribute
2. {
3.     public string MappingName = null;
4.     public AbstractMappingAttribute(string mappingName)
5.     {
6.         this.MappingName = mappingName;
7.     }
8. }

复制代码

映射表名。

1. [AttributeUsage(AttributeTargets.Class)]
2. public class DBProxyTableAttribute: AbstractMappingAttribute
3. {
4.     public DBProxyTableAttribute(string tableName) : base(tableName){}
5. }

复制代码

映射列名。

1.     [AttributeUsage(AttributeTargets.Property)]
2.     public class DBProxyColumnAttribute : AbstractMappingAttribute
3.     {
4.         public DBProxyColumnAttribute(string columnName):base(columnName) {}
5.     }

复制代码

在类名上添加特性。

1. [DBProxyTable("Sys_Company")]
2. public class Company : BaseModel
3. {
4.     [DBProxyColumn("Company_Name")]
5.     public string Name { get; set; }
6.     ......
7. }

复制代码

获取实体类名或属性上的特性值来映射数据库的方法。

1. public static class DBProxyMappingExtension
2. {
3.     public static string GetMappingName(this MemberInfo member)
4.     {
5.         string name = null;
6.         if (member.IsDefined(typeof(AbstractMappingAttribute), true))
7.         {
8.             var attribute = member.GetCustomAttribute<AbstractMappingAttribute>();
9.             name = attribute.MappingName;
10.         }
11.         else
12.         {
13.             name = member.Name;
14.         }
15.         return name;
16.     }
17. }

复制代码

最后，重新修改通用方法。

1. public T Find<T>(int id) where T : BaseModel // 泛型约束，必须继承自BaseModel
2. {
3.     //string colums = string.Join(",", typeof(T).GetProperties().Select(p => $"[{p.Name}]").ToArray());
4.     string colums = string.Join(",", typeof(T).GetProperties().Select(p => $"[{p.GetMappingName()}]").ToArray());
6.     //string sql = $"SELECT {colums} FROM [{typeof(T).Name}] WHERE Id={id}";
7.     string sql = $"SELECT {colums} FROM [{typeof(T).GetMappingName()}] WHERE Id={id}";
9.     using (SqlConnection conn = new SqlConnection(ConnectionStringCustomers))
10.     {
11.         SqlCommand command = new SqlCommand(sql, conn);
12.         conn.Open();
13.         var reader = command.ExecuteReader();
14.         if (reader.Read())
15.         {
16.             // 反射实例化
17.             T t = Activator.CreateInstance<T>();
18.             foreach (var property in typeof(T).GetProperties())
19.             {
20.                 //property.SetValue(t, reader[property.Name] is DBNull ? null : reader[property.Name]);
21.                 property.SetValue(t, reader[property.GetMappingName()] is DBNull ? null : reader[property.GetMappingName()]);
22.             }
23.             return t;
24.         }
25.         else
26.         {
27.             return null;
28.         }
29.     }
30.     return default(T);
31. }

复制代码