基于DotNet构件技术的企业级敏捷软件开发平台 - AgileEAS.NET - 统一数据访问

魏琼东

发布于 2018-01-11 11:46:21

6010

发布于 2018-01-11 11:46:21

文章被收录于专栏：魏琼东魏琼东

统一数据访问（Uniform Data Access，简写为UDA）用于隔离系统和数据平台，使系统可以在各种数据库平台上自由移植。该数据库访问接口要求通过该接口对数据库进行访问的模块要提交标准的SQL语句，而不仅仅是对当前数据库有效的语句。

统一数据访问与数据层分离是相互相成的两个概念和实践、统一数据访问为数据层分离提供数据库访问环境及接口的独立、接口驱动及数据层体系结构的一致性提供保证。

统一数据访问内部自动包装ADO.NET，具体使用何种数据库则在外部由系统管理员定义在配置文件中。统一数据访问接口内部提供对数据库连接对象、数据命令对象、事务对象等的管理，因此客户端不需要自己管理这些对象，只需要提交数据库命令即可。

在UDA中主要的数据结构为“结果数据”。结果数据是数据库操作的结果的包装。如果是一个查询命令，则可能返回一个IDataReader对象、一个DataSet对象、一个DataTable对象、一个IDictionary对象、一个IList对象、一个数据对象（在数据对象管理中定义的数据结构）或者一个单纯的结果等，当然用户可以要求以XML的格式返回数据。

AgileEAS.NET提供了IDataAccessor和IDataConntion两个接口：

IDataAccessor提供了对数据的操作：查询结果和执行SQL语句两种基本操作，同时提供了SQL批处理、代理查询和事务委托操作，而IDataConnetion相当于为IDataAccessor提供了一个数据库执行环境。

下面详细的看一下两个接口：

IDataAccessor：

