GrandM-Patterns_in_Java

378 • Глава 8. Поведенческие шаблоны проектирования

РЕШЕНИЕ

Рассмотрим два основных подхода к решению проблемы сохранения копии со­ стояния объекта и восстановления его состояния из этой копии. Сначала опи­ шем применение объектов Mernento для создания временной копии частичного состояния объекта. Затем - использование сериализации для восстановления состояния объекта, и потом сравним эти два способа.

На рис. 8.15 представлена основная организация объектов, использующих объ­ екты Mernento для сохранения и восстановления состояния объекта.

Рис. 8.15. Моментальный снимок, использующий объекты Memento

Опишем роли, исполняемые изображенными на рис. 8.15 классами в рамках некоторой версии шаблона Snapshot, использующей объекты Меrnепto.

Originator. Класс в этой роли представляет собой класс, информация о состоя­

нии экземпляров которого подлежит сохранению и восстановлению. При вы­

зове метод createMernento создает объект Mernento, который содержит копию

информации о состоянии объекта Originator. Позднее можно восстановИТЬ

состояние объекта Originator, передавая объект Mernento его методу setMe­ rnento.

Memento. Класс в этой роли представляет собой закрытый статический класс

класса Originator, реализующий интерфейс Mernento IF. Его задачей являетсЯ

инкапсуляция моментальных снимков состояния объекта Originator. Он яв­ ляется закрытым членом класса Originator, поэтому к нему может обращать­ ся только класс Or ig inator . Другие классы должны осуществлять доступ к эК­ земплярам класса Mernento либо как экземпляры класса Obj ect, либо через

интерфейс Mernento I F.

MementoIF. Все классы, кроме класса Originator, обращаются к объектам Mernento через этот интерфейс. Интерфейсы в этой роли обычно не объявляЮТ

Snapshot _ 379

методов. Если они объявляют какие-либо методы, такие методы не должны до­ пускать изменения инкапсулированного состояния, что гарантирует совмести­ мость и целостность информации о состоянии. Интерфейсыгл. в этой роли проек­

тируются при помощи шаблона Rеаd-Опlу lnterface (см. 6).

Caretaker. Экземпляры классов в роли Caretaker поддерживают коллекцию объектов Memento. После того как объект Memento создан, он обычно добавля­ ется в коллекцию объекта Caretaker. Если должна выполняться операция от­

мены, объект Caretaker обычно сотрудничает с другим объектом для выбора объекта Memento. После выбора объекта Memento именно объект Caretaker, как правило, вызывает метод setMemento объекта Originator для восстанов­

ления его состояния.

Другой механизм создания моментального снимка состояния объекта - это се­ риализация (рис. 8.16). Сериализация отличается от большинства других объ­ ектно-ориентированных технологий тем, что при работе она нарушает инкап­ суляцию объекта, подлежащего сериализации. Большая (но не обязательно вся) часть нарушения инкапсуляции производится из-за механизма отражения языка Java.

Рис. 8.16. Моментальный снимок с nрименением сериалиэации

Опишем роли, исполняемые классами в той верси'и шаблона Snapshot, которая

применяет сериализацию.

Target. Объект Obj ectOutputStream превращает состояние экземпляров клас­ сов, выступаюших в этой роли, в байтовый поток. Объект Obj ect lnputStream

Восстанавливает состояние экземпляров классов, выступающих в этой роли,

из байтового потока. Роль объекта Target при выполнении таких дейст­

Вий пассивная. Все работу выполняет объект Obj ectOutputStream или объект

Obj ectlnputStream.

ObjectOutputStream. Выступаюший в -этой роли класс обычно представляет собой стандартный класс языка Java j ava . io . ОЬ ] ectOutputStream. Он

находит и осушествляет доступ к информации о состоянии объекта Target,

айтакже записывает ее в байтовый поток вместе с дополнительной информаци

е , которая позволяет объекту Obj ectInputStream восстанавливать инфор­­

Мацию о состоянии.

РЕАЛИЗАЦИЯ

Использование объектов Memento ДЛЯ выполнения моментальных снимков со­ стояния объекта реализуется очень просто. Применение сериализации требует большей компетентности и иногда большей сложности. Полное описание се­ риализации выходит за рамки данной книги. Приведем описание некоторых

характеристик сериализации, необходимых при рассмотрении шаблона Snapshot.

Чтобы выполнить сериализацию объекта, нужно создать объект Obj ectOut ­ putStream, передавая объект OutputStream его конструктору. Это делается примерно так:

