DbKit

ADO.NET数据库开发连接辅助工具。

A helpful database kit for ADO.NET development.

简介 Introduction

这是一个专门为ADO.NET开发的辅助类工具，目前已完成对 Microsoft SQL Server 数据库的增删改查操作，支持连接模式和断开模式的操作。基于抽象工厂模式（Abstract factory pattern）和反射（Reflection）的原理进行封装（encapsulation）。

This is a specialized kit for ADO.NET development, has supported the common data management for Microsoft SQL Server database in connection mode or disconnect mode.And encapsulating it based on abstract factory pattern and reflection principle.

开始 Start

可用以下方式获取DbKit.cs文件 Several start options are available:：

• 点击下载 Click here to download

• 使用git工具克隆 Use git to clone the repo：

  $ git clone https://github.com/tatwd/dbkit.git 

推荐使用第二种方式。Recommend the second way.

用法 Usage

⚠️ 注意：以下所有例子均省去命名空间的引入、相关变量的具体定义，实际开发不可省去！

DbHelper 类

该类只定义了一个属性和一个方法，用于获取一个连接对象。

属性

• ConnectorClassName

  只读的静态私有属性，表示连接器类名。

方法

• GetConnector(params string[] dbConnStrName)

  静态公共方法，用来获取一个对应用户数据库类型的连接器对象，目前支持最多传入一个参数。

  参数：

  dbConStrname：可变参数数组，表示在配置文件中的连接字符串名。

  返回值：

  连接器（Connector）。

  举例：

  Connector connector = DbHelper.GetConnector("MyDB");

Connector 接口

该接口定义了6个接口方法，用于对数据库的管理。

方法

• Execute(string executeType, string cmdText, params object[] cmdParams)

  用来执行执行SQL语句（支持带安全参数）并返回执行的结果，传入三种参数。

  参数：

  executeType：表示执行类型，有3个值：Non、Reader、Scalar、Xml，即对应执行 ExecuteNonQuery、ExecuteReader、ExecuteScalar、ExecuteXmlReader 方法，参考文档。

  cmdText：表示命令文本，可以是SQL语句或存储过程，但此方法只支持SQL语句的执行。

  cmdParams：表示命令参数对象的可变数组，SQL语句带安全参数时传入。

  返回值：

  执行结果，object类型数据。赋值时需类型转换（拆箱）。

  举例：

  // 插入
  // 返回值为受影响行数，当不需要获取返回行数时，允许不赋值
  
  // 普通插入操作
  int line1 = (int)connector.Execute("non", sql);
  connector.Execute("non", sql);
  
  // 带安全参数的插入操作
  int line2 = (int)connector.Execute("non", sqlWithParams, parameter);
  connector.Execute("non", sqlWithParams, parameter);
  
  // 删除、更新操作同上
  
  // 查询
  
  // 查询所有信息
  SqlDaTaReader reader1 = (SqlDaTaReader)connector.Execute("reader", sql);
  // 带安全参数的插入操作
  SqlDaTaReader reader2 = (SqlDaTaReader)connector.Execute("reader", sqlWithParams, parameter);
  
  // 单值的查询
  
  // 普通查询
  int id1 = (int)connector.Execute("scalar", sql);
  
  // 带安全参数
  int id2 = (int)connector.Execute("scalar", sqlWithParams, parameter);

  注意：事例代码，说明大概，具体情况，具体分析！

• Execute(string executeType, string cmdText, CommandType cmdType, params object[] cmdParams)

  上一个 Execute 方法的重载，支持执行存储过程，增加一个新参数。

  参数：

  cmdType：命令类型，有3个值：CommandType.StoredProcedure（存储过程）、CommandType.Text（SQL语句）、TableDirect（数据表）,此方法支持前两个类型，参考文档。

  返回值：

  执行结果，object类型数据。赋值时需类型转换（拆箱）。

• GetDataTable(string cmdText, params object[] cmdParams)

  断开模式下，用于获取数据表（DataTable）。

  参数：

  cmdText：表示命令文本，可以是SQL语句或存储过程，但此方法只支持SQL语句的执行。

  cmdParams：表示命令参数对象的可变数组，SQL语句带安全参数时传入。

  返回值：

  数据表，DataTable类型。

• GetDataTable(string cmdText, CommandType cmdType, params object[] cmdParams)

  上一个方法的重载，支持执行存储过程，增加一个参数。

  参数：

  cmdType：命令类型，有3个值：CommandType.StoredProcedure（存储过程）、CommandType.Text（SQL语句）、TableDirect（数据表）,此方法支持前两个类型，参考文档。

  返回值：

  数据表，DataTable类型。

• DataSet GetDataSet(string cmdText, params object[] cmdParams)

  断开模式下，用于获取数据集（DataSet）。

  参数:

  cmdText：表示命令文本，可以是SQL语句或存储过程，但此方法只支持SQL语句的执行。

  cmdParams：表示命令参数对象的可变数组，SQL语句带安全参数时传入。

  返回值：

  数据集，DataSet类型。

• GetDataSet(string cmdText, CommandType cmdType, params object[] cmdParams)

  上一个方法的重载，支持执行存储过程，增加一个参数。

  参数:

  cmdType：命令类型，有3个值：CommandType.StoredProcedure（存储过程）、CommandType.Text（SQL语句）、TableDirect（数据表）,此方法支持前两个类型，参考文档。

  返回值：

  数据集，DataSet类型。

MsSqlConnector 类

Microsoft SQL Server 数据库连接器，使用 SQL Server 数据提供程序，是对 Connector 接口的实现。

计划 Plans

• 实现 MySQL 数据库连接器（MySqlConnector）。

• 异步管理数据。

• 异常处理机制。

---

Loading... 😄