ApplicationSettingsBase записывает пустой тег для пользовательской коллекции - PullRequest
2 голосов
/ 10 июня 2011

Я борюсь с этим время от времени уже несколько дней. Мне нужно хранить коллекцию пользовательских объектов как часть настроек пользователя. Основываясь на большом количестве работ в Google, кажется, что создание класса предпочтений из ApplicationSettingsBase является подходящим способом сделать это. Проблема, с которой я сталкиваюсь, состоит в том, что как только я пытаюсь сохранить коллекцию пользовательского типа, никакие данные не сохраняются для этого свойства. Если я буду придерживаться коллекций базовых типов, таких как строка, все работает. У меня есть отдельное доказательство концепции проекта, с которым я работал в течение последнего дня, чтобы выделить только эту проблему.

Этот проект состоит из окна WPF со списком и двумя кнопками «+» и «-». У меня есть класс Prefs с тремя свойствами, определяющими различные типы коллекций. В моем коде окна я привязываю список к одному из этих списков, а кнопки либо добавляют, либо удаляют элемент в / из списка. Закрытие окна должно сохранить содержимое списка в файл users.config для текущего пользователя. Повторное открытие должно отобразить сохраненное содержимое списка.

Если я использую List1 (ObservableCollection<string>) и нажимаю кнопку + несколько раз, затем закрываю окно, данные правильно сохраняются в user.config. Однако, если я изменяю и использую List2 (ObservableCollection<Foo>) или List3 (FooCollection), я просто получаю пустой тег значения. Я пытался реализовать ISerializable и IXmlSerializable в попытках заставить это работать без изменений в поведении. Фактически работа в режиме отладки с точками останова показывает, что коллекция содержит данные при вызове метода сохранения, но методы интерфейса сериализации никогда не вызываются.

Чего мне не хватает?

ОБНОВЛЕНИЕ: Я изменил свой подход и на время записал данные в другой файл рядом с user.config, чтобы я мог продвинуться в других частях приложения. Но я все еще хотел бы знать, почему в базе настроек приложения не удалось записать данные моей коллекции.

Вот весь соответствующий код, если кто-то считает упущенный раздел важным, я добавлю его обратно в пост.

user.config после добавления пары элементов в каждое свойство списка

<setting name="List1" serializeAs="Xml">
    <value>
        <ArrayOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
            <string>0</string>
            <string>1</string>
            <string>2</string>
        </ArrayOfString>
    </value>
</setting>
<setting name="List2" serializeAs="Xml">
    <value />
</setting>
<setting name="List3" serializeAs="Xml">
    <value />
</setting>

Окно XAML

<Grid>
    <Grid.ColumnDefinitions>
        <ColumnDefinition></ColumnDefinition>
        <ColumnDefinition Width="Auto"></ColumnDefinition>
    </Grid.ColumnDefinitions>
    <ListBox Name="l1" Grid.Column="0" Grid.Row="0" ItemsSource="{Binding}"></ListBox>
    <StackPanel Grid.Column="1" Grid.Row="0">
        <Button Name="bP" Margin="5" Padding="5" Click="bP_Click">+</Button>
        <Button Name="bM" Margin="5" Padding="5" Click="bM_Click">-</Button>
    </StackPanel>

</Grid>

Код для окна

public partial class Window1 : Window
{
    Prefs Prefs = new Prefs();

    public Window1()
    {
        InitializeComponent();

        //l1.DataContext = Prefs.List1;
        //l1.DataContext = Prefs.List2;
        l1.DataContext = Prefs.List3;
    }

    private void Window_Closed(object sender, EventArgs e)
    {
        Prefs.Save();
    }

    private void bP_Click(object sender, RoutedEventArgs e)
    {
        //Prefs.List1.Add(Prefs.List1.Count.ToString());
        //Prefs.List2.Add(new Foo(Prefs.List2.Count.ToString()));
        Prefs.List3.Add(new Foo(Prefs.List3.Count.ToString()));
    }

    private void bM_Click(object sender, RoutedEventArgs e)
    {
        //Prefs.List1.RemoveAt(Prefs.List1.Count - 1);
        //Prefs.List2.RemoveAt(Prefs.List2.Count - 1);
        Prefs.List3.RemoveAt(Prefs.List3.Count - 1);
    }
}

Prefs class

class Prefs : ApplicationSettingsBase
{
    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute(null)]
    public System.Collections.ObjectModel.ObservableCollection<string> List1
    {
        get
        {
            System.Collections.ObjectModel.ObservableCollection<string> Value = this["List1"] as System.Collections.ObjectModel.ObservableCollection<string>;
            if (Value == null)
            {
                Value = new System.Collections.ObjectModel.ObservableCollection<string>();
                this["List1"] = Value;
            }
            return Value;
        }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute(null)]
    public System.Collections.ObjectModel.ObservableCollection<Foo> List2
    {
        get
        {
            System.Collections.ObjectModel.ObservableCollection<Foo> Value = this["List2"] as System.Collections.ObjectModel.ObservableCollection<Foo>;
            if (Value == null)
            {
                Value = new System.Collections.ObjectModel.ObservableCollection<Foo>();
                this["List2"] = Value;
            }
            return Value;
        }
    }

    [UserScopedSettingAttribute()]
    [DefaultSettingValueAttribute(null)]
    public FooCollection List3
    {
        get
        {
            FooCollection Value = this["List3"] as FooCollection;
            if (Value == null)
            {
                Value = new FooCollection();
                this["List3"] = Value;
            }
            return Value;
        }
    }
}

Foo Class

