【Effective Java中文版】第二版:第三章 对于所有对象都通用的方法[002] [20180110]

第10条：始终要覆盖toString

第11条：谨慎地覆盖clone

Cloneable接口的目的是作为对象的一个mixin接口(mixin interface)，见第18条， 表明这样的对象允许被克隆，遗憾的是，它并没有成功地达到这个目的。起主要的缺陷在于，它缺少一个克隆方法，Object的clone方法是受保护的。如果不借助于反射(reflection)（见第53条），就不能仅仅因为一个对象实现了Cloneable就可以调用clone方法。即使是通过反射调用也可能是失败，因为不能保证该对象一定具有可访问clone的方法。金冠存在这样那样的缺陷，这项设施仍然被广泛地使用，因此值得我们进一步了解。本条目将告诉你如何实现一个行为良好的clone方法，并讨论什么时候适合这样做，同时也简单地讨论了其它的可替换做法。

既然Cloneable中并没有包含任何方法，那么它到底是做什么用的呢？它决定了Object中受保护的clone方法实现的行为：如果一个类实现了Cloneable，Object的clone方法就返回该对象的逐域拷贝，否则就抛出CloneNotSuportedException异常，这是接口的一种极端非典型的用法，也不值得效仿。通常情况下，实现接口是为了表明类可以为它的客户做些什么。然后，对于Cloneable而言，它改变了超类中受保护方法的行为。

如果实现Cloneable接口是要对某个类起到作用，类和他的所有超类都必须遵守一个相当复杂的，不可实施的，并且基本没有文档说明的协议。由此得到一种语言之外的(extralinguistic)机制：无需调用构造器就可以创建对象。

Clone方法的通用约定是非常弱的，下面是来自Object规范中的约定内容[JavaSE6]：

创建和返回该对象的一个拷贝，这个拷贝的精确含义取决于该对象的类。一般的含义是，对于任何对象x， 表达式

x.clone() != x

将会是true, 并且,表达式

x.clone().getClass() == x.getClass()

将会是true， 但这些都不是绝对的要求。虽然通常情况下，表达式

x.clone().equals(x)

将会是true，但是这也也不是一个绝对的要求，拷贝对象往往会导致创建它的类的一个新实例，但是同时也会要求拷贝内部的数据结构，这个过程中没有调用构造器。

对于这个约定存在几个问题，“不调用构造器”的规定太强硬了，行为良好的clone方法可以调用构造器来创建对象，构造之后再复制内部数据。如果这个类是final的，clone甚至可能会返回一个由构造器创建的对象。

然而，x.clone().getClass()通常应该等同于x.getClass()的规定又太软弱了，在实践中，程序员会假设，如果他们扩展了一个类，并且从子类中调用了super.clone，返回的对象就将是该子类的实例。超类能够提供这种功能唯一的途径是，返回一个通过调用super.clone()而得到的对象。如果clone方法返回一个由构造器创建的对象，它就得到一个错误的类。因此如果你覆盖了非final中的clone方法，则应该返回一个通过调用super.clone而得到的对象。如果类的所有超类都遵守这条规则，那么调用super.clone最终会调用

Object的clone方法，从而创建出正确的实例。这种机制大体上类似于自动的构造器调用链，只不过它不是强制要求的。

假设你希望在一个类中实现Cloneable，并且它的超类都提供了良好的clone方法。你从super.clone()中得到的对象可能会接近于最终要返回的对象，也可能相差甚远，这要取决于这个类的本质。从每个超类的角度来看，这个对象僵尸原始对象功能完整克隆。在这个类中声明的域将等同于被克隆对象中相应的域，如果每个域包含一个基本类型的值，或者包含一个指向不明对象的引用，那么被返回的对象则可能正是你所需要的对象，在这种情况下不需要再做进一步处理。例如第9条中的PhoneNumber类正是如此。在这种情况下，你所需要做的，除了声明实现了Cloneable之外，就是对Object中受保护的clone方法提供共有的访问途径。

