保存的自定义配置部分没有数据

时间:2012-05-05 17:35:43

标签: c# .net configuration app-config

我想在应用程序会话之间保留一些数据,并决定使用.NET配置API(System.Configuration命名空间),这已被证明比我预期的要困难得多。

我已经创建了一个自定义配置部分:

UserMailSourcesSection

public class UserMailSourcesSection : ConfigurationSection
{
    [ConfigurationProperty("User", IsRequired = true)]
    public string User { get; set; }

    [ConfigurationProperty("UserMailSources", IsDefaultCollection = false)]
    [ConfigurationCollection(typeof(MailSourceElemet))]
    public MailSourceElemetCollection MailSources
    {
        get
        {
            return (MailSourceElemetCollection)this["UserMailSources"];
        }

        set
        {
            this["UserMailSources"] = value;
        }
    }

    public UserMailSourcesSection()
    {
        this.User = String.Empty;
    }
}

(其余相关代码在问题的最后)

现在实际的问题是,在我配置了我想要保留的所有值之后,我的代码中保存了这部分的异常(不是非常具有描述性的,请注意)。我将其追溯到使用具有一些空值的参数调用的MailSourceElementCollection.Add。该参数是从微软代码传递的。我推断它必须使用默认的无参数构造函数创建参数的新实例。 我虽然解决方案是显式编写一个无参数构造函数,用一些默认值(特别是String.Empty)替换空值,这似乎有效。代码运行,save方法没有抛出,但是出现了一个新问题 - 即使我在Main方法中明确设置了所有内容,也没有实际保存数据:

PublisherElemet publisher = new PublisherElemet();
publisher.Publisher = "test";

PublisherElementCollection publishers = new PublisherElementCollection();
publishers.Add(publisher);
MailSourceElemet mailSource = new MailSourceElemet();
mailSource.HostName = "test";
mailSource.Port = 0;
mailSource.Username = "test";
mailSource.Password = "test";
mailSource.Publishers = publishers;

MailSourceElemetCollection mailSources = new MailSourceElemetCollection();
mailSources.Add(mailSource);

UserMailSourcesSection userMailSources = new UserMailSourcesSection();
userMailSources.User = Environment.UserName;
userMailSources.MailSources = mailSources;

Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
config.Sections.Add("MailSources", userMailSources);
config.Save(ConfigurationSaveMode.Modified);

在此之后,预期的输出是:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <configSections>
  <section name="MailSources" type="Email_To_Rss_V2.Classes.UserMailSourcesSection, Email-To-Rss-V2, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
 </configSections>
 <MailSources User="User">
  <UserMailSources>
    <add HostName="test" Port="0" Username="test" Password="test">
      <Publishers>
        <add Publihser="test" />
      </Publishers>
    </add>
  </UserMailSources>
</MailSources>

虽然实际输出是:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
 <configSections>
  <section name="MailSources" type="Email_To_Rss_V2.Classes.UserMailSourcesSection, Email-To-Rss-V2, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
 </configSections>
 <MailSources User="">
  <UserMailSources>
    <add HostName="" Port="0" Username="" Password="">
      <Publishers>
        <add Publihser="" />
      </Publishers>
    </add>
  </UserMailSources>
</MailSources>

真正奇怪的是,在调试器中数据显示在那里,它似乎没有输出到文件。

以下是相关代码的其余部分:

MailSourceElementCollection

public class MailSourceElemetCollection : ConfigurationElementCollection
{
    public override ConfigurationElementCollectionType CollectionType
    {
        get
        {
            return ConfigurationElementCollectionType.AddRemoveClearMap;
        }
    }

    public MailSourceElemet this[int index]
    {
        get
        {
            return (MailSourceElemet)BaseGet(index);
        }

        set
        {
            if (BaseGet(index) != null)
            {
                BaseRemoveAt(index);
            }

            BaseAdd(0, value);
        }
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        if (((MailSourceElemet)element).Username == null)
        {
            Console.WriteLine("null");
        }

        return ((MailSourceElemet)element).Username;
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new MailSourceElemet();
    }

    public void Add(MailSourceElemet mailSource)
    {
        BaseAdd(mailSource);
    }

    public void Clear()
    {
        this.BaseClear();
    }

    public void Remove(MailSourceElemet element)
    {
        BaseRemove(element.Username);
    }

    public void Remove(string name)
    {
        BaseRemove(name);
    }

    public void RemoveAt(int index)
    {
        BaseRemoveAt(index);
    }
}

MailSourceElement

public class MailSourceElemet : ConfigurationElement
{
    [ConfigurationProperty("HostName", IsRequired = true)]
    public string HostName { get; set; }

    [ConfigurationProperty("Port", IsRequired = true)]
    public int Port { get; set; }

    [ConfigurationProperty("Username", IsRequired = true)]
    public string Username { get; set; }

    [ConfigurationProperty("Password", IsRequired = true)]
    public string Password { get; set; }

    [ConfigurationProperty("Publishers", IsDefaultCollection = false)]
    [ConfigurationCollection(typeof(PublisherElemet))]
    public PublisherElementCollection Publishers
    {
        get
        {
            return (PublisherElementCollection)this["Publishers"];
        }

        set
        {
            this["Publishers"] = value;
        }
    }

    public MailSourceElemet()
    {
        this.HostName = String.Empty;
        this.Port = 0;
        this.Username = String.Empty;
        this.Password = String.Empty;
    }
}

PublisherElementCollection

public class PublisherElementCollection : ConfigurationElementCollection
{
    public override ConfigurationElementCollectionType CollectionType
    {
        get
        {
            return ConfigurationElementCollectionType.AddRemoveClearMap;
        }
    }

    public PublisherElemet this[int index]
    {
        get
        {
            return (PublisherElemet)BaseGet(index);
        }

        set
        {
            if (BaseGet(index) != null)
            {
                BaseRemoveAt(index);
            }

            BaseAdd(0, (PublisherElemet)value);
        }
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((PublisherElemet)element).Publisher;
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new PublisherElemet();
    }

    public void Add(PublisherElemet publisher)
    {
        BaseAdd(publisher);
    }

    public void Clear()
    {
        this.BaseClear();
    }

    public void Remove(PublisherElemet publisher)
    {
        BaseRemove(publisher.Publisher);
    }

    public void Remove(string name)
    {
        BaseRemove(name);
    }

    public void RemoveAt(int index)
    {
        BaseRemoveAt(index);
    }
}

PublisherElement

public class PublisherElemet : ConfigurationElement
{
    [ConfigurationProperty("Publihser", IsRequired = true)]
    public string Publisher { get; set; }

    public PublisherElemet()
    {
        Publisher = String.Empty;
    }
}

提前致谢!

1 个答案:

答案 0 :(得分:3)

看看'Configuration Section Designer',这是一个很好的 'Visual Studio插件,允许您以图形方式设计.NET配置节,并自动生成所有必需的代码和模式定义(XSD)。

使用此工具设计您的配置部分,[我想您会喜欢它:)]。