シリアル化可能なオブジェクトをファイルに保存/ファイルから復元する方法は?


94

オブジェクトのリストがあり、それをコンピューターのどこかに保存する必要があります。私はいくつかのフォーラムを読みましたが、オブジェクトはでなければならないことを知っていますSerializable。しかし、私が例を示すことができれば素晴らしいでしょう。たとえば、次の場合:

[Serializable]
public class SomeClass
{
     public string someProperty { get; set; }
}

SomeClass object1 = new SomeClass { someProperty = "someString" };

しかし、どうすればobject1自分のコンピューターのどこかに保存して、後で取得できますか?


3
ここでは、ファイルにシリアライズする方法を示しているチュートリアルですswitchonthecode.com/tutorials/...
ブルック

回答:


140

次のものを使用できます。

    /// <summary>
    /// Serializes an object.
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="serializableObject"></param>
    /// <param name="fileName"></param>
    public void SerializeObject<T>(T serializableObject, string fileName)
    {
        if (serializableObject == null) { return; }

        try
        {
            XmlDocument xmlDocument = new XmlDocument();
            XmlSerializer serializer = new XmlSerializer(serializableObject.GetType());
            using (MemoryStream stream = new MemoryStream())
            {
                serializer.Serialize(stream, serializableObject);
                stream.Position = 0;
                xmlDocument.Load(stream);
                xmlDocument.Save(fileName);
            }
        }
        catch (Exception ex)
        {
            //Log exception here
        }
    }


    /// <summary>
    /// Deserializes an xml file into an object list
    /// </summary>
    /// <typeparam name="T"></typeparam>
    /// <param name="fileName"></param>
    /// <returns></returns>
    public T DeSerializeObject<T>(string fileName)
    {
        if (string.IsNullOrEmpty(fileName)) { return default(T); }

        T objectOut = default(T);

        try
        {
            XmlDocument xmlDocument = new XmlDocument();
            xmlDocument.Load(fileName);
            string xmlString = xmlDocument.OuterXml;

            using (StringReader read = new StringReader(xmlString))
            {
                Type outType = typeof(T);

                XmlSerializer serializer = new XmlSerializer(outType);
                using (XmlReader reader = new XmlTextReader(read))
                {
                    objectOut = (T)serializer.Deserialize(reader);
                }
            }
        }
        catch (Exception ex)
        {
            //Log exception here
        }

        return objectOut;
    }

1
いいね!が、string attributeXml = string.Empty;中にはDeSerializeObject使用されることはありません。)
神保

3
usingブロック内のリーダーでcloseメソッドを呼び出す必要はありません。Dispose()は暗黙的であり、明示的なClose()の前にブロック内で例外が発生した場合でも実行されます。コードの非常に便利なブロック。
S.ブレントソン2016

2
この関数を使用してオブジェクトのリストを保存する方法を使用しましたが、リストの最後のオブジェクトのみを保存しています
Decoder94

1
このメソッドは内部またはプライベートフィールドを保存しません。これを使用できます:github.com/mrbm2007/ObjectSaver
mrbm

148

オブジェクトのデータをBinary、XML、またはJsonに保存することに関するブログ投稿を書いたところです。[Serializable]属性を使用してクラスを装飾する必要があるのは正しいですが、バイナリシリアル化を使用している場合に限られます。XMLまたはJsonシリアル化を使用することをお勧めします。さまざまな形式でこれを行う関数を次に示します。詳細については、私のブログ投稿を参照してください。

バイナリ

/// <summary>
/// Writes the given object instance to a binary file.
/// <para>Object type (and all child types) must be decorated with the [Serializable] attribute.</para>
/// <para>To prevent a variable from being serialized, decorate it with the [NonSerialized] attribute; cannot be applied to properties.</para>
/// </summary>
/// <typeparam name="T">The type of object being written to the binary file.</typeparam>
/// <param name="filePath">The file path to write the object instance to.</param>
/// <param name="objectToWrite">The object instance to write to the binary file.</param>
/// <param name="append">If false the file will be overwritten if it already exists. If true the contents will be appended to the file.</param>
public static void WriteToBinaryFile<T>(string filePath, T objectToWrite, bool append = false)
{
    using (Stream stream = File.Open(filePath, append ? FileMode.Append : FileMode.Create))
    {
        var binaryFormatter = new System.Runtime.Serialization.Formatters.Binary.BinaryFormatter();
        binaryFormatter.Serialize(stream, objectToWrite);
    }
}

/// <summary>
/// Reads an object instance from a binary file.
/// </summary>
/// <typeparam name="T">The type of object to read from the binary file.</typeparam>
/// <param name="filePath">The file path to read the object instance from.</param>
/// <returns>Returns a new instance of the object read from the binary file.</returns>
public static T ReadFromBinaryFile<T>(string filePath)
{
    using (Stream stream = File.Open(filePath, FileMode.Open))
    {
        var binaryFormatter = new System.Runtime.Serialization.Formatters.Binary.BinaryFormatter();
        return (T)binaryFormatter.Deserialize(stream);
    }
}

