【.net 深呼吸】自定义应用程序配置节

作者: 晋座

更新时间:2022-03-26 13:10:29

4697 阅读

实际上,应用程序配置文件 App.config,是由各个节(Configuration Section)组成的,通常,配置节是按功能划分的,比如我们很熟悉的 appSettings、connectionStrings、startup、system.ServiceModel……

在实际开发中,我们的应用程序也应该需要一个咱们程序专且功能的配置节,这样也方便我们在代码中通过相关的API来读取,而不是用普通的XML文件读取方法。

其实,实现自定义配置节并不难,只是,有几个问题要注意。

老周一边给大伙伴们演示一边讲解,这样会比较有情调。

要自定义应用配置节,必须从 ConfigurationSection 类派生,该类是个抽象类,所以我们必须以其作为基类来定义自己的配置节。虽然它是一个抽象类,但是,功能很完善,多数情况下,我们是不需要重写它的成员(特殊需求的话,可以按需重写),给大家演示一下,看看我这个类。

    public class MyDemoSection : ConfigurationSection
    {
            ……
    }

那么,我们在这个类中要干啥呢?我们要给它添加我们需要的属性。比如,我需要两个属性——一个 User,字符串类型;另一个Age,类型为int。

    public class MyDemoSection : ConfigurationSection
    {
        public string User
        {
            get {……}
            set { ……}
        }

        public int Age
        {
            get { ……}
            set { …… }
        }
    }

这时候,你一定会想到一个问题:那配置文件API在保存到配置文件时,是如何识别的呢。其实这个 ConfigurationSection 类的基类是 ConfigurationElement。ConfigurationElement 是所有配置文件元素的共同基类。配置节实则就是一种特殊的配置元素,它与普通的配置元素的区别在于,配置节通常作为一类功能的主节点。而配置节的子元素就是普通的配置元素;配置节在使用前必须在 configSections 节点下进行声明,声明后才能在配置文件中使用。这个咱们后面再谈。

 

ConfigurationElement 类公开了以下两个版本的索引器:

protected internal object this[string propertyName] { get; set; }

protected internal object this[ConfigurationProperty prop] { get; set; }

我们一般用的是带string参数的版本,这个索引器只能在派生类中访问,不对外部公开。而 ConfigurationSection 类是从 ConfigurationElement 类派生的,自然会继承这个索引器。

所以,我们在自定义配置节的属性包装中,可以通过这个索引器来存取内容,其操作方法类似于字典。

    public class MyDemoSection : ConfigurationSection
    {
        public string User
        {
            get { return (string)this["user"]; }
            set { this["user"] = value; }
        }

        public int Age
        {
            get { return (int)this["age"]; }
            set { this["age"] = value; }
        }
    }

 

代码写到这里,貌似是完成了,其实未然。这时候,如果你想用代码把这个自定义节点写入配置文件,就会收到以下异常。

因为我们的自定义配置节类还没有完工,还差一个 Attribute 没有应用。应该这样写。

        [ConfigurationProperty("user")]
        public string User
        {
            get { return (string)this["user"]; }
            set { this["user"] = value; }
        }

        [ConfigurationProperty("age")]
        public int Age
        {
            get { return (int)this["age"]; }
            set { this["age"] = value; }
        }

注意,严重要注意!!应用的ConfigurationPropertyAttribute 中指定的name一定要和索引器(this["....."])中使用的名字相同,比如上面的代码,age要一致,如果改为这样,就会报错。

        [ConfigurationProperty("number")]
        public int Age
        {
            get { return (int)this["age"]; }
            set { this["age"] = value; }
        }

因为 number 和 age 不匹配,不过,类型的属性名不要求,比如,Age属性可以改为 Num。

        [ConfigurationProperty("age")]
        public int Num
        {
            get { return (int)this["age"]; }
            set { this["age"] = value; }
        }

把属性名改为 Num 是不会报错的。只要 ConfigurationPropertyAttribute 中的 name 参数与索引器中的名字一致即可

 

