Джош Блох

Глава 11 • Сериализация

только в рамках пакета, его действие будет распространяться только на подклассы внутри одного и того же пакета. Если он защищенный или открытый, то его действие будет распространяться на все подклассы, не переопределяющие его. Если метод readResolve защищен или явля­ ется открытым и подклассы его не переопределяют, то десериализация и сериализация экземпляра подкласса произведет экземпляр суперклас­ са, который, скорее всего, приведет к ошибке ClassCastException.

Подведем итоги. Вам нужно использовать перечислимые типы, чтобы установить контроль экземпляров над инвариантами, насколь­ ко это возможно. Если это невозможно и вам нужен класс, который был бы и сериализуемым, и с контролем экземпляров, то вам нужен метод read Resolve, чтобы убедиться, что все поля экземпляров клас­ са являются либо примитивными, либо переходными (transient).

Рассмотрите использование агентов сериализации вместо сериализованных экземпляров

Как уже говорилось в статье 74 и обсуждалось на протяжении всей главы, применение Serializable увеличивает вероятность ошибок и проблем с безопасностью, так как он приводит к созданию экземпля­ ров, использующих механизмы, за пределами языка вместо обычных конструкторов. Есть тем не менее прием, который существенно снижает подобный риск. Этот прием известен как шаблон агента сериализации.

Шаблон агента сериализации довольно прямолинеен. Во-пер­ вых, создайте закрытый статический вложенный класс сериализуе­ мого класса, который точно представляет собой логическое состояние экземпляра окружающего класса. Этот вложенный класс, известный как агент сериализации, должен иметь один конструктор, типом па­ раметров которого является окружающий класс. Этот конструктор просто копирует данные из его аргумента: ему не требуется провер­ ка целостности или резервное копирование. С точки зрения дизайна сериализованная форма агента сериализации по умолчанию является

430

С татья 78

совершенной сериализованной формой окружающего класса. И окру­ жающий класс, и его агент сериализации должны быть декларирова­ ны так, чтобы реализовывать Serializable.

Например, рассмотрим неизменяемый класс Period, написанный в статье 39 и сериализованный в статье 76. Вот агент сериализации для этого класса. Period настолько прост, что его агент сериализации содержит в точности те же самые поля, что и класс:

// Агент сериализации класса Period

private static class SerializationProxy implements Serializable { private final Date start;

private final Date end; SerializationProxy(Period p) {

this.start = p.start; this.end = p.end;

}

private static final long serialVersionlllD = 234098243823485285L; // Any number will do (Item 75)

}

Затем добавьте следующий метод writeReplace к окружающе­ му классу. Этот метод можно дословно скопировать в любой класс

сагентом сериализации:

//writeReplace method for the serialization proxy pattern private Object writeReplace() {

return new SerializationProxy(this);

}

Присутствие этого метода заставляет систему сериализации выдать экземпляр SerializzationProxy вместо экземпляра окру­ жающего класса. Другими словами, метод writeReplace переводит экземпляр окружающего класса в его агент сериализации до самой сериализации.

При использовании метода writeReplace система сериализации никогда не выдаст сериализованный экземпляр окружающего клас­ са, но его можно сфабриковать при попытке злонамеренно разрушить

431

Глава 11 • Сериализация

инварианты класса. Для того чтобы гарантировать, что такая атака не удастся, просто добавьте метод readObject к окружающему классу:

// Метод readObject для шаблона агента сериализации private void readObject(ObjectInputStream stream) throws InvalidObjectException {

throw new InvalidObjectException(“Proxy required”);

}

Наконец, предоставьте метод readResolve классу SerializationProxy, который возвратит логически эквивалентный экземпляр окру­ жающего класса. Присутствие этого метода приводит к тому, что система сериализации переводит агента сериализации обратно в эк­ земпляр окружающего класса при десериализации.

Этот метод readResolve создает экземпляр окружающего класса, используя только открытый API, и в этом и заключается вся красота шаблона. Он в большей степени избегает неязыковой сути сериали­ зации, потому что создается десериализованный экземпляр с исполь­ зованием тех же самых конструкторов, методов статической генера­ ции, как при создании любого другого экземпляра. Это освобождает вас от необходимости отдельно проверять, чтобы десериализованные экземпляры подчинялись инвариантам класса. Если методы стати­ ческой генерации класса или конструкторы устанавливают эти ин­ варианты и методы его экземпляра поддерживают их, то у вас есть гарантия, что сериализация будет также их поддерживать.

