美文网首页
C# 配置文件 App.config 的使用方法及技巧

C# 配置文件 App.config 的使用方法及技巧

作者: 电工王大爷 | 来源:发表于2020-10-15 11:17 被阅读0次

    在使用Winform进行工控软件开发的过程中,会涉及到保存设备连接参数的需求,可以有多种方式来实现参数的保存,比如:可以自定义一个文件进行保存,另外也可以写到内置的配置文件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=;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,请往下看。

    二、C# 中的 ConfigurationManager类引用方法

    c#添加了Configuration;后,竟然找不到 ConfigurationManager 这个类,后来才发现:虽然引用了using System.Configuration;这个包,但是还是不行的。

    后来终于找到一个解决方法,就是在解决方案资源管理器里找到类文件选择“引用”,然后右击选择“添加引用”,并且从 .net 中找到System.Configuration把它加上去就OK啦

    三、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文件的意义了,还不如自己定义一个配置文件方便。

    相关文章

      网友评论

          本文标题:C# 配置文件 App.config 的使用方法及技巧

          本文链接:https://www.haomeiwen.com/subject/zuunpktx.html