[Serializable()]
class Foo : System.ComponentModel.INotifyPropertyChanged, ISerializable, IXmlSerializable
{
    private string _Name;
    private const string PropName_Name = "Name";
    public string Name
    {
        get { return this._Name; }
        set
        {
            if (value != this._Name)
            {
                this._Name = value;
                RaisePropertyChanged(Foo.PropName_Name);
            }
        }
    }
    public override string ToString()
    {
        return Name;
    }

    public Foo() { }
    public Foo(string name)
    {
        this._Name = name;
    }

    #region INotifyPropertyChanged Members
/***Omitted for space***/
    #endregion

    #region ISerializable Members
    public Foo(SerializationInfo info, StreamingContext context)
    {
        this._Name = (string)info.GetValue(Foo.PropName_Name, typeof(string));
    }
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        info.AddValue(Foo.PropName_Name, this._Name);
    }
    #endregion

    #region IXmlSerializable Members
    public System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(System.Xml.XmlReader reader)
    {
        reader.MoveToContent();
        _Name = reader.GetAttribute(Foo.PropName_Name);
        bool Empty = reader.IsEmptyElement;
        reader.ReadStartElement();
        if (!Empty)
        {
            reader.ReadEndElement();
        }
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        writer.WriteAttributeString(Foo.PropName_Name, _Name);
    }
    #endregion
}

и класс FooCollection

[Serializable()]
class FooCollection : ICollection<Foo>, System.ComponentModel.INotifyPropertyChanged, INotifyCollectionChanged, ISerializable, IXmlSerializable
{
    List<Foo> Items;
    private const string PropName_Items = "Items";

    public FooCollection()
    {
        Items = new List<Foo>();
    }

    public Foo this[int index]
    {
/***Omitted for space***/
    }

    #region ICollection<Foo> Members
/***Omitted for space***/
    #endregion

    public void RemoveAt(int index)
    {
/***Omitted for space***/
    }

    #region IEnumerable Members
/***Omitted for space***/
    #endregion

    #region INotifyCollectionChanged Members
/***Omitted for space***/
    #endregion

    #region INotifyPropertyChanged Members
/***Omitted for space***/
    #endregion

    #region ISerializable Members
    public FooCollection(SerializationInfo info, StreamingContext context)
    {
        this.Items = (List<Foo>)info.GetValue(FooCollection.PropName_Items, typeof(List<Foo>));
    }
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        info.AddValue(FooCollection.PropName_Items, this.Items);
    }
    #endregion

    #region IXmlSerializable Members
    public System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(System.Xml.XmlReader reader)
    {
        XmlSerializer FooSerializer = new XmlSerializer(typeof(Foo));

        reader.MoveToContent();
        bool Empty = reader.IsEmptyElement;
        reader.ReadStartElement();
        if (!Empty)
        {
            if (reader.IsStartElement(FooCollection.PropName_Items))
            {
                reader.ReadStartElement();

                while (reader.IsStartElement("Foo"))
                {
                    this.Items.Add((Foo)FooSerializer.Deserialize(reader));
                }

                reader.ReadEndElement();
            }

            reader.ReadEndElement();
        }
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        XmlSerializer FooSerializer = new XmlSerializer(typeof(Foo));

        writer.WriteStartElement(FooCollection.PropName_Items);

        foreach (Foo Item in Items)
        {
            writer.WriteStartElement("Foo");
            FooSerializer.Serialize(writer, Item);
            writer.WriteEndElement();//"Foo"
        }

        writer.WriteEndElement(); //FooCollection.PropName_Items
    }
    #endregion
}

Ответы [ 2 ]

1 голос
/ 21 февраля 2012

У меня также была похожая проблема, которую мне удалось исправить, но я не использовал ObservableCollection, но обычный List<Column>, Column был моим классом, который содержал в качестве открытых членов: string, int и bool, которые все xmlserializable. List<>, поскольку он реализует IEnumerable также XMLSerializable.

Единственное, о чем вы должны позаботиться в пользовательском классе Foo: у вас должны быть открытые члены, конструктор без параметров и сам класс должен быть открытым. Вам не нужно добавлять тег [Serializable] для сериализации xml.

Мне не нужно было реализовывать класс FooCollection, поскольку я использую List, у которого нет проблем с сериализацией xml.

Другое дело:

  • класс, производный от ApplicationSettingsBase, может быть внутренне запечатан - не нужно, чтобы он был общедоступным.
  • над списком реквизитов добавить тот факт, что он сериализуем для xml:

    [глобальный :: System.Configuration.UserScopedSettingAttribute ()] [SettingsSerializeAs (SettingsSerializeAs.Xml)] [Глобального :: System.Configuration.DefaultSettingValueAttribute ( "")] общедоступный список столбцов { получить { return ((List) this ["Columns"]); } задавать { this ["Columns"] = (Список) значение; } }

Если это не работает, вы также можете попробовать реализовать TypeConverter.

0 голосов
/ 07 ноября 2011

Я боролся с очень похожей проблемой в течение двух дней, но теперь я нашел недостающую ссылку, которая может помочь здесь.Если ваш и мой случай на самом деле похожи, то классы 'Foo' и 'FooCollection' должны быть явно публичными!

Я предполагаю, что в случае List2 (ObservableCollection<Foo>) и List3(FooCollection) the.NET сталкивается с IXmlSerializable, который требует как-то явного публичного доступа (пересекает границу собственной сборки).

Опция List1 (ObservableCollection<string>) в противоположность, кажется, работает на плоской строке-Typeconversion, которая довольна (внутренним) классом 'Foo' ...

(из ApplicationsettingsBase Docu: Существует два основных механизма, которые ApplicationSettingsBase использует для сериализации настроек: 1) Если существует TypeConverter, который может преобразовывать строку в строку и из нее, мы ее используем.2) Если нет, мы отступаем к XmlSerializer)

С уважением, Руди

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...