[이펙티브 자바] Item13. clone 재정의는 주의해서 진행하라. (Clone규약)

 

item13. clone 재정의는 주의해서 진행하라. 

 

 

Clone() 이란? 

: Object 클래스의 clone() 메서드는 자신을 복제하여 새로운 인스턴스를 생성하는 일을 한다. 

단순히 인스턴스 변수의 값만 복사하기 때문에 참조타입의 인스턴스 변수가 있는 클래스는 완전한 인스턴스 복사가 이루어지지 않는다. 

 

Clone()을 사용하려면 복제할 클래스가 Cloneable 인터페이스를 구현해야 한다. 

Cloneable 인터페이스는 들어가보면 아무런 내용이 없는 빈 인터페이스인데 그냥 이 인터페이스는 해당 클래스가 복제 가능하다는 것을 알려준다고 할 수 있다. 

 

public class PhoneNumber implements Cloneable{

    private final short areaCode, prefix, lineNum;

    public PhoneNumber(int areaCode, int prefix, int lineNum)
    {
        this.areaCode = rangeCheck(areaCode, 999, "area code");
        this.prefix = rangeCheck(prefix, 999, "prefix");
        this.lineNum = rangeCheck(lineNum, 9999, "line num");
        System.out.println("constructor is called !");
    }

    // toString이 반환된 값에 포함된 정보를 얻을 수 있는 API를 제공하는 것이 좋다.
    public short getAreaCode()
    {
        return areaCode;
    }

    public short getPrefix()
    {
        return prefix;
    }

    public short getLineNum()
    {
        return lineNum;
    }

    private static short rangeCheck(int val, int max, String arg)
    {
        if (val < 0 || val > max) {
            throw new IllegalArgumentException(arg + ": " + val);
        }
        return (short) val;
    }

    // PhoneNumber를 리턴하도록 해서 클라이언트가 사용할 때 타입 캐스팅을 하지 않아도 된다.
    @Override
    public PhoneNumber clone() {
        try {
            return (PhoneNumber) super.clone();
        } catch (CloneNotSupportedException e) { // 일어날 수 없는 일이다.
            throw new AssertionError(); // 대신 에러를 던져줬음
        }
    }

    @Override
    public boolean equals(Object o)
    {
        if (this == o)
            return true;
        if (!(o instanceof PhoneNumber)) {
            return false;
        }

        PhoneNumber that = (PhoneNumber) o;
        return areaCode == that.areaCode && prefix == that.prefix && lineNum == that.lineNum;
    }

    @Override
    public int hashCode()
    {
        int result = Short.hashCode(areaCode);
        result = result + 31 * Short.hashCode(prefix);
        result =result +  31 * Short.hashCode(lineNum);

        return result;
    }

    @Override
    public String toString()
    {
        return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
    }

    public static PhoneNumber of(String phoneNumberString)
    {
        String[] split = phoneNumberString.split("-");
        PhoneNumber phoneNumber = new PhoneNumber(Integer.parseInt(split[0]), Integer.parseInt(split[1]), Integer.parseInt(split[2]));
        return phoneNumber;
    }

}

Clone을 재정의했는데 IDE의 도움으로 clone을 재정의하면 접근제어자가 public 이 아닌 protected 여서 다른클래스가 복제할 때 clone메서드를 호출할 수 없으므로 public으로 변경해준다. 

 

 

그리고 이를 실행해보면 

phoneNumber.clone()을 하면 PhoneNumber을 정상적으로 clone한 것을 확인할 수 있다. 

 

위의 PhoneNumber는 불변 클래스라서 Cloneable 인터페이스를 구현하고, clone() 메서드를 재정의하면 된다. 

(Cloneable 인터페이스를 구현하지 않으면 clone을 할 수 없다.) 

 

❗️ 그리고 여기서 주의할 점으로 반드시 super.clone() 을 사용해야 한다는 점이다. 

public class Item implements Cloneable {

    private String name;

    // 이렇게 구현하면 하위 클래스의 clone()이 깨질 수 있다.
    // 생성자를 호출해서 만들면 안된다!!!!
    @Override
    public Item clone() {
        Item item = new Item();
        item.name = this.name;
        return item;
    }
  }

public class SubItem extends Item implements Cloneable{

    private String name;

    @Override
    public SubItem clone() {
        return (SubItem) super.clone(); // Item -> SubItem으로 변환을 못하기 때문에 에러 발생함..!!
    }

    public static void main(String[] args) {
        SubItem subItem = new SubItem();
        SubItem clone = subItem.clone();

        System.out.println("(clone != null) = " + (clone != null));
        System.out.println("(clone.getClass() == subItem.getClass()) = " + (clone.getClass() == subItem.getClass()));
        System.out.println("clone.equals(subItem) = " + clone.equals(subItem));
    }
}

Item에서 Cloneable 인터페이스를 구현하고 clone()을 재정의할 때 , super.clone() 이 아닌 생성자를 호출하면 

Item을 상속받은 SubItem에서 clone할 때, Item을 subItem으로 변환할 수 없기 때문에 에러가 발생한다. 

Exception in thread "main" java.lang.ClassCastException: class chapter02.item13.clone_use_constructor.Item cannot be cast to class chapter02.item13.clone_use_constructor.SubItem (chapter02.item13.clone_use_constructor.Item and chapter02.item13.clone_use_constructor.SubItem are in unnamed module of loader 'app') at chapter02.item13.clone_use_constructor.SubItem.clone(SubItem.java:12) at chapter02.item13.clone_use_constructor.SubItem.main(SubItem.java:17)

 

// 제대로 구현한 clone
@Override
public Item clone()  {
    Item result = null;
    try {
        result = (Item) super.clone();
        return result;
    } catch (CloneNotSupportedException e) {
        throw new AssertionError();
    }
}

Item clone을 super.clone으로 바꿔서 다시 구현한 코드인데 이렇게 하면 에러가 발생하지 않는다. 

 

 

Clone 규약 

- x.clone() != x 는 반드시 true이다. 

- x.clone().getClass() == x.getClass() 는 반드시 true이다. 

- x.clone().equals(x) 는 ture가 아닐 수도 있다. 

 

-> clone 규약을 보면 살짝 애매모호하다.