Laravelのここがすごい

  • 86
    Like
  • 2
    Comment

本記事は Qiita Advent Calendar 2016 - Laravel の 1 日目の記事です。

今年から Laravel を仕事で使うようになって、開発がすこぶる捗ったので、Laravel 使って何がよかったか、といったところを中心にご紹介したいと思います。

これから Laravel を試してみたい、という方の一助になれば幸いです。

2016年12月1日現在、最新バージョンは 5.3、LTS1 なバージョンは 5.1 です。

Symfony や CakePHP といった他の主要なフレームワークに比べるとバージョンアップがわりと速く、思い切った変更がしれっと入っていたりするので、選定の際には注意が必要です。

概要

Laravel は、リフレクションを使った柔軟な DI (Dependency Injection: 依存性注入) と、デフォルトで Amazon SQS (キューサービス), SES (Eメールサービス), S3 (ストレージサービス) と連携できたり、フロントエンドのMVVMフレームワークである Vue.js が使えたり、至れり尽くせりなフレームワークです (このトゥーマッチな感じがイヤなひともいるかもしれません、私も最初そうでしたが)。

以下に、一部ではありますが、Laravel のここがすごい!という点をいくつかご紹介します。

Artisan コマンド

ここがすごい!

  • コマンドがとにかく豊富
  • 追加も簡単

コマンドがとにかく豊富

Symfony や CakePHP にも専用のコマンドインタフェースがありますが、Laravel の Artisan ほどコマンドの種類は多くありません (多ければいいというものでもないですが)。

試しにコマンド一覧を出力してみると、

» php artisan list                                                                                                                      Laravel Framework version 5.3.23

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  clear-compiled       Remove the compiled class file
  down                 Put the application into maintenance mode
  env                  Display the current framework environment
  help                 Displays help for a command
  inspire              Display an inspiring quote
  list                 Lists commands
  migrate              Run the database migrations
  optimize             Optimize the framework for better performance
  serve                Serve the application on the PHP development server
  tinker               Interact with your application
  up                   Bring the application out of maintenance mode
 app
  app:name             Set the application namespace
 auth
  auth:clear-resets    Flush expired password reset tokens
 cache
  cache:clear          Flush the application cache
  cache:table          Create a migration for the cache database table
 config
  config:cache         Create a cache file for faster configuration loading
  config:clear         Remove the configuration cache file
 db
  db:seed              Seed the database with records
 debugbar
  debugbar:clear       Clear the Debugbar Storage
 event
  event:generate       Generate the missing events and listeners based on registration
 key
  key:generate         Set the application key
 make
  make:auth            Scaffold basic login and registration views and routes
  make:command         Create a new Artisan command
  make:controller      Create a new controller class
  (多すぎるので省略)
 migrate
  migrate:install      Create the migration repository
  migrate:refresh      Reset and re-run all migrations
  migrate:reset        Rollback all database migrations
  migrate:rollback     Rollback the last database migration
  migrate:status       Show the status of each migration
 notifications
  notifications:table  Create a migration for the notifications table
  (多すぎるので省略)
 vendor
  vendor:publish       Publish any publishable assets from vendor packages
 view
  view:clear           Clear all compiled view files

手元のプロジェクトでは全部で 60 ありました!

Model や Controller をはじめとするLaravel アプリケーションを構成するクラス (他にはイベント、通知、ジョブなど) や、マイグレーションファイルは Artisan コマンドから生成すると、スケルトンを吐き出してくれるので便利です。

追加も簡単

ひとつだけ、これは便利と思った機能を紹介します。 $signature というプロパティに {} でくくったプレースホルダを使うと、実行時の引数として $this->argument()$this->option() メソッドで取得できるようになります。

クラスの追加はもちろん php artisan make:command でやります。

CreateAdmin.php
class CreateAdmin extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'app:admin:create {name} {email}';
}

と書いておくと、handle側では、

$this->argument('name')$this->argument('email') で取れるようになります。

便利ですね。

他にも、対話的に入力を受け取る askconfirm といったメソッドも用意されているのも嬉しいです。

以下の記事も参考にしてください。

Laravelでウェブアプリケーションをつくるときのベストプラクティスを探る (8) コマンド編 - Qiita

Eloquent ORM

Ruby on Rails の ActiveRecord のような直感的に使える「設定より規約」な ORM です。

ここがすごい!

  • クエリスコープメソッド
  • 論理削除のサポート

クエリスコープメソッド

Eloquent なモデルクラスに scope で始まるメソッドを追加すると、絞り込み用の特殊なメソッドを定義できます。

最新記事を10件取ってくるクエリを考えてみます。

クエリスコープメソッドを使わない場合、

NewsController.php
$latestNews = News::orderBy('created_at', 'desc')->take(10)->get();

みたいなかんじになると思いますが、クエリスコープメソッドを使うとこんなかんじになります。

NewsController.php
$latestNews = News::latest(10)->get();

クエリスコープメソッドは以下のように定義します。

News.php
public function scopeLatest($query, $size)
{
    return $query->orderBy('created_at', 'desc')->take($size);
}

論理削除のサポート

deleted_at (デフォルト値) というカラム名をつくって SoftDeletes トレイトを使えば、論理削除をすぐに使えます。

News.php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class News extends Model
{
    use SoftDeletes;

    protected $dates = ['deleted_at'];
}

書くのはこれだけ。

これで、クエリビルダでクエリを実行すると生成される SQL に、 deleted_at is null という条件が自動的に追加されて、論理削除されたレコードを除外するようになります。

