ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

C# 读写App.config配置文件的方法

2021-10-01 09:32:29  阅读:288  来源: 互联网

标签:配置文件 ConfigurationManager C# appSettings 配置 Configuration config


C# 读写App.config配置文件的方法

一、配置文件概述:

应用程序配置文件是标准的 XML 文件,XML 标记和属性是区分大小写的。它是可以按需要更改的,开发人员可以使用配置文件来更改设置,而不必重编译应用程序。配置文件的根节点是configuration。我们经常访问的是appSettings,它是由.Net预定义的配置节。我们经常使用的配置文件的架构是客诉下面的形式。先大概有个印象,通过后面的实例会有一个比较清楚的认识。下面的“配置节”可以理解为进行配置一个XML的节点。

常见配置文件模式:

<configuration>
<configSections>                    //配置节声明区域,包含配置节和命名空间声明
<section>                         //配置节声明
<sectionGroup>                //定义配置节组
<section>                        //配置节组中的配置节声明
<appSettings>                       //预定义配置节
<Custom element for configuration section>   //配置节设置区域

下面是一个最常见的应用程序配置文件的例子,只有appSettings节:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <appSettings>
        <add key="connectionstring" value="User Source=.;Password=123456;Initial Catalog=test;Provider=SQLOLEDB.1;" />
        <add key="TemplatePATH" value="Template" />
    </appSettings>
</configuration>

在预定义的 appSettings 节(注意大小写),有很多的元素,这些元素名称都是“add”,有两个属性分别是“key”和“value”。

.NET 提供了对appSettings节的访问方法。在 .NET 1.0 和 1.1 版本中,可以使用 System.Configuration.ConfigurationSettings.AppSettings["Key"] 来对 key = "Key" 的<add>元素的 value属性 进行访问。

注意:现在.Net FrameWork 2.0中已经明确表示此ConfigurationSettings属性已经废弃,建议改为 ConfigurationManager 或 WebConfigurationManager。

使用 System.Configuration.ConfigurationManager,需要在工程里添加对 system.configuration.dll 程序集的引用。(在解决方案管理器中右键点击工程名称,在右键菜单中选择添加引用,在.NET选项卡下即可找到。)

添加引用后,就可以用 ConfigurationManager.AppSettings["Key"] 来读取对应的值了.

但是,ConfigurationManager.AppSettings 属性是只读的,并不支持修改属性值。这是因为据说微软不太建议我们动态写入app.config文件,而是建议手工配置后,在程序运行时只做静态访问。

如果实在需要在程序中进行修改,也即写入App.Config,请往下看。

 

二、appSettings配置节的读写操作

读取App.config文件的appSettings节的方法比较简单,可以通过上文中 System.Configuration.ConfigurationManager.AppSettings["Key"]的方法进行访问,但前面也已经说了,该方法不提供写入。

如果希望写入配置文件,可以使用ConfigurationManager对象执行打开配置文件的操作后,将会返回一个Configuration的对象,利用该对象进行操作(增删改查都可以哦)。

下面给出实现的代码(增加引用using System.Configuration名称空间)

private void AccessAppSettings()
{
    //获取Configuration对象
    Configuration config = System.Configuration.ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
    //根据Key读取<add>元素的Value
    string name = config.AppSettings.Settings["name"].Value;
    //写入<add>元素的Value
    config.AppSettings.Settings["name"].Value = "fx163";
    //增加<add>元素
    config.AppSettings.Settings.Add("url", "http://www.fx163.net");
    //删除<add>元素
    config.AppSettings.Settings.Remove("name");
    //一定要记得保存,写不带参数的config.Save()也可以
    config.Save(ConfigurationSaveMode.Modified);
    //刷新,否则程序读取的还是之前的值(可能已装入内存)
    System.Configuration.ConfigurationManager.RefreshSection("appSettings");
}

需要注意的是:

1、根据并不存在的Key值访问<add>元素,甚至使用remove()方法删除不存在的元素,都不会导致异常,前者会返回null。

2、add已经存在的<add>元素也不会导致异常,而是concat了已有的Value和新的Value,用","分隔,例如:"olldvalue,newvalue"。

3、在项目进行编译后,在运行目录bin\Debuge文件下,将出现两个配置文件,一个名为“ProjectName.exe.config”,另一个名为“ProjectName.vshost.exe.config”。第一个文件为项目实际使用的配置文件,在程序运行中所做的更改都将被保存于此;第二个文件其实为原代码中“App.config”的同步文件,在程序运行中不会发生更改。

4、特别注意大小写(XML文件是区分大小写的),例如appSettings配置节。

5、可能有读者会想到,既然app.config是标准XML,当然也可以用操纵一般XML文件的方法来读写。这当然是可以的!只不过我认为这样就失去了VS提供app.config文件的意义了,还不如自己定义一个配置文件方便。

 

本文只是粗略地讲了app.config文件中appSettings配置节的访问方法,connectionStrings配置节的操作基本是类似的,也可以自定义配置节。这些高级的用法可以自己体会,VS对app.config这个配置文件的管理还是很强大的,例如WinForm应用程序的Settings设置(可以在IDE中或者通过代码访问)其实也是利用了app.config文件。

 

背景

利用C#做一个串口通信项目,客户需求保存串口COM口的配置信息,在此利用Settings来进行保存。

正文

".Settings"的创建

点击项目 --> 添加新项 --> 选择设置文件并重命名该文件,如下图所示:

    • 各项的含义
      名称既是你需要保存的变量名;类型为变量的类型;注意范围这个变量,为用户(user)时,则意味着该变量可在App运行时被更改,为应用程序(Application)时,则意味着该变量只可读;则是该变量的默认值。

      • 调用方法
        首先创建一个类型为stringtestconfig变量,

      //将该变量赋值到应用程序内
      string myconfig = mysetting.Default.testconfig;
      //将应用程序内的值保存到默认配置
      mysetting.Default.testconfig = "hello world";
      mysetting.Default.Save();//一定要调用此函数进行保存
      
      • 保存位置
        保存位置在"MSDN"中已说明,其保存的配置随着应用程序的不同而不同,在此仅以我自己的Application为例,其配置信息保存在
        C:\Users\Chyq\AppData\Local\Microsoft\TestSettings.exe_Url_h1u3x4fbmh3kx2jeusg4tablc5gwws1z\1.0.0.0
        文件夹中的user.config文件内,其中Chyq为我电脑用户名,文件夹
        TestSettings.exe_Url_h1u3x4fbmh3kx2jeusg4tablc5gwws1z
        中的TestSettings.exe为我生成的Application的名称。

      "COM"口配置信息的保存

      • 如下图所示:

        只要将对应的Serialport内的参数一一罗列出来即可。

      至此记录完毕。

 

标签:配置文件,ConfigurationManager,C#,appSettings,配置,Configuration,config
来源: https://www.cnblogs.com/funiyi816/p/15358758.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有