IDataAccessor	/// <summary>
	/// 数据访问提供者/数据访问器。
	/// </summary>
	public interface IDataAccessor
	{
        /// <summary>
        /// 获取或设置数据访问环境。
        /// </summary>
        IDataConnection DataConnection { get;set;}

        /// <summary>
        /// 执行指定的非查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句。该语句必须是标准的数据库语句。</param>
        /// <returns>返回命令影响的行数。</returns>
        int Execute(string commandString);

        /// <summary>
        /// 执行指定的非查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句。该语句必须是标准的数据库语句。</param>
        /// <param name="parameters">要执行的命令的参数集合。</param>
        /// <returns>返回命令影响的行数。</returns>
        int Execute(string commandString, ParameterCollection parameters);

        /// <summary>
        /// 执行指定的非查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句。该语句必须是标准的数据库语句。</param>
        /// <param name="commandType">要执行的命令类型。</param>
        /// <returns>返回命令影响的行数。</returns>
        int Execute(string commandString, System.Data.CommandType commandType);

        /// <summary>
        /// 执行指定的非查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句。该语句必须是标准的数据库语句。</param>
        /// <param name="commandType">要执行的命令类型。</param>
        /// <param name="parameters">要执行的命令的参数集合。</param>
        /// <returns>返回命令影响的行数。</returns>
        int Execute(string commandString, System.Data.CommandType commandType, ParameterCollection parameters);

        /// <summary>
        /// 执行指定的非查询命令。
        /// </summary>
        /// <param name="command">要执行的数据库访问命令。该命令必须是有效的数据库访问参数的封装。</param>		
        /// <returns>返回命令影响的行数。</returns>
        int Execute(DbCommand command);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句，可能是select语句，也可能是存储过程名称。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(string commandString);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句，可能是select语句，也可能是存储过程名称。</param>
        /// <param name="resultType">调用方要求的返回结果的类型。</param>
        /// <param name="fillParameters">当结果类型为DataSet、DataTable、或者Xml时的OleDbDataAdapter 的填充参数，其他ResultType 忽略该参数。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(string commandString, EAS.Data.Access.ResultType resultType, params object[] fillParameters);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句，可能是select语句，也可能是存储过程名称。</param>
        /// <param name="parameters">命令执行需要的参数。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(string commandString, ParameterCollection parameters);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句，可能是select语句，也可能是存储过程名称。</param>
        /// <param name="parameters">命令执行需要的参数。</param>
        /// <param name="resultType">调用方要求的返回结果的类型。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(string commandString, ParameterCollection parameters, EAS.Data.Access.ResultType resultType);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="commandString">要执行的命令语句，可能是select语句，也可能是存储过程名称。</param>
        /// <param name="commandType">要执行的命令的类型。</param>
        /// <param name="parameters">命令执行需要的参数。</param>
        /// <param name="resultType">调用方要求的返回结果的类型。</param>
        /// <param name="fillParameters">当结果类型为DataSet、DataTable、或者Xml时的OleDbDataAdapter 的填充参数，其他ResultType 忽略该参数。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(string commandString, System.Data.CommandType commandType, ParameterCollection parameters, EAS.Data.Access.ResultType resultType, params object[] fillParameters);

        /// <summary>
        /// 执行给定的数据库查询命令。
        /// </summary>
        /// <param name="command">要执行的数据库访问命令。该命令必须是有效的数据库访问参数的封装，可能是select语句，也可能是存储过程名称。</param>
        /// <returns>返回查询到的数据结果。</returns>
        object Query(DbCommand command);

        /// <summary>
        /// 执行指定的非查询命令（批处理指令）。
        /// </summary>
        /// <param name="commands">要执行的数据库访问命令集合。该命令集合必须是有效的数据库访问参数的封装。</param>		
        /// <returns>返回命令影响的行数。</returns>
        int BachExecute(DbCommandCollection commands);

        /// <summary>
        /// 执行给定的数据库查询命令集合（批查询指令）。
        /// </summary>
        /// <param name="commands">要执行的数据库访问命令集合。该命令必须是有效的数据库访问参数的封装，可能是select语句，也可能是存储过程名称。</param>
        /// <returns>返回查询到的数据结果集合。</returns>
        /// </remarks>
        EAS.Data.Access.DbResultCollection BackQuery(DbCommandCollection commands);


        /// <summary>
        /// 在事务环境中执行给定的EAS.Data.Access.TransactionHandler，该EAS.Data.Access.TransactionHandler中包括了要在事务中执行的所有数据库操作。
        /// </summary>
        /// <param name="handler">要执行的EAS.Data.Access.TransactionHandler 对象。</param>
        /// <returns>返回受影响的行数，该值为EAS.Data.Access.TransactionHandler 返回的结果，默认返回0。</returns>
        int TransactionExecute(EAS.Data.Access.TransactionHandler handler);

        /// <summary>
        /// 委托查询。当调用方需要返回DataReader时，如果使用Query，则必须自行打开环境和关闭环境以及DataReader的关闭。
        /// 调用方可以将处理DataReader结果的代码包装在DataReaderHandler委托中，由DelegateQuery方法代表调用方调用数据处理程序，并在DelegateQuery的内部管理数据访问环境和DataReader的生存周期。
        /// </summary>
        /// <param name="handler">需要由DelegateQuery方法代为调用的EAS.Data.Access.DataReaderHandler委托对象。handler中的方法可以关闭DataReader对象，也可以不关闭DataReader对象。</param>
        /// <param name="commandString">要执行的查询命令文本。</param>
        void DelegateQuery(EAS.Data.Access.DataReaderHandler handler, string commandString);

        /// <summary>
        /// 委托查询。当调用方需要返回DataReader时，如果使用Query，则必须自行打开环境和关闭环境以及DataReader的关闭。
        /// 调用方可以将处理DataReader结果的代码包装在DataReaderHandler委托中，由DelegateQuery方法代表调用方调用数据处理程序，并在DelegateQuery的内部管理数据访问环境和DataReader的生存周期。
        /// </summary>
        /// <param name="handler">需要由DelegateQuery方法代为调用的EAS.Data.Access.DataReaderHandler委托对象。handler中的方法可以关闭DataReader对象，也可以不关闭DataReader对象。</param>
        /// <param name="commandString">要执行的查询命令文本。</param>
        /// <param name="commandType">查询命令类型。</param>
        /// <param name="parameters">命令参数。</param>
        void DelegateQuery(EAS.Data.Access.DataReaderHandler handler, string commandString, System.Data.CommandType commandType, ParameterCollection parameters);
	}

