Книга: ЯЗЫК ПРОГРАММИРОВАНИЯ С# 2005 И ПЛАТФОРМА .NET 2.0. 3-е издание

Настройка параметров сериализации с помощью ISerializable

Настройка параметров сериализации с помощью ISerializable

Объекты, обозначаемые атрибутом [Serializable], имеют возможность реализовать интерфейс ISerializable. В этом случае вы можете "участвовать" в процессе сериализации, выполняя любое предварительное или последующее форматирование данных. Указанный интерфейс очень прост, поскольку он определяет единственный метод, GetObjectData().

// Для настройки процесса сериализации реализуйте ISerializable.
public interface ISerializable {
 void GetObjectData(SerializationInfo info, StreamingContext context);
}

Метод GetObjectData() вызывается форматтером в процессе сериализации автоматически. Реализация этого метода предоставляет через входной параметр SerializationInfo серию пар имен и значений, которые (обычно) соответствуют полям данных того объекта, который следует сохранить. Тип SerializationInfo определяет перегруженный метод AddValue(), имеющий множество вариаций, а также небольшой набор свойств, которые позволяют читать и устанавливать имя типа, имя определяющего компоновочного блока и значение счетчика членов. Вот фрагмент соответствующего программного кода.

public sealed class SerializationInfo: object {
 public SerializationInfo(Type type, IFormatterConverter converter);
 public string AssemblyName { get; set; }
 public string FullTypeName { get; set; }
 public int MemberCount { get; }
 public void AddValue(string name, short value);
 public void AddValue(string name, UInt16 value);
 public void AddValue(string name, int value);
 …
}

Типы, реализующие интерфейс ISerializable, должны также определять специальный конструктор в соответствии со следующим шаблоном.

// Следует предложить пользовательский конструктор следующего вида,
// чтобы среда выполнения могла установить состояние вашего объекта.
[Serializable]
class SomeClass: ISerializable {
 private SomeClass(SerializationInfo si, StreamingContext ctx) {…}
 …
}

Обратите внимание на то, что для области видимости этого конструктора указано private. Это вполне допустимо, поскольку форматтер получает доступ к этому члену независимо от его видимости. Эти специальные конструкторы чаще всего обозначаются как приватные, чтобы обеспечить невозможность случайного создания объекта пользователем объекта с помощью такого конструктора. Заметьте, что первый параметр этого конструктора является (как и ранее) экземпляром типа SerializationInfo.

Второй параметр этого специального конструктора является типом StreamingContext, содержащим информацию об источнике или пункте назначения битов. Самым информативным членом этого типа является свойство State, которое представляет значение из перечня StreamingContextStates. Значения этого перечня соответствуют базовой композиции текущего потока.

Честно говоря, если вашей задачей разработки не является низкоуровневый пользовательский сервис удаленного доступа, вам вряд ли придется обращаться к указанному перечню непосредственно. Тем не менее, ниже приводятся имена элементов перечня StreamingContextStates (подробности его описания можно найти в документации .NET Framework 2.0 SDK).

public enum StreamingContextStates {
 CrossProcess,
 CrossMachine,
 File,
 Persistence,
 Remoting,
 Other,
 Clone,
 CrossAppDomain,
 All
}

Чтобы иллюстрировать возможности настройки процесса сериализации с помощью ISerializable, предположим, что у нас есть тип класса, который определяет два элемента строковых данных. Кроме того, предположим, что все символы этих строк должны сохраняться в поток в верхнем регистре, а восстанавливаться из потока – в нижнем. Чтобы учесть эти требования, вы можете реализовать ISerializable так. как показано ниже (не забудьте указать using для пространства имен System.Runtime.Serialization).

[Seriаlizable]
class MyStringData: ISerializable {
 public string dataItemOne, dataItemTwo;
 public MyStringData() {}
 private MyStringData(SerializationInfo si, StreamingContext ctx) {
  // Регидратация члена из потока.
  dataItemOne = si.GetString(First_Item").ToLower();
  dataItemTwo = si.GetString("dataItemTwo").ToLower();
 }
 void ISerializable.GetObjectData(SerializatianInfo info, StreamingContext ctx) {
  // Наполнение объекта SerializationInfo
  // форматированными данными.
  info.AddValue("First_Item", dataItemOne.ToUpper());
  info.AddValue("dataItemTwo", dataItemTwo.ToUpper());
 }
}

Обратите внимание на то, что при "наполнении" типа SerializationInfo в методе GetObjectData() не требуется, чтобы элементы данных назывались одинаково с внутренними членами-переменными типа. Это может оказаться полезным тогда, когда нужно выделять данные из сохраненного формата. При этом не следует забывать о том, что для получения значений из приватного конструктора необходимо использовать имена, которые назначаются в рамках GetObjectData().

Чтобы проверить пользовательские настройки, предположим, что вы сохранили экземпляр MyStringData с помощью SoapFormatter. Заглянув в результирующий файл *.soap, вы увидите, что строковые поля в нем действительно представлены в верхнем регистре.

‹SOAP-ENV:Envelope xmlns:xsi="…"›
 ‹SOAP-ENV:Body›
  ‹a1:MyStringData xmlns:a1="…"›
   ‹First_Item›ЭTO НЕКОТОРЫЕ ДАННЫЕ.‹/First_Item›
   ‹dataItemTwo›ЭTO НЕКОТОРЫЕ ДОПОЛНИТЕЛЬНЫЕ ДАННЫЕ‹/dataItemTwo›
  ‹/a1:MyStringData›
 ‹/SOAP-ENV:Body›
‹/SOAP-ENV:Envelope›

Оглавление книги