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

Хотя реализация интерфейса ISerializable в .NET 2.0 все еще допустима, для настройки процесса сериализации теперь более предпочтительным считается определение методов, наделенных одним из целого ряда новых атрибутов, связанных с задачами сериализации (это атрибуты [OnSerializing], [OnSerialized], [OnDeserializing] и [OnDeserialized]). Использование этих атрибутов оказывается менее громоздким, чем реализация ISerializable, поскольку тогда не возникает необходимости вручную взаимодействовать с поступающим параметром SerializationInfo. Вместо этого вы получаете возможность непосредственно изменять данные состояния во время воздействия форматтера на тип.

При использовании этих атрибутов методы должны определяться так, чтобы они получали параметр StreamingContext и не возвращали ничего (в противном случае в среде выполнения генерируется соответствующее исключение). Обратите внимание на то, что не требуется учитывать все указанные атрибуты сериализации – можно учесть только те стадии сериализации, для которых следует выполнить перехват. Для примера рассмотрите новый тип [Serializable] с теми же требованиями, что и у MyStringData, но на этот раз с использованием атрибутов [OnSerializing] и [OnDeserialized].

[Serializable]

class MoreData {

 public string dataItemOne, dataItemTwo;

 [OnSerializing]

 internal void OnSerializing(StreamingContext context) {

  // Выполняется в процессе сериализации.

  dataItemOne = dataItemOne.ToUpper();

  dataItemTwo = dataItemTwo.ToUpper();

 }

 [OnDeserialized]

 internal void OnDeserialized(StreamingContext, context) {

  // Выполняется по завершении реконструкции объекта.

  dataItemOne = dataItemOne.ToLower();

  dataItemTwo = dataItemTwo.ToLower();

 }

}

Если выполнись сериализацию этого нового типа, вы снова обнаружите, что данные сохраняются в верхнем регистре, а воcстанавливаются – в нижнем.

Исходный код. Проект СustomSerialization размещен в подкаталоге, соответствующем главе 17.

Поддержка версий сериализации объектов

В завершение обсуждения этой главы мы рассмотрим тему поддержки версий сериализации объектов. Чтобы понять, почему это необходимо, мы используем следующий сценарий. Предположим, что мы создали класс UserPrefs (он уже упоминался в начале главы) так, как показано ниже.

[Serializable]

class UserPrefs {

 public string objVersion = "1.0";

 public ConsoleColor BackgroundColor;

 public ConsoleColor ForegroundColor;

 public UserPrefs() {

  BackgroundColor = ConsoleColor.Black;

  ForegroundColor = ConsoleColor.Red;

 }

}

Теперь предположим, что у нас есть приложение, в котором выполняется сериализация экземпляра этого класса с помощью BinaryFormatter.

static void Main(string[] args) {

 UserPrefs up = new UserPrefs();

 up.BackgroundColor = ConsoleColor.DarkBlue;

 up.ForegroundColor = ConsoleColor.White;

 // Сохранение экземпляра UserPrefs в файле.

 BinaryFormatter binFormat = new BinaryFormatter();

 Stream fStream = new FileStream(@"C:\user.dat", FileMode.Create, FileAccess.Write, FileShare.None);

 birFormat.Serialize(fStream, up);

 fStream.Сlose();

 Console.ReadLine();

}

К этому моменту экземпляр UserPrefs (версии 1.0) сохранен в C:\user.dat. Но давайте добавим в определение класса UserPrefs два новых поля.

[Serializable]

class UserPrefs {

 public string objVersion = "2.0";

 public ConsoleColor BackgroundColor;

 public ConsoleColor ForegroundColor;

 // Являются новыми!

 public int BeepFreq;

 public string ConsoleTitle;

 public UserPrefs() {

  BeepFreq = 1000;

  ConsoleTitle = "Моя консоль";

  BackgroundColor = ConsoleColor.Black;

  ForegroundColor = ConsoleColor.Red;

 }

}

