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

現在作成中のサービスで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周りと入力値の検証用ライブラリ、ロジックの分離ができたら実際にアプリを作ってみたいと思います。