便利ですね。

DI と サービスコンテナ

ここがすごい!

  • コンストラクタインジェクション
  • メソッドインジェクション
  • サービスコンテナ

コンストラクタインジェクション

PHP で DI と言えば Pimple や PHP-DI が有名ですが、Laravel には、DI の仕組みが内蔵されていて、メソッドの引数にインジェクトしたいオブジェクトを書くだけで、DI できます。

以下は、RESTful な API を提供するコントローラーの例です。

UserController.php
<?php

namespace App\Http\Controllers;

use App\User;

class UserController extends Controller
{
    private $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }
}

これだけで、コントローラー内のすべてのメソッドから、いちいち new することなく User クラスのメソッドを呼び出すことができます。

便利ですね。

メソッドインジェクション

一方、特定のアクションメソッド (ルーティングで使われるコントローラーのメソッド) でだけ使用したいクラスもあります。その場合はコンストラクタインジェクションではなくメソッドインジェクションを使います。

UserController.php
<?php

namespace App\Http\Controllers;

use App\User;

class UserController extends Controller
{
    public function index(User $user)
    {
        // User オブジェクトを使って何かやる処理
    }
}

サービスコンテナ

アプリケーションが複雑になってくるとサービスクラスが必要になるケースがありますが、Laravel ではデフォルトでサービスを扱えます (詳しくはService Container - Laravel - The PHP Framework For Web Artisansをご覧ください)。

DI が使えるクラス (コントローラーとかイベントとか) では、どんなオブジェクトでも DI できるので、もちろんサービスもインジェクトできるんですが、それ以外のクラスからは、サービスコンテナから呼び出す必要があります。

DI が使える場合

SomeController.php
public function __construct(SomeService $someService)
{
    $this->someService = $someService;
}

DI が使えない場合

SomeService.php
$anotherService = resolve('AnotherService', ['param' => $param]);

便利な反面、グローバル変数的な使い方ができてしまうので注意が必要です。

ServiceProvider::boot で依存関係をつくってしまうという方法もあります。

AppServiceProvider.php
class AppServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton('App\Services\SomeService', function ($app, $params) {
            return new SomeService($params);
        });
        $this->app->bind('App\Services\AnotherService', 'App\Services\AnotherService');
    }

    public function boot(AnotherService $anotherService)
    {
        $backlog = resolve('App\Services\SomeService', ['anotherService' => $anotherService]);
    }
}

他にも、サービスプロバイダとサービスコンテナを使った様々なトリックがありますので、興味ある方は調べてみてください。

イベントとジョブとキュー

ここがすごい!

  • すぐに使えるキュー
  • すぐに使えるイベント

詳しくはこちらの記事をご覧ください。

Laravelでウェブアプリケーションをつくるときのベストプラクティスを探る (6) イベント&ジョブ編 - Qiita

使えるキューは、MySQL や PostgreSQL などのRDBMS、Redis、Beanstalkd、Amazon SQS のドライバーが公式で提供されている他、サードパーティ製の RabbitMQ2 や IronMQ3用のドライバーなどがあります。

通知とメールサービス

ここがすごい!

  • Amazon SES がすぐに使える
  • モデルを送信先にできる

Amazon SES がすぐに使える

Amazon SES4 は、自ドメインを使いつつも、Amazon からEメールを送受信できるサービスです。

ドライバーをインストールする必要がありますが、いつものように composer require コマンドを実行するだけです。あとはコーヒーでも淹れながらお待ちください。

設定は、config/services.php と、各環境の .env ファイルに書きます。

config/services.php
'ses' => [
    'key' => env('SES_KEY'),
    'secret' => env('SES_SECRET'),
    'region' => 'us-east-1',
],

たったこれだけです、便利ですね。

詳しくは、Mail - Laravel - The PHP Framework For Web Artisans を参照してください。

モデルを送信先にできる

これは 5.3 の新しい機能で、実はまだプロダクションコードでは使ったことがないんですが、Notification クラスと Notifiable トレイトを組み合せて、「何の通知を」「誰に」送るか、というのを直感的に書くことができます。

ユーザーがパスワードを変更したことを当該ユーザーに通知したい、というのは、

$user->notify(new PasswordChanged($user));

というような書き方になります (どの手段で通知するかは PasswordChanged クラスの実装によります)。

5.2 までは以下のような書き方しかできず、自分で Notification クラスをつくっていました (通知はメールだけでなく、Slack や Twilio も使っていたので、コントローラー側から見えないように、実装を隠蔽する必要がありました)。

Mail::send('emails.password_reset', ['user' => $user], function ($m) use ($user) {
    $m->to($user->email, $user->name)->subject('Your password has been changed');
});

Notification を使えば、ひとつのクラスで、複数の通知手段を使うことができますし、キューを使うか使わないかも隠蔽することができます。

詳しくは Notifications - Laravel - The PHP Framework For Web Artisans をご覧ください。

まとめ

ほんの一部ではありますが、Laravel の便利なところを紹介しました。
今回の記事を書くにあたって改めてソースコードを読み直し、新たな発見や実装のヒントが得られたので、いい機会になりました。

Laravel のすごいところ

  • 機能豊富なCUIインタフェース Artisan
  • 機能豊富なORM Eloquent
  • 便利な DI とサービスコンテナ
  • キューが使えるイベントとジョブがお手軽
  • メールや Slack への通知もお手軽

他にも「こんなところもすごいよ」とか「ここは正直改善してほしい」など、Laravel の特徴に関するコメントいただけると助かります :bow: