辞書メンバーを含むクラスをシリアル化


144

以前の問題を拡張して、うまく機能した構成ファイルクラスを(逆)シリアル化することにしました。

私は今、マップするために、ドライブ文字の連想配列を保存する(キー値がネットワークパスで、ドライブ名です)と使用して試してみましたDictionaryHybridDictionaryと、Hashtableこのためのが、呼び出したとき、私はいつも次のエラーを取得しますConfigFile.Load()ConfigFile.Save()

タイプ「App.ConfigFile」を反映するエラーがありました。[切り取り] System.NotSupportedException:メンバーApp.Configfile.mappedDrivesをシリアル化できません[切り取り]

私が読んだことから、辞書とハッシュテーブルはシリアル化できるので、何が間違っているのですか?

[XmlRoot(ElementName="Config")]
public class ConfigFile
{
    public String guiPath { get; set; }
    public string configPath { get; set; }
    public Dictionary<string, string> mappedDrives = new Dictionary<string, string>();

    public Boolean Save(String filename)
    {
        using(var filestream = File.Open(filename, FileMode.OpenOrCreate,FileAccess.ReadWrite))
        {
            try
            {
                var serializer = new XmlSerializer(typeof(ConfigFile));
                serializer.Serialize(filestream, this);
                return true;
            } catch(Exception e) {
                MessageBox.Show(e.Message);
                return false;
            }
        }
    }

    public void addDrive(string drvLetter, string path)
    {
        this.mappedDrives.Add(drvLetter, path);
    }

    public static ConfigFile Load(string filename)
    {
        using (var filestream = File.Open(filename, FileMode.Open, FileAccess.Read))
        {
            try
            {
                var serializer = new XmlSerializer(typeof(ConfigFile));
                return (ConfigFile)serializer.Deserialize(filestream);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message + ex.ToString());
                return new ConfigFile();
            }
        }
    }
}

回答:


77

IDictionaryを実装するクラスをシリアル化することはできません。このリンクをチェックしてください

Q:ハッシュテーブルをシリアル化できないのはなぜですか?

A:XmlSerializerは、IDictionaryインターフェイスを実装するクラスを処理できません。これは、一部はスケジュールの制約によるものであり、一部はハッシュテーブルがXSD型システムに対応するものを持たないという事実によるものでした。唯一の解決策は、IDictionaryインターフェイスを実装しないカスタムハッシュテーブルを実装することです。

だから、私はあなたがこれのためにあなた自身のバージョンの辞書を作成する必要があると思います。この他の質問を確認してください。


4
DataContractSerializerクラスでそれができるのかと思っているだけです。出力だけが少し見苦しいです。
rekire

186

Paul Welterのウェブログに解決策があります-XML Serializable Generic Dictionary

何らかの理由で、.net 2.0の汎用ディクショナリはXMLシリアライズ可能ではありません。次のコードスニペットは、XMLシリアル化可能な汎用辞書です。辞書は、IXmlSerializableインターフェイスを実装することでシリアル化できます。

using System;
using System.Collections.Generic;
using System.Text;
using System.Xml.Serialization;

[XmlRoot("dictionary")]
public class SerializableDictionary<TKey, TValue>
    : Dictionary<TKey, TValue>, IXmlSerializable
{
    public SerializableDictionary() { }
    public SerializableDictionary(IDictionary<TKey, TValue> dictionary) : base(dictionary) { }
    public SerializableDictionary(IDictionary<TKey, TValue> dictionary, IEqualityComparer<TKey> comparer) : base(dictionary, comparer) { }
    public SerializableDictionary(IEqualityComparer<TKey> comparer) : base(comparer) { }
    public SerializableDictionary(int capacity) : base(capacity) { }
    public SerializableDictionary(int capacity, IEqualityComparer<TKey> comparer) : base(capacity, comparer) { }

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

    public void ReadXml(System.Xml.XmlReader reader)
    {
        XmlSerializer keySerializer = new XmlSerializer(typeof(TKey));
        XmlSerializer valueSerializer = new XmlSerializer(typeof(TValue));

        bool wasEmpty = reader.IsEmptyElement;
        reader.Read();

        if (wasEmpty)
            return;

        while (reader.NodeType != System.Xml.XmlNodeType.EndElement)
        {
            reader.ReadStartElement("item");

            reader.ReadStartElement("key");
            TKey key = (TKey)keySerializer.Deserialize(reader);
            reader.ReadEndElement();

            reader.ReadStartElement("value");
            TValue value = (TValue)valueSerializer.Deserialize(reader);
            reader.ReadEndElement();

            this.Add(key, value);

            reader.ReadEndElement();
            reader.MoveToContent();
        }
        reader.ReadEndElement();
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        XmlSerializer keySerializer = new XmlSerializer(typeof(TKey));
        XmlSerializer valueSerializer = new XmlSerializer(typeof(TValue));

        foreach (TKey key in this.Keys)
        {
            writer.WriteStartElement("item");

            writer.WriteStartElement("key");
            keySerializer.Serialize(writer, key);
            writer.WriteEndElement();

            writer.WriteStartElement("value");
            TValue value = this[key];
            valueSerializer.Serialize(writer, value);
            writer.WriteEndElement();

            writer.WriteEndElement();
        }
    }
    #endregion
}

