読者です 読者をやめる 読者になる 読者になる

白猫のメモ帳

JavaとかJavaScriptとかHTMLとか機械学習とか。

ダブルディスパッチってちょっとかっこよくない?

Java

こんばんは。

昼間は割と暖かいですが、
朝晩は寒いので服装選びに失敗します。わたしです。

オブジェクト指向プログラミングにおいて利用されるテクニックに、
ダブルディスパッチというものがあります。

名前がかっこいい!
フィギュアスケートの技にありそう。

・・・。
えーとこれ、GoFデザインパターンのうちのひとつ、Visitorパターンと一緒に語られる事が多いのですが、
なんだかややこしいのでちょっと整理してみます。

そもそもディスパッチって何?


シングルだとかダブルだとか言う前にディスパッチがよくわかりません。
いつものようにWikipediaさんに聞いてみたいのですが、「多重ディスパッチ」という項目しかありません。
仕方がないのでこれを見ます。

多重ディスパッチ(英: Multiple dispatch)またはマルチメソッド(英: Multimethods)は、多重定義された関数やメソッドからそこで呼び出されるべき1つの定義を選出し実行する(ディスパッチする)際に、2個以上の複数の引数が関与してどれかひとつを選ぶこと(特殊化)がおこなわれるものである。

多重定義を許すプログラミング言語では、同一の名前の(すなわち、多重定義された)関数やメソッドのうちのどれを呼出す(ディスパッチする)かを決定する、ということをしなければならない。

つまり、「ディスパッチ」は「1つの定義を選出し実行する」ってところが当てはまりそうですね。
そしてさらに読んでいくと、

Java のように単一ディスパッチしかしない言語では、コードは次のようになる(ただし、Visitor パターンをこれに活用することも可能)。

とあるように、どうやらJavaは単一ディスパッチらしいです。
ほうほう。ん?

オーバーロードと多重ディスパッチの違い


「多重定義された関数やメソッドからそこで呼び出されるべき1つの定義を選出し実行する」という文章から思うのは、
Javaにはオーバーロードがあるから多重ディスパッチできるんじゃないの?ということです。

結論から書くと、

オーバーロードは、メソッド引数の定義型を基に静的に(コンパイル時に)メソッドの呼び出しを決定する
・多重ディスパッチは、引数に実際に渡される型を基に動的に(実行時に)メソッドの呼び出しを決定する

という違いがあります。

interface Animal {}
class Cat implements Animal {}
class Dog implements Animal {}

void introduction(Cat cat) {
    System.out.println("ねこだよ");
}

void introduction(Dog dog) {
    System.out.println("いぬだよ");
}

例えば上のような定義をしたとき、
変数の型をインスタンスの型とちゃんと合わせるとオーバーロードメソッドで呼び出しをちゃんと決定できます。

Cat cat = new Cat();
Dog dog = new Dog();

introduction(cat); // ねこだよ
introduction(dog); // いぬだよ

一方で、変数の型をインタフェースにしてしまうと、
インスタンスの型としてはちゃんと一致していてもメソッドを呼び出すことはできません。
オーバーロードメソッドの選択時にインスタンスの型は参照されないためです。
多重ディスパッチが可能な言語では、この呼び出しは特に問題ありません。

Animal animal1 = new Cat();
Animal animal2 = new Dog();

//method(animal1); エラー
//method(animal2); エラー

単一ディスパッチの言語でもなんとかするために、
メソッド引数の型をAnimalにしてみましょう。

void introduction(Animal animal) {
    if (animal instanceof Cat) {
        System.out.println("ねこだよ");
    } else if (animal instanceof Dog) {
        System.out.println("いぬだよ");
    } else {
        System.out.println("?");
    }
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

introduction(animal1); // ねこだよ
introduction(animal2); // いぬだよ

おぉ、カッコ悪い!
オブジェクト指向の言語であれば普通はそれぞれのクラス側に処理を書く方が綺麗ですね。

interface Animal {
    void introduction();
}

class Cat implements Animal {
    @Override
    public void introduction() {
        System.out.println("ねこだよ");
    }
}

class Dog implements Animal {
    @Override
    public void introduction() {
        System.out.println("いぬだよ");
    }
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

animal1.introduction(); // ねこだよ
animal1.introduction(); // いぬだよ

なんかもう別に多重ディスパッチとかなくていいような気がしてきました。

プレゼントはわたし


さて、最初の定義を2引数に変えてみました。

interface Animal {}
class Cat implements Animal {}
class Dog implements Animal {}

interface Food {}
class CatFood implements Food {}
class DogFood implements Food {}

void feed(Cat cat, CatFood catFood) {
    System.out.println("うまいにゃ");
}

void feed(Cat cat, DogFood dogFood) {
    System.out.println("まぁまぁにゃ");
}

void feed(Dog dog, CatFood catFood) {
    System.out.println("まぁまぁわん");
}

void feed(Dog dog, DogFood dogFood) {
    System.out.println("うまいわん");
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

Food food1 = new CatFood();
Food food2 = new DogFood();

//feed(animal1, food1); エラー
//feed(animal1, food2); エラー
//feed(animal2, food1); エラー
//feed(animal2, food2); エラー

やっぱりインタフェースが使えなくて困るので、ダサいバージョンにしてみます。

void feed(Animal animal, Food food) {
    if (animal instanceof Cat && food instanceof CatFood) {
        System.out.println("うまいにゃ");
    } else if (animal instanceof Cat && food instanceof DogFood) {
        System.out.println("まぁまぁにゃ");
    } else if (animal instanceof Dog && food instanceof CatFood) {
        System.out.println("まぁまぁわん");
    } else if (animal instanceof Dog && food instanceof DogFood) {
        System.out.println("うまいわん");
    } else {
        System.out.println("?");
    }
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

Food food1 = new CatFood();
Food food2 = new DogFood();

animal1.eat(food1); // うまいにゃ
animal1.eat(food2); // まぁまぁにゃ
animal2.eat(food1); // まぁまぁわん
animal2.eat(food2); // うまいわん

読みづらいけど、とりあえず呼べるようになりました。
では、先程と同じようにクラス側に処理を移しましょう。

interface Animal {
    void eat(Food food);
}
class Cat implements Animal {
    @Override
    public void eat(Food food) {
        if (food instanceof CatFood) {
            System.out.println("うまいにゃ");
        } else if (food instanceof DogFood) {
            System.out.println("まぁまぁにゃ");
        } else {
            System.out.println("?");
        }
    }
}
class Dog implements Animal {
    @Override
    public void eat(Food food) {
        if (food instanceof CatFood) {
            System.out.println("まぁまぁわん");
        } else if (food instanceof DogFood) {
            System.out.println("うまいわん");
        } else {
            System.out.println("?");
        }
    }
}

困ったことにダサさが残っています。
仕方がないのでメソッドを分けましょう。

interface Animal {
    void eat(CatFood food);
    void eat(DogFood food);
}
class Cat implements Animal {
    @Override
    public void eat(CatFood food) {
        System.out.println("うまいにゃ");
    }
    @Override
    public void eat(DogFood food) {
        System.out.println("まぁまぁにゃ");
    }
}
class Dog implements Animal {
    @Override
    public void eat(CatFood food) {
        System.out.println("まぁまぁわん");
    }
    @Override
    public void eat(DogFood food) {
        System.out.println("うまいわん");
    }
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

Food food1 = new CatFood();
Food food2 = new DogFood();

//animal1.eat(food1); エラー
//animal1.eat(food2); エラー
//animal2.eat(food1); エラー
//animal2.eat(food2); エラー

また呼び出せなくなってしまいました。
そこで、さらにこんなことをしてみます。

interface Food {
    void eatenBy(Animal animal);
}
class CatFood implements Food {
    @Override
    public void eatenBy(Animal animal) {
        animal.eat(this);
    }
}
class DogFood implements Food {
    @Override
    public void eatenBy(Animal animal) {
        animal.eat(this);
    }
}

Animal animal1 = new Cat();
Animal animal2 = new Dog();

Food food1 = new CatFood();
Food food2 = new DogFood();

food1.eatenBy(animal1); // うまいにゃ
food2.eatenBy(animal1); // まぁまぁにゃ
food1.eatenBy(animal2); // まぁまぁわん
food2.eatenBy(animal2); // うまいわん

できた!(なんかひっくり返ったけど)

ポイントはFoodインタフェースの実装クラスで、
引数として渡されたオブジェクトに対して自分自身を引数として呼び出し返していることです。

このようにして1段階でメソッドの呼び出し(ディスパッチ)が確定できない場合に、
2つのオブジェクトを使って2段階に呼び出すことを「ダブルディスパッチ」といいます。

Visitorパターン


さてさて、やっとこさダブルディスパッチの正体がわかりましたが、
最初にも触れたように、これを利用したデザインパターンにVisitorパターンがあるので併せて確認しておきます。

Visitorパターンの目的は「アルゴリズムをオブジェクトの構造から分離する」ことにあります。

何らかのデータはAcceptor(受け入れ側)になります。

interface Acceptor {
    void accept(Visitor visitor);
}

class Cat implements Acceptor {
    @Override
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }
}

class Dog implements Acceptor {
    @Override
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }
}

class Fish implements Acceptor {
    @Override
    public void accept(Visitor visitor) {
        visitor.visit(this);
    }
}

データに対する処理はVisitor(訪問者側)になります。

interface Visitor {
    void visit(Cat cat);
    void visit(Dog dog);
    void visit(Fish fish);
}

class MofMofVisitor implements Visitor {

    @Override
    public void visit(Cat cat) {
        System.out.println("もふもふじゃー!あー、やめて!引っ掻かないで!");
    }

    @Override
    public void visit(Dog dog) {
        System.out.println("もふもふじゃー!もふもふもふー");
    }

    @Override
    public void visit(Fish fish) {
        System.out.println("もふもふじゃー!びしょびしょ・・・");
    }
}

処理がちゃんとデータ構造の外側にあるため、
新しいVisitorを作れば別の処理ができることがわかりますね。

List<Acceptor> list = new ArrayList<>();
list.add(new Cat());
list.add(new Dog());
list.add(new Dog());
list.add(new Fish());
list.add(new Cat());
list.add(new Fish());

Visitor visitor = new MofMofVisitor();

list.stream().forEach(acceptor -> acceptor.accept(visitor));

また、Visitorは状態を持つことができるので、
上の例であれば、猫、犬、魚がそれぞれ何匹づつかと最終的に集計することなどもできます。

Compositeパターンと組み合わせると、ディレクトリ構造を渡り歩きながら処理もできますね。

必殺技じゃなかった


わたしはたまにチェッカークラスで使ったりするくらいです。
チェックする対象がどんな構造になっていてもチェック処理を一か所にまとめられるし、
結果を貯めておけるのもポイントが高いです。

難しいものはかっこよく見えるものですが、
基本的にはプログラムに求められるのはシンプルさですから使いどころは難しいですよね。

何にしろ、引き出しが増えるのは良いものです。