ITEM 13: 重写CLONE要谨慎

ITEM 13: OVERRIDE CLONE JUDICIOUSLY
  Cloneable 接口被设计为 mixin 接口，用于类声明它们允许克隆。不幸的是，Cloneable 接口没有达到这个目的。它的主要缺点是缺少克隆方法，而 Object 的 clone 方法是 protected的。如果不利用 reflection，就不能仅仅因为对象实现了Cloneable 就在对象上调用clone。甚至反射调用也可能失败，因为不能保证对象具有可访问的 clone 方法。尽管有这个缺陷和其他许多缺陷，但该工具的使用相当广泛，因此理解它是值得的。item 13 将告诉您如何实现行为良好的克隆方法，讨论什么时候适合这样做，并提供替代方法。那么，如果Cloneable不包含方法，它会做什么呢?它确定对象受保护的克隆实现的行为：如果类实现了Cloneable，对象的克隆方法将返回对象的一个字段到另一个字段的副本；否则它会抛出CloneNotSupportedException 异常。这是一种非常常用的接口使用方式，不需要模仿。通常，实现接口说明类可以为其客户端做什么。在本例中，它修改超类上受保护方法的行为。
  尽管规范没有说明，但是在实践中，实现 Cloneable 的类应该提供一个正常运行的public clone 方法。为了实现这一点，类及其所有超类必须遵循复杂的、不可强制执行的、文档很少的协议。产生的机制是脆弱的、危险的和超语言的：它创建对象而不调用构造函数。
  clone 方法的通用规范很脆弱，以下是从Object规范中复制的：
  创建并返回此对象的副本。“copy” 的确切含义可能取决于对象的类。一般来说，对于任何对象x，要符合 x.clone() != x 为true 且 x.clone().getClass() == x.getClass() 为 true，但这并不是绝对的。x.clone().equals(x) 可能为true，但这个要求不是绝对的。
  根据规范要求，此方法返回的对象应该通过调用 super.clone 来获得。如果一个类及其所有超类(Object 除外)都遵守这个约定，那么情况正是如此：x.clone().getClass() == x.getClass()。
  按照惯例，返回的对象应该独立于被克隆的对象。为了实现这种独立性，在返回之前可能需要修改 super 返回的对象的一个或多个字段。
  这种机制与构造函数链有点类似，只是没有强制执行：如果类的克隆方法返回一个实例，而这个实例不是通过调用 super 获得的，而是通过调用构造函数获得的，编译器是不会报错的。但如果一个子类调用 super.clone，且该 clone 方法生成的对象具有错误的类，这将阻止子类的clone 方法正常工作。如果重写 clone 的类是final的，则可以安全地忽略此规则，因为它并不会有子类。但是如果一个final类有一个不调用 super.clone 的 clone 方法，那么这个类没有理由实现Cloneable接口，因为它不依赖于 Object 的 clone 实现的行为。
  假设您想让一个类实现 Cloneable 接口，该类的超类提供了一个行为良好的 clone 方法。首先调用 super.clone， 得到的对象将是原对象的一个功能完整的副本。类中声明的任何字段的值都将与原始字段的值相同。如果每个字段都包含一个原始值或对不可变对象的引用，则返回的对象可能正是您所需要的，在这种情况下不需要进一步处理。例如，item 11 中的 PhoneNumber 类就是这种情况，但是请注意，不可变类永远不应该提供 clone 方法，因为它只会鼓励浪费的复制。注意，下面是PhoneNumber 的克隆方法：

