用C#打造自己的通用数据访问类库(续)

昵称29801243 2015-12-29

展开全文

说明：此篇文章是给那些和我一样仍在使用ADO.NET访问数据库的.NET开发人员写的，因为某些原因，比如还在使用.NET3.0以下版本开发.NET应用或者所使用的数据库对ORM支持不是很好，或者是对ORM的性能有所怀疑（其实在访问量不是很大的情况下没有必要过分追求性能的极限）等等，这部分人仍在使用传统的ADO.NET来访问数据库，他们或手写或采用代码生成工具来生成实体类和增删改查的SQL语句，在将DataTable或者DataReader转换成对应的实体类的时候仍需要一行行写代码，本类就是为了解决这个问题的，可以用几个类来实现方便快捷的转换。本类库在SQL Server/MySQL/SQLite下测试通过，由于条件有限未在所有的数据库下测试，如果有问题请在此留言或者在周公的微博留言(http://weibo.com/zhoufoxcn)。

其实在写这套类库之前，去年周公就写了两篇有关的文章，一篇叫《用C#打造自己的实体转换器》，另一篇叫《利用ADO.NET的体系架构打造通用的数据库访问通用类》（两篇文章的阅读地址会在文末给出），本篇的代码就是在这两篇文章的基础上经过实际应用修改而成，主要是修正了几个问题：1.如果在SELECT子句的字段中不包含对应实体类的某个属性，那么该属性的值就为它对应Type的默认值（如int,short为0,引用类型为null)，而不是像以前那样用Ignorable，因为有些属性可能在某个查询中需要而在另外一个查询中不需要，采用Ignorable这样的Attribute的话太武断；2.修正了在泛型类型时的错误；3.在类的属性类型中除了支持常见数据类型（数值类型、可空类型和string）之外，还支持byte[]这种常见的数据类型。

本类库共有5个类：DbProviderType、ProviderFactory、DbUtility、EntityReader、ColumnNameAttribute。

其中DbProviderType、ProviderFactory、DbUtility三个类的相关代码如下：

using System; 
using System.Collections.Generic; 
using System.Data; 
using System.Data.Common; 
 
namespace NetSkycn.Data 
{ 
    ///  
    /// 通用数据库访问类，封装了对数据库的常见操作 
    /// 作者：周公 
    /// 创建日期：2011-07-18 
    /// 修改日期：2012-04-12 
    /// 新浪微博地址：http://weibo.com/zhoufoxcn 
    ///  
    public sealed class DbUtility 
    { 
        public string ConnectionString { get; set; } 
        private DbProviderFactory providerFactory; 
        ///  
        /// 构造函数 
        ///  
        /// 数据库连接字符串 
        /// 数据库类型枚举，参见 
        public DbUtility(string connectionString, DbProviderType providerType) 
        { 
            ConnectionString = connectionString; 
            providerFactory = ProviderFactory.GetDbProviderFactory(providerType); 
            if (providerFactory == null) 
            { 
                throw new ArgumentException('Can't load DbProviderFactory for given value of providerType'); 
            } 
        } 
        ///     
        /// 对数据库执行增删改操作，返回受影响的行数。    
        ///     
        /// 要执行的增删改的SQL语句    
        /// 执行增删改语句所需要的参数 
        ///    
        public int ExecuteNonQuery(string sql, IList parameters) 
        { 
            return ExecuteNonQuery(sql, parameters, CommandType.Text); 
        } 
        ///     
        /// 对数据库执行增删改操作，返回受影响的行数。    
        ///     
        /// 要执行的增删改的SQL语句    
        /// 执行增删改语句所需要的参数 
        /// 执行的SQL语句的类型 
        ///  
        public int ExecuteNonQuery(string sql, IList parameters, CommandType commandType) 
        { 
            using (DbCommand command = CreateDbCommand(sql, parameters, commandType)) 
            { 
                command.Connection.Open(); 
                int affectedRows = command.ExecuteNonQuery(); 
                command.Connection.Close(); 
                return affectedRows; 
            } 
        } 
 
        ///     
        /// 执行一个查询语句，返回一个关联的DataReader实例    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        ///   
        public DbDataReader ExecuteReader(string sql, IList parameters) 
        { 
            return ExecuteReader(sql, parameters, CommandType.Text); 
        } 
 
        ///     
        /// 执行一个查询语句，返回一个关联的DataReader实例    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        /// 执行的SQL语句的类型 
        ///   
        public DbDataReader ExecuteReader(string sql, IList parameters, CommandType commandType) 
        { 
            DbCommand command = CreateDbCommand(sql, parameters, commandType); 
            command.Connection.Open(); 
            return command.ExecuteReader(CommandBehavior.CloseConnection); 
        } 
 
        ///     
        /// 执行一个查询语句，返回一个包含查询结果的DataTable    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        ///  
        public DataTable ExecuteDataTable(string sql, IList parameters) 
        { 
            return ExecuteDataTable(sql, parameters, CommandType.Text); 
        } 
        ///     
        /// 执行一个查询语句，返回一个包含查询结果的DataTable    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        /// 执行的SQL语句的类型 
        ///  
        public DataTable ExecuteDataTable(string sql, IList parameters, CommandType commandType) 
        { 
            using (DbCommand command = CreateDbCommand(sql, parameters, commandType)) 
            { 
                using (DbDataAdapter adapter = providerFactory.CreateDataAdapter()) 
                { 
                    adapter.SelectCommand = command; 
                    DataTable data = new DataTable(); 
                    adapter.Fill(data); 
                    return data; 
                } 
            } 
        } 
 
        ///     
        /// 执行一个查询语句，返回查询结果的第一行第一列    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数    
        ///     
        public Object ExecuteScalar(string sql, IList parameters) 
        { 
            return ExecuteScalar(sql, parameters, CommandType.Text); 
        } 
 
        ///     
        /// 执行一个查询语句，返回查询结果的第一行第一列    
        ///     
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数    
        /// 执行的SQL语句的类型 
        ///     
        public Object ExecuteScalar(string sql, IList parameters, CommandType commandType) 
        { 
            using (DbCommand command = CreateDbCommand(sql, parameters, commandType)) 
            { 
                command.Connection.Open(); 
                object result = command.ExecuteScalar(); 
                command.Connection.Close(); 
                return result; 
            } 
        } 
 
        ///  
        /// 查询多个实体集合 
        ///  
        /// 返回的实体集合类型 
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        ///  
        public List QueryForList(string sql, IList parameters) where T : new() 
        { 
            return QueryForList(sql, parameters, CommandType.Text); 
        } 
 
        ///  
        ///  查询多个实体集合 
        ///  
        /// 返回的实体集合类型 
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数    
        /// 执行的SQL语句的类型 
        ///  
        public List QueryForList(string sql, IList parameters, CommandType commandType) where T : new() 
        { 
            DataTable data = ExecuteDataTable(sql, parameters, commandType); 
            return EntityReader.GetEntities(data); 
        } 
        ///  
        /// 查询单个实体 
        ///  
        /// 返回的实体集合类型 
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        ///  
        public T QueryForObject(string sql, IList parameters) where T : new() 
        { 
            return QueryForObject(sql, parameters, CommandType.Text); 
        } 
 
        ///  
        /// 查询单个实体 
        ///  
        /// 返回的实体集合类型 
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数    
        /// 执行的SQL语句的类型 
        ///  
        public T QueryForObject(string sql, IList parameters, CommandType commandType) where T : new() 
        { 
            return QueryForList(sql, parameters, commandType)[0]; 
        } 
 
        public DbParameter CreateDbParameter(string name, object value) 
        { 
            return CreateDbParameter(name, ParameterDirection.Input, value); 
        } 
 
        public DbParameter CreateDbParameter(string name, ParameterDirection parameterDirection, object value) 
        { 
            DbParameter parameter = providerFactory.CreateParameter(); 
            parameter.ParameterName = name; 
            parameter.Value = value; 
            parameter.Direction = parameterDirection; 
            return parameter; 
        } 
 
        ///  
        /// 创建一个DbCommand对象 
        ///  
        /// 要执行的查询语句    
        /// 执行SQL查询语句所需要的参数 
        /// 执行的SQL语句的类型 
        ///  
        private DbCommand CreateDbCommand(string sql, IList parameters, CommandType commandType) 
        { 
            DbConnection connection = providerFactory.CreateConnection(); 
            DbCommand command = providerFactory.CreateCommand(); 
            connection.ConnectionString = ConnectionString; 
            command.CommandText = sql; 
            command.CommandType = commandType; 
            command.Connection = connection; 
            if (!(parameters == null || parameters.Count == 0)) 
            { 
                foreach (DbParameter parameter in parameters) 
                { 
                    command.Parameters.Add(parameter); 
                } 
            } 
            return command; 
        } 
    } 
    ///  
    /// 数据库类型枚举 
    ///  
    public enum DbProviderType : byte 
    { 
        SqlServer, 
        MySql, 
        SQLite, 
        Oracle, 
        ODBC, 
        OleDb, 
        Firebird, 
        PostgreSql, 
        DB2, 
        Informix, 
        SqlServerCe 
    } 
    ///  
    /// DbProviderFactory工厂类 
    ///  
    public class ProviderFactory 
    { 
        private static Dictionary<>string> providerInvariantNames = new Dictionary<>string>(); 
        private static Dictionary providerFactoies = new Dictionary(20); 
        static ProviderFactory() 
        { 
            //加载已知的数据库访问类的程序集 
            providerInvariantNames.Add(DbProviderType.SqlServer, 'System.Data.SqlClient'); 
            providerInvariantNames.Add(DbProviderType.OleDb, 'System.Data.OleDb'); 
            providerInvariantNames.Add(DbProviderType.ODBC, 'System.Data.ODBC'); 
            providerInvariantNames.Add(DbProviderType.Oracle, 'Oracle.DataAccess.Client'); 
            providerInvariantNames.Add(DbProviderType.MySql, 'MySql.Data.MySqlClient'); 
            providerInvariantNames.Add(DbProviderType.SQLite, 'System.Data.SQLite'); 
            providerInvariantNames.Add(DbProviderType.Firebird, 'FirebirdSql.Data.Firebird'); 
            providerInvariantNames.Add(DbProviderType.PostgreSql, 'Npgsql'); 
            providerInvariantNames.Add(DbProviderType.DB2, 'IBM.Data.DB2.iSeries'); 
            providerInvariantNames.Add(DbProviderType.Informix, 'IBM.Data.Informix'); 
            providerInvariantNames.Add(DbProviderType.SqlServerCe, 'System.Data.SqlServerCe'); 
        } 
        ///  
        /// 获取指定数据库类型对应的程序集名称 
        ///  
        /// 数据库类型枚举 
        ///  
        public static string GetProviderInvariantName(DbProviderType providerType) 
        { 
            return providerInvariantNames[providerType]; 
        } 
        ///  
        /// 获取指定类型的数据库对应的DbProviderFactory 
        ///  
        /// 数据库类型枚举 
        ///  
        public static DbProviderFactory GetDbProviderFactory(DbProviderType providerType) 
        { 
            //如果还没有加载，则加载该DbProviderFactory 
            if (!providerFactoies.ContainsKey(providerType)) 
            { 
                providerFactoies.Add(providerType, ImportDbProviderFactory(providerType)); 
            } 
            return providerFactoies[providerType]; 
        } 
        ///  
        /// 加载指定数据库类型的DbProviderFactory 
        ///  
        /// 数据库类型枚举 
        ///  
        private static DbProviderFactory ImportDbProviderFactory(DbProviderType providerType) 
        { 
            string providerName = providerInvariantNames[providerType]; 
            DbProviderFactory factory = null; 
            try 
            { 
                //从全局程序集中查找 
                factory = DbProviderFactories.GetFactory(providerName); 
            } 
            catch (ArgumentException e) 
            { 
                factory = null; 
            } 
            return factory; 
        } 
    } 
}

其中EntityReader、ColumnNameAttribute的代码如下：

没办法，不能在这里粘贴全部代码，所以放在附件下载了，这不是我的错，请大家谅解。

本类库经过NUnit测试通过，测试截图如下：

因为测试用的代码涉及到下一篇博文的内容，所以会将测试代码放到下一篇博文中。

2012-04-12

周公

------------------------------------------------

广告：为便于武汉市的.NET开发人员和学生参加在武汉举办的学习交流活动（本人绝没有地域歧视，只为线下交流方便），请有意者加以下QQ群：武汉IT群（11690964），武汉微软移动俱乐部（198027326）。4月14日本周六 13:30 - 17:00就有一个有关WPhone的免费线下交流活动，地点在武汉光谷软件园DEMO咖啡屋。如果有兴趣请在新浪微博上报名，报名地址：http://event.weibo.com/405882

本文出自 “周公（周金桥）的专栏” 博客，请务必保留此出处http://zhoufoxcn.blog.51cto.com/792419/832631

上一篇那些年，我们一起找过的工作下一篇 “春Phone计划”51CTO沙龙武汉站分享