【.net 深呼吸】在运行阶段修改应用配置文件

作者: 杭谨

更新时间:2022-03-26 13:11:06

1032 阅读

上一篇博文中,老周所介绍的自行编写的配置类,虽然能够很好地做封装,但它仅允许修改用户级别的配置,所以文件都是保存到用户配置目录下的。可是,许多情况下,我们还是不考虑用户隔离,而是能够直接修改与应用程序同目录的App.config文件。

那么,能不能在代码文件中编辑 app.config 文件呢?当然是可以的。其实,配置文件本质上是个XML文档,所以,你是可以使用普通XML文件的编辑方式来修改的。但.net类库还是提供有于读写配置文件的专用API,使用专用的API,使得生成的配置比较规范。

.net 的配置文件是由N个配置节组成,每个配置节面向不同的功能,比如 startup 可以配置程序所需要的.net 框架版本。为了便于管理,通常,咱们的应用程序设置都会放到 AppSettings 节上,XML节点为 appSettings。每一条配置都比较简单,就是由 key 和 value 组成。

要对配置文件进行操作,你记得要引用 System.Configuration.dll 程序集,因为System程序集只包含一些常规的类型,而专用于读写配置文件的类型都会包装到 System.Configuration 程序集中。这些API既适用于app.config,也适用于web.config文件。

好,上面这几段废话只要你看懂了,那么下面我们就可以开始干活了。放心,很简单的,老周给你分享的东西,向来都是简单且有实用价值的。

 

首先,老周介绍一下大概的类型使用过程。

——读取 app.config 文件中 appSettings 节中的内容很简单,使用 ConfigurationManager 类,它公开了两个静态属性,别小看它们,有了这两个属性,读取配置会轻松很多。ConnectionStrings:做过数据库连接的话,你肯定很熟悉它的,这个节点下专门存放连接字符串;AppSettings:这个专门访问 appSettings 节点下的内容,表示形式很简洁,就是key - value 对,而且都是字符串类型。

——写入修改会稍稍复杂一点,但也不是难题。

  a、ConfigurationManager类有个静态方法 OpenExeConfiguration ,你可以指定exe文件路径,它自动找到匹配的app.config文件,然后打开,返回一个 Configuration 类型的实例。

  b、Configuration 类可以对配置文件进行修改,修改完后,可以掉用 Save 方法保存,或调用 SaveAs 方法把配置存到其他文件上。

 

接下来,老周上一个例子,这个例子运行后,在窗口上可以设置电脑自爆的日期,当窗口关闭时会把这个日期写入配置文件中的appSettings 节点下。如下图所示。

 

 跟你开个玩笑而已,计算机不会真的爆炸。

通常,我们会在窗口加载时读出配置文件中的值,以便在界面上显示用户上一次设置的内容,不然用户会误以为配置丢失。

            var q = ConfigurationManager.AppSettings.AllKeys.AsQueryable();
            var r = from c in q where c == BOMB_DATE select c;
            if (r.Count() > 0)
            {
                string datestr = ConfigurationManager.AppSettings[BOMB_DATE];
                picker.SelectedDate = DateTime.Parse(datestr);
            }

在读应用配置前,我用 LINQ 语句查询了一下,确认我要访问的设置项是否存在,如果没有要的设置项,那读个鸡毛。设置节的key是用字符串来表示的,BOMB_DATE是我定义的一个常量。

 const string BOMB_DATE = "bombDate";

配置文件中的设置值是以字符串形保存的,而咱们窗口上的控件需要的是 DateTime 类型的实例,所以读出来后记得要 Parse 一下。

 

接下来,我们再看看如何修改并保存 app.config 文件。

先把日期选择控件中用户选择的日期转为字符串。

            DateTime seldate = picker.SelectedDate ?? DateTime.Today;
            string forstr = seldate.ToShortDateString();

 

然后,还得获取当前程序的exe路径。

string exePath = Environment.GetCommandLineArgs()[0];

GetCommandLineArgs 方法返回的字符串数组中,第一个元素就是本程序exe的路径。

 

调用 ConfigurationManager.OpenExeConfiguration 静态方法打开app.config文件。

            Configuration config = ConfigurationManager.OpenExeConfiguration(exePath);

 

随后,是重点部分,就是写入设置内容。

            if (config.AppSettings.Settings.AllKeys.Count(s => s == BOMB_DATE) > 0)
            {
                // 如果设置项已经存在
                // 则直接修改
                var kv = config.AppSettings.Settings[BOMB_DATE];
                kv.Value = forstr;
            }
            else
            {
                // 如果设置项不存在
                // 则添加新项
                config.AppSettings.Settings.Add(BOMB_DATE, forstr);
            }

这里有个很严重的内容,大家一定、必须、特别要注意。得判一下设置项的key是否已存在,因为你如果直接调用 Add 方法添加的话,如果设置项的key已存在,它不是替换整个值,而是会在原来的值后面追加内容。

比如在本例中,要是我写入了 2017/10/1,第一次保存,因为设置项不存在,所以没问题。但是,一旦我把值修改为 2017/11/5,然后再保存,那么设置项的值 就会变为

2017/10/1,2017/11/5

也就是说,新保存的内容不会替换,而是追加,然后用逗号分隔每个值。

如此一来,在读取的时候就麻烦了,这样的字符串是不能转化为 DateTime 实例的。

 

所以,这里要先分析一下,如果设置项已经存在,那就通过索引器得到这个设置项的内容,它用一个 KeyValueConfigurationElement 类封装,其中,Value 属性是可以修改的(Key不能变,所以只读),此时,我们只要直接给 Value 属性赋新的值,那么保存时就会覆盖原有的值,而不会在后面追加了。而如果设置项不存在,那太好办,直接一个Add方法添加就可以了。

 

最后,修改完了,别忘了保存,不保存的话,是不会写入app.config文件的。

            if (config.AppSettings.SectionInformation.IsLocked)
            {
                // 如果配置节已锁定,则放弃保存
                return;
            }
            config.Save(ConfigurationSaveMode.Modified);

保存前检测 IsLocked 属性,是看看这个配置节是否被锁定,如果锁了,你是不能保存的。

在配置文件中,你可以用这种方法来让某个节点被锁定。

    <appSettings lockItem="true">
        ……

</appSettings>

锁定后,节点就不允许别人编辑了。当然了,你手动打开配置文件是可以改的,我说的是在代码中用API不能改。

 

在调用 Configuration 实例的 Save 方法时,可以向方法传递一个 ConfigurationSaveMode 枚举值,这里我用 Modified,表示只对被修改过的节点进行写入,这样做可以省时省力省开销。

 

保存后的 app.config 文件的appSettings节点如下。

    <appSettings>
        <add key="bombDate" value="2017/7/28" />
    </appSettings>

 

=================================================

以上示例的源代码下载,请点击▶这里◀

 

怎么样,学了后有用吧。差点忘了说,如果你把exe文件放在如 Program Files 等需要管理员权限的目录中,你必须以管理员身份运行应用程序才能保存配置文件。

 

版权声明:本文著作权归作者【杭谨 】所有,不代表本网站立场。

侵权请联系:root_email@163.com