APP.Config配置文件

红太狼 2024-02-18 15:36 8阅读 0赞

## 目录 ##

*  目录
 *  背景
 *  什么是配置文件
 *  在哪里创建配置文件
 *  connectionStrings 配置节
 *  appSettings 配置节
 *  读取与更新 appconfig
    
     *  1 读取connectionStrings配置节
     *  2 更新connectionStrings配置节
     *  3 读取appStrings配置节
     *  4 更新connectionStrings配置节

## 背景 ##

最近在程序开发过程中总是用到配置文件APP.Config。它的好处就是方便后期维护。接下来我将为大家展示system.configuration namespace with .net2.0中How to read/write to App.Config。

## 什么是配置文件： ##

用户配置文件就是在用户使用软件时，软件系统为用户所要加载所需环境的设置和文件的集合。它包括所有用户专用的配置设置，如数据库链接等  
　　配置文件分为两种 一种是应用程序的配置文件(app.config), 一种是web的配置文件(web.config).两种配置文件最大的区别是web的配置文件更新之后会实时更新, 应用程序的配置文件不会实时更新.今天讨论的则是app.config。

## 在哪里创建配置文件： ##

右击项目名称，选择“添加”→“添加新建项”，在出现的“添加新项”对话框中，选择“添加应用程序配置文件”；如果项目以前没有配置文件，则默认的文件名称为“app.config”，单击“确定”。出现在设计器视图中的。  
![这里写图片描述][SouthEast]

app.config文件初始状态为：

<?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <startup> 
            <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
        </startup>
    </configuration>

在项目进行编译后，在bin\\Debuge文件下，将出现两个配置文件(以本项目为例)，一个名为“解决方案名.vshost.exe”，另一个名为“解决方案名.vshost.exe.manifest”。第一个文件为项目实际使用的配置文件，在程序运行中所做的更改都将被保存于此；第二个文件为原代码“app.config”的同步文件，在程序运行中不会发生更改。  
![这里写图片描述][SouthEast 1]

## connectionStrings 配置节 ##

请注意：在当前使用的sql数据库版本中，则默认安装时 SQL 服务器实例名为localhost/SQLExpress ，可以将以下实例中“ Data Source=localhost; ”一句为“ Data Source=localhost/SQLExpress; ”，也可以不改，在等于号的两边不要加上空格。如果忘记了安装数据库是实例名，可以用英文的句号代替。“Data Source=.”

< connectionStrings >
             < clear />
             < add name = "conJxcBook "
                  connectionString = "Data Source=localhost;Initial Catalog=jxcbook;User                                   ID=sa;password=******** "
                  providerName = "System.Data.SqlClient " />
         </ connectionStrings >

## appSettings 配置节 ##

appSettings 配置节为整个程序的配置，如果是对当前用户的配置，请使用 userSettings 配置节，其格式与以下配置书写要求一样。

< appSettings >
             < clear />
             < add key = "userName "value = "" />
             < add key = "password "value = "" />
             < add key = "Department "value = "" />
             < add key = "returnValue "value = "" />
             < add key = "pwdPattern "value = "" />
             < add key = "userPattern "value = "" />
    </ appSettings >

## 读取与更新 app.config ##

请注意：要使用以下的代码访问app.config文件，除添加引用System.Configuration外，还必须在项目添加对System.Configuration.dll的引用。

### 1） 读取connectionStrings配置节 ###

/// <summary>
    /// 依据连接串名字connectionName返回数据连接字符串
    /// </summary>
    /// <param name="connectionName"></param>
    /// <returns></returns>
    private static string GetConnectionStringsConfig(string connectionName)
    {
    string connectionString =
            ConfigurationManager .ConnectionStrings[connectionName].ConnectionString.ToString();
        Console .WriteLine(connectionString);
        return connectionString;
    }

### 2） 更新connectionStrings配置节 ###

/// <summary>
    /// 更新连接字符串
    /// </summary>
    /// <param name="newName"> 连接字符串名称 </param>
    /// <param name="newConString"> 连接字符串内容 </param>
    /// <param name="newProviderName"> 数据提供程序名称 </param>
    private static void UpdateConnectionStringsConfig(string newName,
        string newConString,
        string newProviderName)
    {
        bool isModified = false ;    // 记录该连接串是否已经存在
        // 如果要更改的连接串已经存在
        if (ConfigurationManager .ConnectionStrings[newName] != null )
        {
            isModified = true ;
        }
        // 新建一个连接字符串实例
        ConnectionStringSettings mySettings =
            new ConnectionStringSettings (newName, newConString, newProviderName);
        // 打开可执行的配置文件*.exe.config
        Configuration config =
            ConfigurationManager .OpenExeConfiguration(ConfigurationUserLevel .None);
        // 如果连接串已存在，首先删除它
        if (isModified)
        {
            config.ConnectionStrings.ConnectionStrings.Remove(newName);
        }
        // 将新的连接串添加到配置文件中.
        config.ConnectionStrings.ConnectionStrings.Add(mySettings);
        // 保存对配置文件所作的更改
        config.Save(ConfigurationSaveMode .Modified);
        // 强制重新载入配置文件的ConnectionStrings配置节
        ConfigurationManager .RefreshSection("ConnectionStrings" );
    }

### 3） 读取appStrings配置节 ###

/// <summary>
    /// 返回＊.exe.config文件中appSettings配置节的value项
    /// </summary>
    /// <param name="strKey"></param>
    /// <returns></returns>
    private static string GetAppConfig(string strKey)
    {
        foreach (string key in ConfigurationManager .AppSettings)
        {
            if (key == strKey)
            {
                return ConfigurationManager .AppSettings[strKey];
            }
        }
        return null ;
    }

### 4） 更新connectionStrings配置节 ###

/// <summary>
    /// 在＊.exe.config文件中appSettings配置节增加一对键、值对
    /// </summary>
    /// <param name="newKey"></param>
    /// <param name="newValue"></param>
    private static void UpdateAppConfig(string newKey, string newValue)
    {
        bool isModified = false ;   
        foreach (string key in ConfigurationManager .AppSettings)
        {
           if (key==newKey)
            {   
                isModified = true ;
            }
        }
    
        // Open App.Config of executable
        Configuration config =
            ConfigurationManager .OpenExeConfiguration(ConfigurationUserLevel .None);
        // You need to remove the old settings object before you can replace it
        if (isModified)
        {
            config.AppSettings.Settings.Remove(newKey);
        }   
        // Add an Application Setting.
        config.AppSettings.Settings.Add(newKey,newValue);  
        // Save the changes in App.config file.
        config.Save(ConfigurationSaveMode .Modified);
        // Force a reload of a changed section.
        ConfigurationManager .RefreshSection("appSettings" );
    }

[SouthEast]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/b6b73256f67f4dcaa87ad5c0bf384574.png
[SouthEast 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/3b5a872ea3334ac8ac3e1c5ac0e1024c.png