天天看點

C#對App.config檔案或者web.config檔案中節點的操作類

//==============================================

//        FileName: ConfigManager

//        Description: 靜态方法業務類,用于對C#、ASP.NET中的WinForm & WebForm 項目程式配置檔案

//             app.config和web.config的[appSettings]和[connectionStrings]節點進行新增、修改、删除和讀取相關的操作。

//==============================================

using System;

using System.Data;

using System.Configuration;

using System.Web;

using System.Collections.Generic;

using System.Text;

using System.Xml;

using TempusMq;

namespace Kevin.DAL

{

   public enum ConfigurationFile

   {

        AppConfig=1,

        WebConfig=2

   }

    /// <summary>

    /// ConfigManager 應用程式配置檔案管理器

    /// </summary>

   public class ConfigManager

   {

       public ConfigManager()

       {

           //

           // TODO: 在此處添加構造函數邏輯

           //

       }

       /// <summary>

       /// 對[appSettings]節點依據Key值讀取到Value值,傳回字元串

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="key">要讀取的Key值</param>

       /// <returns>傳回Value值的字元串</returns>

       public static string ReadValueByKey(ConfigurationFile configurationFile, string key)

       {

           string value = string.Empty;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//appSettings");   //得到[appSettings]節點

           得到[appSettings]節點中關于Key的子節點

           XmlElement element = (XmlElement)node.SelectSingleNode("//add[@key='" + key + "']");

           if (element != null)

           {

               value = element.GetAttribute("value");

           }

           return value;

       }

       /// <summary>

       /// 對[connectionStrings]節點依據name值讀取到connectionString值,傳回字元串

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="name">要讀取的name值</param>

       /// <returns>傳回connectionString值的字元串</returns>

       public static string ReadConnectionStringByName(ConfigurationFile configurationFile, string name)

       {

           string connectionString = string.Empty;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//connectionStrings");   //得到[appSettings]節點

           得到[connectionString]節點中關于name的子節點

           XmlElement element = (XmlElement)node.SelectSingleNode("//add[@name='" + name + "']");

           if (element != null)

           {

               connectionString = element.GetAttribute("connectionString");

           }

           return connectionString;

       }

       /// <summary>

       /// 更新或新增[appSettings]節點的子節點值,存在則更新子節點Value,不存在則新增子節點,傳回成功與否布爾值

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="key">子節點Key值</param>

       /// <param name="value">子節點value值</param>

       /// <returns>傳回成功與否布爾值</returns>

       public static bool UpdateOrCreateAppSetting(ConfigurationFile configurationFile, string key, string value)

       {

           bool isSuccess = false;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//appSettings");   //得到[appSettings]節點

           try

           {

               得到[appSettings]節點中關于Key的子節點

               XmlElement element = (XmlElement)node.SelectSingleNode("//add[@key='" + key + "']");

               if (element != null)

               {

                   //存在則更新子節點Value

                   element.SetAttribute("value", value);

               }

               else

               {

                   //不存在則新增子節點

                   XmlElement subElement = doc.CreateElement("add");

                   subElement.SetAttribute("key", key);

                   subElement.SetAttribute("value", value);

                   node.AppendChild(subElement);

               }

               //儲存至配置檔案(方式一)

               using (XmlTextWriter xmlwriter = new XmlTextWriter(filename, null))

               {

                   xmlwriter.Formatting = Formatting.Indented;

                   doc.WriteTo(xmlwriter);

                   xmlwriter.Flush();

               }

               isSuccess = true;

           }

           catch (Exception e)

           {

               isSuccess = false;

               //輸出的調試字元串

               string strOuput = string.Format("更新或新增[appSettings]節點的子節點值失敗:{0}\n", e.Message);

               //将資訊寫入到日志輸出檔案

               DllComm.TP_WriteAppLogFileEx(DllComm.g_AppLogFileName, strOuput);

           }

           return isSuccess;

       }

       /// <summary>

       /// 更新或新增[appSettings]節點的子節點值,存在則更新子節點Value,不存在則新增子節點,傳回成功與否布爾值

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="key">子節點Key值</param>

       /// <param name="value">子節點value值</param>

       /// <returns>傳回成功與否布爾值</returns>

       public static bool UpdateOrCreateAppSetting(ConfigurationFile configurationFile,string configFileName,string key, string value)

           {

               bool isSuccess = false;

               string filename = configFileName;

               XmlDocument doc = new XmlDocument();

               doc.Load(filename); //加載配置檔案

               XmlNode node = doc.SelectSingleNode("//appSettings");   //得到[appSettings]節點

               try

                {

                    得到[appSettings]節點中關于Key的子節點

                    XmlElement element = (XmlElement)node.SelectSingleNode("//add[@key='" + key + "']");

                    if (element != null)

                        {

                        //存在則更新子節點Value

                        element.SetAttribute("value", value);

                        }

                    else

                        {

                        //不存在則新增子節點

                        XmlElement subElement = doc.CreateElement("add");

                        subElement.SetAttribute("key", key);

                        subElement.SetAttribute("value", value);

                        node.AppendChild(subElement);

                        }

                    //儲存至配置檔案(方式一)

                    using (XmlTextWriter xmlwriter = new XmlTextWriter(filename, null))

                        {

                        xmlwriter.Formatting = Formatting.Indented;

                        doc.WriteTo(xmlwriter);

                        xmlwriter.Flush();

                        }

                    isSuccess = true;

                }

               catch (Exception e)

                {

                isSuccess = false;

                //輸出的調試字元串

                string strOuput = string.Format("更新或新增[appSettings]節點的子節點值失敗:{0}\n", e.Message);

                //将資訊寫入到日志輸出檔案

                DllComm.TP_WriteAppLogFileEx(DllComm.g_AppLogFileName, strOuput);

                }

               return isSuccess;

           }

