兩種讀寫配置檔案的方案(app.config與web.config通用)

夢在旅途發表於2015-04-07

第一種方法:採用MS現有的ConfigurationManager來進行讀寫

using System.Configuration;


namespace Zwj.TEMS.Common
{
    public abstract class ConfigHelper
    {
        private ConfigHelper()
        { }

        /// <summary>
        /// 獲取配置值
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        public static string GetAppSettingValue(string key)
        {
            return ConfigurationManager.AppSettings[key];
        }

        /// <summary>
        /// 設定配置值(存在則更新,不存在則新增)
        /// </summary>
        /// <param name="key"></param>
        /// <param name="value"></param>
        public static void SetAppSettingValue(string key, string value)
        {
            var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            var setting = config.AppSettings.Settings[key];
            if (setting==null)
            {
                config.AppSettings.Settings.Add(key, value);
            }
            else
            {
                setting.Value = value;
            }

            config.Save(ConfigurationSaveMode.Modified);
            ConfigurationManager.RefreshSection("appSettings");
        }

        /// <summary>
        /// 刪除配置值
        /// </summary>
        /// <param name="key"></param>
        public static void RemoveAppSetting(string key)
        {
            var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            config.AppSettings.Settings.Remove(key);
            config.Save(ConfigurationSaveMode.Modified);
            ConfigurationManager.RefreshSection("appSettings");
        }


        /// <summary>
        /// 獲取連線字串
        /// </summary>
        /// <param name="name"></param>
        /// <returns></returns>
        public static string GetConnectionString(string name)
        {
          return  ConfigurationManager.ConnectionStrings[name].ConnectionString;
        }

        /// <summary>
        /// 設定連線字串的值(存在則更新,不存在則新增)
        /// </summary>
        /// <param name="name"></param>
        /// <param name="connstr"></param>
        /// <param name="provider"></param>
        public static void SetConnectionString(string name,string connstr, string provider)
        {
            var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            ConnectionStringSettings connStrSettings = config.ConnectionStrings.ConnectionStrings[name];
            if (connStrSettings != null)
            {
                connStrSettings.ConnectionString = connstr;
                connStrSettings.ProviderName = provider;
            }
            else
            {
                connStrSettings = new ConnectionStringSettings(name, connstr, provider);
                config.ConnectionStrings.ConnectionStrings.Add(connStrSettings);
            }

            config.Save(ConfigurationSaveMode.Modified);
            ConfigurationManager.RefreshSection("connectionStrings");
        }

        /// <summary>
        /// 刪除連線字串配置項
        /// </summary>
        /// <param name="name"></param>
        public static void RemoveConnectionString(string name)
        {
            var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            config.ConnectionStrings.ConnectionStrings.Remove(name);
            config.Save(ConfigurationSaveMode.Modified);
            ConfigurationManager.RefreshSection("connectionStrings");
        }

    }
}

 注意:不能直接使用ConfigurationManager.AppSettings及ConfigurationManager.ConnectionStrings進行寫操作(即:Add,Remove),因為這兩個屬性是隻讀的,本人之前也疑惑,明明能夠呼叫Add,Remove方法,但使用時卻報錯。

第二種方法:採用原生的XML+XPATH來讀寫(來源於網路)

//==============================================
// 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;

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 ex)
        {
            isSuccess = false;
            throw ex;
        }
        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 ex)
        {
            isSuccess = false;
            throw ex;
        }
        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 ex)
        {
            isSuccess = false;
        }
        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 ex)
        {
            isSuccess = false;
        }
        return isSuccess;
    }
}

更多IT相關技術文章與資訊,歡迎光臨我的個人網站:http://www.zuowenjun.cn

相關文章