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

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

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

В завершение обсуждения этой главы мы рассмотрим тему поддержки версий сериализации объектов. Чтобы понять, почему это необходимо, мы используем следующий сценарий. Предположим, что мы создали класс 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.

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