Artisanコマンドとは?個人的によく使うLaravelのArtisanコマンドをまとめてみました。
New
Section: Technology
2021-07-03
Tags: Laravel

Artisanとは

ArtisanはLaravelに含まれるコマンドラインインターフェースです。

php artisanから始まるコマンドを叩くだけで、様々な共通する処理を自動で行ってくれます。

そのため、Laravelを用いた開発において大変重要なものになっています。

はじめはコマンドを叩くことに抵抗を覚えるかもしれませんが、慣れてくるとコマンドを欲してくるようになるので、一つ一つ見ていきましょう!

Artisanで使えるリストとヘルプ

まずLaravelアプリケーションのルートでphp artisan listとコマンドを叩くと、Artisanコマンドで使えるもののリストが表示されます。便利なものからネタなものまで様々なコマンドが数多く存在します。自分の環境では以下のようになりました。

Laravel Framework 8.21.0

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -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
  db                   Start a new database CLI session
  down                 Put the application into maintenance / demo 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             Cache the framework bootstrap files
  serve                Serve the application on the PHP development server
  test                 Run the application tests
  tinker               Interact with your application
  up                   Bring the application out of maintenance mode
 auth
  auth:clear-resets    Flush expired password reset tokens
 cache
  cache:clear          Flush the application cache
  cache:forget         Remove an item from the 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
  db:wipe              Drop all tables, views, and types
 event
  event:cache          Discover and cache the application's events and listeners
  event:clear          Clear all cached events and listeners
  event:generate       Generate the missing events and listeners based on registration
  event:list           List the application's events and listeners
 inertia
  inertia:middleware   Create a new Inertia middleware
 jetstream
  jetstream:install    Install the Jetstream components and resources
 key
  key:generate         Set the application key
 make
  make:cast            Create a new custom Eloquent cast class
  make:channel         Create a new channel class
  make:command         Create a new Artisan command
  make:component       Create a new view component class
  make:controller      Create a new controller class
  make:event           Create a new event class
  make:exception       Create a new custom exception class
  make:factory         Create a new model factory
  make:job             Create a new job class
  make:listener        Create a new event listener class
  make:mail            Create a new email class
  make:middleware      Create a new middleware class
  make:migration       Create a new migration file
  make:model           Create a new Eloquent model class
  make:notification    Create a new notification class
  make:observer        Create a new observer class
  make:policy          Create a new policy class
  make:provider        Create a new service provider class
  make:request         Create a new form request class
  make:resource        Create a new resource
  make:rule            Create a new validation rule
  make:seeder          Create a new seeder class
  make:test            Create a new test class
 migrate
  migrate:fresh        Drop all tables and re-run all migrations
  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
 optimize
  optimize:clear       Remove the cached bootstrap files
 package
  package:discover     Rebuild the cached package manifest
 queue
  queue:batches-table  Create a migration for the batches database table
  queue:clear          Delete all of the jobs from the specified queue
  queue:failed         List all of the failed queue jobs
  queue:failed-table   Create a migration for the failed queue jobs database table
  queue:flush          Flush all of the failed queue jobs
  queue:forget         Delete a failed queue job
  queue:listen         Listen to a given queue
  queue:prune-batches  Prune stale entries from the batches database
  queue:restart        Restart queue worker daemons after their current job
  queue:retry          Retry a failed queue job
  queue:retry-batch    Retry the failed jobs for a batch
  queue:table          Create a migration for the queue jobs database table
  queue:work           Start processing jobs on the queue as a daemon
 route
  route:cache          Create a route cache file for faster route registration
  route:clear          Remove the route cache file
  route:list           List all registered routes
 sail
  sail:install         Install Laravel Sail's default Docker Compose file
  sail:publish         Publish the Laravel Sail Docker files
 schedule
  schedule:list        List the scheduled commands
  schedule:run         Run the scheduled commands
  schedule:test        Run a scheduled command
  schedule:work        Start the schedule worker
 schema
  schema:dump          Dump the given database schema
 session
  session:table        Create a migration for the session database table
 storage
  storage:link         Create the symbolic links configured for the application
 stub
  stub:publish         Publish all stubs that are available for customization
 vendor
  vendor:publish       Publish any publishable assets from vendor packages
 view
  view:cache           Compile all of the application's Blade templates
  view:clear           Clear all compiled view files
 ziggy
  ziggy:generate       Generate js file for including in build process

また特定のコマンドのヘルプが知りたい場合、php artisan help [options] [--] [<command_name>]のようなコマンドになります。helpについての詳細が知りたい時php artisan help helpとすると以下のように出力されます。

Description:
  Displays help for a command

Usage:
  help [options] [--] [<command_name>]

Arguments:
  command_name          The command name [default: "help"]

Options:
      --format=FORMAT   The output format (txt, xml, json, or md) [default: "txt"]
      --raw             To output raw command help
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -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

Help:
  The help command displays help for a given command:

    artisan help list

  You can also output the help in other formats by using the --format option:

    artisan help --format=xml list

  To display the list of available commands, please use the list command.

起動系

開発環境で簡単にサーバを立ち上げるのに使用します。

