C#做定時任務:一是Timer;而是Quartz.net;本文就學習一下Quartz.net框架
Quartz.net非常的靈活,開發人員能用很少的代碼就能完成“每隔一小時執行”、“每天2點執行”、“每月27日的下午執行8次”等各種定時任務。它實現了作業job和觸發器trigger之間多對多的關系,還能把多個作業與不同的觸發器關聯。
開發步驟:
1、添加Quartz.dll引用
第三方框架從“管理NuGet程序包”中搜索並添加,如果高版本安裝不成功請試試低版本。我使用的”.NETFramework,Version=v4.5“,無法安裝“Quartz.net 3.0.5”版本,但可以安裝"2.4.1"。安裝完之后會自動添加如下圖所示的另外兩個引用。
2、{我建得是WindowsFrrm項目)修改Form1程序代碼

using Quartz; using Quartz.Impl; using System; using System.Threading; using System.Windows.Forms; namespace WindowsFormsApplication_1709 { public partial class Form1 : Form { public Form1() { InitializeComponent(); } private void button1_Click(object sender, EventArgs e) { CodeMethod();//通過代碼的方式調用 //ConfigMethod(); } public static log4net.ILog log = log4net.LogManager.GetLogger("LogLogger"); /// <summary> /// 通過代碼的方式調用 /// </summary> private static void CodeMethod() { try { log.Info("-----------------" + DateTime.Now.ToString() + " Initializing ----------------------"); //1.首先創建一個作業調度池 ISchedulerFactory scheduler = new StdSchedulerFactory(); IScheduler sched = scheduler.GetScheduler(); log.Info("-----------------" + DateTime.Now.ToString() + " Initialization Complete -----------"); log.Info("-----------------" + DateTime.Now.ToString() + " Scheduling Job -------------------"); //2.創建一個具體的作業 IJobDetail job = JobBuilder.Create<PostRawMaterialDistributionPlan>().Build(); //3.創建並配置一個觸發器 #region 每隔5秒執行一次Execute方法,無休止 ISimpleTrigger trigger = (ISimpleTrigger)TriggerBuilder.Create().WithSimpleSchedule(x => x.WithIntervalInSeconds(5).WithRepeatCount(int.MaxValue)).Build(); #endregion #region 程序每5秒執行一次,一共執行50次,開始執行時間設定在當前時間,結束時間設定在1小時候,不管50次有沒有執行完,1小時候程序都不在繼續執行 //DateTimeOffset startTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddSeconds(1), 2); //DateTimeOffset endTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddMinutes(5), 5); //ISimpleTrigger trigger = (ISimpleTrigger)TriggerBuilder.Create().StartAt(startTime).EndAt(endTime).WithSimpleSchedule(x => x.WithIntervalInSeconds(5).WithRepeatCount(50)).Build(); #endregion #region 實現各種時間緯度的調用(使用cron-like):在每小時的第10、20、30分鍾,每分鍾的第11、27秒執行一次 //ICronTrigger trigger = (ICronTrigger)TriggerBuilder.Create().StartAt(startTime).EndAt(endTime).WithCronSchedule("11,27 0,2,58 * * * ? ").Build(); #endregion //4.加入作業調度池中 sched.ScheduleJob(job, trigger); //5.開始執行 sched.Start(); log.Info("-----------------" + DateTime.Now.ToString() + " Started Scheduler -----------------"); Thread.Sleep(TimeSpan.FromSeconds(65));//第一個線程執行之后休息65秒,第二個線程開始執行,等第十個線程執行完后剛剛好就又該第一個線程執行了,因為定時器設置的是每5秒執行一次 log.Info("-----------------" + DateTime.Now.ToString() + " Shutting Down ---------------------"); sched.Shutdown(true); log.Info("-----------------" + DateTime.Now.ToString() + " Shutdown Complete -----------------"); } catch (Exception ec) { log.Error("-----------------" + DateTime.Now.ToString() + "[Error Occurred]", ec); } } /// <summary> /// 通過配置文件的方式調用 static /// </summary> private static void ConfigMethod() { try { log.Info("-----------------" + DateTime.Now.ToString() + " Initializing ----------------------"); //工廠 ISchedulerFactory factory = new StdSchedulerFactory(); //啟動 IScheduler scheduler = factory.GetScheduler(); scheduler.Start(); log.Info("-----------------" + DateTime.Now.ToString() + " Started Scheduler -----------------"); PostRawMaterialDistributionPlan job = new PostRawMaterialDistributionPlan(); job.Execute(null); Thread.Sleep(TimeSpan.FromSeconds(65));//第一個線程執行之后休息65秒,第二個線程開始執行,等第十個線程執行完后剛剛好就又該第一個線程執行了,因為定時器設置的是每5秒執行一次 log.Info("-----------------" + DateTime.Now.ToString() + " Shutting Down ---------------------"); scheduler.Shutdown(true); log.Info("-----------------" + DateTime.Now.ToString() + " Shutdown Complete -----------------"); } catch (Exception ex) { throw ex; } } } }
Quartz.net的使用可以通過兩種方式調用:一是通過代碼的方式,而是通過配置文件的方式;
通過代碼的方式雖然很簡單,但是也有一個不利點,現在需求有變更,我需要將WithIntervalInSeconds(5) 改成WithIntervalInSeconds(20),也就是每5秒執行一次改成每20秒執行一次,這個就頭疼了,你不得不面對改一次需求,就需要編譯一次再發布,這樣的傷筋動骨;如果用配置文件的話當需求變更的時候我們僅僅需要更改配置文件即可,大大節省了工作量,極力推薦使用配置文件的方式;
3、創建具體的job類:需要實現IJob接口,並重寫它的方法Execute()為具體的業務邏輯

using Common.Logging; using Quartz; using System; using System.Collections.Generic; using System.Data; using System.Linq; using System.Text; using System.Threading.Tasks; namespace WindowsFormsApplication_1709 { public class PostRawMaterialDistributionPlan : IJob { public static log4net.ILog log = log4net.LogManager.GetLogger("LogLogger"); /// <summary> /// 作業調度每次要定時執行的方法 /// </summary> /// <param name="context"></param> public void Execute(IJobExecutionContext context) { //ILog log = LogManager.GetLogger(typeof(JobDemo)); DataSet data = SqlHelper.ExecuteDataset(SqlHelper.GetConnSting(), CommandType.StoredProcedure, "P_HTTP_RawMaterialDistributionPlan"); try { log.Info("返回內容:" + ConvertJson.ToJson(data) + "-------------------"); //以下為示例返回的內容 //{ "Table":[ //{ "id":"CDAFA658-90C2-4D00-92E3-6E2E206BB358","sale_no":"W240200400201805310001","mat_no":"W240300440","mat_name":"行星輪軸","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"5DC694BE-46F5-4154-9556-CBF312C0FE0C","sale_no":"W240200400201805310001","mat_no":"W240300442","mat_name":"球面墊片","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"BB89E5D8-B268-4FAB-BC1F-BF2D93EE9D45","sale_no":"W240200400201805310001","mat_no":"W240300439","mat_name":"行星齒輪","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"ADC69606-7168-4467-9227-B9287C778258","sale_no":"W240200400201805310001","mat_no":"W240300426","mat_name":"差速器殼","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"971B4922-5DC5-4D62-A7C6-A62D0208FD9C","sale_no":"W240200400201805310001","mat_no":"W240300441","mat_name":"調整墊片","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"E6A69690-891A-4307-8324-EAB75A940FAE","sale_no":"W240200400201805310001","mat_no":"W240300381","mat_name":"半軸齒輪","plan_qty":2,"proline_no":"C001","proline_workpos":"OP101","workpos_assignqty":""}, //{ "id":"C18A7EE2-6AD0-49FA-8C16-4FB1FE7A668A","sale_no":"W240200400201805310001","mat_no":"W240300429","mat_name":"差速器總成","plan_qty":2,"proline_no":"C001","proline_workpos":"OP102","workpos_assignqty":""}, //{ "id":"63190B60-8A5B-4E58-AF25-EDAE1F4023E2","sale_no":"W240200400201805310001","mat_no":"23945465","mat_name":"差速器軸承","plan_qty":2,"proline_no":"C001","proline_workpos":"OP103","workpos_assignqty":""}, //{ "id":"EAD94B9F-B7D6-41D2-B789-42446FD59286","sale_no":"W240200400201805310001","mat_no":"W240200426","mat_name":"主動傘齒輪","plan_qty":2,"proline_no":"C001","proline_workpos":"OP103","workpos_assignqty":""}, //{ "id":"842B45E8-7B04-4999-8FB9-F5035F724495","sale_no":"W240200400201805310001","mat_no":"9026219","mat_name":"被齒鎖緊螺栓","plan_qty":2,"proline_no":"C001","proline_workpos":"OP103","workpos_assignqty":""}, //{ "id":"74EF003F-1778-476C-8211-E824ED43D7D8","sale_no":"W240200400201805310001","mat_no":"W240200427","mat_name":"被動傘齒輪","plan_qty":2,"proline_no":"C001","proline_workpos":"OP103","workpos_assignqty":""}]}------------------- } catch (Exception ex) { log.Info("返回數據錯誤:" + ex.InnerException); } } } }
通過前面的1、2、3步就完成了通過代碼調用;下圖是產生的日志文件
4.通過配置文件方式調用首先啟用Form1.ConfigMethod類
5.創建quartz_jobs.xml文件
在添加quartz.net引用后還自動添加了“job_scheduling_data_2_0.xsd”文件,它是用來寫xml時做代碼提示用的!!!需要做一下配置才有提示信息。
配置過程、選中一個xml文件(例如"quartz_jobs.xml",VS工具欄上會出現XML(X),不選就沒有哦!!!)------->>點擊XML架構------->>點擊添加------->>選中.xsd文件------>>點擊打開------>>點擊確定!!!完成,綠色框為完成之后的狀態,寫xml時就有了智能提示了!!
下面為quartz_jobs.xml的代碼

<?xml version="1.0" encoding="UTF-8"?> <!-- This file contains job definitions in schema version 2.0 format --> <job-scheduling-data xmlns="http://quartznet.sourceforge.net/JobSchedulingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0"> <processing-directives> <overwrite-existing-data>true</overwrite-existing-data> </processing-directives> <schedule> <!--SampleJob測試 任務配置--> <job> <name>SampleJob</name> <group>Sample</group> <description>SampleJob測試</description> <!--job-type節點中定義了需要執行job的命名空間和類名,也是最終schedule需要調度的任務--> <job-type>WindowsFormsApplication_1709.PostRawMaterialDistributionPlan, WindowsFormsApplication_1709</job-type> <durable>true</durable> <recover>false</recover> </job> <!--每隔3秒執行一次--> <trigger> <cron> <name>SampleJobTrigger</name> <group>SampleGroup</group> <description>SampleJob</description> <job-name>SampleJob</job-name> <job-group>Sample</job-group> <!--<start-time>2018-05-28T00:00:00+08:00</start-time>--> <cron-expression>0/3 * * * * ?</cron-expression> </cron> </trigger> </schedule> </job-scheduling-data>
6.修改App.config文件

<?xml version="1.0" encoding="utf-8" ?> <configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/> <section name="quartz" type="System.Configuration.NameValueSectionHandler"/> </configSections> <log4net> <root> <level value="ALL" /> <appender-ref ref="SysAppender" /> </root> <logger name="LogLogger"> <level value="DEBUG"/> </logger> <appender name="SysAppender" type="log4net.Appender.RollingFileAppender,log4net" > <!--是否追加到文件:日志文件路徑,文件夾不存在則新建 --> <param name="File" value="logfile.txt" /> <!--是否追加到文件--> <param name="AppendToFile" value="true" /> <!--記錄日志寫入文件時,不鎖定文本文件,防止多線程時不能寫Log,官方說線程非安全--> <lockingModel type="log4net.Appender.FileAppender+MinimalLock" /> <!--使用Unicode編碼--> <Encoding value="UTF-8" /> <!--最多產生的日志文件數,超過則只保留最新的n個。設定值value="-1"為不限文件數--> <param name="MaxSizeRollBackups" value="10" /> <!--是否只寫到一個文件中--> <param name="StaticLogFileName" value="false" /> <!--按照何種方式產生多個日志文件(日期[Date],文件大小[Size],混合[Composite])--> <param name="RollingStyle" value="Composite" /> <!--按日期產生文件夾和文件名[在日期方式與混合方式下使用]--> <!--此處按日期產生文件夾,文件名固定。注意" 的位置--> <param name="DatePattern" value="yyyy-MM-dd/"ReflectionLayout.log"" /> <!--這是按日期產生文件夾,並在文件名前也加上日期--> <!--<param name="DatePattern" value="yyyyMMdd/yyyyMMdd"-TimerServer.log"" />--> <!--這是先按日期產生文件夾,再形成下一級固定的文件夾--> <!--<param name="DatePattern" value="yyyyMMdd/"TimerServer/TimerServer.log"" />--> <!--每個文件的大小:只在混合方式與文件大小方式下使用。超出大小后在所有文件名后自動增加正整數重新命名,數字最大的最早寫入。可用的單位:KB|MB|GB。不要使用小數,否則會一直寫入當前日志--> <param name="maximumFileSize" value="500KB" /> <!--計數類型為1,2,3…--> <param name="CountDirection" value="1"/> <!--記錄的格式。一般用log4net.Layout.PatternLayout布局--> <layout type="log4net.Layout.PatternLayout,log4net"> <param name="Header" value="[Header] "/> <param name="Footer" value="[Footer] "/> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" /> </layout> <!--記錄的格式。一般用log4net.Layout.PatternLayout布局--> <!--用自定義布局測試失敗--> <!--此處用繼承了log4net.Layout.PatternLayout的自定義布局,TGLog.ExpandLayout2為命名空間。%property{Operator}、%property{Action}是自定義的輸出--> <!--<layout type="TGLog.ExpandLayout2.ReflectionLayout,TGLog"> <param name="ConversionPattern" value="記錄時間:%date 線程ID:[%thread] 日志級別:%-5level 記錄類:%logger 操作者ID:%property{Operator} 操作類型:%property{Action}%n 當前機器名:%property%n當前機器名及登錄用戶:%username %n 記錄位置:%location%n 消息描述:%property{Message}%n 異常:%exception%n 消息:%message%newline%n%n" /> </layout>--> <!--過濾設置,LevelRangeFilter為使用的過濾器--> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="DEBUG" /> <param name="LevelMax" value="WARN" /> </filter> </appender> <!--<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender,log4net" > <layout type="log4net.Layout.PatternLayout,log4net"> <param name="ConversionPattern" value="%d [%t] %-5p %c [%x] - %m%n" /> </layout> </appender>--> </log4net> <quartz> <add key="quartz.scheduler.instanceName" value="ExampleDefaultQuartzScheduler"/> <add key="quartz.threadPool.type" value="Quartz.Simpl.SimpleThreadPool, Quartz"/> <add key="quartz.threadPool.threadCount" value="10"/> <add key="quartz.threadPool.threadPriority" value="2"/> <add key="quartz.jobStore.misfireThreshold" value="60000"/> <add key="quartz.jobStore.type" value="Quartz.Simpl.RAMJobStore, Quartz"/> <!--******************************Plugin配置*********************************************--> <add key="quartz.plugin.xml.type" value="Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz" /> <add key="quartz.plugin.xml.fileNames" value="~/quartz_jobs.xml"/> </quartz> <connectionStrings> <add name="ConnectionStringMain" connectionString="Data Source=192.168.1.211;Initial Catalog=WLZhuJianMes;Persist Security Info=True;User ID=sa;Password=sa;MultipleActiveResultSets=True" providerName="System.Data.SqlClient" /> </connectionStrings> <startup> <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" /> </startup> </configuration>
由於我無論是通過代碼方式調用還是配置文件方式調用,具體的job都用的是同一個PostRawMaterialDistributionPlan,所以再次經過后面幾部的過程通過配置文件的方式調用就完成了。下圖為返回內容的日志,兩者沒有差別的。
附錄:
1、SqlHelper類

using System; using System.Collections; using System.Collections.Generic; using System.Configuration; using System.Data; using System.Data.SqlClient; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Xml; namespace WindowsFormsApplication_1709 { public sealed class SqlHelper { #region 私有構造函數和方法 private SqlHelper() { } /// <summary> /// 將SqlParameter參數數組(參數值)分配給SqlCommand命令. /// 這個方法將給任何一個參數分配DBNull.Value; /// 該操作將阻止默認值的使用. /// </summary> /// <param name="command">命令名</param> /// <param name="commandParameters">SqlParameters數組</param> private static void AttachParameters(SqlCommand command, SqlParameter[] commandParameters) { if (command == null) throw new ArgumentNullException("command"); if (commandParameters != null) { foreach (SqlParameter p in commandParameters) { if (p != null) { // 檢查未分配值的輸出參數,將其分配以DBNull.Value. if ((p.Direction == ParameterDirection.InputOutput || p.Direction == ParameterDirection.Input) && (p.Value == null)) { p.Value = DBNull.Value; } command.Parameters.Add(p); } } } } /// <summary> /// 將DataRow類型的列值分配到SqlParameter參數數組. /// </summary> /// <param name="commandParameters">要分配值的SqlParameter參數數組</param> /// <param name="dataRow">將要分配給存儲過程參數的DataRow</param> private static void AssignParameterValues(SqlParameter[] commandParameters, DataRow dataRow) { if ((commandParameters == null) || (dataRow == null)) { return; } int i = 0; // 設置參數值 foreach (SqlParameter commandParameter in commandParameters) { // 創建參數名稱,如果不存在,只拋出一個異常. if (commandParameter.ParameterName == null || commandParameter.ParameterName.Length <= 1) throw new Exception( string.Format("請提供參數{0}一個有效的名稱{1}.", i, commandParameter.ParameterName)); // 從dataRow的表中獲取為參數數組中數組名稱的列的索引. // 如果存在和參數名稱相同的列,則將列值賦給當前名稱的參數. if (dataRow.Table.Columns.IndexOf(commandParameter.ParameterName.Substring(1)) != -1) commandParameter.Value = dataRow[commandParameter.ParameterName.Substring(1)]; i++; } } /// <summary> /// 將一個對象數組分配給SqlParameter參數數組. /// </summary> /// <param name="commandParameters">要分配值的SqlParameter參數數組</param> /// <param name="parameterValues">將要分配給存儲過程參數的對象數組</param> private static void AssignParameterValues(SqlParameter[] commandParameters, object[] parameterValues) { if ((commandParameters == null) || (parameterValues == null)) { return; } // 確保對象數組個數與參數個數匹配,如果不匹配,拋出一個異常. if (commandParameters.Length != parameterValues.Length) { throw new ArgumentException("參數值個數與參數不匹配."); } // 給參數賦值 for (int i = 0, j = commandParameters.Length; i < j; i++) { // If the current array value derives from IDbDataParameter, then assign its Value property if (parameterValues[i] is IDbDataParameter) { IDbDataParameter paramInstance = (IDbDataParameter)parameterValues[i]; if (paramInstance.Value == null) { commandParameters[i].Value = DBNull.Value; } else { commandParameters[i].Value = paramInstance.Value; } } else if (parameterValues[i] == null) { commandParameters[i].Value = DBNull.Value; } else { commandParameters[i].Value = parameterValues[i]; } } } /// <summary> /// 預處理用戶提供的命令,數據庫連接/事務/命令類型/參數 /// </summary> /// <param name="command">要處理的SqlCommand</param> /// <param name="connection">數據庫連接</param> /// <param name="transaction">一個有效的事務或者是null值</param> /// <param name="commandType">命令類型 (存儲過程,命令文本, 其它.)</param> /// <param name="commandText">存儲過程名或都T-SQL命令文本</param> /// <param name="commandParameters">和命令相關聯的SqlParameter參數數組,如果沒有參數為'null'</param> /// <param name="mustCloseConnection"><c>true</c> 如果連接是打開的,則為true,其它情況下為false.</param> private static void PrepareCommand(SqlCommand command, SqlConnection connection, SqlTransaction transaction, CommandType commandType, string commandText, SqlParameter[] commandParameters, out bool mustCloseConnection) { if (command == null) throw new ArgumentNullException("command"); if (commandText == null || commandText.Length == 0) throw new ArgumentNullException("commandText"); // If the provided connection is not open, we will open it if (connection.State != ConnectionState.Open) { mustCloseConnection = true; connection.Open(); } else { mustCloseConnection = false; } // 給命令分配一個數據庫連接. command.Connection = connection; // 設置命令文本(存儲過程名或SQL語句) command.CommandText = commandText; // 分配事務 if (transaction != null) { if (transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); command.Transaction = transaction; } // 設置命令類型. command.CommandType = commandType; // 分配命令參數 if (commandParameters != null) { AttachParameters(command, commandParameters); } return; } #endregion 私有構造函數和方法結束 #region 數據庫連接 /// <summary> /// 一個有效的數據庫連接字符串 /// </summary> /// <returns></returns> public static string GetConnSting() { return ConfigurationManager.ConnectionStrings["ConnectionStringMain"].ConnectionString; } /// <summary> /// 一個有效的數據庫連接對象 /// </summary> /// <returns></returns> public static SqlConnection GetConnection() { SqlConnection Connection = new SqlConnection(SqlHelper.GetConnSting()); return Connection; } #endregion #region ExecuteNonQuery命令 /// <summary> /// 執行指定連接字符串,類型的SqlCommand. /// </summary> /// <remarks> /// 示例: /// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders"); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本, 其它.)</param> /// <param name="commandText">存儲過程名稱或SQL語句</param> /// <returns>返回命令影響的行數</returns> public static int ExecuteNonQuery(string connectionString, CommandType commandType, string commandText) { return ExecuteNonQuery(connectionString, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定連接字符串,類型的SqlCommand.如果沒有提供參數,不返回結果. /// </summary> /// <remarks> /// 示例: /// int result = ExecuteNonQuery(connString, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本, 其它.)</param> /// <param name="commandText">存儲過程名稱或SQL語句</param> /// <param name="commandParameters">SqlParameter參數數組</param> /// <returns>返回命令影響的行數</returns> public static int ExecuteNonQuery(string connectionString, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); return ExecuteNonQuery(connection, commandType, commandText, commandParameters); } } /// <summary> /// 執行指定連接字符串的存儲過程,將對象數組的值賦給存儲過程參數, /// 此方法需要在參數緩存方法中探索參數並生成參數. /// </summary> /// <remarks> /// 這個方法沒有提供訪問輸出參數和返回值. /// 示例: /// int result = ExecuteNonQuery(connString, "PublishOrders", 24, 36); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串/param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配到存儲過程輸入參數的對象數組</param> /// <returns>返回受影響的行數</returns> public static int ExecuteNonQuery(string connectionString, string spName, params object[] parameterValues) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果存在參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從探索存儲過程參數(加載到緩存)並分配給存儲過程參數數組. SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); return ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數情況下 return ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫連接對象的命令 /// </summary> /// <remarks> /// 示例: /// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型(存儲過程,命令文本或其它.)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQuery(SqlConnection connection, CommandType commandType, string commandText) { return ExecuteNonQuery(connection, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接對象的命令 /// </summary> /// <remarks> /// 示例: /// int result = ExecuteNonQuery(conn, CommandType.StoredProcedure, "PublishOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型(存儲過程,命令文本或其它.)</param> /// <param name="commandText">T存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">SqlParamter參數數組</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQuery(SqlConnection connection, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connection == null) throw new ArgumentNullException("connection"); // 創建SqlCommand命令,並進行預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (SqlTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection); // Finally, execute the command int retval = cmd.ExecuteNonQuery(); // 清除參數,以便再次使用. cmd.Parameters.Clear(); if (mustCloseConnection) connection.Close(); return retval; } /// <summary> /// 執行指定數據庫連接對象的命令,將對象數組的值賦給存儲過程參數. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值 /// 示例: /// int result = ExecuteNonQuery(conn, "PublishOrders", 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQuery(SqlConnection connection, string spName, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數 SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 給存儲過程分配參數值 AssignParameterValues(commandParameters, parameterValues); return ExecuteNonQuery(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteNonQuery(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行帶事務的SqlCommand. /// </summary> /// <remarks> /// 示例.: /// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "PublishOrders"); /// </remarks> /// <param name="transaction">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型(存儲過程,命令文本或其它.)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回影響的行數/returns> public static int ExecuteNonQuery(SqlTransaction transaction, CommandType commandType, string commandText) { return ExecuteNonQuery(transaction, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行帶事務的SqlCommand(指定參數). /// </summary> /// <remarks> /// 示例: /// int result = ExecuteNonQuery(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型(存儲過程,命令文本或其它.)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">SqlParamter參數數組</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQuery(SqlTransaction transaction, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); // 預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 執行 int retval = cmd.ExecuteNonQuery(); // 清除參數集,以便再次使用. cmd.Parameters.Clear(); return retval; } /// <summary> /// 執行帶事務的SqlCommand(指定參數值). /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值 /// 示例: /// int result = ExecuteNonQuery(conn, trans, "PublishOrders", 24, 36); /// </remarks> /// <param name="transaction">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回受影響的行數</returns> public static int ExecuteNonQuery(SqlTransaction transaction, string spName, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteNonQuery方法結束 #region ExecuteDataset方法 /// <summary> /// 執行指定數據庫連接字符串的命令,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string commandText) { return ExecuteDataset(connectionString, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接字符串的命令,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(connString, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">SqlParamters參數數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(string connectionString, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); // 創建並打開數據庫連接對象,操作完成釋放對象. using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); // 調用指定數據庫連接字符串重載方法. return ExecuteDataset(connection, commandType, commandText, commandParameters); } } /// <summary> /// 執行指定數據庫連接字符串的命令,直接提供參數值,返回DataSet. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值. /// 示例: /// DataSet ds = ExecuteDataset(connString, "GetOrders", 24, 36); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(string connectionString, string spName, params object[] parameterValues) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中檢索存儲過程參數 SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 給存儲過程參數分配值 AssignParameterValues(commandParameters, parameterValues); return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteDataset(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫連接對象的命令,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlConnection connection, CommandType commandType, string commandText) { return ExecuteDataset(connection, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接對象的命令,指定存儲過程參數,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <param name="commandParameters">SqlParamter參數數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlConnection connection, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connection == null) throw new ArgumentNullException("connection"); // 預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (SqlTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection); // 創建SqlDataAdapter和DataSet. using (SqlDataAdapter da = new SqlDataAdapter(cmd)) { DataSet ds = new DataSet(); // 填充DataSet. da.Fill(ds); cmd.Parameters.Clear(); if (mustCloseConnection) connection.Close(); return ds; } } /// <summary> /// 執行指定數據庫連接對象的命令,指定參數值,返回DataSet. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸入參數和返回值. /// 示例.: /// DataSet ds = ExecuteDataset(conn, "GetOrders", 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlConnection connection, string spName, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); if ((parameterValues != null) && (parameterValues.Length > 0)) { // 比緩存中加載存儲過程參數 SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 給存儲過程參數分配值 AssignParameterValues(commandParameters, parameterValues); return ExecuteDataset(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteDataset(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定事務的命令,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="transaction">事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlTransaction transaction, CommandType commandType, string commandText) { return ExecuteDataset(transaction, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定事務的命令,指定參數,返回DataSet. /// </summary> /// <remarks> /// 示例: /// DataSet ds = ExecuteDataset(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <param name="commandParameters">SqlParamter參數數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlTransaction transaction, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); // 預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 創建 DataAdapter & DataSet using (SqlDataAdapter da = new SqlDataAdapter(cmd)) { DataSet ds = new DataSet(); da.Fill(ds); cmd.Parameters.Clear(); return ds; } } /// <summary> /// 執行指定事務的命令,指定參數值,返回DataSet. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸入參數和返回值. /// 示例.: /// DataSet ds = ExecuteDataset(trans, "GetOrders", 24, 36); /// </remarks> /// <param name="transaction">事務</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回一個包含結果集的DataSet</returns> public static DataSet ExecuteDataset(SqlTransaction transaction, string spName, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數 SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 給存儲過程參數分配值 AssignParameterValues(commandParameters, parameterValues); return ExecuteDataset(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteDataset(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteDataset數據集命令結束 #region ExecuteReader 數據閱讀器 /// <summary> /// 枚舉,標識數據庫連接是由SqlHelper提供還是由調用者提供 /// </summary> private enum SqlConnectionOwnership { /// <summary>由SqlHelper提供連接</summary> Internal, /// <summary>由調用者提供連接</summary> External } /// <summary> /// 執行指定數據庫連接對象的數據閱讀器. /// </summary> /// <remarks> /// 如果是SqlHelper打開連接,當連接關閉DataReader也將關閉. /// 如果是調用都打開連接,DataReader由調用都管理. /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="transaction">一個有效的事務,或者為 'null'</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <param name="commandParameters">SqlParameters參數數組,如果沒有參數則為'null'</param> /// <param name="connectionOwnership">標識數據庫連接對象是由調用者提供還是由SqlHelper提供</param> /// <returns>返回包含結果集的SqlDataReader</returns> private static SqlDataReader ExecuteReader(SqlConnection connection, SqlTransaction transaction, CommandType commandType, string commandText, SqlParameter[] commandParameters, SqlConnectionOwnership connectionOwnership) { if (connection == null) throw new ArgumentNullException("connection"); bool mustCloseConnection = false; // 創建命令 SqlCommand cmd = new SqlCommand(); try { PrepareCommand(cmd, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 創建數據閱讀器 SqlDataReader dataReader; if (connectionOwnership == SqlConnectionOwnership.External) { dataReader = cmd.ExecuteReader(); } else { dataReader = cmd.ExecuteReader(CommandBehavior.CloseConnection); } // 清除參數,以便再次使用.. // HACK: There is a problem here, the output parameter values are fletched // when the reader is closed, so if the parameters are detached from the command // then the SqlReader can磘 set its values. // When this happen, the parameters can磘 be used again in other command. bool canClear = true; foreach (SqlParameter commandParameter in cmd.Parameters) { if (commandParameter.Direction != ParameterDirection.Input) canClear = false; } if (canClear) { cmd.Parameters.Clear(); } return dataReader; } catch { if (mustCloseConnection) connection.Close(); throw; } } /// <summary> /// 執行指定數據庫連接字符串的數據閱讀器. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText) { return ExecuteReader(connectionString, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接字符串的數據閱讀器,指定參數. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(connString, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <param name="commandParameters">SqlParamter參數數組(new SqlParameter("@prodid", 24))</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(string connectionString, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); SqlConnection connection = null; try { connection = new SqlConnection(connectionString); connection.Open(); return ExecuteReader(connection, null, commandType, commandText, commandParameters, SqlConnectionOwnership.Internal); } catch { // If we fail to return the SqlDatReader, we need to close the connection ourselves if (connection != null) connection.Close(); throw; } } /// <summary> /// 執行指定數據庫連接字符串的數據閱讀器,指定參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// 示例: /// SqlDataReader dr = ExecuteReader(connString, "GetOrders", 24, 36); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(string connectionString, string spName, params object[] parameterValues) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); if ((parameterValues != null) && (parameterValues.Length > 0)) { SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteReader(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫連接對象的數據閱讀器. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名或T-SQL語句</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlConnection connection, CommandType commandType, string commandText) { return ExecuteReader(connection, commandType, commandText, (SqlParameter[])null); } /// <summary> /// [調用者方式]執行指定數據庫連接對象的數據閱讀器,指定參數. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandParameters">SqlParamter參數數組</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlConnection connection, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { return ExecuteReader(connection, (SqlTransaction)null, commandType, commandText, commandParameters, SqlConnectionOwnership.External); } /// <summary> /// [調用者方式]執行指定數據庫連接對象的數據閱讀器,指定參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// 示例: /// SqlDataReader dr = ExecuteReader(conn, "GetOrders", 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">T存儲過程名</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlConnection connection, string spName, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); if ((parameterValues != null) && (parameterValues.Length > 0)) { SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return ExecuteReader(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// [調用者方式]執行指定數據庫事務的數據閱讀器,指定參數值. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlTransaction transaction, CommandType commandType, string commandText) { return ExecuteReader(transaction, commandType, commandText, (SqlParameter[])null); } /// <summary> /// [調用者方式]執行指定數據庫事務的數據閱讀器,指定參數. /// </summary> /// <remarks> /// 示例: /// SqlDataReader dr = ExecuteReader(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlTransaction transaction, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); return ExecuteReader(transaction.Connection, transaction, commandType, commandText, commandParameters, SqlConnectionOwnership.External); } /// <summary> /// [調用者方式]執行指定數據庫事務的數據閱讀器,指定參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// SqlDataReader dr = ExecuteReader(trans, "GetOrders", 24, 36); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReader(SqlTransaction transaction, string spName, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); AssignParameterValues(commandParameters, parameterValues); return ExecuteReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteReader(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteReader數據閱讀器 #region ExecuteScalar 返回結果集中的第一行第一列 /// <summary> /// 執行指定數據庫連接字符串的命令,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(connString, CommandType.StoredProcedure, "GetOrderCount"); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(string connectionString, CommandType commandType, string commandText) { // 執行參數為空的方法 return ExecuteScalar(connectionString, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接字符串的命令,指定參數,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(connString, CommandType.StoredProcedure, "GetOrderCount", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(string connectionString, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); // 創建並打開數據庫連接對象,操作完成釋放對象. using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); // 調用指定數據庫連接字符串重載方法. return ExecuteScalar(connection, commandType, commandText, commandParameters); } } /// <summary> /// 執行指定數據庫連接字符串的命令,指定參數值,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// int orderCount = (int)ExecuteScalar(connString, "GetOrderCount", 24, 36); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(string connectionString, string spName, params object[] parameterValues) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteScalar(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteScalar(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫連接對象的命令,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlConnection connection, CommandType commandType, string commandText) { // 執行參數為空的方法 return ExecuteScalar(connection, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接對象的命令,指定參數,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(conn, CommandType.StoredProcedure, "GetOrderCount", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlConnection connection, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connection == null) throw new ArgumentNullException("connection"); // 創建SqlCommand命令,並進行預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, connection, (SqlTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection); // 執行SqlCommand命令,並返回結果. object retval = cmd.ExecuteScalar(); // 清除參數,以便再次使用. cmd.Parameters.Clear(); if (mustCloseConnection) connection.Close(); return retval; } /// <summary> /// 執行指定數據庫連接對象的命令,指定參數值,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// int orderCount = (int)ExecuteScalar(conn, "GetOrderCount", 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlConnection connection, string spName, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteScalar(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteScalar(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫事務的命令,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount"); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlTransaction transaction, CommandType commandType, string commandText) { // 執行參數為空的方法 return ExecuteScalar(transaction, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫事務的命令,指定參數,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 示例: /// int orderCount = (int)ExecuteScalar(trans, CommandType.StoredProcedure, "GetOrderCount", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlTransaction transaction, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); // 創建SqlCommand命令,並進行預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 執行SqlCommand命令,並返回結果. object retval = cmd.ExecuteScalar(); // 清除參數,以便再次使用. cmd.Parameters.Clear(); return retval; } /// <summary> /// 執行指定數據庫事務的命令,指定參數值,返回結果集中的第一行第一列. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// int orderCount = (int)ExecuteScalar(trans, "GetOrderCount", 24, 36); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalar(SqlTransaction transaction, string spName, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // PPull the parameters for this stored procedure from the parameter cache () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteScalar(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteScalar(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteScalar #region ExecuteXmlReader XML閱讀器 /// <summary> /// 執行指定數據庫連接對象的SqlCommand命令,並產生一個XmlReader對象做為結果集返回. /// </summary> /// <remarks> /// 示例: /// XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句 using "FOR XML AUTO"</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReader(SqlConnection connection, CommandType commandType, string commandText) { // 執行參數為空的方法 return ExecuteXmlReader(connection, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫連接對象的SqlCommand命令,並產生一個XmlReader對象做為結果集返回,指定參數. /// </summary> /// <remarks> /// 示例: /// XmlReader r = ExecuteXmlReader(conn, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句 using "FOR XML AUTO"</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReader(SqlConnection connection, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (connection == null) throw new ArgumentNullException("connection"); bool mustCloseConnection = false; // 創建SqlCommand命令,並進行預處理 SqlCommand cmd = new SqlCommand(); try { PrepareCommand(cmd, connection, (SqlTransaction)null, commandType, commandText, commandParameters, out mustCloseConnection); // 執行命令 XmlReader retval = cmd.ExecuteXmlReader(); // 清除參數,以便再次使用. cmd.Parameters.Clear(); return retval; } catch { if (mustCloseConnection) connection.Close(); throw; } } /// <summary> /// 執行指定數據庫連接對象的SqlCommand命令,並產生一個XmlReader對象做為結果集返回,指定參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// XmlReader r = ExecuteXmlReader(conn, "GetOrders", 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱 using "FOR XML AUTO"</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReader(SqlConnection connection, string spName, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteXmlReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteXmlReader(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定數據庫事務的SqlCommand命令,並產生一個XmlReader對象做為結果集返回. /// </summary> /// <remarks> /// 示例: /// XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders"); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句 using "FOR XML AUTO"</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReader(SqlTransaction transaction, CommandType commandType, string commandText) { // 執行參數為空的方法 return ExecuteXmlReader(transaction, commandType, commandText, (SqlParameter[])null); } /// <summary> /// 執行指定數據庫事務的SqlCommand命令,並產生一個XmlReader對象做為結果集返回,指定參數. /// </summary> /// <remarks> /// 示例: /// XmlReader r = ExecuteXmlReader(trans, CommandType.StoredProcedure, "GetOrders", new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句 using "FOR XML AUTO"</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReader(SqlTransaction transaction, CommandType commandType, string commandText, params SqlParameter[] commandParameters) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); // 創建SqlCommand命令,並進行預處理 SqlCommand cmd = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(cmd, transaction.Connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 執行命令 XmlReader retval = cmd.ExecuteXmlReader(); // 清除參數,以便再次使用. cmd.Parameters.Clear(); return retval; } /// <summary> /// 執行指定數據庫事務的SqlCommand命令,並產生一個XmlReader對象做為結果集返回,指定參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// XmlReader r = ExecuteXmlReader(trans, "GetOrders", 24, 36); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="spName">存儲過程名稱</param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> /// <returns>返回一個包含結果集的DataSet.</returns> public static XmlReader ExecuteXmlReader(SqlTransaction transaction, string spName, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 return ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { // 沒有參數值 return ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName); } } #endregion ExecuteXmlReader 閱讀器結束 #region FillDataset 填充數據集 /// <summary> /// 執行指定數據庫連接字符串的命令,映射數據表並填充數據集. /// </summary> /// <remarks> /// 示例: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.)</param> public static void FillDataset(string connectionString, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (dataSet == null) throw new ArgumentNullException("dataSet"); // 創建並打開數據庫連接對象,操作完成釋放對象. using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); // 調用指定數據庫連接字符串重載方法. FillDataset(connection, commandType, commandText, dataSet, tableNames); } } /// <summary> /// 執行指定數據庫連接字符串的命令,映射數據表並填充數據集.指定命令參數. /// </summary> /// <remarks> /// 示例: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> public static void FillDataset(string connectionString, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (dataSet == null) throw new ArgumentNullException("dataSet"); // 創建並打開數據庫連接對象,操作完成釋放對象. using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); // 調用指定數據庫連接字符串重載方法. FillDataset(connection, commandType, commandText, dataSet, tableNames, commandParameters); } } /// <summary> /// 執行指定數據庫連接字符串的命令,映射數據表並填充數據集,指定存儲過程參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// FillDataset(connString, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, 24); /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> public static void FillDataset(string connectionString, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (dataSet == null) throw new ArgumentNullException("dataSet"); // 創建並打開數據庫連接對象,操作完成釋放對象. using (SqlConnection connection = new SqlConnection(connectionString)) { connection.Open(); // 調用指定數據庫連接字符串重載方法. FillDataset(connection, spName, dataSet, tableNames, parameterValues); } } /// <summary> /// 執行指定數據庫連接對象的命令,映射數據表並填充數據集. /// </summary> /// <remarks> /// 示例: /// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> public static void FillDataset(SqlConnection connection, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { FillDataset(connection, commandType, commandText, dataSet, tableNames, null); } /// <summary> /// 執行指定數據庫連接對象的命令,映射數據表並填充數據集,指定參數. /// </summary> /// <remarks> /// 示例: /// FillDataset(conn, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> public static void FillDataset(SqlConnection connection, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params SqlParameter[] commandParameters) { FillDataset(connection, null, commandType, commandText, dataSet, tableNames, commandParameters); } /// <summary> /// 執行指定數據庫連接對象的命令,映射數據表並填充數據集,指定存儲過程參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// FillDataset(conn, "GetOrders", ds, new string[] {"orders"}, 24, 36); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> public static void FillDataset(SqlConnection connection, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if (connection == null) throw new ArgumentNullException("connection"); if (dataSet == null) throw new ArgumentNullException("dataSet"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 FillDataset(connection, CommandType.StoredProcedure, spName, dataSet, tableNames, commandParameters); } else { // 沒有參數值 FillDataset(connection, CommandType.StoredProcedure, spName, dataSet, tableNames); } } /// <summary> /// 執行指定數據庫事務的命令,映射數據表並填充數據集. /// </summary> /// <remarks> /// 示例: /// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> public static void FillDataset(SqlTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames) { FillDataset(transaction, commandType, commandText, dataSet, tableNames, null); } /// <summary> /// 執行指定數據庫事務的命令,映射數據表並填充數據集,指定參數. /// </summary> /// <remarks> /// 示例: /// FillDataset(trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> public static void FillDataset(SqlTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params SqlParameter[] commandParameters) { FillDataset(transaction.Connection, transaction, commandType, commandText, dataSet, tableNames, commandParameters); } /// <summary> /// 執行指定數據庫事務的命令,映射數據表並填充數據集,指定存儲過程參數值. /// </summary> /// <remarks> /// 此方法不提供訪問存儲過程輸出參數和返回值參數. /// /// 示例: /// FillDataset(trans, "GetOrders", ds, new string[]{"orders"}, 24, 36); /// </remarks> /// <param name="transaction">一個有效的連接事務</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="parameterValues">分配給存儲過程輸入參數的對象數組</param> public static void FillDataset(SqlTransaction transaction, string spName, DataSet dataSet, string[] tableNames, params object[] parameterValues) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (dataSet == null) throw new ArgumentNullException("dataSet"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果有參數值 if ((parameterValues != null) && (parameterValues.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 給存儲過程參數賦值 AssignParameterValues(commandParameters, parameterValues); // 調用重載方法 FillDataset(transaction, CommandType.StoredProcedure, spName, dataSet, tableNames, commandParameters); } else { // 沒有參數值 FillDataset(transaction, CommandType.StoredProcedure, spName, dataSet, tableNames); } } /// <summary> /// [私有方法][內部調用]執行指定數據庫連接對象/事務的命令,映射數據表並填充數據集,DataSet/TableNames/SqlParameters. /// </summary> /// <remarks> /// 示例: /// FillDataset(conn, trans, CommandType.StoredProcedure, "GetOrders", ds, new string[] {"orders"}, new SqlParameter("@prodid", 24)); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="transaction">一個有效的連接事務</param> /// <param name="commandType">命令類型 (存儲過程,命令文本或其它)</param> /// <param name="commandText">存儲過程名稱或T-SQL語句</param> /// <param name="dataSet">要填充結果集的DataSet實例</param> /// <param name="tableNames">表映射的數據表數組 /// 用戶定義的表名 (可有是實際的表名.) /// </param> /// <param name="commandParameters">分配給命令的SqlParamter參數數組</param> private static void FillDataset(SqlConnection connection, SqlTransaction transaction, CommandType commandType, string commandText, DataSet dataSet, string[] tableNames, params SqlParameter[] commandParameters) { if (connection == null) throw new ArgumentNullException("connection"); if (dataSet == null) throw new ArgumentNullException("dataSet"); // 創建SqlCommand命令,並進行預處理 SqlCommand command = new SqlCommand(); bool mustCloseConnection = false; PrepareCommand(command, connection, transaction, commandType, commandText, commandParameters, out mustCloseConnection); // 執行命令 using (SqlDataAdapter dataAdapter = new SqlDataAdapter(command)) { // 追加表映射 if (tableNames != null && tableNames.Length > 0) { string tableName = "Table"; for (int index = 0; index < tableNames.Length; index++) { if (tableNames[index] == null || tableNames[index].Length == 0) throw new ArgumentException("The tableNames parameter must contain a list of tables, a value was provided as null or empty string.", "tableNames"); dataAdapter.TableMappings.Add(tableName, tableNames[index]); tableName += (index + 1).ToString(); } } // 填充數據集使用默認表名稱 dataAdapter.Fill(dataSet); // 清除參數,以便再次使用. command.Parameters.Clear(); } if (mustCloseConnection) connection.Close(); } #endregion #region UpdateDataset 更新數據集 /// <summary> /// 執行數據集更新到數據庫,指定inserted, updated, or deleted命令. /// </summary> /// <remarks> /// 示例: /// UpdateDataset(conn, insertCommand, deleteCommand, updateCommand, dataSet, "Order"); /// </remarks> /// <param name="insertCommand">[追加記錄]一個有效的T-SQL語句或存儲過程</param> /// <param name="deleteCommand">[刪除記錄]一個有效的T-SQL語句或存儲過程</param> /// <param name="updateCommand">[更新記錄]一個有效的T-SQL語句或存儲過程</param> /// <param name="dataSet">要更新到數據庫的DataSet</param> /// <param name="tableName">要更新到數據庫的DataTable</param> public static void UpdateDataset(SqlCommand insertCommand, SqlCommand deleteCommand, SqlCommand updateCommand, DataSet dataSet, string tableName) { if (insertCommand == null) throw new ArgumentNullException("insertCommand"); if (deleteCommand == null) throw new ArgumentNullException("deleteCommand"); if (updateCommand == null) throw new ArgumentNullException("updateCommand"); if (tableName == null || tableName.Length == 0) throw new ArgumentNullException("tableName"); // 創建SqlDataAdapter,當操作完成后釋放. using (SqlDataAdapter dataAdapter = new SqlDataAdapter()) { // 設置數據適配器命令 dataAdapter.UpdateCommand = updateCommand; dataAdapter.InsertCommand = insertCommand; dataAdapter.DeleteCommand = deleteCommand; // 更新數據集改變到數據庫 dataAdapter.Update(dataSet, tableName); // 提交所有改變到數據集. dataSet.AcceptChanges(); } } #endregion #region CreateCommand 創建一條SqlCommand命令 /// <summary> /// 創建SqlCommand命令,指定數據庫連接對象,存儲過程名和參數. /// </summary> /// <remarks> /// 示例: /// SqlCommand command = CreateCommand(conn, "AddCustomer", "CustomerID", "CustomerName"); /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="sourceColumns">源表的列名稱數組</param> /// <returns>返回SqlCommand命令</returns> public static SqlCommand CreateCommand(SqlConnection connection, string spName, params string[] sourceColumns) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 創建命令 SqlCommand cmd = new SqlCommand(spName, connection); cmd.CommandType = CommandType.StoredProcedure; // 如果有參數值 if ((sourceColumns != null) && (sourceColumns.Length > 0)) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 將源表的列到映射到DataSet命令中. for (int index = 0; index < sourceColumns.Length; index++) commandParameters[index].SourceColumn = sourceColumns[index]; // Attach the discovered parameters to the SqlCommand object AttachParameters(cmd, commandParameters); } return cmd; } #endregion #region ExecuteNonQueryTypedParams 類型化參數(DataRow) /// <summary> /// 執行指定連接數據庫連接字符串的存儲過程,使用DataRow做為參數值,返回受影響的行數. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQueryTypedParams(String connectionString, String spName, DataRow dataRow) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteNonQuery(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫連接對象的存儲過程,使用DataRow做為參數值,返回受影響的行數. /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQueryTypedParams(SqlConnection connection, String spName, DataRow dataRow) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteNonQuery(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫事物的存儲過程,使用DataRow做為參數值,返回受影響的行數. /// </summary> /// <param name="transaction">一個有效的連接事務 object</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回影響的行數</returns> public static int ExecuteNonQueryTypedParams(SqlTransaction transaction, String spName, DataRow dataRow) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // Sf the row has values, the store procedure parameters must be initialized if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteNonQuery(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteDatasetTypedParams 類型化參數(DataRow) /// <summary> /// 執行指定連接數據庫連接字符串的存儲過程,使用DataRow做為參數值,返回DataSet. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回一個包含結果集的DataSet.</returns> public static DataSet ExecuteDatasetTypedParams(string connectionString, String spName, DataRow dataRow) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); //如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteDataset(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫連接對象的存儲過程,使用DataRow做為參數值,返回DataSet. /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回一個包含結果集的DataSet.</returns> /// public static DataSet ExecuteDatasetTypedParams(SqlConnection connection, String spName, DataRow dataRow) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteDataset(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫事務的存儲過程,使用DataRow做為參數值,返回DataSet. /// </summary> /// <param name="transaction">一個有效的連接事務 object</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回一個包含結果集的DataSet.</returns> public static DataSet ExecuteDatasetTypedParams(SqlTransaction transaction, String spName, DataRow dataRow) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteDataset(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteReaderTypedParams 類型化參數(DataRow) /// <summary> /// 執行指定連接數據庫連接字符串的存儲過程,使用DataRow做為參數值,返回DataReader. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReaderTypedParams(String connectionString, String spName, DataRow dataRow) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteReader(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫連接對象的存儲過程,使用DataRow做為參數值,返回DataReader. /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReaderTypedParams(SqlConnection connection, String spName, DataRow dataRow) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteReader(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫事物的存儲過程,使用DataRow做為參數值,返回DataReader. /// </summary> /// <param name="transaction">一個有效的連接事務 object</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回包含結果集的SqlDataReader</returns> public static SqlDataReader ExecuteReaderTypedParams(SqlTransaction transaction, String spName, DataRow dataRow) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteReader(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteScalarTypedParams 類型化參數(DataRow) /// <summary> /// 執行指定連接數據庫連接字符串的存儲過程,使用DataRow做為參數值,返回結果集中的第一行第一列. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalarTypedParams(String connectionString, String spName, DataRow dataRow) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connectionString, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteScalar(connectionString, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫連接對象的存儲過程,使用DataRow做為參數值,返回結果集中的第一行第一列. /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalarTypedParams(SqlConnection connection, String spName, DataRow dataRow) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteScalar(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫事務的存儲過程,使用DataRow做為參數值,返回結果集中的第一行第一列. /// </summary> /// <param name="transaction">一個有效的連接事務 object</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回結果集中的第一行第一列</returns> public static object ExecuteScalarTypedParams(SqlTransaction transaction, String spName, DataRow dataRow) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteScalar(transaction, CommandType.StoredProcedure, spName); } } #endregion #region ExecuteXmlReaderTypedParams 類型化參數(DataRow) /// <summary> /// 執行指定連接數據庫連接對象的存儲過程,使用DataRow做為參數值,返回XmlReader類型的結果集. /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReaderTypedParams(SqlConnection connection, String spName, DataRow dataRow) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteXmlReader(connection, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteXmlReader(connection, CommandType.StoredProcedure, spName); } } /// <summary> /// 執行指定連接數據庫事務的存儲過程,使用DataRow做為參數值,返回XmlReader類型的結果集. /// </summary> /// <param name="transaction">一個有效的連接事務 object</param> /// <param name="spName">存儲過程名稱</param> /// <param name="dataRow">使用DataRow作為參數值</param> /// <returns>返回XmlReader結果集對象.</returns> public static XmlReader ExecuteXmlReaderTypedParams(SqlTransaction transaction, String spName, DataRow dataRow) { if (transaction == null) throw new ArgumentNullException("transaction"); if (transaction != null && transaction.Connection == null) throw new ArgumentException("The transaction was rollbacked or commited, please provide an open transaction.", "transaction"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); // 如果row有值,存儲過程必須初始化. if (dataRow != null && dataRow.ItemArray.Length > 0) { // 從緩存中加載存儲過程參數,如果緩存中不存在則從數據庫中檢索參數信息並加載到緩存中. () SqlParameter[] commandParameters = SqlHelperParameterCache.GetSpParameterSet(transaction.Connection, spName); // 分配參數值 AssignParameterValues(commandParameters, dataRow); return SqlHelper.ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName, commandParameters); } else { return SqlHelper.ExecuteXmlReader(transaction, CommandType.StoredProcedure, spName); } } #endregion } /// <summary> /// SqlHelperParameterCache提供緩存存儲過程參數,並能夠在運行時從存儲過程中探索參數. /// </summary> public sealed class SqlHelperParameterCache { #region 私有方法,字段,構造函數 // 私有構造函數,妨止類被實例化. private SqlHelperParameterCache() { } // 這個方法要注意 private static Hashtable paramCache = Hashtable.Synchronized(new Hashtable()); /// <summary> /// 探索運行時的存儲過程,返回SqlParameter參數數組. /// 初始化參數值為 DBNull.Value. /// </summary> /// <param name="connection">一個有效的數據庫連接</param> /// <param name="spName">存儲過程名稱</param> /// <param name="includeReturnValueParameter">是否包含返回值參數</param> /// <returns>返回SqlParameter參數數組</returns> private static SqlParameter[] DiscoverSpParameterSet(SqlConnection connection, string spName, bool includeReturnValueParameter) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); SqlCommand cmd = new SqlCommand(spName, connection); cmd.CommandType = CommandType.StoredProcedure; connection.Open(); // 檢索cmd指定的存儲過程的參數信息,並填充到cmd的Parameters參數集中. SqlCommandBuilder.DeriveParameters(cmd); connection.Close(); // 如果不包含返回值參數,將參數集中的每一個參數刪除. if (!includeReturnValueParameter) { cmd.Parameters.RemoveAt(0); } // 創建參數數組 SqlParameter[] discoveredParameters = new SqlParameter[cmd.Parameters.Count]; // 將cmd的Parameters參數集復制到discoveredParameters數組. cmd.Parameters.CopyTo(discoveredParameters, 0); // 初始化參數值為 DBNull.Value. foreach (SqlParameter discoveredParameter in discoveredParameters) { discoveredParameter.Value = DBNull.Value; } return discoveredParameters; } /// <summary> /// SqlParameter參數數組的深層拷貝. /// </summary> /// <param name="originalParameters">原始參數數組</param> /// <returns>返回一個同樣的參數數組</returns> private static SqlParameter[] CloneParameters(SqlParameter[] originalParameters) { SqlParameter[] clonedParameters = new SqlParameter[originalParameters.Length]; for (int i = 0, j = originalParameters.Length; i < j; i++) { clonedParameters[i] = (SqlParameter)((ICloneable)originalParameters[i]).Clone(); } return clonedParameters; } #endregion 私有方法,字段,構造函數結束 #region 緩存方法 /// <summary> /// 追加參數數組到緩存. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符串</param> /// <param name="commandText">存儲過程名或SQL語句</param> /// <param name="commandParameters">要緩存的參數數組</param> public static void CacheParameterSet(string connectionString, string commandText, params SqlParameter[] commandParameters) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (commandText == null || commandText.Length == 0) throw new ArgumentNullException("commandText"); string hashKey = connectionString + ":" + commandText; paramCache[hashKey] = commandParameters; } /// <summary> /// 從緩存中獲取參數數組. /// </summary> /// <param name="connectionString">一個有效的數據庫連接字符</param> /// <param name="commandText">存儲過程名或SQL語句</param> /// <returns>參數數組</returns> public static SqlParameter[] GetCachedParameterSet(string connectionString, string commandText) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (commandText == null || commandText.Length == 0) throw new ArgumentNullException("commandText"); string hashKey = connectionString + ":" + commandText; SqlParameter[] cachedParameters = paramCache[hashKey] as SqlParameter[]; if (cachedParameters == null) { return null; } else { return CloneParameters(cachedParameters); } } #endregion 緩存方法結束 #region 檢索指定的存儲過程的參數集 /// <summary> /// 返回指定的存儲過程的參數集 /// </summary> /// <remarks> /// 這個方法將查詢數據庫,並將信息存儲到緩存. /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符</param> /// <param name="spName">存儲過程名</param> /// <returns>返回SqlParameter參數數組</returns> public static SqlParameter[] GetSpParameterSet(string connectionString, string spName) { return GetSpParameterSet(connectionString, spName, false); } /// <summary> /// 返回指定的存儲過程的參數集 /// </summary> /// <remarks> /// 這個方法將查詢數據庫,並將信息存儲到緩存. /// </remarks> /// <param name="connectionString">一個有效的數據庫連接字符.</param> /// <param name="spName">存儲過程名</param> /// <param name="includeReturnValueParameter">是否包含返回值參數</param> /// <returns>返回SqlParameter參數數組</returns> public static SqlParameter[] GetSpParameterSet(string connectionString, string spName, bool includeReturnValueParameter) { if (connectionString == null || connectionString.Length == 0) throw new ArgumentNullException("connectionString"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); using (SqlConnection connection = new SqlConnection(connectionString)) { return GetSpParameterSetInternal(connection, spName, includeReturnValueParameter); } } /// <summary> /// [內部]返回指定的存儲過程的參數集(使用連接對象). /// </summary> /// <remarks> /// 這個方法將查詢數據庫,並將信息存儲到緩存. /// </remarks> /// <param name="connection">一個有效的數據庫連接字符</param> /// <param name="spName">存儲過程名</param> /// <returns>返回SqlParameter參數數組</returns> internal static SqlParameter[] GetSpParameterSet(SqlConnection connection, string spName) { return GetSpParameterSet(connection, spName, false); } /// <summary> /// [內部]返回指定的存儲過程的參數集(使用連接對象) /// </summary> /// <remarks> /// 這個方法將查詢數據庫,並將信息存儲到緩存. /// </remarks> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名</param> /// <param name="includeReturnValueParameter"> /// 是否包含返回值參數 /// </param> /// <returns>返回SqlParameter參數數組</returns> internal static SqlParameter[] GetSpParameterSet(SqlConnection connection, string spName, bool includeReturnValueParameter) { if (connection == null) throw new ArgumentNullException("connection"); using (SqlConnection clonedConnection = (SqlConnection)((ICloneable)connection).Clone()) { return GetSpParameterSetInternal(clonedConnection, spName, includeReturnValueParameter); } } /// <summary> /// [私有]返回指定的存儲過程的參數集(使用連接對象) /// </summary> /// <param name="connection">一個有效的數據庫連接對象</param> /// <param name="spName">存儲過程名</param> /// <param name="includeReturnValueParameter">是否包含返回值參數</param> /// <returns>返回SqlParameter參數數組</returns> private static SqlParameter[] GetSpParameterSetInternal(SqlConnection connection, string spName, bool includeReturnValueParameter) { if (connection == null) throw new ArgumentNullException("connection"); if (spName == null || spName.Length == 0) throw new ArgumentNullException("spName"); string hashKey = connection.ConnectionString + ":" + spName + (includeReturnValueParameter ? ":include ReturnValue Parameter" : ""); SqlParameter[] cachedParameters; cachedParameters = paramCache[hashKey] as SqlParameter[]; if (cachedParameters == null) { SqlParameter[] spParameters = DiscoverSpParameterSet(connection, spName, includeReturnValueParameter); paramCache[hashKey] = spParameters; cachedParameters = spParameters; } return CloneParameters(cachedParameters); } #endregion 參數集檢索結束 } }
2、ConvertJson類

using System; using System.Collections.Generic; using System.Data; using System.Linq; using System.Text; using System.Threading.Tasks; namespace WindowsFormsApplication_1709 { /// <summary> /// DataTable 轉換成Json 操作類 /// </summary> public static class ConvertJson { #region DataSet轉換為Json /// <summary> /// DataSet轉換為Json /// </summary> /// <param name="dataSet">DataSet對象</param> /// <returns>Json字符串</returns> public static string ToJson(DataSet dataSet) { string jsonString = "{"; foreach (DataTable table in dataSet.Tables) { jsonString += "\"" + table.TableName + "\":" + ToJson(table) + ","; } jsonString = jsonString.TrimEnd(','); return jsonString + "}"; } #endregion #region Datatable轉換為Json /// <summary> /// Datatable轉換為Json /// </summary> /// <param name="table">Datatable對象</param> /// <returns>Json字符串</returns> public static string ToJson(DataTable dt) { StringBuilder jsonString = new StringBuilder(); jsonString.Append("["); DataRowCollection drc = dt.Rows; for (int i = 0; i < drc.Count; i++) { jsonString.Append("{"); for (int j = 0; j < dt.Columns.Count; j++) { string strKey = dt.Columns[j].ColumnName; string strValue = drc[i][j].ToString(); Type type = dt.Columns[j].DataType; jsonString.Append("\"" + strKey + "\":"); strValue = StringFormat(strValue, type); if (j < dt.Columns.Count - 1) { jsonString.Append(strValue + ","); } else { jsonString.Append(strValue); } } jsonString.Append("},"); } jsonString.Remove(jsonString.Length - 1, 1); jsonString.Append("]"); return jsonString.ToString(); } /// <summary> /// DataTable轉換為Json /// </summary> public static string ToJson(DataTable dt, string jsonName) { StringBuilder Json = new StringBuilder(); if (string.IsNullOrEmpty(jsonName)) jsonName = dt.TableName; Json.Append("{\"" + jsonName + "\":["); if (dt.Rows.Count > 0) { for (int i = 0; i < dt.Rows.Count; i++) { Json.Append("{"); for (int j = 0; j < dt.Columns.Count; j++) { Type type = dt.Rows[i][j].GetType(); Json.Append("\"" + dt.Columns[j].ColumnName.ToString() + "\":" + StringFormat(dt.Rows[i][j].ToString(), type)); if (j < dt.Columns.Count - 1) { Json.Append(","); } } Json.Append("}"); if (i < dt.Rows.Count - 1) { Json.Append(","); } } } Json.Append("]}"); return Json.ToString(); } #endregion /// <summary> /// 格式化字符型、日期型、布爾型 /// </summary> /// <param name="str"></param> /// <param name="type"></param> /// <returns></returns> private static string StringFormat(string str, Type type) { if (type == typeof(string)) { str = String2Json(str); str = "\"" + str + "\""; } else if (type == typeof(DateTime)) { str = "\"" + str + "\""; } else if (type == typeof(bool)) { str = str.ToLower(); } else if (type != typeof(string) && string.IsNullOrEmpty(str)) { str = "\"" + str + "\""; } return str; } #region 私有方法 /// <summary> /// 過濾特殊字符 /// </summary> /// <param name="s">字符串</param> /// <returns>json字符串</returns> private static string String2Json(String s) { StringBuilder sb = new StringBuilder(); for (int i = 0; i < s.Length; i++) { char c = s.ToCharArray()[i]; switch (c) { case '\"': sb.Append("\\\""); break; case '\\': sb.Append("\\\\"); break; case '/': sb.Append("\\/"); break; case '\b': sb.Append("\\b"); break; case '\f': sb.Append("\\f"); break; case '\n': sb.Append("\\n"); break; case '\r': sb.Append("\\r"); break; case '\t': sb.Append("\\t"); break; default: sb.Append(c); break; } } return sb.ToString(); } #endregion } }