Базовая сериализация

Самый простой способ создать сериализуемый класс — отметить его атрибутом Serializable следующим образом.

[Serializable]
public class MyObject {
  public int n1 = 0;
  public int n2 = 0;
  public String str = null;
}

В примере кода показано, как экземпляр этого класса можно сериализовать в файл.

MyObject obj = new MyObject();
obj.n1 = 1;
obj.n2 = 24;
obj.str = "Some String";
IFormatter formatter = new BinaryFormatter();
Stream stream = new FileStream("MyFile.bin", FileMode.Create, FileAccess.Write, FileShare.None);
formatter.Serialize(stream, obj);
stream.Close();

В этом примере для сериализации используется двоичный модуль форматирования. Все, что нужно сделать, — создать экземпляр потока и модуль форматирования, который будет использоваться, а затем вызвать для модуля форматирования метод Serialize. Сериализуемый поток и объект для этого вызова предоставляются как параметры. Хотя в этом примере это явно не показано, будут сериализованы все переменные членов класса — даже переменные, отмеченные как закрытые. Таким образом, двоичная сериализация отличается от класса XMLSerializer, при котором выполняется сериализация только открытых полей. Сведения об исключении переменных членов из двоичной сериализации см. в разделе Выборочная сериализация.

Не менее просто и восстановление объекта в предыдущее состояние. Сначала создайте поток для чтения и модуль форматирования, а затем дайте модулю форматирования команду десериализовать объект. Эта процедура показана в следующем примере кода.

IFormatter formatter = new BinaryFormatter();
Stream stream = new FileStream("MyFile.bin", FileMode.Open, FileAccess.Read, FileShare.Read);
MyObject obj = (MyObject) formatter.Deserialize(stream);
stream.Close();

// Here's the proof.
Console.WriteLine("n1: {0}", obj.n1);
Console.WriteLine("n2: {0}", obj.n2);
Console.WriteLine("str: {0}", obj.str);

Используемый выше BinaryFormatter очень эффективен и генерирует компактный поток байтов. Все сериализуемые с использованием этого модуля форматирования объекты можно также десериализовать с его помощью, что делает его идеальным инструментом для сериализации объектов, которые будут десериализованы в платформе .NET Framework. Важно отметить, что во время десериализации объекта конструкторы не вызываются. Это ограничение накладывается на десериализацию по причинам обеспечения производительности. Однако при этом способе нарушаются некоторые обычные контракты, которые осуществляет среда выполнения с использованием модуля записи объектов, и разработчики, отмечая объект как сериализуемый, должны понимать последствия.

Если требуется обеспечение переносимости, используйте SoapFormatter. Просто замените BinaryFormatter в коде выше на SoapFormatter, и вызовите Serialize и Deserialize, как и раньше. Результатом работы этого модуля форматирования в примере выше является следующее.

<SOAP-ENV:Envelope
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:SOAP- ENC="https://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP- ENV="https://schemas.xmlsoap.org/soap/envelope/"
  SOAP-ENV:encodingStyle=
  "https://schemas.microsoft.com/soap/encoding/clr/1.0"
  "https://schemas.xmlsoap.org/soap/encoding/"
  xmlns:a1="https://schemas.microsoft.com/clr/assem/ToFile">

  <SOAP-ENV:Body>
    <a1:MyObject id="ref-1">
      <n1>1</n1>
      <n2>24</n2>
      <str id="ref-3">Some String</str>
    </a1:MyObject>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Важно отметить, что атрибут Serializable не может быть унаследован. Если новый класс наследуется от MyObject, новый класс также должен быть отмечен атрибутом, иначе его сериализация невозможна. Например, при попытке сериализовать экземпляр класса (см. ниже), будет выдано исключение SerializationException, информирующее о том, что тип MyStuff не отмечен как сериализуемый.

public class MyStuff : MyObject 
{
  public int n3;
}

Использование атрибута Serializable удобно, но у него есть свои ограничения, как это показано выше. См. раздел Правила сериализации, чтобы получить сведения о том, в каких случаях класс следует отмечать для сериализации. Сериализацию невозможно добавить в класс после компиляции.

См. также

Другие ресурсы

Двоичная сериализация
Remote Objects
XML- и SOAP-сериализация