@Override
protected Object clone()  {
try {
return (PhoneNumber) super.clone();
} catch (CloneNotSupportedException e) {
throw new AssertionError();// Can't happen
}

}

主要上述的clone方法返回的是PhoneNumber而不是Object，从Java1.5发行版开始，这么做是合法的，也是我们期待的，因为1.5发行版引入了协变返回类型(convariant return type)作为泛型，换句话说，目前覆盖方法的返回类型可以是被覆盖方法的返回类型的子类了。这样有助于覆盖方法提供更多关于被返回对象的信息，并且在客户端中不必进行转换。由于Object.clone返回Object, PhoneNumber.clone必须在返回super.clone()的结果之前将它转换。这个体现了一个通则：永远不要客户去做任何类库能够替客户完成的事情。
如果对象中的域引用了可变的对象，使用上述这种简单的clone实现可能会导致灾难性的后果，例如,考虑第6条中的Stack类：

/**
* @author lee
*
*/
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);

}

}

假设你希望吧这个类做成可克隆的，如果它的clone方法仅仅返回super.clone()，这样得到的stack实例，在其size域中具有正确的值，但是它的elements域将引用与原始stack相同的数组，修改原始的实例将会破坏被克隆对象中的约束条件，反之亦然。很快你就会发现，这个程序将产生毫无意义的结果，或者抛出空指针异常。
如果调用构造器，这种情况就不会发生，实际上，clone方法就是另一个构造器，你必须确保它不会伤害到原始的对象，并确保正确地创建被克隆对象中的约束条件(invariant)。为了是Stack类中的clone()正常地工作，它必须要拷贝栈的内部信息。最容易的做法是，在elements数组中递归滴调用clone：

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

注意，我们不一定要将elements.clone的结果集转换为Object[]，自Java1.5发行版起，在数组上调用clone返回的数值，其编译时类型与被克隆数组的类型相同。
还要注意，如果elements域是final的，那么上述方案就是不能正常工作的，因为clone方法是被禁止给elements赋值的，这是个根本的问题：clone架构与引用可变对象的final域的正常用法是不相兼容的，除非在原始对象和克隆对象之间可以安全地共享此可变对象。为了使类成为可克隆的，可能有必要从某些域中去掉final修饰符。

递归调用clone有时候可能还不够，比如，假设你正在为一个散列表编写clone方法，它的内部数据包含一个散列桶数组，每个散列桶都指向“键-值”对链表的第一项，如果桶是空的，则为null，出于性能方面的考虑，该类实现了它自己的轻量级单项链表，而没有使用java内部的LinkedList。该类如下:

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;
}
}
@Override
public  HashTable clone() {

try {
HashTable result = (HashTable)super.clone();
result.buckets = buckets.clone();
return result;
} catch (CloneNotSupportedException e) {

throw new AssertionError();
}
}

}

假设仅仅是递归地克隆这个散列桶数组，就像上面一样，虽然被克隆之间有它自己的散列桶，但是这个数组引用的链表与原始对象是一样的，从而很容易引起克隆之间的和原始对象中不确定的行为。为了修正这个问题，必须单独地拷贝并组成每个桶的链表。下面是一种常见的做法：

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.Entry被加强了，它支持一个深度拷贝方法，HashTable上的clone方法分配了一个大小适中的，新的buckets数组，并且遍历原始的buckets数组，对每一个非空散列桶进行了深度拷贝，Entry类中的深度拷贝方法递归到它自身，一边拷贝整个链表。虽然这种方法很灵活，如果散列桶不是很长的话，也会工作得很好，但是这样克隆一个链表并不是一个好办法，因为针对每一个元素，它都要消耗一段栈空间，如果链表比较长，这很容易导致栈溢出。为了避免发生这种情况，你可以在deepCopy中迭代(iteration)来代替递归(recursion)

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;
}