XML

System.Xmlアセンブリがプロジェクトに含まれている必要があります。

/// <summary>
/// Writes the given object instance to an XML file.
/// <para>Only Public properties and variables will be written to the file. These can be any type though, even other classes.</para>
/// <para>If there are public properties/variables that you do not want written to the file, decorate them with the [XmlIgnore] attribute.</para>
/// <para>Object type must have a parameterless constructor.</para>
/// </summary>
/// <typeparam name="T">The type of object being written to the file.</typeparam>
/// <param name="filePath">The file path to write the object instance to.</param>
/// <param name="objectToWrite">The object instance to write to the file.</param>
/// <param name="append">If false the file will be overwritten if it already exists. If true the contents will be appended to the file.</param>
public static void WriteToXmlFile<T>(string filePath, T objectToWrite, bool append = false) where T : new()
{
    TextWriter writer = null;
    try
    {
        var serializer = new XmlSerializer(typeof(T));
        writer = new StreamWriter(filePath, append);
        serializer.Serialize(writer, objectToWrite);
    }
    finally
    {
        if (writer != null)
            writer.Close();
    }
}

/// <summary>
/// Reads an object instance from an XML file.
/// <para>Object type must have a parameterless constructor.</para>
/// </summary>
/// <typeparam name="T">The type of object to read from the file.</typeparam>
/// <param name="filePath">The file path to read the object instance from.</param>
/// <returns>Returns a new instance of the object read from the XML file.</returns>
public static T ReadFromXmlFile<T>(string filePath) where T : new()
{
    TextReader reader = null;
    try
    {
        var serializer = new XmlSerializer(typeof(T));
        reader = new StreamReader(filePath);
        return (T)serializer.Deserialize(reader);
    }
    finally
    {
        if (reader != null)
            reader.Close();
    }
}

ジェイソン

Json.NET NuGet Packageから取得できるNewtonsoft.Jsonアセンブリへの参照を含める必要があります。

/// <summary>
/// Writes the given object instance to a Json file.
/// <para>Object type must have a parameterless constructor.</para>
/// <para>Only Public properties and variables will be written to the file. These can be any type though, even other classes.</para>
/// <para>If there are public properties/variables that you do not want written to the file, decorate them with the [JsonIgnore] attribute.</para>
/// </summary>
/// <typeparam name="T">The type of object being written to the file.</typeparam>
/// <param name="filePath">The file path to write the object instance to.</param>
/// <param name="objectToWrite">The object instance to write to the file.</param>
/// <param name="append">If false the file will be overwritten if it already exists. If true the contents will be appended to the file.</param>
public static void WriteToJsonFile<T>(string filePath, T objectToWrite, bool append = false) where T : new()
{
    TextWriter writer = null;
    try
    {
        var contentsToWriteToFile = JsonConvert.SerializeObject(objectToWrite);
        writer = new StreamWriter(filePath, append);
        writer.Write(contentsToWriteToFile);
    }
    finally
    {
        if (writer != null)
            writer.Close();
    }
}

/// <summary>
/// Reads an object instance from an Json file.
/// <para>Object type must have a parameterless constructor.</para>
/// </summary>
/// <typeparam name="T">The type of object to read from the file.</typeparam>
/// <param name="filePath">The file path to read the object instance from.</param>
/// <returns>Returns a new instance of the object read from the Json file.</returns>
public static T ReadFromJsonFile<T>(string filePath) where T : new()
{
    TextReader reader = null;
    try
    {
        reader = new StreamReader(filePath);
        var fileContents = reader.ReadToEnd();
        return JsonConvert.DeserializeObject<T>(fileContents);
    }
    finally
    {
        if (reader != null)
            reader.Close();
    }
}

// Write the contents of the variable someClass to a file.
WriteToBinaryFile<SomeClass>("C:\someClass.txt", object1);

// Read the file contents back into a variable.
SomeClass object1= ReadFromBinaryFile<SomeClass>("C:\someClass.txt");

2
私はあなたのバイナリシリアル化コードが好きです。しかし、WriteToBinaryFileでは、なぜファイルに追加する必要があるのでしょうか。どのような場合でも新しいファイルを作成する必要があるようです。それ以外の場合は、逆シリアル化に関する追加情報がたくさんあります。
パブリックワイヤレス

1
@publicwirelessええ、あなたはおそらく正しいです。当時はあまり考えませんでした。3つの関数のシグネチャを一致させたかっただけです:P
deadlydog

appendメソッドを使用して、同じファイル内の多くのオブジェクトをシリアル化します。それらを逆シリアル化するにはどうすればよいですか?ストリームでどのようにシークしますか?
John Demetriou