// Clone method for class with no references to mutable state
@Override 
public PhoneNumber clone() {
  try {
    return (PhoneNumber) super.clone();
  } catch (CloneNotSupportedException e) { 
    throw new AssertionError(); // Can't happen
  } 
}

  为了使这个方法工作，必须修改PhoneNumber的类声明，以表明它实现了Cloneable。虽然Object 的 clone 方法返回Object ，但是这个 clone 方法返回PhoneNumber。这样做是合法的，也是可取的，因为Java支持协变返回类型。换句话说，重写方法的返回类型可以是被重写方法的返回类型的子类，这就不必在客户代码中进行强制转换类型。在返回之前，我们必须将 super.clone 的结果从 Object 转换为 PhoneNumber，转换一定会成功。
  对 super.clone 的调用包含在 try-catch 块中。这是因为 Object 声明了它的 clone 方法可能抛出 CloneNotSupportedException，这是一个检查时异常。因为PhoneNumber 实现了 Cloneable，所以我们知道对 super.clone 的调用将会成功。对这种样板代码的需求表明, CloneNotSupportedException 应该已经不会在检查时发生了。
  如果对象引用了可变类的实例，前面显示的简单 clone 实现可能是灾难性的。例如, 请考虑 item 7 中的堆栈类：

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; // Eliminate obsolete reference return result;
  }
  // Ensure space for at least one more element. 
  private void ensureCapacity() {
    if (elements.length == size)
      elements = Arrays.copyOf(elements, 2 * size + 1);
  } 
}

  假设您想使这个类可克隆。如果 clone 方法只返回 super.clone()，则生成的堆栈实例的 size 字段将具有正确的值，但其 elements 字段将引用与原始堆栈实例相同的数组。修改原实例将破坏clone的实例，反之亦然。您将很快发现，您的程序会产生无意义的结果，或者抛出 NullPointerException。
  这种情况永远不会因为调用堆栈类中的唯一构造函数而发生。实际上，如果用 clone 方法充当构造函数，您必须确保它不会对原始对象造成损害，并且正确地在 clone的实例中建立不变量。为了使类 Stack 的 clone 方法正常工作，它必须复制堆栈的内部。最简单的方法是递归调用克隆元素数组：

// Clone method for class with references to mutable state
@Override public Stack clone() {
  try {
    Stack result = (Stack) super.clone(); 
    result.elements = elements.clone(); 
    return result;
  } catch (CloneNotSupportedException e) { 
    throw new AssertionError();
  } 
}

  请注意, 我们不必将 elements.clone 的结果转换为 Object[]。在数组上调用克隆返回一个数组, 其运行时和编译时类型与正在克隆的数组的类型相同。这是复制数组的首选语法。事实上，数组是克隆设施唯一引人注目的用途。
  另请注意, 如果元素字段是 fianl 的, 则较早的解决方案将不起作用, 因为 clone 将被禁止为字段分配新值。这是一个基本问题：与序列化一样, 可克隆体系结构与引用可变对象的最终字段的正常使用不兼容，除非可变对象可能在对象及其克隆之间安全共享。为了使类可克隆, 可能需要从某些字段中删除 final 修饰符。
  仅仅递归调用克隆并不总是足够的。例如，假设您正在为一个哈希表编写一个 clone 方法，该哈希表的内部由一个 bucket 数组组成，每个 bucket 引用键值对链表中的第一个条目。为了提高性能，该类实现了自己的轻量级单链表，而不是使用java.util.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;
    } 
  }
  ... // Remainder omitted 
}

  假设您只是递归地克隆 bucke t数组，就像我们对 Stack 所做的那样：

// Broken clone method - results in shared mutable state!
@Override 
public HashTable clone() { 
  try {
    HashTable result = (HashTable) super.clone(); 
    result.buckets = buckets.clone();
    return result;
  } catch (CloneNotSupportedException e) { 
    throw new AssertionError();
  } 
}

  虽然克隆有自己的bucket数组，但是这个数组引用的链表与原始链表相同，这很容易导致克隆和原始链表中的不确定性行为。要解决这个问题，您必须复制包含每个bucket的链表。这里有一个常见的方法：

// Recursive clone method for class with complex mutable state
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;
    }
    // Recursively copy the linked list headed by this Entry
    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(); }
  }
  ... // Remainder omitted 
}

  私有类 HashTable.Entry 已经被升级，能够支持 “deep copy” 方法。HashTable 上的clone 方法分配一个大小合适的新 bucket 数组，并在原始 bucket 数组上迭代，深度复制每个非空 bucket。Entry 上的 deepCopy 方法递归地调用自身来复制整个链表。虽然这种技术很可爱，如果存储段不太长也可以很好地工作，但它不是克隆链表的好方法，因为它会为列表中的每个元素消耗一个堆栈帧。如果列表很长，这很容易导致堆栈溢出。为了防止这种情况发生，您可以用迭代替换 deepCopy 中的递归：