下面,我们试试这个自定义配置节,我们通过代码来配置,然后保存到 App.Config 中。

            Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            MyDemoSection sect = new MyDemoSection();
            config.Sections.Add("myInfo", sect);
            //sect.SectionInformation.ForceSave = false;
            sect.User = "Ben Dan";
            sect.Age = 25;
            // 保存
            config.Save(ConfigurationSaveMode.Modified);

通过....Sections.Add 方法就可以把自定义的配置节添加配置文件中,其中,有一个name 参数,它用来指定在使用该配置时的XML元素名称。这个你如果不理解,不急,你先记住我们代码中写的名字叫 myInfo。

然后执行一下上面的代码,再打开与应用程序相关的App.config文件,注意不是项目中的config文件,是bin\\ 目录下的。打开后你会看到这样的内容。

<configuration>
    <configSections>
        <section name="myInfo" type="CustConfigs.MyDemoSection, CaiDemo, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
    </configSections>
    <myInfo user="Ben Dan" age="25" />
…… </configuration>

怎么样,你现在看明白了没,知道那个 myInfo 怎么用了吧。

首先,要在 configSections 节中用 section 元素来配置一下自定义配置节的类型,type指定的就是我们刚刚定义的那个 MyDemoSection 类,其实只需要写上类型名和程序集名即可。name 指定一个名称,就是你随后在配置文件使用时的XML元素名,如本例中的 myInfo。

 在上面的代码中,可能你注意到有一行代码被注释了,

sect.SectionInformation.ForceSave = false;

MSDN 上说,这个属性指示是否要强制保存配置节的内容,哪怕它没有被修改过,这里我用不上,就注释掉了,因为MSDN上的示例有这一行,我故意加上来装逼一下的。

 

刚才,我们通过代码应用我自定义配置节,内容已写入 app.config 文件,此时我们如果再次运行上面的代码,你会发现报错了。

原来配置节是不能重复 Add 的,所以我们改改代码,先进行判断。

            Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            MyDemoSection sect = config.Sections["myInfo"] as MyDemoSection;
            if(sect == null)
            {
                sect = new MyDemoSection();
                config.Sections.Add("myInfo", sect);
            }
            sect.User = "Ben Dan";
            sect.Age = 25;
            // 保存
            config.Save(ConfigurationSaveMode.Modified);

好了,这样可避免报错了。

 

接下来,老周再给各位举一例,这一次我们不用代码来写配置文件,而是直接编辑配置文件,然后在代码中读出配置信息。这种做法应该最常用。

还是那样,我们自定义一个配置节类型。

    public class DBSection : ConfigurationSection
    {
        [ConfigurationProperty("dbName", DefaultValue = "db.mdf")]
        public string DBName
        {
            get { return (string)this["dbName"]; }
            set { this["dbName"] = value; }
        }

        [ConfigurationProperty("loginName", DefaultValue = "sa")]
        public string LoginName
        {
            get { return (string)this["loginName"]; }
            set { this["loginName"] = value; }
        }
    }

假设,DBName 表示数据库文件的名字,LoginName表示登入 MSSQL 的名称(默认是 sa)。

 

然后,我们打开\bin\debug 下面的app.config,注意,不是项目中的配置文件。先为自定义配置节进行声明。

  <configSections>
    <section name="db" type="CustConfigs.DBSection, CaiDemo"/>
  </configSections>

这时候,要配置的话,XML元素名为db。

 <db dbName ="app.mdf" loginName="admin" />

注意这里设置的属性名不是类上的属性名,而是 ConfigurationPropertyAttribute 所指定的名称。

 

现在,我们在代码中读出这些配置参数。

            Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
            DBSection sect = config.Sections["db"] as DBSection;
            if (sect != null)
            {
                string s = $"数据库:{sect.DBName},登录名:{sect.LoginName}。";
                Console.WriteLine(s);
            }

注意刚刚我们在配置文件中声明时,给自定义节的元素命名为 db 。

 <section name="db" type="CustConfigs.DBSection, CaiDemo"/>

所以,我们读的时候,也要用 db 作为名字取出配置节实例,然后再读属性的值。

最后,输出结果如下:

 

 好了,今天的内容就扯到这里吧,这个玩意儿,大家学会之后,还是很有实战价值的,而且也不难。

 

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

侵权请联系:root_email@163.com

相关推荐