       /// <summary>

       /// 更新或新增[connectionStrings]節點的子節點值,存在則更新子節點,不存在則新增子節點,傳回成功與否布爾值

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="name">子節點name值</param>

       /// <param name="connectionString">子節點connectionString值</param>

       /// <param name="providerName">子節點providerName值</param>

       /// <returns>傳回成功與否布爾值</returns>

       public static bool UpdateOrCreateConnectionString(ConfigurationFile configurationFile, string name, string connectionString, string providerName)

       {

           bool isSuccess = false;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//connectionStrings");   //得到[connectionStrings]節點

           try

           {

               得到[connectionStrings]節點中關于Name的子節點

               XmlElement element = (XmlElement)node.SelectSingleNode("//add[@name='" + name + "']");

               if (element != null)

               {

                   //存在則更新子節點

                   element.SetAttribute("connectionString", connectionString);

                   element.SetAttribute("providerName", providerName);

               }

               else

               {

                   //不存在則新增子節點

                   XmlElement subElement = doc.CreateElement("add");

                   subElement.SetAttribute("name", name);

                   subElement.SetAttribute("connectionString", connectionString);

                   subElement.SetAttribute("providerName", providerName);

                   node.AppendChild(subElement);

               }

               //儲存至配置檔案(方式二)

               doc.Save(filename);

               isSuccess = true;

           }

           catch (Exception e)

           {

               isSuccess = false;

               //輸出的調試字元串

               string strOuput = string.Format("更新或新增[connectionStrings]節點的子節點值:{0}失敗:{1}\n",name,e.Message);

               //将資訊寫入到日志輸出檔案

               DllComm.TP_WriteAppLogFileEx(DllComm.g_AppLogFileName, strOuput);

           }

           return isSuccess;

       }

       /// <summary>

       /// 删除[appSettings]節點中包含Key值的子節點,傳回成功與否布爾值

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="key">要删除的子節點Key值</param>

       /// <returns>傳回成功與否布爾值</returns>

       public static bool DeleteByKey(ConfigurationFile configurationFile, string key)

       {

           bool isSuccess = false;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//appSettings");   //得到[appSettings]節點

           得到[appSettings]節點中關于Key的子節點

           XmlElement element = (XmlElement)node.SelectSingleNode("//add[@key='" + key + "']");

           if (element != null)

           {

               //存在則删除子節點

               element.ParentNode.RemoveChild(element);

           }

           else

           {

               //不存在

           }

           try

           {

               //儲存至配置檔案(方式一)

               using (XmlTextWriter xmlwriter = new XmlTextWriter(filename, null))

               {

                   xmlwriter.Formatting = Formatting.Indented;

                   doc.WriteTo(xmlwriter);

                   xmlwriter.Flush();

               }

               isSuccess = true;

           }

           catch (Exception e)

           {

               //輸出的調試字元串

               string strOuput = string.Format("删除[appSettings]節點中包含Key:{0}值的子節點失敗:{1}\n",key, e.Message);

               //将資訊寫入到日志輸出檔案

               DllComm.TP_WriteAppLogFileEx(DllComm.g_AppLogFileName, strOuput);

           }

           return isSuccess;

       }

       /// <summary>

       /// 删除[connectionStrings]節點中包含name值的子節點,傳回成功與否布爾值

       /// </summary>

       /// <param name="configurationFile">要操作的配置檔案名稱,枚舉常量</param>

       /// <param name="name">要删除的子節點name值</param>

       /// <returns>傳回成功與否布爾值</returns>

       public static bool DeleteByName(ConfigurationFile configurationFile, string name)

       {

           bool isSuccess = false;

           string filename = string.Empty;

           if (configurationFile.ToString() == ConfigurationFile.AppConfig.ToString())

           {

               filename = System.Windows.Forms.Application.ExecutablePath + ".config";

           }

           else

           {

               filename = System.AppDomain.CurrentDomain.BaseDirectory + "web.config";

           }

           XmlDocument doc = new XmlDocument();

           doc.Load(filename); //加載配置檔案

           XmlNode node = doc.SelectSingleNode("//connectionStrings");   //得到[connectionStrings]節點

           得到[connectionStrings]節點中關于Name的子節點

           XmlElement element = (XmlElement)node.SelectSingleNode("//add[@name='" + name + "']");

           if (element != null)

           {

               //存在則删除子節點

               node.RemoveChild(element);

           }

           else

           {

               //不存在

           }

           try

           {

               //儲存至配置檔案(方式二)

               doc.Save(filename);

               isSuccess = true;

           }

           catch (Exception e)

           {

               isSuccess = false;

               //輸出的調試字元串

               string strOuput = string.Format("删除[connectionStrings]節點中包含name:{0}值的子節點失敗:{1}\n",name,e.Message);

               //将資訊寫入到日志輸出檔案

               DllComm.TP_WriteAppLogFileEx(DllComm.g_AppLogFileName, strOuput);

           }

           return isSuccess;

       }

   }

}