IDataConnetion：

IDataConnection    /// <summary>
    /// 数据访问连接/环境。
    /// </summary>
    /// <remarks>
    /// 本接口是数据访问的一个基础接口，用于建设数据访问连接/环境。
    /// </remarks>
    public interface IDataConnection : EAS.Sessions.ISessionResource
    {
        /// <summary>
        /// 在此连接上创建一个数据访问器。
        /// </summary>
        /// <returns>成功创建的数据访问器。</returns>
        IDataAccessor CreateDataAccessor();

        /// <summary>
        /// 在此连接上创建一个数据访问器。
        /// </summary>
        /// <returns>成功创建的数据访问器。</returns>
        [Obsolete("方法已过期，请使用CreateDataAccessor方法")]
        IDataAccessor CreateAccessor();

        /// <summary>
        /// 打开数据连接。
        /// </summary>
        void Open();

        /// <summary>
        /// 关闭数据连接。
        /// </summary>
        void Close();
    }
}

数据访问器（IDataAccessor）是统一数据访问中进行数据存取的接口，他生存于数据库环境IDataAccessor之中，客户端只需通过该访问器提供的方法并为这些方法提供适当的参数进行数据库操作。访问器内部自动在当前数据库连接上创建数据库命令，并包装返回的结果。

目前访问器在传回查询结果时，加入了一步装箱操作，返回统一类型的数据（object），使用者需求使用拆箱，然后得到具体的数据结果。

因为在访问数据库时定了一个原则：IDataAccessor不得随意变更IDataConnetion的状态，我们知道在访问数据库时需要打开和关闭数据库操作，所以在IDataAccessor执行SQL命令过程上，首先判读IDataConnetion是否打开，如果未打开则执行IDataConnetion.Open()并在执行SQL完毕进行IDataConnetion.Close()。

	bool open = this.Connection.IsOpen;
	if(!open)
		this.Connection.Open();

	try
	{
		//执行SQL
	}
	finally
	{
		if(!open)
			this.Connection.Close();
	}

而在执行查询命令时有一种返回结果IDataReader，这种状态需要数据库一直保持打开状态，所以我们增加了一个委托方法DelegateQuery，委托DataReaderHandler定义如下：

    /// <summary>
    /// 定义以DataReader作为结果返回时的数据访问委托。
    /// </summary>
    /// <remarks>
    /// 该委托的实例可以由Accessor.DelegateQuery方法在内部调用，这样委托实例就不需要考虑关闭DataReader的问题。
    /// </remarks>
    public delegate void DataReaderHandler(System.Data.IDataReader dataReader);

在数据库事务这一块，提供了除正常的开启事务、关闭事务之后，我更推荐一种事务委托和方式去执行，IDataAccessor提供了TransactionExecute方法，其委托TransactionHandler定义：

    /// <summary>
    /// 定义数据库操作的事务处理委托。该委托将代表客户执行数据库事务，这样使用者不需要考虑事务的开始和结束。
    /// </summary>
    public delegate int TransactionHandler(IDataAccessor Accessor);

目前实现了SQL数据库（SQLServerConnection、SQLServerAccessor）、OleDb数据库（OleDbConnection、OleDbAccessor）、ODBC数据库（ODBCConnection、ODBCAccessor），ORACLE数据库由单独的数据库访问服务程序集实现。

具体的数据访问例程我将在后面展示：

下面来说一下AgileEAS.NET中的ORM。

QQ群：15118502

本文参与腾讯云自媒体分享计划，分享自作者个人站点/博客。

原始发表：2010-07-01 ，如有侵权请联系 cloudcommunity@tencent.com 删除

.net