Mojolicious::Plugin::SQLMaker – search.cpan.org

ソースはこちら。
fukata/Mojolicious-Plugin-SQLMaker

そんなsessionに関して、使う機会があったので少しでもまともな実装を探してみました。

Plack::Middleware？Mojolicious::Plugin？

PerlのWAFはMojolicious推しな件とそのノウハウ – ゆーすけべー日記

でも書かれている通り、デフォルトのsession管理は使えない。また、この中ではPlackのセッション機構を使っている。個人的に、環境依存ファイルは極力少なくしたかったので可能な限りMojolicious::Plugin::Configで利用している設定ファイルのみに留めておきたかった。

ただ、Mojoliciousで利用している設定ファイルと共通化したいというのも下記のMojolicious::Plugin::PlackMiddlewareというのを使えばもしかしたら解決できるのかもしれない。ただ、試していないのでなんとも言えないが。

Mojolicious::Plugin::PlackMiddleware – search.cpan.org

MojoX::Session

今回、初めてMojoliciousを使うということもあって標準的なものを使おうと色々探してみたところ、MojoX::Sessionというのを見つけました。

MojoX::Session – search.cpan.org

データストアとしてRedisを使っていたので当然MojoX::Session::Store::Redisを使うことにしました。実際に使ってみると・・・。

全然動かねぇ！！！

なんで動かないのか調べてみると、Redisのデータとして「Hash(x14123)」みたいな文字が入っていました。もしや・・・と思い、実装を見てみると、hashrefをそのまま格納してやがりました。RedisなんでせめてHash型として入れてくれていれば最低限動いていたんですが、全く動かない程度の実装になっていました。

MojoX::Session::Storeの方でbase64など暗号化した文字列を下位モジュールへ渡してくれると思いきや、MojoX::Sessionの実装方針がわかりませんが、同梱されているMojoX::Session::Store::dbiの実装を見てみるとMojoX::Session::Store::dbiの中でbase64化していました。

これは、MongoDBなどコレクションに格納する際にはデータを構造的に入れれるためへの配慮なんだろうと思い、Redisの方ではjson化したものを突っ込むようにしました。本家の方にPull Requestは送ったんですがまだ取り込まれる気配はありません。

現在までの実装はgithubへアップしています。

fukata/p5-MojoX-Session-Store-Redis

json化するのとRedisのキー自体にもexpireを適用するようにも対応しています。

インタフェース

無事、データストアにsessionを保存することができるようになったので、実際にコントローラ内部で使ってみたいと思います。MojoX::Sessionを使う場合、startupの中で下記のように定義します。

    $self->plugin(
        session => {
            stash_key => 'mojox-session',
            store     => MojoX::Session::Store::Redis->new(
                {
                    server  => '127.0.0.1:6379',
                    redis_prefix    => 'mojo-session',
                    redis_dbid      => 1,
                }
            ),
            expires_delta => 3600,
        }
    );

そうするとコントローラ内ではこんな感じになります。

my $session = $self->stash('mojox-session');
$session->load;
$session->create unless $session->sid;
#set 
$session->data(
    id => 5,
    name => 'hoge',
);
#get
my $name = $session->data('name');

Helper

sessionを取り出すのにstash関数を直に使うのもダサいし、リクエスト毎に自分でloadしたりするのもなんだかなぁと思ったので簡単なHelperを実装しました。

use strict;
use warnings;
use utf8;

package Hoge::Mojolicious::Plugin::SessionHelper;
use Mojo::Base 'Mojolicious::Plugin';

sub register {
    my ($self, $app, $conf) = @_; 
    $conf ||= {}; 
    $conf->{stash_key} ||= 'mojox-session';

    my $stash_key = $conf->{stash_key};

    $app->hook(
        before_dispatch => sub {
            my $self = shift;
            my $session = $self->stash( $stash_key );
            $session->load;
            $session->create unless $session->sid;

            $self->stash()
        }   
    );  

    $app->helper( sessions => sub { shift->stash($stash_key); } );
}

1;

これで、コントローラ内部ではこんな感じで書けるようになりました。

#set
$self->sessions->data(
    id => 5,
    name => 'hoge',
);
#get
my $name = $self->sessions->data('name');

リクエスト毎にloadなどもしないで良いし、セッション用のAPIも用意することで見た目もすっきりするようになりました。本当は$self->session->data(‘name’)みたいな感じで書けると良かったんですがsessionメソッドはMojolicious::Controllerに既に定義されているためできませんでした。

MojoX::Sessionも元々存在するMojolicious::Controller::sessionメソッドは利用していないので、フックしにくい構造になっているのかもしれない。せっかくデフォルトでAPIを定義しているのだからこれを上手く利用したいし、その方がわかりやすいだろう。

その辺の話はまた今度。今回はとりあえずこの実装でやってみる。

追記：2012.11.14
MojoX::Session::Store::Redisが動くようになりました！でMergeされて無事動くようになりました。

Mojolicious.pm内で下記のようなコードがあったので、この辺を上書きして上げれば変更できそう。

# Paths
my $home = $self->home;
push @{$self->renderer->paths}, $home->rel_dir('templates');
push @{$self->static->paths},   $home->rel_dir('public');

中規模程度のサイトになってくるとそれなりに処理を共通化させないと自分の頭ではどこに何があるか分からなくなるので、これらは必須です。