克隆复杂对象的最后一种办法是,先调用super.clone，然后把结果对象中的所有域都设置成它们的空白状态(virgin state)，然后调用高层(higher-level)的方法重新产生对象的状态。在我们的HashTable的例子中，buckets域将被初始化一个新的散列桶数组，然后，对于正在被克隆的散列表中的每一个键-值映射，都调用put(K, V)方法。这种做法往往会产生一个简单，合理且相当优美的clone方法，但是它运行起来通常没有“直接操作对象及其克隆对象的内部状态的clone方法”快。

如果构造器一样，clone方法不应该在构造的过程中，调用新对象中任何非final的方法。如果clone调用了一个被覆盖的方法，那么在该方法所在的子类有机会修正它在克隆对象中的状态之前，该方法就会先被执行，这样很有可能会导致克隆之间和原始对象之间的不一致。

简而言之，所有实现了Cloneable接口的类都应该用一个公有的方法覆盖clone,此公有方法首先调用super.clone，然后修正任何需要修正的域，一般情况下，这意味着要拷贝任何包含内部“深层结构”的可变对象，并用指向新对象的引用代替原来指向这些对象的引用。虽然这些内部拷贝操作往往可以通过递归地调用clone来完成，但这通常并不是最佳方法。如果该类只包含基本类型的域，譬如，代表序列号或其它唯一ID值得域，或者代表对象的创建时间的域，不管这些域是基本的还是不可变的，它们也都需要被修正。

真的有必要这么复杂吗？很少有这种必要，如果你扩展一个实现了Cloneable接口的类，那么你除了实现一个行为良好的clone方法外，没有别的选择。否则最好提供某些其它的途径来代替对象拷贝，或者干脆不提供这样的功能。例如，对于不可变类，支持对象拷贝并没有太大的意义，因为被拷贝的对象与原始对象没有什么实质的不同。

另一个实现对象拷贝的好办法就是提供一个拷贝构造器(copy constructor)或者拷贝工厂(copy factory)。拷贝构造器只是一个构造器，它唯一的参数类型是包含该构造器的类，例如

public Yum(Yum yum)

拷贝工厂是类似于拷贝构造器的静态工厂

public static Yum newInstance(Yum yum)

拷贝构造器的做法，及其静态工厂方法的变形，都比Cloneable/clone方法具有更多的优势，他们不依赖于某一种很有风险的，语言之外的对象创建机制，他们不要求遵守尚未指定好文档的规范；不会与final域的正常使用发生冲突，；它们不会抛出不必要的受检异常(check exception)；他们不需要进行类型转换。虽然你不可能把拷贝构造器或者静态工厂放在接口中，但是由于Cloneable缺少一个公有的clone方法，所以它也没有提供一个接口该有的特性。因此，使用拷贝构造器或者拷贝工厂来代替clone方法时，并没有舍弃接口的功能特性。
更进一步说，拷贝构造器或者拷贝工厂可以带一个参数，参数类型是通过该类实现的接口，例如，按照惯例，所有通用集合都提供了一个拷贝构造器，它的参数类型为Collection或者Map，基于接口的拷贝构造器和拷贝工厂(更准确说叫’转换构造器conversion constructor‘)和转换工厂(conversion factory)），允许客户选择拷贝的实现类型，而不是强迫用户去接受原始的实现类型。例如，假设你有一个HashSet，并且希望把它拷贝成一个TreeSet，clone的方法无法提供这样的功能，但是用转换构造器很容易实现。

既然Cloneable有那么多的问题，可以肯定的说，其它的接口都不应该扩展这个接口，为了继承为设计的类也不应该实现这个接口。由于它具有这么多缺点，有些专家级的程序员干脆不去覆盖clone方法，也从来不去调用它，除非拷贝数组。你必须清楚一点，对于一个专门为继承而设计的类，如果你未能提供行为良好的受保护的clone方法，它的子类就不能实现Cloneable接口。