1
バイナリシリアライザーにコメントを追加してください。リダイレクトバインディングを追加したり、上記のバインディングを尊重しない環境(例:powershell)で実行したりせずに、結果のデータにアセンブリの厳密な名前がスタンプされ、バージョンが変更されることを通知します。失敗
zaitsman 2017年

1
@JohnDemetriou複数のものをファイルに保存する場合は、オブジェクトを何らかの形のコンテキストオブジェクトでラップし、そのオブジェクトをシリアル化することをお勧めします(オブジェクトマネージャーが必要な部分を解析できるようにします)。メモリに保持できる以上のデータを保存する場合は、ファイルではなくオブジェクトストア(オブジェクトデータベース)に切り替えることをお勧めします。
Tezra

30

何かにシリアライズする必要があります。つまり、バイナリまたはxml(デフォルトのシリアライザーの場合)を選択するか、カスタムシリアライゼーションコードを記述して、他のテキスト形式にシリアライズします。

それを選択すると、シリアライゼーションは(通常)ある種のファイルに書き込んでいるストリームを呼び出します。

したがって、コードで、XMLシリアル化を使用していた場合:

var path = @"C:\Test\myserializationtest.xml";
using(FileStream fs = new FileStream(path, FileMode.Create))
{
    XmlSerializer xSer = new XmlSerializer(typeof(SomeClass));

    xSer.Serialize(fs, serializableObject);
}

次に、逆シリアル化するには:

using(FileStream fs = new FileStream(path, FileMode.Open)) //double check that...
{
    XmlSerializer _xSer = new XmlSerializer(typeof(SomeClass));

    var myObject = _xSer.Deserialize(fs);
}

注:このコードはコンパイルされていません。実行はもちろんですが、エラーが発生する可能性があります。また、これは完全に独創的なシリアライゼーション/デシリアライゼーションを前提としています。カスタム動作が必要な場合は、追加の作業を行う必要があります。


10

1.ファイルからオブジェクトを復元

ここでは 次の2つの方法でファイルからオブジェクトをデシリアライズすることができます。

ソリューション1:ファイルを文字列に読み取り、JSONを型に逆シリアル化する

string json = File.ReadAllText(@"c:\myObj.json");
MyObject myObj = JsonConvert.DeserializeObject<MyObject>(json);

ソリューション2:JSONをファイルから直接デシリアライズする

using (StreamReader file = File.OpenText(@"c:\myObj.json"))
{
    JsonSerializer serializer = new JsonSerializer();
    MyObject myObj2 = (MyObject)serializer.Deserialize(file, typeof(MyObject));
}

2.オブジェクトをファイルに保存

ここから、2つの方法でオブジェクトをファイルにシリアル化できます。

解決策1:JSONを文字列にシリアル化し、文字列をファイルに書き込む

string json = JsonConvert.SerializeObject(myObj);
File.WriteAllText(@"c:\myObj.json", json);

解決策2:JSONを直接ファイルにシリアル化する

using (StreamWriter file = File.CreateText(@"c:\myObj.json"))
{
    JsonSerializer serializer = new JsonSerializer();
    serializer.Serialize(file, myObj);
}

3.追加

次のコマンドを使用して、NuGetからNewtonsoft.Jsonをダウンロードできます。

Install-Package Newtonsoft.Json

1

** 1。json文字列をbase64stringに変換し、バイナリファイルに書き込むか追加します。2.バイナリファイルからbase64stringを読み取り、BsonReaderを使用して逆シリアル化します。**

 public static class BinaryJson
{
    public static string SerializeToBase64String(this object obj)
    {
        JsonSerializer jsonSerializer = new JsonSerializer();
        MemoryStream objBsonMemoryStream = new MemoryStream();
        using (BsonWriter bsonWriterObject = new BsonWriter(objBsonMemoryStream))
        {
            jsonSerializer.Serialize(bsonWriterObject, obj);
            return Convert.ToBase64String(objBsonMemoryStream.ToArray());
        }           
        //return Encoding.ASCII.GetString(objBsonMemoryStream.ToArray());
    }
    public static T DeserializeToObject<T>(this string base64String)
    {
        byte[] data = Convert.FromBase64String(base64String);
        MemoryStream ms = new MemoryStream(data);
        using (BsonReader reader = new BsonReader(ms))
        {
            JsonSerializer serializer = new JsonSerializer();
            return serializer.Deserialize<T>(reader);
        }
    }
}

0

NewtonsoftライブラリのJsonConvertを使用できます。オブジェクトをシリアル化してjson形式でファイルに書き込むには:

File.WriteAllText(filePath, JsonConvert.SerializeObject(obj));

そしてそれをオブジェクトに逆シリアル化するには:

var obj = JsonConvert.DeserializeObject<ObjType>(File.ReadAllText(filePath));
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.