Flyweight を Java で

Flyweight は、構造に関するデザインパターンの一つで、メモリー消費量を低く抑えることで、プログラムが膨大な数のオブジェクトを支えることができるようにします。

複数のオブジェクト間でオブジェクトの状態の一部を共有することにより、これを実現します。つまり、 Flyweight は、異なるオブジェクトによって使われる同じデータをキャッシュすることにより、 RAM を節約します。

Flyweight の詳細

複雑度：

人気度：

使用例： Flyweight の目的はただ一つです：メモリー摂取を最小にする。もしご自分のプログラムが RAM 不足で困っていない場合は、このパターンのことはしばらく忘れて大丈夫です。

Java のコア・ライブラリーでの Flyweight の例：

java.lang.Integer#valueOf(int) （Boolean、 Byte、 Character、 Short、 Long、 BigDecimal も同様）

見つけ方： Flyweight は、新規オブジェクトの代わりにキャッシュされたオブジェクトを返す生成メソッドの存在により識別できます。

森林の描画

この例では、 100 万本もの木からなる森林を描画します。木の一本一本は、個別のオブジェクトで表現され、何らかの状態（座標、質感など）を持ちます。プログラムはその本来の目的である仕事を行いますが、当然大量の RAM を消費します。

理由は単純です：あまりに多くの木オブジェクトが重複データ（名前、質感、色）をかかえている。これが、 Flyweight を適用可能な理由で、これらの値は別個のフライウェイト・オブジェクト（TreeType クラス）の内部に保存できます。こうすると、同じデータを何千もの Tree オブジェクト内に保存する代わりに、特定の値の組み合わせに対応するフライウェイト・オブジェクトへの参照を行えます。

フライウェイト・オブジェクトを再利用するための煩雑さはフライウェイト・ファクトリーの中に隠蔽されているため、クライアント・コードは何も違いに気づきません。

trees

trees/Tree.java: それぞれの木の固有状態を含む

package refactoring_guru.flyweight.example.trees;

import java.awt.*;

public class Tree {
    private int x;
    private int y;
    private TreeType type;

    public Tree(int x, int y, TreeType type) {
        this.x = x;
        this.y = y;
        this.type = type;
    }

    public void draw(Graphics g) {
        type.draw(g, x, y);
    }
}

trees/TreeType.java: いくつかの木が共有する状態を含む

package refactoring_guru.flyweight.example.trees;

import java.awt.*;

public class TreeType {
    private String name;
    private Color color;
    private String otherTreeData;

    public TreeType(String name, Color color, String otherTreeData) {
        this.name = name;
        this.color = color;
        this.otherTreeData = otherTreeData;
    }

    public void draw(Graphics g, int x, int y) {
        g.setColor(Color.BLACK);
        g.fillRect(x - 1, y, 3, 5);
        g.setColor(color);
        g.fillOval(x - 5, y - 10, 10, 10);
    }
}

trees/TreeFactory.java: フライウェイト作成の複雑さをカプセル化する

package refactoring_guru.flyweight.example.trees;

import java.awt.*;
import java.util.HashMap;
import java.util.Map;

public class TreeFactory {
    static Map<String, TreeType> treeTypes = new HashMap<>();

    public static TreeType getTreeType(String name, Color color, String otherTreeData) {
        TreeType result = treeTypes.get(name);
        if (result == null) {
            result = new TreeType(name, color, otherTreeData);
            treeTypes.put(name, result);
        }
        return result;
    }
}

forest

forest/Forest.java: 描画対象の森林

package refactoring_guru.flyweight.example.forest;

import refactoring_guru.flyweight.example.trees.Tree;
import refactoring_guru.flyweight.example.trees.TreeFactory;
import refactoring_guru.flyweight.example.trees.TreeType;

import javax.swing.*;
import java.awt.*;
import java.util.ArrayList;
import java.util.List;

public class Forest extends JFrame {
    private List<Tree> trees = new ArrayList<>();

    public void plantTree(int x, int y, String name, Color color, String otherTreeData) {
        TreeType type = TreeFactory.getTreeType(name, color, otherTreeData);
        Tree tree = new Tree(x, y, type);
        trees.add(tree);
    }

    @Override
    public void paint(Graphics graphics) {
        for (Tree tree : trees) {
            tree.draw(graphics);
        }
    }
}

Demo.java: クライアント・コード

package refactoring_guru.flyweight.example;

import refactoring_guru.flyweight.example.forest.Forest;

import java.awt.*;

public class Demo {
    static int CANVAS_SIZE = 500;
    static int TREES_TO_DRAW = 1000000;
    static int TREE_TYPES = 2;

    public static void main(String[] args) {
        Forest forest = new Forest();
        for (int i = 0; i < Math.floor(TREES_TO_DRAW / TREE_TYPES); i++) {
            forest.plantTree(random(0, CANVAS_SIZE), random(0, CANVAS_SIZE),
                    "Summer Oak", Color.GREEN, "Oak texture stub");
            forest.plantTree(random(0, CANVAS_SIZE), random(0, CANVAS_SIZE),
                    "Autumn Oak", Color.ORANGE, "Autumn Oak texture stub");
        }
        forest.setSize(CANVAS_SIZE, CANVAS_SIZE);
        forest.setVisible(true);

        System.out.println(TREES_TO_DRAW + " trees drawn");
        System.out.println("---------------------");
        System.out.println("Memory usage:");
        System.out.println("Tree size (8 bytes) * " + TREES_TO_DRAW);
        System.out.println("+ TreeTypes size (~30 bytes) * " + TREE_TYPES + "");
        System.out.println("---------------------");
        System.out.println("Total: " + ((TREES_TO_DRAW * 8 + TREE_TYPES * 30) / 1024 / 1024) +
                "MB (instead of " + ((TREES_TO_DRAW * 38) / 1024 / 1024) + "MB)");
    }

    private static int random(int min, int max) {
        return min + (int) (Math.random() * ((max - min) + 1));
    }
}

OutputDemo.png: スクリーン・ショット

OutputDemo.txt: RAM 使用状況

1000000 trees drawn
---------------------
Memory usage:
Tree size (8 bytes) * 1000000
+ TreeTypes size (~30 bytes) * 2
---------------------
Total: 7MB (instead of 36MB)