不変クラスの原則

オブジェクトの状態を変更するメソッドを提供しない。
- プライベートフィールドの値を設定するようなミューテーターメソッド
クラスを拡張できないようにする
- finalを付けてサブクラス化を防ぐ
全てのフィールドをfinalにする
全てのフィールドをprivateにする *
可変オブジェクトのフィールドの参照を、クライアントが取得できないようにする
- 防御的コピーを利用する

防御的コピー

以下のクラスはリストを持っていて、そのリストを返すメソッドを持っています。

public class Anime {
    
    private List<String> characters = new ArrayList<>();
    
    public Anime(String... args){
        for(String talent : args){
            this.characters.add(talent);
        }
    }

    public List<String> getCharacters(){
        return this.characters;
    }
}

テストします。これは取得したリストに追加すると取得元のリストにも追加されてしまうものです。

@Test
    public void test_01(){
        // とあるに出てくるキャラクターを保持しています。
        Anime toaru = new Anime("御坂美琴","白井黒子","食蜂操祈");
        // とあるのキャラクターリストを取得しました。
        List<String> characters = toaru.getCharacters();
        // 俺妹のキャラが入ってきたけど、新しい変数に割り当ててるから大丈夫？？
        characters.add("高坂桐乃");
        // とあるキャラのリストを、Animeとあるから再度取得（桐乃はいないよね？）
        List<String> toarucharacters = toaru.getCharacters();
        // failed
        assertEquals(false, toarucharacters.contains("高坂桐乃"));
    }

getCharactersメソッドを以下のようにするとテストは成功します。

public List<String> getCharacters(){
        return this.characters.stream().collect(Collectors.toList());
    }

今までのは参照を返していたので、新しいリストを返すようにすれば取得元のリストに影響が出ることはありません。

わかりやすくログを出すとこんな感じです

characters.forEach(s->{
    System.out.println(s);
});
System.out.println("-------------------");
toarucharacters.forEach(s->{
    System.out.println(s);
});
----------------------------------------------
御坂美琴
白井黒子
食蜂操祈
高坂桐乃
-------------------
御坂美琴
白井黒子
食蜂操祈

このように、攻撃される可能性がある可変オブジェクトは、防御的にコピーすることでオブジェクトの内部状態は安全になります。

不変クラス

Haskellでは変数aとbを足すと新しい変数cを返して、変数aも変数bも値が変化しません。このような関数型っぽく書くことでクラスを不変にします。

/**
 * ゲコ太石とは、とあるスマホゲームで利用する仮想通過のようなものです。
 * ゲコ太石を購入し消費することで、プレイヤーはガチャを回すことができます。
 */
public final class GekotaStone {

    private final int id;
    private final int amt;

    private GekotaStone(int id,int amt){
        this.id = id;
        this.amt = amt;
    }

    /**
     * 新しいゲコ太石を作成します。
     *
     * @param amt
     * @return
     */
    public static GekotaStone of(int amt){
        return new GekotaStone(1,amt);
    }

    public int get(){
        return this.amt;
    }

    /**
     * ゲコ太石を購入します。
     *
     * @param amt
     * @return
     */
    public GekotaStone buy(int amt){
        return new GekotaStone(this.id + 1,this.amt + amt);
    }

    /**
     * ゲコ太石を消費します。
     *
     * @param amt
     * @return
     */
    public GekotaStone pay(int amt) throws Exception {
        if(this.amt - amt < 0){
            throw new Exception("ゲコ太石が足りません");
        }
        return new GekotaStone(this.id + 1, this.amt - amt);
    }

    /**
     * ゲコ太石の現在の状態を返却します。
     *
     * @return
     */
    @Override
    public String toString() {
        return "GekotaStone{" +
                "id=" + id +
                ", amt=" + amt +
                '}';
    }

ゲコ太石クラスは追加しても消費しても、新しいインスタンスを返しますので、元のオブジェクトの状態が変わることがありません。

テストをしてみます。

@Test
    public void test_() throws Exception {

        GekotaStone myStone = GekotaStone.of(3000);
        GekotaStone myStone2 = myStone.buy(3000);
        GekotaStone myStone3 = myStone2.pay(1000);

        assertEquals(5000,myStone3.get());
        System.out.println(myStone.toString());
        System.out.println(myStone2.toString());
        System.out.println(myStone3.toString());
    }

ログを見るとオブジェクトが不変であることがわかります

GekotaStone{id=1, amt=3000}

GekotaStone{id=2, amt=6000}

GekotaStone{id=3, amt=5000}