php artisan serve

これを用いるとApacheやNginxなどのサーバをベットで用意する必要がなくなります。

注意点として、Descriptionに書いてあるように開発環境向けなので、プロダクション環境では使用してはいけません。

Serve the application on the PHP development server

生成系

makeArtisanコマンドでは、様々なものを自動で生成してくれます。今回はよく使用する5つのコマンドを紹介します。他にもファクトリ、シーダ等の生成コマンドもあり、make系のコマンドを用いることで、名前空間やクラスの基盤など共通する部分を自ら記述する必要がなくなります。

マイグレーションの生成

テーブルを作成したいときに使用するデータベースマイグレーションを生成します。

ユーザuserのテーブルを作成したいときは、以下のコマンドになります。(複数形であることに注意してください)

php artisan make:migration create_users_table

このコマンドを実行すると、database/migrationsディレクトリに、2021_01_25_062410_create_users_table.phpのようなファイルが生成されます。

モデルの生成

Laravelには、データベースの情報を便利に用いられるようにするオブジェクトリレーショナルマッパー(ORM)であるEloquentがあります。

ユーザuserのモデルを作成したいときは、以下のコマンドになります。(単数形であることに注意してください)

php artisan make:model User

このコマンドを実行すると、app/Modelsディレクトリに、User.phpのようなファイルが生成されます。

必要に応じて--migrationのようなオプションを加えると、同時にオプションのものも生成されます。

コントローラの生成

ある関連するリクエスト処理を一つのクラスにグループ化でき、そのクラスをコントローラと呼びます。

ユーザuserのコントローラを作成したいときは、以下のコマンドになります。(単数形であることに注意してください)

php artisan make:controller UserController

このコマンドを実行すると、app/Http/Controllersディレクトリに、UserController.phpのようなファイルが生成されます。

作成、読み取り、更新、削除のようなCRUDルートを用いたい場合、--resourceオブションを加えると処理するためのメソッド等が用意された状態で生成されます。--model=Userのようなオプションを加えると、そのモデルに合わせてコントローラを生成してくれます。両方用いたユーザuserのコントローラを作成したいときは、以下のコマンドになります。

php artisan make:controller UserController --resource --model=User

メールを送信するクラスの生成

メールを送信するためのクラスを作成することができます。

例えば、SendMailというMailのクラスを作成したい場合、以下のコマンドになります。

php artisan make:mail SendMail

SendMailの内容やメールの送受信の設定などを済ませると、

Mail:to($to)->send(new SendMail());

というように、簡潔にメールが送信できるようになります。

コマンドの生成

php artisanのコマンドを使用するだけでなく、自ら作成することもできます。

コマンドの文字とその内容を記述するコマンドのクラスnewCommandを生成したい場合、以下のコマンドになります。

php artisan make:command newCommand

マイグレーション系

マイグレーション関連ではマイグレーションファイルを生成するだけでなく、マイグレーションの実行等にも使用できます。

実行

まだ処理していないマイグレーションをすべて実行したいときに使用します。

php artisan migrate

ロールバック

一番新しいマイグレーション操作を戻したいときに、ロールバックをします。

php artisan migrate:rollback

例えば、開発環境で既にuserspostsの一連の処理があり、新しくCommentsに関する処理を開発しているとします。そのテーブルの仕様変更をしたいとなったときファイルの内容を変更しても、php artisan migrateでは既にマイグレーションされているため、実行されません。php artisan migrate:rollbackを使用すると、Commentsのマイグレーションがロールバックされます。

複数戻したい場合は--step=数字オプションを加え、全て戻したいときはphp artisan migrate:resetを使用します。

refresh

一つのコマンドで、全てのマイグレーションをロールバックし、migrateコマンドを実行してくれます。

php artisan migrate:refresh

fresh

refreshコマンドと似ているが若干違いがあり、データベースから全てのテーブルを削除した後、migrateコマンドを実行してくれます。

php artisa migrate:fresh

キャッシュ系

LaravelではControllerRouteなどを変更したときに以前のキャッシュが残り、変更が反映されていない場合があります。

とりあえず変更点が反映されないときは、こちらを実行すると一気に様々なものをキャッシュしてくれるので、試すべきです。

php artisan optimize

ネタ系

名言

様々な方の名言が表示されます。息抜きに丁度いいかもしれません。

php artisan inspire

自分用備忘録

リソースモデル作成

データベースで情報を管理し、リソースモデルを採用する際のパターンが基本的に同じです。しかしたまにしか作成せず、毎回ドキュメンテーションを読んでしまうので、まとめておきます。

ユーザuserのリソースモデルを採用する場合

php artisan make:migration create_users_table
php artisan make:model User
php artisan make:controller UserController --resource --model=User

一気にmigrationmodelとかを作成したりするコマンドもあります。しかし自分はmigrationを作成したらそこに必要な情報を追記して、その次にmodelの作成に移行するため、コマンドを分けています。

まとめ

もっと詳しく知りたいという方は、Laravelのドキュメンテーションを参考にすることをお勧めします。ここでは紹介していない便利なコマンドが沢山あります。