Объект Obj ectOutputStream будет записывать создаваемый им байтовый по­

ТОК в объект OutputStream, переданный его конструктору.

После создания объекта Obj ectOutputStream можно сериализовать объект,

Передавая этот объект методу writeObj ect объекта Obj ectOutputStream,

Примерно таким образом:

ObOut . writeObject (foo) ;

Метод wri teObj ect использует механизм отражения языка Java для обнаруже­

1<Ния переменных экземпляра объекта, на который ссылается foo, и обращается ним. Если значение переменной экземпляра имеет простой тип, например,

382 • Глава 8. Поведенческие шаблоны проектирования

int или doub le, оно записывается прямо в байтовый поток. Если значениеectле­

ременной экземпляра - это ссылка на другой объект, то метод wr i teObj

сериализует также и тот объект.

Преобразование сериализованного байтового потока в объект называется

десериализациеЙ. Чтобы десериализовать байтовый поток, создается объект

Obj e c t I nputStream путем передачи объекта I nputStream его КОНСТРУКтору

примерно таким образом=:

FileInputStream fin new= FileInputStream("filename . ser") ; ObjectInputStream obIn new ObjectInputStream (fin) ;

Объект Obj ect I npu tStream будет считывать байты из входного потока, пере­ данного его конструктору.

Если создан объект Obj ect InputStream, можно десериализовать связанный

с ним байтовый поток, вызывая его метод readObj ect, например, так:

GameModel q = (GameМodel) obIn . readObject() ;

Метод readObj ect возвращает ссылку на Obj ect. Скорее всего, будет нужно, чтобы возвращаемый методом readObj ect объект был экземпляром какого-то конкретного класса, поэтому придется выполнить операцию приведения типов.

Еще один момент, который необходимо учитывать при сериализации объекта: экземпляр класса можно сериализовать только тогда, когда класс разрешает се­ риализацию. Класс допускает сериализацию своих экземпляров в том случае, если он реализует интерфейс j ava . io . Seri al izable:

import java . io . serializable;

