Clone 메서드

원본 객체의 필드값과 동일한 값을 가지는 새로운 객체를 생성해 주는 메서드

Shallow 복사 방법을 사용하며, 만약 객체가 참조타입의 멤버를 가지고 있다면 참조값만 복사하는 특징이 있다.

아래 코드에서 s1과 s2는 같은 name 필드를 가지게 되지만, s1 == s2는 false 이다.

class Student implements Cloneable{
    String name;
    Student(String name){
        this.name = name;
    }
    protected Object clone() throws CloneNotSupportedException{
        return super.clone();
    }
}

class Main {
    public static void main(String[] args) {
        Student s1 = new Student("홍길동");
        try {
            Student s2 = (Student)s1.clone();
            System.out.println(s1.name);
            System.out.println(s2.name);
						System.out.println(s1 == s2);
        } catch (CloneNotSupportedException e) {
            e.printStackTrace();
        }
    }
}

---

Cloneable의 역할

Cloneable은 복제해도 되는 클래스임을 명시하는 용도로 쓰인다. Cloneable 인터페이스 내에는 clone 메서드가 없다. clone 메서드가 선언된 곳은 Object이며 protected이기에, Coneable을 구현하는 것만으로는 외부 객체에서 clone 메서드를 호출할 수 없다.

메서드 하나 없는 Cloneable 인터페이스는 Object의 protected 메서드인 clone의 동작 방식을 결정한다.

• Cloneable을 구현 → 객체의 필드들을 하나하나 복사한 객체 반환
• Cloneable을 미구현 → CloneNotSupportedException을 던짐

Cloneable 사용 시 주의할 점

1. 가변 객체 참조 CASE

public class Stack {
	private Object[] elements;
	private int size = 0;
	private static final int DEFAULT_INITIAL_CAPACITY = 16;

	public Stack() {
		this.elements = new Object[DEFAULT_INITIAL_CAPACITY];
	}

	public void push(Object e) {
		ensureCapacity();
		elements[size++] = e;
	}

	public Object pop() {
		if (size == 0)
			throw new EmptyStackException();
		Object result = elements[--size];
		elements[size] = null;
		return result;
	}

	// 원소를 위한 공간을 적어도 하나 이상 확보한다.
	private void ensureCapacity() {
		if (elements.length == size)
		elements = Arrays.copyOf(elements, 2 * size + 1);
	}
}

위 클래스를 복제 가능하게 만든다면, array 타입의 elements 필드는 원본과 같은 배열을 참조하게 된다. 즉, 배열을 복사할 때 단순히 clone()만 구현한다면 잘못된 결과를 만든다.

이러면 불변식을 해치게 되고 프로그램이 이상하게 작동할 수 있다.

따라서 clone 메서드는 본 객체에 아무런 해를 끼치지 않는 동시에 복제된 객체의 불변식을 보장해야 한다.

올바른 배열 복사

따라서 array type을 필드로 갖는 class는 배열을 아래와 같은 방법으로 각각 clone해야 한다.

@Override public Stack clone() {
	try {
		Stack result = (Stack) super.clone();
		result.elements = elements.clone();
		return result;
	} catch (CloneNotSupportedException e) {
		throw new AssertionError();
	}
}

2. Stack Overflow CASE

public class HashTable implements Cloneable {
	private Entry[] buckets = ...;

	private static class Entry {
		final Object key;
		Object value;
		Entry next;

		Entry(Object key, Object value, Entry next) {
			this.key = key;
			this.value = value;
			this.next = next;
		}
	
		// 이 엔트리가 가리키는 연결 리스트를 재귀적으로 복사
		Entry deepCopy() {
			return new Entry(key, value,
				next == null ? null : next.deepCopy());
		}
	}
	
	@Override public HashTable clone() {
		try {
			HashTable result = (HashTable) super.clone();
			result.buckets = new Entry[buckets.length];
			for (int i = 0; i < buckets.length; i++) {
				if (buckets[i] != null)
					result.buckets[i] = buckets[i].deepCopy();
			return result;
		} catch (CloneNotSupportedException e) {
			throw new AssertionError();
		}
	}
	... // 나머지 코드는 생략
}

위 예제에서 HashTable 클래스는 buckets이라는 Entry 타입의 array를 필드로 가진다. Entry 타입은 next 필드를 통해 연결 리스트를 참조하고 있다.

위 코드에서 볼 수 있드시, HashTable clone 메서드는 deep copy를 지원한다. clone 메서드는 먼저 적절한 크기의 새로운 버킷 배열을 할당하고, 깊은 복사를 수행한다. 이 때 Entry의 deepCopy 메서드는 자신이 가리키는 연결 리스트 전체를 복사하기 위해 자신을 재귀적으로 호출한다. 하지만 연결 리스트를 복제하는 방법으로는 적절하지 않다. 재귀 호출 때문에 리스트의 원소 수만큼 스택 프레임을 소비하여, 리스트가 길면 스택 오버플로를 일으킬 위험이 있기 때문이다.

이를 해결하기 위한 방법은 deepCopy를 재귀 호출 대신 반복자를 쓰는 것이다. 아래 코드 참조.

Entry deepCopy() {
	Entry result = new Entry(key, value, next);
	for (Entry p = result; p.next != null; p = p.next)
		p.next = new Entry(p.next.key, p.next.value, p.next.next);
	return result;
}

---

Cloneable 사용법 정리

Cloneable을 구현하는 모든 클래스는 clone을 재정의해야 한다. 이때 접근 제한자는 public으로, 반환 타입은 클래스 자신으로 변경한다. 이 메서드는 가장 먼저 super.clone을 호출한 후 필요한 필드를 전부 적절히 수정한다. 일반적으로 이 말은 그 객체의 내부 '깊은 구조'에 숨어 있는 모든 가변 객체를 복사하고, 복제본이 가진 객체 참조 모두가 복사된 객체들을 가리키게 함을 뜻한다. 이러한 내부 복사는 주로 clone을 재귀적으로 호출해 구현하지만, 이 방식이 항상 최선인 것은 아니다. 기본 타입 필드와 불변 객체 참조만 갖는 클래스라면 아무 필드도 수정할 필요가 없다. 단, 일련번호나 고유 IDsms 비록 기본 타입이나 불변일지라도 수정해줘야 한다.

Cloneable 대안

복사 생성자와 복사 팩터리라는 더 나은 객체 복사 방식을 제공할 수 있다.

복사 생성자란 단순히 자신과 같은 클래스의 인스턴스를 인수로 받는 생성자를 말한다.

// 복사 생성자
public Yum(Yum yum) {...};

// 복사 팩터리
public static Yum newInstance(Yum yum) {...};

복사 생성자와 그 변형인 복사 팩터리는 Cloneable과 Clone 방식보다 나은 점이 많다.

언어 모순적이고 위험천만한 객체 생성 메커니즘(생성자를 쓰지 않는 방식)을 사용하지 않으며, 엉성하게 문서화된 규약에 기대지 않고, 정상적인 final 필드 용법과도 충돌하지 않으며, 불필요한 검사 예외를 던지지 않고, 형변환도 필요치 않다.

또한, 복사 생성자와 복사 펙터리는 해당 클래스가 구현한 '인터페이스' 타입의 인스턴스를 인수로 받을 수 있다. 이들을 이용하여 HashSet 객체 s를 TreeSet 타입으로 복제할 수 있다.