3.8. Дублирование объектов

Метод Object.сlone помогает производить в ваших классах дублирование объектов. При дублировании возвращается новый объект, исходное состояние которого копирует состояние объекта, для которого был вызван метод clone. Все последующие изменения, вносимые в объект-дубль, не изменяют состояния исходного объекта.

При написании метода clone следует учитывать три основных момента:

• Для нормальной работы метода clone необходимо реализовать интерфейс Cloneable. /В будущих реализациях название интерфейса может быть исправлено на Clonable/

• Метод Object.clone выполняет простое дублирование, заключающееся в копировании всех полей исходного объекта в новый объект. Для многих классов такой вариант работает, но, возможно, в вашем классе его придется дополнить за счет переопределения метода (см. ниже).

• Исключение CloneNotSupportedException сигнализирует о том, что метод clone данного класса не должен вызываться.

Существует четыре варианта отношения класса к методу clone:

• Класс поддерживает clone. Такие классы реализуют Cloneable, а в объявлении метода clone обычно не указывается никаких запускаемых исключений.

• Класс условно поддерживает clone. Такой класс может представлять собой коллекцию (набор объектов), которая в принципе может дублироваться, но лишь при условии, что дублируется все ее содержимое. Такие классы реализуют Cloneable, но при этом допускают возникновение в методе clone исключения CloneNotSupportedException, которое может быть получено от других объектов при попытке их дублирования во время дублирования коллекции. Кроме того, бывает желательно разрешить возможность дублирования класса, но при этом не требовать, чтобы дублирование также поддерживалось и для всех подклассов.

• Класс разрешает поддержку clone в подклассах, но не объявляет об этом открыто. Такие классы не реализуют Cloneable, но обеспечивают реализацию clone для правильного дублирования полей, если реализация по умолчанию оказывается неправильной.

• Класс запрещает clone. Такие классы не реализуют Cloneable, а метод clone в них всегда запускает исключение CloneNotSupportedException.

Object.clone сначала проверяет, поддерживается ли интерфейс Cloneable объектом, для которого вызван метод clone; если нет— запускается исключение CloneNotSupportedException. В противном случае создается новый объект, тип которого совпадает с типом исходного, и его поля инициализируются значениями полей исходного объекта. При завершении работы Object.clone возвращает ссылку на новый объект.

Самая простая возможность создать дублируемый класс— объявить о реализации в нем интерфейса Cloneable:

public class MyClass extends AnotherClass

implements Cloneable

{

// ...

}

Метод clone в интерфейсе Cloneable имеет атрибут public, следовательно, метод MyClass.clone, унаследованный от Object, также будет public. После такого объявления можно дублировать объекты MyClass. Дублирование в данном случае выполняется тривиально— Object.clone копирует все поля MyClass в новый объект и возвращает его.

В методе Cloneable.clone присутствует объявление throws CloneNotSupportedException, так что возможна ситуация, при которой класс является дублируемым, а его подкласс— нет. В подклассе будет реализован интерфейс Cloneable (так как он расширяет класс, в котором есть данный интерфейс), однако на самом деле объекты подкласса не могут дублироваться. Выход оказывается простым— расширенный класс переопределяет метод clone так, чтобы последний всегда запускал исключение CloneNotSupportedException, и об этом сообщается в документации. Соблюдайте осторожность— такой подход означает, что во время выполнения программы нельзя определить, допускается ли дублирование объектов класса, простой проверкой реализации интерфейса Cloneable. Некоторые классы, для которых дублирование запрещено, вынуждены сигнализировать об этом, запуская исключение.

Большинство классов является дублируемыми. Даже если вы не реализуете в своем классе интерфейс Cloneable, необходимо убедиться в правильности работы метода clone. Во многих случаях реализация, принятая по умолчанию, не подходит, поскольку при ее выполнении происходит нежелательное размножение ссылок на объекты. В таких случаях необходимо переопределить метод clone и исправить его поведение. По умолчанию значение каждого поля исходного объекта присваивается аналогичному полю нового объекта.

Если, например, в вашем объекте присутствует ссылка на массив, то в дубликате объекта также будет находиться ссылка на тот же самый массив. Если данные массива доступны только для чтения, то в подобном совместном использовании, скорее всего, нет ничего плохого. Однако нередко требуется, чтобы ссылки внутри исходного объекта и дубликата были разными,— вероятно, ситуация, при которой дубликат может изменить содержимое массива в исходном объекте или наоборот, окажется нежелательной.

Поясним суть проблемы на примере. Предположим, у нас имеется простой стек, содержащий целые числа:

public class IntegerStack implements Cloneable {

private int[] buffer;

private int top;

public IntegerStack(int maxContents) {;

buffer = new int[maxContents];

top = -1;

}

public void push(int val) {

buffer[++top] = val;

}

Теперь рассмотрим фрагмент программы, который создает объект Integer Stack, заносит в него данные и затем дублирует:

IntegerStack first = new IntegerStack(2);

first.push(2);

first.push(9);

IntegerStack second = (IntegerStack)first.clone();

При использовании метода clone, принятого по умолчанию, данные в памяти будут выглядеть следующим образом:

Теперь рассмотрим, что произойдет после вызова first.pop(), за которым следует first.push(17). Значение верхнего элемента стека first, как и ожидалось, изменяется с 9 на 17. Тем не менее, к удивлению программиста, верхний элемент стека second тоже становится равным 17, поскольку оба стека совместно используют один и тот же массив данных.

Выход заключается в переопределении метода clone и создании в нем отдельной копии массива:

public Object clone() {

try {

IntegerStack nObj = (IntegerStack)super.clone();

nObj.buffer = (int[])buffer.clone();

return nObj;

} catch (CloneNotSupportedExeption e) {

// Не может произойти - метод clone() поддерживается

// как нашим классом, так и массивами

throw new InternalError(e.toString());

}

}

Метод clone начинается с вызова super.clone, присутствие которого чрезвычайно важно, поскольку суперкласс может решать какие-то свои проблемы, связанные с совместно используемыми объектами. Если не вызвать метод суперкласса, то это решит одни проблемы, создав взамен другие. Кроме того, вызов super.clone приводит к обращению к методу Object.clone, создающему объект правильного типа. Построение объекта IntegerStack в IntegerStack.clone приведет к неправильной работе классов-расширений IntegerStack— при вызове super.clone в расширенном классе будет создаваться объект типа IntegerStack, а не нужного, расширенного типа.

Затем значение, возвращаемое super.clone, преобразуется в ссылку на IntegerStack. Механизм приведения типов описан в разделе “Приведение типов”; с его помощью ссылка на один тип (в нашем случае— тип Object, возвращаемый clone) превращается в ссылку на другой тип (IntegerStack). Преобразование оказывается успешным лишь в том случае, если объект может использоваться в качестве объекта типа, к которому преобразуется ссылка.

Object.clone инициализирует каждое поле объекта-дубликата, присваивая ему значение соответствующего поля исходного объекта. Вам остается только написать специализированный код для обработки тех полей, для которых копирование по значению не подходит. IntegerStack.clone не копирует поле top, поскольку в него уже занесено правильное значение во время стандартного копирования значений полей.

После появления специализированного метода clone содержимое памяти для нашего примера будет выглядеть так:

Иногда добиться правильной работы clone оказывается настолько сложно, что игра не стоит свеч, и некоторые классы отказываются от поддержки clone. В таких случаях ваш метод clone должен возбуждать исключение Clone NotSupportedException, чтобы его вызов никогда не приводил к созданию неправильных объектов.

Вы также можете потребовать, чтобы метод clone поддерживался во всех подклассах данного класса,— для этого следует переопределить метод clone так, чтобы в его сигнатуру не входило объявление о возбуждении исключения CloneNotSupportedException. В результате подклассы, в которых реализуется метод clone, не смогут возбуждать исключение CloneNotSupported Exception, поскольку методы подкласса не могут вводить новые исключения. Аналогично, если метод clone в вашем классе объявлен public, то во всех расширенных классах он также будет иметь атрибут public— вспомним о том, что метод подкласса не может быть менее доступным, чем соответствующий ему метод суперкласса.

Упражнение 3.8

Реализуйте интерфейс Cloneable в классах Vehicle и PassengerVehicle. Какой из четырех описанных выше вариантов отношения к дублированию должен быть реализован в каждом из этих классов? Сработает ли простое копирование, осуществляемое в Object.clone, при дублировании объектов этих классов?

Упражнение 3.9

Напишите класс Garage (гараж), объекты которого будут сохранять вмассиве некоторое число объектов Vehicle. Реализуйте интерфейс Cloneable и напишите для него соответствующий метод clone. Напишите метод Garage.main для его тестирования.

Упражнение 3.10

Реализуйте в классе LinkedList интерфейс Cloneable; метод clone должен возвращать новый список со значениями исходного списка (а не с их дубликатами). Другими словами, изменения в одном списке не должны затрагивать второго списка, однако изменения в объектах, ссылки на которые хранятся в списке, должны проявляться в обоих списках.