16
+1。ねえ、なぜスタックオーバーフローに[コードをコピー]ボタンがないのですか?うーん?このコードはコピーする価値があります!
toddmo 2013

1
+1素晴らしい答え。SortedListでも機能し、「SerializableDictionary」を「SerializableSortedList」に、「Dictionary <TKey、TValue>」を「SortedList <TKey、TValue>」に変更しただけです。
kdmurray 2014年

1
+1と1つの提案。SerializableDictionaryオブジェクトが複数の要素を保持している場合、例外がスローされます... ReadStartElement( "item");を移動するには、ReadXml()およびWriteXml()を変更する必要があります。およびWriteStartElement( "item"); 関連するReadEndElement()およびWriteEndElement()は、whileループの外にあります。
MNS、2015

1
それは、その後のフレームワークでIDictionaryがシリアライズ可能であることを意味しますか?
トーマス

1
この実装は、ディクショナリがstring値などを格納している場合は機能しますが、InvalidOperationExceptionカスタムオブジェクトまたは文字列配列を格納しようとすると、予期しないラッパー要素について言及する非直列化をスローします。(私がこれで直面した問題の例については、私の質問を参照しください。)
クリストファーカイルホートン

57

を使用XmlSerializerする代わりに、を使用できますSystem.Runtime.Serialization.DataContractSerializer。これにより、辞書をシリアル化し、やり取りすることができます。

ここに完全な例へのリンクがあります、http://theburningmonk.com/2010/05/net-tips-xml-serialize-or-deserialize-dictionary-in-csharp/


2
ベストアンサー、ハンズダウン。
DWRoelands