// Iteratively copy the linked list headed by this Entry
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()，将结果对象中的所有字段设置为它们的初始状态，然后调用高级方法来重新生成原始对象的状态。在哈希表的例子中，bucket字段将初始化为一个新的bucket数组，并且将为克隆的哈希表中的每个键-值映射调用 put(key, value) 方法(未显示)。这种方法通常是一个简单、相当优雅的克隆方法，它的运行速度不如直接操作克隆内部的方法快。虽然这种方法是干净的，但它与整个可克隆体系结构是对立的，因为它盲目地覆盖构成体系结构基础的逐个字段的对象副本。与构造函数一样，clone 方法绝不能在正在构造的克隆上调用可覆盖的方法(itme 19)。
  如果 clone 调用在子类中被重写的方法，则该方法将在子类有机会修复其在克隆中的状态之前执行，这很可能导致克隆和原类中的损坏。因此，上一段中讨论的 put(key, value) 方法应该是 final 或 private 的。(如果它是私有的，那么它可能是一个非final公共方法的“helper方法”。)
  Object 的克隆方法声明抛出 CloneNotSupportedException，但不需要覆盖方法。Public clone 方法应该省略 throw子句，因为不抛出已检查异常的方法更容易使用（item 71)。
  在为继承设计类时，您有两种选择(item 19)，但是无论您选择哪一种，该类都不应该实现 Cloneable。您可以选择通过实现一个功能正常的 protected clone 方法来模拟 Object 的行为，该方法声明为抛出CloneNotSupportedException。这给子类是否实现 Cloneable 的自由，就像它们直接扩展 Object 一样。或者，您可以选择不实现工作 clone 方法，并通过提供以下退化 clone 实现来防止子类实现工作克隆方法：

// clone method for extendable class not supporting Cloneable
@Override
protected final Object clone() throws CloneNotSupportedException {
  throw new CloneNotSupportedException(); 
}

  还有一个细节值得注意。如果您编写一个实现 Cloneable 的线程安全类，请记住，它的 clone 方法必须正确地同步，就像任何其他方法一样(item 78)。Object 的 clone 方法不是同步的，因此，即使它的实现在其他方面令人满意，也需要编写一个返回super.clone() 的同步 clone 方法。
  概括一下，所有实现 Cloneable 的类都应该使用一个返回类型为类本身的公共方法覆盖clone。这个方法应该首先调用super.clone()，然后修复需要修复的任何字段。通常，这意味着复制任何包含对象内部“深层结构”的可变对象，把对这些对象的引用替换成对这些对象的克隆的引用。虽然通常可以通过递归调用 clone 来生成这些内部副本，但这并不总是最佳方法。如果类只包含基本字段或对不可变对象的引用，那么很可能不需要固定字段。
  这条规则也有例外。例如，表示序列号或其他惟一ID的字段需要被固定，即使它是原始的或不可变的。
  所有这些复杂性真的有必要吗？很少。如果您扩展了一个已经实现 Cloneable 的类，那么您别无选择，只能实现一个行为良好的 clone 方法。否则，通常最好提供对象复制的替代方法。更好的对象复制方法是提供复制构造函数或复制工厂。复制构造函数只是一个构造函数，它接受一个参数，该参数的类型是包含构造函数的类，例如：

// Copy constructor
public Yum(Yum yum) { ... };

  复制工厂是复制构造函数的静态工厂(item 1)模拟:

// Copy factory
public static Yum newInstance(Yum yum) { ... };

  与 Cloneable/clone 相比，copy 构造函数方法及其静态工厂变体具有许多优势：它们不依赖于容易产生风险的语法之外的对象创建机制；它们不要求无法强制遵守几乎没有文档记录的约定；它们与正确使用 final 字段没有冲突；它们不会抛出不必要的检查异常；而且它们不需要强制类型转换。
  此外，复制构造函数或工厂可以接受一个参数，该参数的类型是类实现的接口。例如，按照惯例，所有通用集合实现都提供一个构造函数，其参数类型为 collection 或Map。基于接口的复制构造函数和工厂(更确切地说是转换构造函数和转换工厂)允许客户端选择复制的实现类型，而不是强迫客户端接受原始的实现类型。例如，假设您有一个HashSet s，并且希望将其复制为 TreeSet，clone 方法不能提供此功能，但是使用转换构造函数很容易：new TreeSet<>(s)。
  考虑到与Cloneable相关的所有问题，新的接口不应该扩展它，新的可扩展类也不应该实现它。虽然最终类实现 Cloneable 的危害较小，但这应该被看作是一种性能优化，只有在极少数情况下才需要这样做(item 67)。通常，复制功能最好由构造函数或工厂提供。这个规则的一个显著例外是数组，最好使用 clone 方法复制数组。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,530评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 86,403评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,120评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,770评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,758评论 5赞 367
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,649评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,021评论 3赞 398
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,675评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,931评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,410评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,004评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2赞 350
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2赞 343