Теперь представьте себе, что это же приложение пытается реконструировать экземпляр сохраненного объекта UserPrefs версии 1.0 так, как показано ниже (заметьте, чтобы этот пример работал, предыдущая программная логика сериализации была удалена).

static void Main(string[] args) {

 // Загрузка экземпляра UserPrefs (1.0) в память?

 UserPrefs up = null;

 BinaryFormatter binFormat = new BinaryFormatter();

 Stream fStream = new FileStream(@"C:\user.dat", FileMode.Open, FileAccess.Read, FileShare.None);

 up = (UserPrefs)binFormat.Deserialize(fStream);

 fStream.Close();

 Console.ReadLine();

}

Вы увидите окно с информацией о следующем исключении, сгенерированном средой выполнения.

Необработанное исключение: System.Runtime.Serialization.SerializationException. Член 'BeepFreq' в классе 'VersionedObject.UserPrefs' не присутствует в сохраненном потоке и не обозначен атрибутом System.Runtime.Serialization.OptionalFieldAttribute.

Проблема в том, что оригинальный объект UserPrefs, сохраненный в C:\user.dat, не сохранял два новых поля, присутствующих в обновленном определении класса (это поля BeepFreq и ConsoleTitle). Очевидно, что это настоящая проблема, поскольку для сохраняемого объекта вполне естественно эволюционировать в процессе существования.

До выхода .NET 2.0 единственной возможностью для учета того, что сохраненный объект может не иметь всех новых полей из обновленной и более поздней версии класса, была необходимость реализации ISerializable и осуществление контроля "вручную". Но с появлением .NET 2.0 новые поля могут явно обозначаться атрибутом [Optional Field] (определенным в рамках пространства имен System.Runtime.Serialization).

[Seriаlizable]

class UserPrefs {

 public ConsoleColor BackgroundColor;

 public ConsoleColor ForegroundColor;

 // Являются новыми!

 [OptionalField]

 public int BeepFreq;

 [OptionalField]

 public string ConsoleTitle;

 public UserPrefs() {

  BeepFreq = 1000;

  ConsoleTitle = ''Моя консоль";

  BackgroundColor = ConsoleColor.Black;

  ForegroundColor = ConsoleColor.Red;

}

Когда форматтер реконструирует объект и обнаруживает, что отсутствующие поля помечены, как необязательные, исключение среды выполнения уже не генерируется. Вместо этого данные, которые были сохранены, проецируется обратно в существующие поля (в данном случае это BackgroundColor и ForegroundColor), a остальным полям присваиваются значения, предусмотренные по умолчанию.

Замечание. Следует понимать, что использование [OptionalField] не решает проблему версий сохраненных объектов полностью. Однако этот атрибут обеспечивает решение самой типичной проблемы (добавление новых полей данных). Для решения более сложных задан поддержки версий все же потребуется реализация интерфейса ISerializable.

Исходный код. Проект VersionedObject размещен в подкаталоге, соответствующем главе 17.

Резюме

В этой главе предлагается обсуждение сервисов сериализации. Вы могли убедиться в том. что платформа .NET для корректного учета всего множества связанных объектов, подлежащих сохранению в потоке, использует объектные графы. Когда каждый член объектного графа обозначен атрибутом [Seriаlizable], данные можно сохранять в любом из нескольких доступных форматов (в двоичном формате, формате SOAP или формате XML).

Вы также узнали о том, что процесс сериализации допускает пользовательскую настройку в рамках двух возможных подходов. Во-первых, у вас есть возможность реализовать интерфейс ISerializable (с поддержкой специального приватного конструктора), чтобы влиять на то. как средства форматирования сохраняют поступающие данные. Во-вторых, вы можете использовать множество новых атрибутов, появившихся в .NET 2.0, которые упрощают процесс сериализации с пользовательскими настройками. Следует просто применить один из атрибутов [OnSerializing], [OnSerialized], [OnDeserializing] или [OnDeserialized] к членам, получающим параметр StreamingContext, и форматтер обработает их соответствующим образом. Завершается глава обсуждением еще одного атрибута, [OptionalField], который может использоваться для поддержки версий сериализации типов.