これは最良の答えです。クリーンでシンプル、そしてドライ(Do n't Repeat Yourself)。
Nolonar 2015年

DataContractSerializerの問題は、アルファベット順にシリアライズおよびデシリアライズされるため、何かを間違った順序でデシリアライズしようとすると、オブジェクトのnullプロパティでサイレントに失敗します
18:09

14

シリアル化サロゲートを作成します。

たとえば、Dictionaryタイプのパブリックプロパティを持つクラスがあるとします。

このタイプのXMLシリアル化をサポートするには、一般的なKey-Valueクラスを作成します。

public class SerializeableKeyValue<T1,T2>
{
    public T1 Key { get; set; }
    public T2 Value { get; set; }
}

XmlIgnore属性を元のプロパティに追加します。

    [XmlIgnore]
    public Dictionary<int, string> SearchCategories { get; set; }

SearchCategoriesプロパティへのシリアル化および逆シリアル化に使用されるSerializableKeyValueインスタンスの配列を保持する、配列型のパブリックプロパティを公開します。

    public SerializeableKeyValue<int, string>[] SearchCategoriesSerializable
    {
        get
        {
            var list = new List<SerializeableKeyValue<int, string>>();
            if (SearchCategories != null)
            {
                list.AddRange(SearchCategories.Keys.Select(key => new SerializeableKeyValue<int, string>() {Key = key, Value = SearchCategories[key]}));
            }
            return list.ToArray();
        }
        set
        {
            SearchCategories = new Dictionary<int, string>();
            foreach (var item in value)
            {
                SearchCategories.Add( item.Key, item.Value );
            }
        }
    }

これは、シリアライゼーションをディクショナリー・メンバーから切り離すため、これが好きです。シリアライゼーション機能を追加したい使用頻度の高いクラスがある場合、辞書をラップすると、継承された型で中断が発生する可能性があります。
VoteCoffee 2014年

これを実装する人への警告:サロゲートプロパティをList(またはその他のコレクション)にしようとすると、XML シリアライザーはセッターを呼び出さない(代わりにゲッターを呼び出して返されたリストに追加しようとする、これは明らかにあなたが望んだものではありません)。このパターンの配列に固執します。
Fraxtil、16

9

Json.Netを探索する必要があります。非常に使いやすく、Jsonオブジェクトをディクショナリで直接逆シリアル化できます。

james_newtonking

例:

string json = @"{""key1"":""value1"",""key2"":""value2""}";
Dictionary<string, string> values = JsonConvert.DeserializeObject<Dictionary<string, string>>(json); 
Console.WriteLine(values.Count);
// 2
Console.WriteLine(values["key1"]);
// value1

6

辞書とハッシュテーブルは、ではシリアル化できませんXmlSerializer。したがって、直接使用することはできません。回避策は、XmlIgnore属性を使用してシリアライザからこれらのプロパティを非表示にし、シリアル化可能なキーと値のペアのリストを介してそれらを公開することです。

PS:の作成XmlSerializerは非常にコストがかかるため、再利用できる可能性がある場合は常にキャッシュしてください。


4

キー/値にxml属性を使用するSerializableDictionaryクラスが必要だったので、Paul Welterのクラスを適合させました。

これは次のようなxmlを生成します:

<Dictionary>
  <Item Key="Grass" Value="Green" />
  <Item Key="Snow" Value="White" />
  <Item Key="Sky" Value="Blue" />
</Dictionary>"

コード:

using System.Collections.Generic;
using System.Xml;
using System.Xml.Linq;
using System.Xml.Serialization;

namespace DataTypes {
    [XmlRoot("Dictionary")]
    public class SerializableDictionary<TKey, TValue>
        : Dictionary<TKey, TValue>, IXmlSerializable {
        #region IXmlSerializable Members
        public System.Xml.Schema.XmlSchema GetSchema() {
            return null;
        }

        public void ReadXml(XmlReader reader) {
            XDocument doc = null;
            using (XmlReader subtreeReader = reader.ReadSubtree()) {
                doc = XDocument.Load(subtreeReader);
            }
            XmlSerializer serializer = new XmlSerializer(typeof(SerializableKeyValuePair<TKey, TValue>));
            foreach (XElement item in doc.Descendants(XName.Get("Item"))) {
                using(XmlReader itemReader =  item.CreateReader()) {
                    var kvp = serializer.Deserialize(itemReader) as SerializableKeyValuePair<TKey, TValue>;
                    this.Add(kvp.Key, kvp.Value);
                }
            }
            reader.ReadEndElement();
        }

        public void WriteXml(System.Xml.XmlWriter writer) {
            XmlSerializer serializer = new XmlSerializer(typeof(SerializableKeyValuePair<TKey, TValue>));
            XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
            ns.Add("", "");
            foreach (TKey key in this.Keys) {
                TValue value = this[key];
                var kvp = new SerializableKeyValuePair<TKey, TValue>(key, value);
                serializer.Serialize(writer, kvp, ns);
            }
        }
        #endregion

        [XmlRoot("Item")]
        public class SerializableKeyValuePair<TKey, TValue> {
            [XmlAttribute("Key")]
            public TKey Key;

            [XmlAttribute("Value")]
            public TValue Value;

            /// <summary>
            /// Default constructor
            /// </summary>
            public SerializableKeyValuePair() { }
        public SerializableKeyValuePair (TKey key, TValue value) {
            Key = key;
            Value = value;
        }
    }
}
}

単体テスト:

using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace DataTypes {
    [TestClass]
    public class SerializableDictionaryTests {
        [TestMethod]
        public void TestStringStringDict() {
            var dict = new SerializableDictionary<string, string>();
            dict.Add("Grass", "Green");
            dict.Add("Snow", "White");
            dict.Add("Sky", "Blue");
            dict.Add("Tomato", "Red");
            dict.Add("Coal", "Black");
            dict.Add("Mud", "Brown");

            var serializer = new System.Xml.Serialization.XmlSerializer(dict.GetType());
            using (var stream = new MemoryStream()) {
                // Load memory stream with this objects xml representation
                XmlWriter xmlWriter = null;
                try {
                    xmlWriter = XmlWriter.Create(stream);
                    serializer.Serialize(xmlWriter, dict);
                } finally {
                    xmlWriter.Close();
                }

                // Rewind
                stream.Seek(0, SeekOrigin.Begin);

                XDocument doc = XDocument.Load(stream);
                Assert.AreEqual("Dictionary", doc.Root.Name);
                Assert.AreEqual(dict.Count, doc.Root.Descendants().Count());

                // Rewind
                stream.Seek(0, SeekOrigin.Begin);
                var outDict = serializer.Deserialize(stream) as SerializableDictionary<string, string>;
                Assert.AreEqual(dict["Grass"], outDict["Grass"]);
                Assert.AreEqual(dict["Snow"], outDict["Snow"]);
                Assert.AreEqual(dict["Sky"], outDict["Sky"]);
            }
        }

        [TestMethod]
        public void TestIntIntDict() {
            var dict = new SerializableDictionary<int, int>();
            dict.Add(4, 7);
            dict.Add(5, 9);
            dict.Add(7, 8);

            var serializer = new System.Xml.Serialization.XmlSerializer(dict.GetType());
            using (var stream = new MemoryStream()) {
                // Load memory stream with this objects xml representation
                XmlWriter xmlWriter = null;
                try {
                    xmlWriter = XmlWriter.Create(stream);
                    serializer.Serialize(xmlWriter, dict);
                } finally {
                    xmlWriter.Close();
                }

                // Rewind
                stream.Seek(0, SeekOrigin.Begin);

                XDocument doc = XDocument.Load(stream);
                Assert.AreEqual("Dictionary", doc.Root.Name);
                Assert.AreEqual(3, doc.Root.Descendants().Count());

                // Rewind
                stream.Seek(0, SeekOrigin.Begin);
                var outDict = serializer.Deserialize(stream) as SerializableDictionary<int, int>;
                Assert.AreEqual(dict[4], outDict[4]);
                Assert.AreEqual(dict[5], outDict[5]);
                Assert.AreEqual(dict[7], outDict[7]);
            }
        }
    }
}

1
見栄えは良いですが、空の辞書で失敗します。ReadXMLメソッドにreader.IsEmptyElementテストが必要です。
AnthonyVO 2015

2

辞書クラスはISerializableを実装します。以下に示すクラス辞書の定義。

[DebuggerTypeProxy(typeof(Mscorlib_DictionaryDebugView<,>))]
[DebuggerDisplay("Count = {Count}")]
[Serializable]
[System.Runtime.InteropServices.ComVisible(false)]
public class Dictionary<TKey,TValue>: IDictionary<TKey,TValue>, IDictionary, IReadOnlyDictionary<TKey, TValue>, ISerializable, IDeserializationCallback  

それは問題ではないと思います。以下のリンクを参照してください。シリアル化できない他のデータ型がある場合、Dictionaryはシリアル化されません。 http://forums.asp.net/t/1734187.aspx?Is+Dictionary+serializable+


これは最新バージョンでも同じですが、.NET 2では、現在でも辞書はシリアル化できません。今日、.NET 3.5を対象とするプロジェクトでそれを確認しました。これが、このスレッドを見つけた方法です。
ブルース

2

ExtendedXmlSerializerを使用できます。クラスがある場合:

public class ConfigFile
{
    public String guiPath { get; set; }
    public string configPath { get; set; }
    public Dictionary<string, string> mappedDrives {get;set;} 

    public ConfigFile()
    {
        mappedDrives = new Dictionary<string, string>();
    }
}

このクラスのインスタンスを作成します:

ConfigFile config = new ConfigFile();
config.guiPath = "guiPath";
config.configPath = "configPath";
config.mappedDrives.Add("Mouse", "Logitech MX Master");
config.mappedDrives.Add("keyboard", "Microsoft Natural Ergonomic Keyboard 4000");

ExtendedXmlSerializerを使用してこのオブジェクトをシリアル化できます。

ExtendedXmlSerializer serializer = new ExtendedXmlSerializer();
var xml = serializer.Serialize(config);

出力xmlは次のようになります。

<?xml version="1.0" encoding="utf-8"?>
<ConfigFile type="Program+ConfigFile">
    <guiPath>guiPath</guiPath>
    <configPath>configPath</configPath>
    <mappedDrives>
        <Item>
            <Key>Mouse</Key>
            <Value>Logitech MX Master</Value>
        </Item>
        <Item>
            <Key>keyboard</Key>
            <Value>Microsoft Natural Ergonomic Keyboard 4000</Value>
        </Item>
    </mappedDrives>
</ConfigFile>

nugetからExtendedXmlSerializerをインストールするか、次のコマンドを実行できます。

Install-Package ExtendedXmlSerializer

こちらがオンラインの例です


弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.