程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> C# >> C#基礎知識 >> C# ConfigHelper 輔助類介紹

C# ConfigHelper 輔助類介紹

編輯:C#基礎知識

代碼如下:

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

}

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved