getIterator()とArrayIteratorの目的がわかりません

Question

デザインパターンというものを知り、中でもIteratorパターンを学習し始めました。
IteratorAggregateインターフェースを活用した下記のコード内で、
getIterator()を使って、わざわざ$this->membersをArrayIteratorでラップして返す目的がわかりません。
IteratorAggregateはインターフェースのため、getIterator()をオーバーライドしないといけないということはわかっているのですが、なぜわざわざそんなことをするのかがわかりません。
foreachも$iterator as $memberではなく$members as $memberで表示上は同じになりますし・・・。
Iteratorパターンの本質をわかっていないのでしょうか。

<?php

class Member{
    private $id;
    private $lastname;
    private $firstname;
    private $email;
    private $password;
    
    public function __construct($id, $lastname, $firstname, $email, $password)
    {
        $this->setId($id);
        $this->setLastname($lastname);
        $this->setFirstname($firstname);
        $this->setEmail($email);
        $this->setPassword($password);
    }


    public function setId(int$id){
      $this->id = $id;
    }
    
    public function getId(){
        return $this->id;
    }
    
     public function setLastname($lastname){
      $this->lastname = $lastname;
    }
    
    public function getLastname(){
        return $this->lastname;
    }
    
     public function setFirstname($firstname){
      $this->firstname = $firstname;
    }
    
    public function getFirstname(){
        return $this->firstname;
    }
    
     public function setEmail($email){
      $this->email = $email;
    }
    
    public function getEmail(){
        return $this->email;
    }
    
     public function setPassword($password){
      $this->password = $password;
    }
    
    public function getPassword(){
        return $this->password;
    }

<?php

class Members implements IteratorAggregate{
    private $members = [];
    
    public function add(Member $member)
    {
        $this->members[] = $member;
    }
    
    public function getIterator()
    {
        return new ArrayIterator($this->members);
    }
}

<?php

require_once 'memberclass.php';
require_once 'membersclass.php';

//ダミーの会員データを作成
$member1 = new Member(1, "姓1", "名1", "名1", "[e-mail]", "password1");
$member2 = new Member(2, "姓2", "名2", "名2", "[e-mail]", "password2");
$member3 = new Member(3, "姓3", "名3", "名3", "[e-mail]", "password3");
$member4 = new Member(4, "姓4", "名4", "名4", "[e-mail]", "password4");
$member5 = new Member(5, "姓5", "名5", "名5", "[e-mail]", "password5");

//Membersクラスに会員データを追加
$members = new Members();
$members->add($member1);
$members->add($member2);
$members->add($member3);
$members->add($member4);
$members->add($member5);

//getIteratorによりイテレーターを取得
$iterator = $members->getIterator();

//ループ処理
foreach ($iterator as $member){
    print $member->getId()." ";
    print $member->getLastname()." ";
    print $member->getFirstname()." ";
    print $member->getEmail()." ";
    print $member->getPassword()." ";
}

Comments

[papinianus]

「foreachも$iterator as $memberではなく$members as $memberで表示上は同じになりますし」のところは、どういう実装にするつもりなのでしょうか。membersクラスを作らないで単にmembersを配列に入れるってことですか？

[awa]

そうです、わかりにくくてすみません。

Answer 1

デザインパターンをやるくらいなので、オブジェクト指向に取り組もうとしているという前提で。(頭のすみに置いておいて欲しいのですが、OOPとかデザパタは教科書・研修レベルでやるとまわりくどいだけにしか思えません)

Iteratorパターンは、forでループできないものをforeachできるようにするためのものです。
PHPでは説明しにくいのですが、順序のない集合(SetとかHashSetとか)や、辞書(PHPだと連想配列)、サイズが変動する配列(ListとかArrayListとか)などを反復による繰り返しでループできるようにするためのものです。
PHPはSetはないですし、(他の言語でも最近は組み込みで)連想配列やList(配列が可変なので)がforeachできるので「何で必要なの」という感覚はやむを得ないと思います。

さて、そんな現状であらためて、Iteratorパターンで何が嬉しいかの話なんですが、まずは設計の観点として、実装を隠蔽すべきです。具体的なインスタンスを配列につっこむといった「何でも組み込みのデータ型だけでやろうとする」のはオブジェクト指向がやろうとしていることと思想レベルで対立しています。データのリストそのものをpublicに公開すべきではないし(アクセサやgetIteratorでアクセスさせるべき)、そもそも配列を外で組み立てて、配列でループするなんてことは、プログラム規模が大きくなってきたら破綻します。
設計ではない、実用上の意味として、列挙にロジックがあることがあるのではないでしょうか？今回は全てのメンバーを全部ただただ回していますが、例えばMemberに仮登録(メール認証待ち)とかのステータスがあるとしたら、getIteratorしたときに、あるときは仮登録の人は除外して欲しいし、あるときは除外しないで欲しい、みたいな判断がくることがあっていいと思います。このとき、isActive()という関数はどこに実装するのが適切でしょうか。もし$membersの配列を使うとしたら、配列に入れるときに、判断するのでしょうか。あるいは、array_filterを書くのでしょうか。Memberクラスに関するフィルタリングをクラス外で実装しはじめると保守の点でつらいです(年齢で絞ったりなど要件が拡張するパターンも考えてみてください)。getIterator()にオプションをつけるなどして、Iterator側でやったほうがいいのではないでしょうか。

まとまりがない気もしますが、まとめますと、配列っぽいデータをそのまま返しているから配列でいいように思えるが、それはそういうサンプルを書いているからです。まわりくどいことが生きる局面はあるはずですが、それはそれなりに作っていかないと実感としては分かりません。無理矢理局面を考えると↑のようなことが考えられます。

Comments

[awa]

ご回答ありがとうございます。下記のように理解しました。
　・Iteratorパターンはオブジェクト指向の設計パターンでありカプセル化できるメリットがある。ここでいうカプセル化とは配列要素をとりだしていくためのインターフェイスをIteratorとして設けることであり、これがあることで条件を満たす要素を取り出す等の場合には、呼び出し元であるクラス外ではなくIterator側に処理を記述することができる。大規模なプログラムであるほど機能変更の際にどれだけ保守性が高いかが効いてくる。

もし誤解あればご指導ください。
大規模なプログラムを書いたことがないので正直まだオブジェクト指向のメリットを実感できてはいませんが、理解できるようにまずは頑張ってみます。