asp.net—自定义轻量级ORM
2024-10-15 14:05:25
大型项目中ORM的使用已经是相当的频繁。目前.NET(C#)中比较流行的ORM框架也有很多，比如SqlSugar，Dapper，Entity Framework(EF)等。
相信很多有2年以上工作经验的园友都会使用其中一种或者几种。同时多多少少也会存在有会用却不懂其中原理的园友（我算其中一个），所以凭借
工作之余独自钻研了一段时间，现在分享下我的钻研成果。 同时也希望园内大能者指出不足之处。
在工作中，本人觉得写SQL 查询数据还是挺方便。所以这个轻量级的ORM中对于查询还是使用写SQL的方式
下图就是主要的文件：
DataFieldAttribute.cs：实体映射表字段 特性（用于标注实体类中成员属性对应数据库中的字段名和字段类型）
PropertyAttribute.cs ：实体映射数据库表 特性（用于标注实体类对应数据库中哪个表）
DBCrateFactory.cs ：创建数据库对象的工厂（用于创建哪种数据库对象 MS SQL 还是 ORACLE）
SQLHelper.cs ：这是一个抽象函数。DBWorks文件夹下所有类都继承该抽象函数，这些子类就必须实现SQLHelper中的抽象方法同时也可以使用该抽象函数的公用方法
IWiteem.cs ： 对外接口
Witeem.cs ：继承并实现IWiteem接口
CommonHelper.cs ：通用工具类
DBWorks文件夹下存放的是数据库操作类（因为是DEMO，所以只设置了MS SQL和ORACLE）
Enum文件夹下存放的是需要使用到的一些枚举类（ColumnKeyType.cs 字段状态， DBEnum.cs 数据库类型）
下图是接口中提供的方法：
下载地址中的代码或许还存在少部分瑕疵，在每次发现并更改过程后我及时更新。
2018-06-26 Bug：
1、SQLHelper类的ExecuteQueryPage函数
2、CommonHelper类的 DataTableToObject<T> 和 DataTableToList<T>修改成根据DataFieldAttribute特性中的字段反射对应的值
public static T DataTableToObject<T>(DataTable dt, bool IsDataField) where T : new()
{
Type type = typeof(T);
string tempName = string.Empty;
T myt = new T();
PropertyInfo[] propertys = myt.GetType().GetProperties();
PropertyInfo[] array = propertys;
int i = ;
DataFieldAttribute attribute = null;
PropertyAttribute proAttribute = null;
while (i < array.Length)
{
PropertyInfo pi = array[i];
if (IsDataField)
{
object[] infos = null;
object[] pros = null;
infos = pi.GetCustomAttributes(typeof(DataFieldAttribute), false);
pros = pi.GetCustomAttributes(typeof(PropertyAttribute), false);
if (infos.Length > )
{
attribute = (DataFieldAttribute)(infos[]);
if (pros.Length>)
{
proAttribute = (PropertyAttribute)(pros[]);
if (proAttribute.columnKeyType != ColumnKeyType.Extend)
{
tempName = attribute.FieldName;
}
}else
tempName = attribute.FieldName;
}
}
else
tempName = pi.Name; if (dt.Columns.Contains(tempName))
{
if (pi.CanWrite)
{
object value = dt.Rows[][tempName];
if (value.GetType().Equals(typeof(DateTime)))
value = Convert.ToString(value);
if (value != DBNull.Value)
pi.SetValue(myt, value, null);
}
}
i += ;
continue;
}
return myt;
}
public static List<T> DataTableToList<T>(DataTable dt, bool IsDataField) where T : new()
{
List<T> ts = new List<T>();
Type type = typeof(T);
string tempName = string.Empty;
foreach (DataRow dr in dt.Rows)
{
T myt = new T();
PropertyInfo[] propertys = myt.GetType().GetProperties();
PropertyInfo[] array = propertys;
int i = ;
DataFieldAttribute attribute = null;
PropertyAttribute proAttribute = null;
while (i < array.Length)
{
PropertyInfo pi = array[i];
if (IsDataField)
{
object[] infos = null;
object[] pros = null;
infos = pi.GetCustomAttributes(typeof(DataFieldAttribute), false);
pros = pi.GetCustomAttributes(typeof(PropertyAttribute), false);
if (infos.Length > )
{
attribute = (DataFieldAttribute)(infos[]);
if (pros.Length > )
{
proAttribute = (PropertyAttribute)(pros[]);
if (proAttribute.columnKeyType != ColumnKeyType.Extend)
{
tempName = attribute.FieldName;
}
}
else
tempName = attribute.FieldName;
}
}
else
tempName = pi.Name;
if (dt.Columns.Contains(tempName))
{
if (pi.CanWrite)
{
object value = dr[tempName];
if (value.GetType().Equals(typeof(DateTime)))
value = System.Convert.ToString(value);
if (value != DBNull.Value)
pi.SetValue(myt, value, null);
}
}
i += ;
continue;
}
ts.Add(myt);
}
return ts;
}
2018-06-28 Bug：反射实体获取表字段时不是去特性中标注的字段名（现已修复）
1、修改工具类中的GetTableColumns函数（注释部分为旧的代码），GetTableColumns函数也做了相应的修改
public static List<string> GetTableColumns(PropertyInfo[] pis, ref List<PropertyInfo> proList, bool Isidentity = false)
{
List<string> columns = new List<string>();
object[] infos = null;
object[] fields = null;
DataFieldAttribute Fieldattribute = null;
PropertyAttribute attribute = null;
foreach (PropertyInfo pi in pis)
{
//获取此成员所有自定义特性
infos = pi.GetCustomAttributes(typeof(PropertyAttribute),false);
fields = pi.GetCustomAttributes(typeof(DataFieldAttribute), false);
if (fields.Length == )
{
continue;
}
Fieldattribute = (DataFieldAttribute)(fields[]);
if (infos.Length > )
{
attribute = (PropertyAttribute)(infos[]);
if (attribute == null)
{
//columns.Add(pi.Name);
columns.Add(Fieldattribute.FieldName);
proList.Add(pi);
}
else
{
switch (attribute.columnKeyType)
{
case ColumnKeyType.Extend: break;
case ColumnKeyType.Identity:
{
if (Isidentity)
{
//columns.Add(pi.Name);
columns.Add(Fieldattribute.FieldName);
proList.Add(pi);
}
}; break;
default:
{
//columns.Add(pi.Name);
columns.Add(Fieldattribute.FieldName);
proList.Add(pi);
};
break;
}
}
}
}
return columns;
}
2、MSSql.cs类 对于上述BUG做了修改
public override int Add<T>(IEnumerable<T> obj)
{
try
{
int i = ;
int result = ;
int success = ;
//Type type = obj.GetType();
Type type = typeof(T);
//获取表名
string tableName = CommonHelper.GetTableName(type);
PropertyInfo[] pis = type.GetProperties();
//获取所有字段，和主键名称
List<string> columns = null;
List<PropertyInfo> proList = new List<PropertyInfo>();
columns = CommonHelper.GetTableColumns(pis,ref proList, false);
//处理是否包含主键插入
//if (isIdentity)
//{
// columns = CommonHelper.GetTableColumns(pis, true);
//}
//else
//{
// columns = CommonHelper.GetTableColumns(pis, false);
//}
foreach (T item in obj)
{
//生成SQL语句
StringBuilder sqlText = new StringBuilder();
sqlText.Append(" INSERT INTO ");
sqlText.Append(tableName);
sqlText.Append(" (");
//第一个字段
sqlText.Append(columns[]);
//第二个起所有字段
int loop = columns.Count;
for (i = ; i < loop; i++)
{
sqlText.Append(",");
sqlText.Append(columns[i]);
}
sqlText.Append(") VALUES (");
//第一个字段
sqlText.Append("@");
sqlText.Append(columns[]);
//第二个起所有字段
for (i = ; i < loop; i++)
{
sqlText.Append(",@");
sqlText.Append(columns[i]);
}
sqlText.Append(");");
//生成SqlParamter
PropertyInfo propertyInfo = null;
List<SqlParameter> paras = new List<SqlParameter>();
for (i = ; i < loop; i++)
{
propertyInfo = proList[i];
SqlParameter para = new SqlParameter(columns[i], CommonHelper.GetSqlType(propertyInfo.PropertyType), -);
para.Value = propertyInfo.GetValue(item);
paras.Add(para);
}
result = ExecuteNonQuery(sqlText.ToString(), CommandType.Text, paras, false);
if (result > )
{
success += ;
}
}
if (conn.State == ConnectionState.Open)
{
ConColsed();
}
return success; }
catch (Exception ex)
{
execlog.Debug(DateTime.Now.ToString() + ": Add失败，原因【" + ex.ToString() + "】");
return -;
}
}
public override int Delete<T>(IEnumerable<T> obj)
{
try
{
int result = ;
int success = ;
//Type type = obj.GetType();
Type type = typeof(T);
//获取表名
string tableName = CommonHelper.GetTableName(type);
PropertyInfo[] pis = type.GetProperties();
PropertyInfo identityInfo = null;
identityInfo = CommonHelper.GetTableIdentity(pis);
string identityName = CommonHelper.GetIdentityName(pis);
if (identityInfo == null)
{
return ;
}
if (string.IsNullOrEmpty(identityName))
{
identityName = identityInfo.Name;
}
foreach (T item in obj)
{
//生成SQL语句
StringBuilder sqlText = new StringBuilder();
sqlText.Append(" DELETE FROM ");
sqlText.Append(tableName);
sqlText.Append(" WHERE 1=1 ");
//主键筛选
sqlText.Append(" AND " + identityName);
sqlText.Append("=@" + identityName);
//生成SqlParamter
List<SqlParameter> paras = new List<SqlParameter>();
SqlParameter para = new SqlParameter(identityName, CommonHelper.GetSqlType(identityInfo.PropertyType), -);
para.Value = identityInfo.GetValue(item);
paras.Add(para);
result = ExecuteNonQuery(sqlText.ToString(), CommandType.Text, paras,false);
if (result>)
{
success += ;
}
}
if (conn.State == ConnectionState.Open)
{
ConColsed();
}
return success;
}
catch (Exception ex)
{
execlog.Debug(DateTime.Now.ToString() + ": Delete失败，原因【" + ex.ToString() + "】");
return -;
}
}
public override int Update<T>(IEnumerable<T> obj)
{
try
{
int i = ;
int result = ;
int success = ;
//Type type = obj.GetType();
Type type = typeof(T);
//获取表名
string tableName = CommonHelper.GetTableName(type);
PropertyInfo[] pis = type.GetProperties();
//获取所有字段，和主键名称
string identityName = CommonHelper.GetIdentityName(pis);
//获取主键名称
PropertyInfo identityInfo = null;
identityInfo = CommonHelper.GetTableIdentity(pis);
if (identityInfo == null)
{
return ;
}
if (string.IsNullOrEmpty(identityName))
{
identityName = identityInfo.Name;
}
List<string> columns = null;
List<PropertyInfo> proList = new List<PropertyInfo>();
//获取所有字段名称
columns = CommonHelper.GetTableColumns(pis, ref proList, true);
foreach (T item in obj)
{
//生成SQL语句
StringBuilder sqlText = new StringBuilder();
int loop = columns.Count;
sqlText.Append(" UPDATE ");
sqlText.Append(tableName);
sqlText.Append(" SET ");
//第二个起所有字段
for (i = ; i < loop; i++)
{
//判断第一个字段是否为主键
if (columns[i] == identityName)
{
continue;
}
sqlText.Append(columns[i] + "=@" + columns[i]);
if (i < loop - )
{
sqlText.Append(",");
}
}
//主键筛选
sqlText.Append(" WHERE " + identityName);
sqlText.Append("=@" + identityName);
//生成SqlParamter
List<SqlParameter> paras = new List<SqlParameter>();
PropertyInfo propertyInfo = null;
for (i = ; i < loop; i++)
{
propertyInfo = proList[i];
SqlParameter para = new SqlParameter(columns[i], CommonHelper.GetSqlType(propertyInfo.PropertyType), -);
para.Value = propertyInfo.GetValue(item);
paras.Add(para);
}
result = ExecuteNonQuery(sqlText.ToString(), CommandType.Text, paras,false);
if (result>)
{
success += ;
}
}
if (conn.State == ConnectionState.Open)
{
ConColsed();
}
return success;
}
catch (Exception ex)
{
execlog.Debug(DateTime.Now.ToString() + ": Update失败，原因【" + ex.ToString() + "】");
return -;
} }
public override T GetModel<T>(string id)
{
int i = ;
Type type = typeof(T);
T myT = new T();
//获取表名
string tableName = CommonHelper.GetTableName(type); PropertyInfo[] pis = type.GetProperties();
PropertyInfo identityInfo = null;
identityInfo = CommonHelper.GetTableIdentity(pis);
string identityName = CommonHelper.GetIdentityName(pis);
if (identityInfo == null)
{
return default(T);
}
if (string.IsNullOrEmpty(identityName))
{
identityName = identityInfo.Name;
}
//获取所有字段，和主键名称
List<string> columns = null;
List<PropertyInfo> proList = new List<PropertyInfo>();
//获取所有字段名称
List<ColumnKeyType> filterList = new List<ColumnKeyType>();
filterList.Add(ColumnKeyType.Default);
filterList.Add(ColumnKeyType.Read);
filterList.Add(ColumnKeyType.Identity);
columns = CommonHelper.GetTableColumns(pis, ref proList, true);
//生成SQL语句
StringBuilder sqlText = new StringBuilder();
sqlText.Append(" SELECT ");
//第一个字段
sqlText.Append(columns[]);
//第二个起所有字段
int loop = columns.Count;
for (i = ; i < loop; i++)
{
sqlText.Append(",");
sqlText.Append(columns[i]);
}
sqlText.Append(" FROM ");
sqlText.Append(tableName);
sqlText.Append(" WHERE 1=1 AND ");
sqlText.Append(identityName + "=@" + identityName);
//生成SqlParamter
List<SqlParameter> paras = new List<SqlParameter>();
SqlParameter para = new SqlParameter(identityName, CommonHelper.GetSqlType(identityInfo.PropertyType), -);
para.Value = id;
paras.Add(para);
return GetModel<T>(sqlText.ToString(), CommandType.Text, paras);
}
3、事务处理应先打开数据库连接
2018-12-13 获取所有字段名称的地方加入缓存机制，目的是避免每次执行都需要去获取字段名称数据集，提高效率：
Update 和 GetModel 方法的缓存机制
//获取所有字段名称(缓存处理)
if (CacheHelper.GetCache(tableName) != null)
{
columns = (List<string>)CacheHelper.GetCache(tableName);
}
else
{
columns = CommonHelper.GetTableColumns(pis, ref proList, true);
CacheHelper.SetCache(tableName, columns, Cache.NoAbsoluteExpiration, TimeSpan.FromMinutes());
}
Add方法的缓存机制：
//获取所有字段名称(缓存处理)
if (CacheHelper.GetCache(tableName + isIdentity.ToString()) != null)
{
columns = (List<string>)CacheHelper.GetCache(tableName + isIdentity.ToString());
}
else
{
columns = CommonHelper.GetTableColumns(pis, ref proList, isIdentity);
CacheHelper.SetCache(tableName + isIdentity.ToString(), columns, Cache.NoAbsoluteExpiration, TimeSpan.FromMinutes());
}
github下载地址：https://github.com/witeem/ASP.NET-ORM.git
最新文章
- winform对话框控件、打印控件
- Kindle Unlimited上的技术书籍
- XE3随笔20:几个和当前路径相关的新函数
- WebFrom 的js日期控件
- javascript 原型详解
- web工程 所需是jar包总结
- SQL Server 脚本
- 【Android】以SimpleAdapter做适配器的ListView和GridView
- mac 卸载通过官网下载包安装的node
- Loj #3093. 「BJOI2019」光线
- SpringBoot--web版的ocr
- APP打包提交审核的步骤
- centos6.5环境下zookeeper-3.4.6集群环境部署及单机部署详解
- Ubuntu16.04 上安装MySQL5.7
- python 学习 map /reduce
- .net4.0、.net4.5、.net4.6 三者对系统的要求
- spring学习九 spring aop详解
- 理解 Azure 平台中虚拟机的计算能力
- 进程和线程（3）-ThreadLocal
- js 字符中 带 函数 再传对象参数