Вот пример метода readResolve для вышеупомянутого Period.

SerializationProxy

// Метод readResolve для Period.SerializationProxy private Object readResolve() {

return new Period(start, end); // Uses public constructor

}

Как и подход с использованием резервного копирования (ста­ тья 76), подход с использованием агента сериализации препятствует тяжелым бит-потоковым атакам (статья 76) и атакам кражи вну­

432

С татья 78

треннего поля (статья 76). В отличие от двух предыдущих подходов этот позволяет полю, принадлежащему к Period, быть завершенным, что требуется для того, чтобы класс Period был на самом деле не­ изменяемым (статья 15). И в отличие от двух предыдущих подхо­ дов он не требует длительного размышления. Вам не нужно думать о том, какие поля могут быть дискредитированы при атаках сериали­ зации, вам также не нужно явно выполнять проверку действительно­ сти в качестве части десериализации.

Рассмотрим случай с EnumSet (статья 32). У этого класса нет от­ крытого конструктора, только методы статической генерации. С точ­ ки зрения клиента, она возвращает экземпляры EnumSet, но на самом деле она возвращают один или два подкласса, в зависимости от раз­ мера основного перечислимого типа (статья 1). Если у основного пе­ речислимого типа 64 или менее элементов, то методы статической генерации выдают Regula гEnumSet; в противном случае они возвра­ щают JumboEnumSet. Теперь посмотрим, что происходит, если вы се­ риализуете набор перечислимых типов, в котором перечислимый тип содержит 60 элементов, затем добавите к нему еще пять элемен­ тов и десериализуете набор. При сериализации это был экземпляр RegularEnumSet, но лучше бы ему быть JumboEnumSet при десериали­ зации. На самом деле это точно то, что и происходит, потому что EnumSet использует шаблон агента сериализации. Если вам интерес­ но, вот как выглядит агент сериализации EnumSet. Он действительно настолько прост:

// Агент сериализации EnumSet

private static class SerializationProxy <E extends Enum<E>> implements Serializable {

//Тип элементов данного набора перечислимых типов private final Class<E> elementType;

//Элементы, содержащиеся в данном наборе перечислимых типов private final Enum[] elements;

SerializationProxy(EnumSet<E> set) { elementType = set.elementType;

elements = set.toArray(EMPTY_ENUM_ARRAY); // (Item 43)

433

Глава 11 • Сериализация

}

private Object readResolve() {

EnumSet<E> result = EnumSet.noneOf(elementType); for (Enum e : elements)

result.add((E)e); return result;

}

private static final long serialVersionUID = 362491234563181265L;

}

У шаблона агента сериализации есть два ограничения. Он несо­ вместим с классами, расширяемыми своими клиентами (статья 17). Он также несовместим с некоторыми классами, диаграммы объек­ тов которых содержат цикличности: если вы попытаетесь запустить метод на объекте в рамках метода readResolve агента сериализации, то получите ошибку ClassCastException, так как у вас еще нет объек­ та, а только его агент сериализации.

Наконец, дополнительные возможности и безопасность шаблона агента сериализации не свободны. Но моей машине на 14% более затратно сериализовывать и десериализовывать экземпляры Period с помощью агента сериализации, чем с помощью резервного копиро-

ВЭ.НИЯ.

Подведем итоги. Рассмотрите шаблон агента сериализации каж­ дый раз, когда вам приходится писать методы readObject или writeObject на классе, который нерасширяем для своих клиентов. Этот ша­ блон, возможно, является простейшим путем сериализации объектов с нетривиальными инвариантами.

434

Список литературы

436

Список литературы

[Javadoc-ref] Javadoc Reference Guide. Sun Microsystems. 2002—2006.

<http:/ /java.sun.com /javase / 6 / docs / technotes/tools / solaris/javadoc.html>

<http: / /java.su n .com /javase/6 / d ocs/tech n otes/tools/ windows/ javadoc.html>

437

Список литературы

<http: / / www.cs.umd.edu / ~pugh / java/m em ory Model / DoubleCheckedLocking.html>

438

Список литературы

439