JavaのcloneメソッドとCloneableインターフェースについて

#1. はじめに
大学のJava言語で学ぶデザインパターン入門の授業でPrototypeパターンについて学び、その中でcloneメソッド,Clonableインターフェースについて調べる機会があったのでまとめておこうと思います。
まずcloneメソッドとCloneableインターフェースについて説明し、その後にそれらを使った浅いコピーと深いコピーの例を示します。
初めてちゃんとした(?)記事を書くので何か不備があればご指摘いただければと思います。

## 目次
[1.はじめに](#1-はじめに)
[2.cloneメソッドとCloneableインターフェースの概要](#2cloneメソッドとcloneableインターフェースの概要)
[3.cloneメソッドとCloneableインターフェースの関係](#3cloneメソッドとcloneableインターフェースの関係)
[4.浅いコピーのサンプル](#4-浅いコピーのサンプル)
[5.深いコピーのサンプル](#5-深いコピーのサンプル)
[6.まとめ](#6-まとめ)
[7.参考文献](#7-参考文献)

#2.cloneメソッドとCloneableインターフェースの概要
<strong>インスタンスの複製をするにはcloneメソッドを使うことが必要</strong>になります。そしてcloneメソッドを使うには、その複製したいクラスがCloneableインターフェースを継承していることが必要です。このCloneableインターフェースを継承している」というのは、

- 複製したいクラスそのものがCloneableインターフェースを継承している
- 複製したいクラスのスーパークラスがCloneableインターフェースを継承している

の２パターンあって、どちらでもOKです。
また、Cloneableインターフェースを継承していないのにcloneメソッドを呼び出そうとするとCloneNotSupportedExceptionが投げられるので、try-catchで囲む必要があります。

#3.cloneメソッドとCloneableインターフェースの関係
先ほど「cloneメソッドを使うにはCloneableインターフェースを継承している必要がある」と書きましたが、そう聞くと「Cloneableインターフェースの中にcloneメソッドが定義されているのかな？」と思ってしまうかもしれません。
しかし！実際はそうではないのです!!
実は、**cloneメソッド自体はjava.lang.Objectクラスのなかで定義されている**もので、そのjava.lang.Objectクラスはすべてのクラスが勝手に継承しているクラスです。なので、すべてのクラスがcloneメソッドを持っていることになります。つまりCloneableインターフェースは1つもメソッドを持っておらず、「このクラスはcloneメソッドで複製できますよ」という目印でしかないのです。こういった目印の役割を持つインターフェースを**マーカーインターフェース**と言います。
また、JavaのAPIリファレンスを見るとcloneメソッドは
> protected Object clone() throws CloneNotSupportedException

というふうになっています。注目して欲しいのがprotectedです。アクセス修飾子がprotectedになっているので、「Aというインスタンスを複製したい！」となった時にmainメソッドのなかで 

```java:Main.java
A.clone();
```

というふうにcloneメソッドを呼び出そうとすると、コンパイル時に

```
clone()はObjectでprotectedアクセスされます
```

というエラーが発生します。
じゃあどうするかというと、**Cloneableを継承したAクラスの中にpublicのcreateCloneとか適当なメソッドを作り、その中でcloneメソッドを呼び出す**という方法をとります。

ここまでで必要最低限のことは書いたと思うので、cloneを使った実際のサンプルを見てみようと思います。
cloneメソッドは浅いコピーと深いコピーの2種類の複製の仕方があるので順番に紹介します。

#4. 浅いコピーのサンプル
Hero.java, Sword.java, Main.java を使った例を示そうと思います。
ここで複製したいのはHeroクラスです。

```java:Hero.java
import java.lang.Cloneable;

public class Hero implements Cloneable{
  String name;
  Sword sword;
  public Hero(String name, Sword sword){
    this.name = name;
    this.sword = sword;
  }

  public Hero createClone(){
    Hero h = null;
    try {
      h = (Hero)clone();
    } catch(Exception e) {
      e.printStackTrace();
    }
    return h;
  }

}
```

```java:Sword.java
public class Sword {
  String name;

  public Sword(String name){
    this.name = name;
  }

}
```

```java:Main.java
public class Main{
  public static void main(String[] args){

    Sword s = new Sword("炭治郎の日輪刀");
    Hero h1 = new Hero("炭治郎", s);
    Hero h2 = h1.createClone();
    Hero h3 = h1;

    System.out.println(h1 == h2); 
    System.out.println(h1 == h3); 

    h1.sword.name = "胡蝶しのぶの日輪刀";
    System.out.println(h1.sword.name);
    System.out.println(h2.sword.name);
    System.out.println(h1.sword == h2.sword);

  }
}
```

どのように出力されるかを見る前にコードを確認します。
複製したいHeroクラスはCloneableを実装しています。そしてprotectedのcloneメソッドをpublicのcreateメソッドの中で呼び出し、それをMainの中で呼び出す、という流れになっています。また、cloneの返り値はObject型なのでHero型にキャストしています。
では出力結果を見てみます。

```
false
true
胡蝶しのぶの日輪刀
胡蝶しのぶの日輪刀
true
```

 h1 == h2 で falseと出力されていることから、cloneメソッドで新しくインスタンスが複製されたことが確認できますね。一方、 h1 == h3 がtrueなのは h3にはHeroインスタンスそのものではなく参照が代入されているためです。cloneとの比較で書いておきました。
問題なのは次の３行の出力です。h1のswordの名前しか変えてないのにh2のswordの名前も変わってしまっています。これは、cloneは**浅いコピー**をしているからです。浅いコピーはフィールドの先にあるインスタンスをコピーするのではなく参照をコピーします。つまり**Heroインスタンスは複製できても、Swordインスタンスは複製できていない**のです。参照しかコピーできていないのでh1.swordもh2.swordも結局同じSwordを指していることになります。そのことはh1.sword == h2.sword が true と出力されていることからも確認できます。
Swordインスタンスも複製したい！となったら**深いコピー**をします。次の項でサンプルを紹介します。

#5. 深いコピーのサンプル
Swordインスタンスも複製されるようにHero.javaとSword.javaを書き直したものがこちらです。(Main.javaはそのまま)

```java:Hero.java
import java.lang.Cloneable;

public class Hero implements Cloneable{
  String name;
  Sword sword;
  public Hero(String name, Sword sword){
    this.name = name;
    this.sword = sword;
    System.out.println("Heroインスタンスを作りました");
  }

  public Hero clone(){
    Hero copy = new Hero(this.name, (Sword)this.sword.createClone());
    return copy;
  }

  public Hero createClone(){
    Hero h = null;
    try {
      h = (Hero)clone();
    } catch(Exception e) {
      e.printStackTrace();
    }
    return h;
  }

}
```

```java:Sword.java
public class Sword implements Cloneable{
  String name;

  public Sword(String name){
    this.name = name;
  }

  public Sword createClone(){
    Sword copy = null;
    try {
      copy = (Sword)this.clone();
    } catch(CloneNotSupportedException e) {
      e.printStackTrace();
    }
    return copy;
  }

}
```

変わったところは
- **SwordクラスがCloneableインターフェースを実装し、createCloneメソッドを持っている**
- **Heroクラスのなかでcloneメソッドをオーバーライドしている**
- **そのなかでSwordクラスのcreateCloneメソッドを呼んでいる**
の3つです。このように書き換えることでSwordインスタンスも複製できます。先ほどのMain.javaを実行してみると、

```
false
true
胡蝶しのぶの日輪刀  //h1のswordだけ名前が変わって
炭治郎の日輪刀  //h4のswordは変わらない！
false // !!
```
h1.sword == h2.sword がfalseになっていることからswordもしっかり複製されていることがわかります！!
やったー！:sparkles:

#6. まとめ
- cloneメソッドを使うためにはcloneableインターフェースを継承する必要がある
- cloneメソッドは自分のクラスの中からしか呼び出せないので他のクラスで複製を要請する場合はpubulicメソッドを定義してその中でcloneを呼び出す必要がある

#7. 参考文献
- [増補改訂版Java言語で学ぶデザインパターン入門](https://www.hyuki.com/dp/)
- https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Cloneable.html
- https://docs.oracle.com/javase/jp/8/docs/api/java/lang/Object.html#clone--