class foo extends bar implements Serializable {

Интерфейс Seriali zable - это маркер-интерфейс. Он не объявляет никаких членовryт . Самый простой способ указать, что экземпляры некоторого класса мо­

быть сериализованы, состоит в том, чтобы объявить этот класс реализую­

щим интерфейс Serial i zable. Если передать объект, не реализующий интерто­

фейс Serial i z abl e, методу wri teObj ect объекта Obj ectOutputStream,

этот метод сгенерирует исключение.

До сих пор сериализация выглядела достаточно простой. Существует много си­

туаций, для которых вышеописанные детали - это все, что нужно знать, но

встречаются и более сложные случаи.

При сериализации объекта задаваемое по умолчанию поведение предполагает

также сериализацию всех объектов, на которые он ссьmается, и всех объектОВ,

на которые те ссылаются и т.д. до тех пор, пока не будет сериализован весь на­

бор. Несмотря на то что объект может быть экземпляром класса, реализуюшЯдеГО­

интерфейс Seriali zable, он может ссылаться на какие-либо объекты, не

ляюшиеся Ser ializ able , тогда любая попытка сериализовать объект обречена

Snapshot - 383

на неудачу. Ошибка возникает в том случае, когда метод wri teObj ect объекта Obj ectOutputStream рекурсивно вызывает сам себя с целью сериализации объекта, который не может быть сериализован, и генерирует исключение. Эта проблема решается следующим образом: можно задать механизм сериализации таким образом, чтобы он игнорировал некоторые экземплярные переменные объекта. Проще всего в этом случае объявить переменную с модификатором transient, например, так:

transient ObjectOutputStream obOut ;

Механизм сериализации игнорирует переменные с модификатором trans ient,

поэтому сериализация проходит успешно, даже если такая переменная ссьиш­

ется на объект, который не может быть сериализован.

Существует также другая проблема, которая может быть решена посредством объявления некоторых переменных экземпляра как transient. Экземпляры ряда классов ссылаются на какие-то объекты, ССbUIaющиеся на многие другие объекты, которые не должны быть сохранены. Сериализация таких объектов просто приводила бы к увеличению затрат на сериализацию и десериализацию. Если значение переменной экземпляра не должно быть частью сериализуемого состояния объекта, то объявление этой переменной экземпляра как transient

позволяет избежать затрат, связанных с ненужной сериализацией и десериали­

зацией значений этой переменной.

Объявление экземплярных переменных как trans ient способствует решению некоторых проблем, связанных с сериализациеЙ. Но появляется проблема, свя­

занная с десериализациеЙ. Сериализованный байтовый поток не содержит зна­ чений для переменных с модификатором transi ent. Если не предпринять

объектный тип, их значением будет nul l . Сериализация игнорирует инициали­ зацию и конструкторы.

Класс Obj ectOutputStream предоставляет механизмы, позволяющие изме­

нять задаваемый по умолчанию способ, в соответствии с которым десериализа­

ция управляет переменными с модификатором transient. Можно создать код, который будет выполняться уже после того, как сериализация произвела

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

Фикатором trans ient переменных, которая не предоставляется при задавае­

Мой по умолчанию сериализации. Класс Obj ectOutputStream предусматрива­

ет механизмы, позволяющие добавлять дополнительную информацию к тем

данным, которые обеспечиваются задаваемыми по умолчанию действиями се­

Риализации. Если можно будет добавлять информацию в сериализованный

байтовый поток и она будет являться достаточной для восстановления значений

Ilеременных объекта с модификатором trans ient, то проблема будет решена.

Чтобы добавить информацию к тем данным, которые обычно предоставляются

Методом writeObj ect класса Obj ectOutputS tream, можно добавить в сериа-

384 • Глава 8. Поведенческие шаблоны проектирования

лизуемый класс метод, который будет вызываться методом wr i teObj eet. Если объект являетсяi экземпляром класса, определяющего соответствующим обра­

зом метод wr teObj eet, то вместо того, чтобы решать, как управлять экземп­

лярными переменными объекта внугри себя, объект Obj eetOutputStream вы­

зывает метод wr i teObj ее t этого объекта. Это позволяет классу определять,

как будут сериализованы его собственные экземnлярные переменные.

Чтобы взять на себя ответственность за сериализацию экземплярных перемен­

ных своих экземпляров, класс должен иметь метод следующего вида:

private void writeObject (ObjectOutputStream stream) throws IOException (

stream.defaultWriteObject () ;

} / / wri teObj ect (Ob j e ctOutputStream)

Метод должен быть закрытым, чтобы объект Obj eetOutputStream мог его распознать. Такие закрытые методы wr i teObj eet отвечают за запись только тех экземnлярных переменных, которые объявлены в своих собственных клас­ сах. Эти методы не отвечают за переменные, объявленные в суперклассах.

Почти все закрытые методы wr iteObj eet преЖде всего должны вызвать метод defaul tWri teObj eet объекта Obj eetOutputStream. При обращении к этому методу объект Obj eetOutputSt ream должен выполнять свои задаваемые по умолчанию действия сериализации для вызвавшего его класса. Затем закрытый метод writeObj eet вызывает другие методы объекта Obj eetOutputStream для записи дополнительной информации, необходимой для восстановления значений временных переменных. Класс Obj eetOutputStream является под­ классомдлякласса DataOutputStream, поэтому он наследует методы, предназна­

ченные записи строк и всех простых типов данных.

Чтобы иметь возможность использовать дополнительную информацию во время

десериализации, класс должен также определять метод readObj eet примерно так:

private void readObject (ObjectInputStream stream) throws IOException {

тоже должен быть закрытым, чтобы его можно было распознать. Он начинает

с вызова метода defaul tReadObj eet объекта Obj eetInputStream. При обра-

Snapshot 8 385

шении к этому методу объект Obj ectlnputStream должен выполнять свои зада­ ваемые по умолчанию действия десериализаuии для вызвавшего его класса. За­

тем закрытый метод readObj ect вызывает другие методы объекта Obj ectln­

С uелью прочтения некоторой дополнительной информаuии,

которая бьша предоставлена для восстановления значений переменных. Класс

ObjОН ectlnputStream является подклассом класса Dat a l nputStream, поэтому наследует методы, предназначенные для чтения строк и всех простых типов данных.

Приведем пример, демонстрирующий совместную работу этих закрытых методов:

puыlcc class TextFileReader implements Serializable private transient RandomAccessFile file ;

private Strinq browseFileName ;

private

void writeObject (ObjectOutputStream stream) throws IOException (

stream. defaultWriteObject () ;

stream. writeLonq (file . qetFilePointer () ) ;

1 1 writeObj ect ( Obj ectOutput S t ream)

private

void readObject (ObjectInputStream stream) throws IOException (

try (

stream. defaultReadObject () ;

file . seek (stream. readLonq () ) ;

1 1 readObj ect (Obj ect lnputSt ream)

1 1 c l ass TextFileReade r

Этот класс называется TextFileReader. Он имеет переменную экземпляра fi le, которая ссылается на объект RandomAcces sFi le. Класс RandomAc­

C:es s F i l e не реализует интерфейс Serial i z able. Чтобы экземпляры класса

'I'extFi leReader могли быть успешно сериализованы и десериализованы, для

388 • Глава 8. Поведенческие шаблоны проектирования

заКРblТblМ, другим классам запрещено использовать этот конструктор, что за­

ставляет их получать экземпляр класса GameMode 1 посредством Вblзова его Ме­

тода getGameModel.

Когда объект Obj ectl nputStream десериализует баЙТОВblЙ поток, он ИСПОль­

зует специальный механизм, который создает объеКТbl, не обращаясь к конст­ рукторам и не проверяя значения инициализироваННblХ перемеННblХ. Если

у него есть экземпляр класса, он присваивает экземплярным перемеННblМ объ­

екта значения, найденные им в сериализованном байтовом потоке.

После того как объект Obj ectl nputStream заканчивает десериализацию объ­

екта, он проверяет, содержит ли этот объект метод readResolve. Если объект

содержит этот метод, то объект Obj ectl nputStream вызывает метод readRe­ sol ve этого объекта и возвращает объект, возвращаемый методом readResolve

(а не вновь созданный объект).

Приведем также метод readResolve класса GameModel, который присваивает экземплярным переменным объекта GameModel програММbl значения, полу­ ченные от десериализованного объекта GameModel . Затем он возвращает объ­ ект GameMode 1 программы.

public Object readResolve=()

GameModel theModel getGameMOdel () ; theModel . mementoмanager = mementoмanager;

return theМodeli

/ / readResolve ( )

Остальная часть класса GameModel, связанная с шаблоном Snapshot, участвует

в управлении объектами Memento.

В реализации класса Mi 1estoneMemento следует отметить несколько важных

моментов. Зто закрытый класс класса GameModel. Он запрещаетлюбым другим классам, кроме класса GameMode1, получать прямой доступ к своим членам. Класс Mi les toneMemen to объявляется как статический. Зта незначитемНельная­

оптимизация позволяет сэкономить затраты на поддержание объектами stoneMemento ссьUIКИ на содержащий их объект GameModel.

Еще один аспект реализации класса MilestoneMemento состоит в малом коли­

честве методов доступа. Считается хорошим тоном позволять другим классам

обращаться к экземллярным переменным объекта только через метоДЬ! доступа

(чтения и записи). Такая практика позволяет получать оптимально инкапсули­

рованные объекты. Из-за тесной связи меЖдУ классом Mi l es tone ementO

и классом GameModel объекты GameMode 1 имеют прямой доступ к экземплЯР­

ным переменным объектов MilestoneMemento. Другие классы могутобращатьсЯ

к классу только через интерфейс ntoIF,

Miles toneMemento Mi les toneMeme 01

поэтому экземплярные переменные объекта Miles toneMemento скрыты

всех остальных классов.

private static class MilestoneМemento implements MilestoneMementoIF

private String descriptioni

/" "

"Constructor

"@pa ram des c ription

"Причина создания этого объе кта .

" /

MilestoneMemento (String= description) this . description descriptioni

/ / constructor ( S t ring)

/" "

"Возвращает причину создания этого объекта memento .

"/

public String getDescription () { return descriptioni }

/ / Значения этих переменных задаются объектом GameModel .

MilestoneМementoмanager mementoмanageri

/ / class Mi les toneMemento

Желательно иметь возможность сериализовать объекты MilestoneMemento. Несложно заметить, что класс Mi les toneMemento не реализует интерфейс Seri alizable. В этом нет необходимости, так как он реализует интерфейс MilestoneMementoIF, который является расширением интерфейса Ser i a l i z­

аЫе.

Теперь напишем методы, предоставляемые классом GameMode l для создания

объектов Memento и для восстановления состояния из объектов Memento: / " "

"Создадим объект Memento, который инкапсулирует

"состояние этого объекта .

"/

MilestoneМementoIF createMemento (String description)

/ / Создаем объект Memento и задаем значения

/ / его экземплярных переменных .

Milestone=Мemento memento i

memento new MilestoneМ=emento (description) i memento . mementoмanager mementoмanager i