題名¶

Moose::Manual::Delegation - アトリビュートの委譲

委譲とはなにか¶

委譲というのは、アトリビュートの別のメソッドを呼ぶだけという「影のような」メソッドを作成できるようにする機能です。この非常に便利な機能を使うと、複雑な「has-a」の関係を単純化して、APIをひとつのクラスに統合してしまうことができるようになります。

また、委譲を使うと、クラスを使う側はそのクラスが持つすべてのオブジェクトを知る必要がなくなるので、覚えなければならないAPIの数も減ります。

委譲の定義は、「本当の」クラス（委譲元のクラス）が提供するひとつ以上のメソッドと、移譲先のクラスに用意するメソッドのマッピングという形で行います。移譲先のクラスでは、委譲元のクラスが提供するメソッド名を再利用することもできますし、独自の名前を用意することもできます。

また、委譲は、既存のクラス（特に、Mooseを使っていないクラスや、サブクラスしづらい（あるいはできない）クラス）をラップするときにも便利です。

マッピングを定義する¶

Mooseは委譲のマッピングを定義するために、簡単なものから複雑なものまで、さまざまなオプションを提供しています。

もっとも簡単なのは、単にメソッドのリストを指定する方法です。

  package Website;

  use Moose;

  has 'uri' => (
      is      => 'ro',
      isa     => 'URI',
      handles => [qw( host path )],
  );

こう定義しておくと、$website->hostを呼べば「とにかく動きます」（裏では、Mooseが$website->uri->hostを呼んでくれます）。

ハッシュリファレンスを使ってマッピングを定義することもできます。こうすると、マッピングの一部でメソッドをリネームできるようになります。

  package Website;

  use Moose;

  has 'uri' => (
      is      => 'ro',
      isa     => 'URI',
      handles => {
          hostname => 'host',
          path     => 'path',
      },
  );

この例ではURI.pmのhostというメソッド名を使うかわりに、$website->hostnameというメソッドを作成しています。

この2つがもっともよく使うマッピングです。残りの方法はもう少し複雑で、あまり一般的でもありません。

  has 'uri' => (
      is      => 'ro',
      isa     => 'URI',
      handles => qr/^(?:host|path|query.*)/,
  );

これは配列の場合と似ていますが、正規表現を使って委譲元が提供しているすべてのメソッドに対してマッチするか調べる点が異なります。これを正しく動作させるためには、アトリビュートのisaパラメータを指定しなければなりません、また、そのパラメータはクラスでなければなりません。Mooseはこのパラメータを利用して委譲元のクラスのイントロスペクションを行い、どんなメソッドを提供しているか判断します。

handlesの値にはロールの名前を使うこともできます。

  has 'uri' => (
      is      => 'ro',
      isa     => 'URI',
      handles => 'HasURI',
  );

Mooseはこのロールのイントロスペクションを行ってどんなメソッドを提供しているか判断し、そのそれぞれのメソッドについてマッピングを生成します。

最後に、マッピングを「生成」するサブルーチンリファレンスを指定することもできます。おそらくこのバージョンを使う必要は（あったとしても）めったにないでしょうが、実際にどう動作するのかについての詳細はMooseのドキュメントをご覧ください。

Perl構造体¶

handlesは一般的なPerl構造体に対しての処理をヘルパーメソッドに委譲することができます。もしMooseX::AttributeHelpersを使ったことあるなら仕組みは非常に似通っています。

  has 'queue' => (
      isa     => 'ArrayRef[Item]',
      traits  => ['Array'],
      default => sub { [ ] },
      handles => {
          add_item  => 'push',
          next_item => 'shift',
      },
  )

Array トレートをtraits 引数に指定することにより、MooseにArrayにまつわるヘルパーを使用したいということを伝えます。このようにすることにより、Mooseは add_item と next_item メソッドを生成してくれます。裏方ではadd_itemは以下のようなイメージの実装になっているます：

  sub add_item {
      my ($self, @items) = @_;

      for my $item (@items) {
          $Item_TC->validate($item);
      }

      push @{ $self->queue }, @items;
  }

Array 以外にも Hash、 Bool、 String、 Number、そして Counter用のトレートも用意されています。詳しくはMoose::Meta::Attribute::Nativeをご覧下さい。

カリー化¶

カリー化とはメソッドや関数を他のメソッドに対し事前に一部の引数を固定して定義してしまったものを刺します。Mooseはメソッド委譲を定義する時にカリー化を行う機能を備えています。

    package Spider;
    use Moose;

    has request => (
        is      => 'ro'
        isa     => 'HTTP::Request',
        handles => {
            set_user_agent => [ header => 'UserAgent' ],
        },
    )

このような定義を行うことにより$spider->set_user_agent('MyClient') を呼ぶと実際には$spider->request->header('UserAgent', 'MyClient')が呼ばれる事になります。

アトリビュートが見つからない場合¶

必須でなかったり未定義になりうるアトリビュートのメソッドを委譲すること自体はまったく問題ありませんが、委譲したメソッドが呼ばれたときにアトリビュートにオブジェクトが入っていなかった場合は実行時エラーが発生します。

作者¶

Dave Rolsky <[email protected]>

コピーライト & ライセンス¶

http://www.iinteractive.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.