現在作成中のサービスでMojoliciousを初めて使っており、今回作成した構造がうまく機能しない可能性もあります。とりあえず、第1弾として実装してみました。また、今回ModelとLogicを分離するのにあたって、Mojoliciousプラグインも一緒に作ってみました。

ディレクトリ構造

lib以下のディレクトリ構造は下記のようになっています。CliとWebでModel, Logicを共通化したかったので、同じ階層に持ってきています。また、分離するのにMojoliciousプラグインとして実装したので、MyApp::Mojolicious::Pluginにプラグインとして置いています。全然大したプラグインではないのと、ほとんど重複しているので1つのプラグインとして実装できると思います。

lib/
├── MyApp
│   ├── Cli
│   │   └── Example.pm
│   ├── Cli.pm
│   ├── Logic
│   │   └── Example.pm
│   ├── Logic.pm
│   ├── Model
│   │   └── Example.pm
│   ├── Model.pm
│   ├── Mojolicious
│   │   └── Plugin
│   │       ├── Logic.pm
│   │       └── Model.pm
│   ├── Web
│   │   └── Controller
│   │       └── Root.pm
│   └── Web.pm
└── MyApp.pm

MyApp::Mojolicious::Plugin::Model

Logicの方はModelの部分がLogicに変わっただけです。今回アプリを実際に作ってみて共通化して問題なさげだったらModelとLogic用のプラグインを1つにまとめた方が良いかもしれません。

MyApp::Modelとその子クラス

ModelのベースとなるMyApp::Modelとその子クラスになります。まだ、Model共通で使うORMなどは定義していないんですが、ここに定義すればいいのかなと思っています。

プラグインの登録、呼び出し

Mojoliciousプラグインは通常Mojolicious::Pluginから検索するんですが、今回はプロジェクト内にアプリ固有のネームスペース配下にプラグインを設置したのでネームスペースを追加する必要があります。

実際にアプリ内から呼び出してみたところ。無名関数なのでアロー演算子があるが、出来ればコレが無い形で提供できれば呼び出しも綺麗になる。もしくは、こんな感じでも良い。

// コレがベスト
my $model = $self->app->model("Example");
// コレでもいい
my $model = $self->app->model->load("Example");

まぁ、オレオレで使うだけなので、極力文字数が少ない方に越したこと無い。

ということで、とりあえずModelとLogicを分離してみました。

プロジェクトのひな形を作る前にどのFWを使おうか迷ったんですが、MVCベースで依存性の低いものが欲しかったのとちょうどMojolicious3.0のリリース記事を見かけたのでMojoliciousを使うことにしました。ちなみにMojoliciousを使うのは今回が初めてです。

今回はMojoliciousにCLI機能を追加してみます。

まず、最終的にこんな感じで実行したいです。

./script/cli Hoge

Hogeはファイル単位に分割されたcli用モジュール名です。

Mojoliciousにcil機能を追加した結果、下記のようなファイル構成になりました。mojo generate app MyApp::WebとすることでWeb用のネームスペースを確保しています。

my_app/
├── lib
│   └── MyApp
│       ├── Cli
│       │   └── Hoge.pm
│       ├── Cli.pm
│       ├── Web
│       │   └── Example.pm
│       └── Web.pm
├── log
├── public
│   └── index.html
├── script
│   ├── cli
│   └── my_app
├── t
│   └── basic.t
└── templates
    ├── example
    │   └── welcome.html.ep
    └── layouts
        └── default.html.ep

新たに追加したファイルはこんな感じになっています。

追加したファイル

MyApp/Cli.pm

#!/usr/bin/env perl
use strict;
use warnings;
use utf8;

package MyApp::Cli;
use Mojo::Base 'Mojo::Command';

use FindBin;
use File::Basename 'dirname';
use File::Spec::Functions qw(catdir splitdir);

sub development_mode {
    my $self = shift;
}

sub production_mode {
    my $self = shift;
}

sub setup {
    my $self = shift;
    my $app  = $self->app;
    my $mode = $app->mode;

    # setup each mode
    eval {
        my $method = "${mode}_mode";
        $self->$method;
    };
}

1;

MyApp/Cli/Hoge.pm

#!/usr/bin/env perl
use strict;
use warnings;
use utf8;

package MyApp::Cli::Hoge;
use Mojo::Base 'MyApp::Cli';

sub run {
    my $self = shift;
    local @ARGV = @_; 

    $self->setup;
}

1;

script/cli

#!/usr/bin/env perl
use strict;
use warnings;
use utf8;

use UNIVERSAL::require;
use File::Basename 'dirname';
use File::Spec::Functions qw(catdir splitdir);

# Source directory has precedence
my @base = (splitdir(dirname(__FILE__)), '..');
my $lib = join('/', @base, 'lib');
-e catdir(@base, 't') ? unshift(@INC, $lib) : push(@INC, $lib);

my $cmd = shift @ARGV;
my $module = "MyApp::Cli::$cmd";
$module->require;
$module->run( @ARGV );

まとめ

とりあえず、./script/cli Hogeの形でモジュールを実行することが出来るようになりました。cli側で$app->pluginメソッドも使えるので、web側と同じようにconfigやdatabase、その他のpluginをロードして利用することが出来るようになっています。

database周りと入力値の検証用ライブラリ、ロジックの分離ができたら実際にアプリを作ってみたいと思います。