Laravel 6.x/7.x

Laravel 開発環境を構築して認証（ログイン）機能を追加してみます。
今回は LTS の Laravel 6.x と 7.x で違いを見てみます。

サポートは下記のようになっているようです。

詳細はこちら　リリースノート

Docker での環境構築はこちらを参照ください。
http://vistylee.com/docker-laravel/

Laravel インストール

ブロジェクト作成

• Laravel 6.x/7.x の場合
  プロジェクトを作成する場合はcreate-projectコマンドを実行します。
  Laravel 7.x がリリースされた関係で Laravel 6.x インストールした場合は、バージョンを指定します。Laravel 7.x の場合はバージョン指定は不要です。

  # 7.x composer create-project --prefer-dist laravel/laravel blog # 6.x composer create-project --prefer-dist laravel/laravel blog "6.*"

  1 2 3 4

  # 7.x composer create-project --prefer-dist laravel/laravel blog # 6.x composer create-project --prefer-dist laravel/laravel blog "6.*"

• Laravel 7.x の場合
  laravel new コマンドでプロジェクト作成できます。
  最新のバージョンとなります。（authオプションで認証機能を一緒に作成することもできます）

  laravel new blog

  1	laravel new blog

認証（ログイン）機能追加

• 事前にマイグレーションを実行します。
  .env ファイルと config/database.php の DB 設定はしておく必要があります。

  php artisan migrate

  1	php artisan migrate

  下記テーブルを作成されます。

  • users
  • password_resets
  • failed_jobs

• Laravel 5.8 までの場合

  php artisan make:auth

  1	php artisan make:auth

Laravel 6.x/7.xでは、laravel/uiパッケージが必要となりますので、composerでインストールします。

• laravel/uiを追加

  # 7.x composer require laravel/ui # 6.x composer require laravel/ui:^1.0 --dev php artisan ui vue --auth

  1 2 3 4 5 6

  # 7.x composer require laravel/ui # 6.x composer require laravel/ui:^1.0 --dev   php artisan ui vue --auth

• フロント側対応
  事前に Node.js と NPM をインストールしておく必要があります。
  npm install npm run dev

  1 2	npm install npm run dev

• Laravel 7.x の場合
  laravel new コマンドでプロジェクト作成時に auth オプションを指定することでも可能です。
  laravel new blog --auth

  1	laravel new blog --auth

バージョン確認

認証機能

認証の機能として主に下記を見ていきます。

• ユーザー登録
• ユーザー認証
  • ログイン
  • ログアウト
• パスワードリセット

初期使用ファイル

ルーティング

Artisan コマンドで確認します。使用するミドルウェアも確認できます。

ファサード

Auth ファサードをいくつか見ていきます。

• Auth::attempt
  attemptメソッドは認証を行います。
  認証に使用する値をキー／値ペアの配列を渡します。

  $credentials = $request->only('email', 'password'); if (Auth::attempt($credentials)) { 　// 認証成功 }

  1 2 3 4

  $credentials = $request->only('email', 'password'); if (Auth::attempt($credentials)) { 　// 認証成功 }

• Auth::check
  checkメソッドはユーザーが既にログインしているかを調べます。

  if (Auth::check()) { // ログインしている }

  1 2 3

  if (Auth::check()) { // ログインしている }

• Auth::user
  userメソッドは認証ユーザーを取得します。

  $user = Auth::user();

  1	$user = Auth::user();

• Auth::guest

  if (Auth::guest()) { // ゲストユーザー }

  1 2 3

  if (Auth::guest()) { // ゲストユーザー }

• Auth::viaRemember
  ユーザーがログイン維持(Remember me)機能を使用して認証されているかを確認します。

  if (Auth::viaRemember()) { // Remember me を使用している }

  1 2 3

  if (Auth::viaRemember()) { // Remember me を使用している }

• Auth::login
  ログインさせる

  Auth::login($user);

  1	Auth::login($user);

• Auth::once
  １回だけ認証する（セッションを持たせない）

  if (Auth::once($credentials)) { // 単発の認証成功 }

  1 2 3

  if (Auth::once($credentials)) { // 単発の認証成功 }

• Auth::routes
  認証用ルーティングを一括しています。

  Auth::routes();

  1	Auth::routes();

• Auth::logout
  ログアウトさせる

  Auth::logout();

  1	Auth::logout();

• Auth::guard
  ガードを使った処理をさせる

  # admin用のguardを作成しておき通常のuserとは別のadminの認証を行う場合 if (Auth::guard('admin')->attempt($credentials)) { // adminユーザー }

  1 2 3 4

  # admin用のguardを作成しておき通常のuserとは別のadminの認証を行う場合 if (Auth::guard('admin')->attempt($credentials)) { // adminユーザー }

認証設定ファイル

config/auth.php の設定を見ていきます。

• defaults デフォルトの認証「ガード」およびパスワードリセットオプション
  • guard 使用する設定を guards から指定、初期値は web
  • passwords 使用する設定を passwords から指定、初期値は users
• guards
  • web
  • driver ドライバーの種類、初期値は session
  • provider 使用する設定を providers から指定、初期値は users
  • api
  • driver ドライバーの種類、初期値は token
  • provider 使用する設定を providers から指定、初期値は users
  • hash APIトークンを平文ではなく SHA-256 にする場合は true、初期値は false
• providers
  • users
  • driver データへアクセスするのに使用するドライバー、初期値は eloquent
  • model 指定したドライバーが eloquent の場合、使用するモデル、初期値は App\User::class
• passwords
  • users
  • provider 使用するproviderの設定、初期値は users
  • table パスワードリセットトークンを格納するテーブル、初期値は password_resets
  • expire 有効時間、初期値は 60
  • throttle 要求制限、スロットル時間（秒）、初期値は 60
• password_timeout パスワード再確認までの時間、初期値は 10800

コントローラー

• パスワード確認
  app\Http\Controllers\Auth\ConfirmPasswordController.php
  パスワード確認の処理をします。
  ConfirmsPasswordsトレイトを使用

• パスワードリセットメール
  app\Http\Controllers\Auth\ForgotPasswordController.php
  パスワードリセットメールの処理をします。
  メールをユーザーに送信
  SendsPasswordResetEmailsトレイトを使用

• ユーザー認証
  app\Http\Controllers\Auth\LoginController.php
  ユーザーを認証し、ホーム画面へリダイレクトの処理をします。
  AuthenticatesUsersトレイトを使用

• ユーザー登録、検証、作成
  app\Http\Controllers\Auth\RegisterController.php
  ユーザー登録、検証、作成の処理をします。
  RegistersUsersトレイトを使用

• パスワードリセット
  app\Http\Controllers\Auth\ResetPasswordController.php
  パスワードのリセット要求の処理をします。
  ResetsPasswordsトレイトを使用

• 最近登録したすべてのユーザーの電子メール検証
  app\Http\Controllers\Auth\VerificationController.php
  最近登録したすべてのユーザーの電子メール検証の処理をします。
  VerifiesEmailsトレイトを使用

ミドルウェア

• 認証チェック
  app\Http\Middleware\Authenticate.php
  認証されていない場合にユーザーをリダイレクトするパスを返す

• 認証ユーザーリダイレクト
  app\Http\Middleware\RedirectIfAuthenticated.php
  リダイレクトを処理します。

プロバイダ

• 認証のゲートやポリシーの登録
  app\Providers\AuthServiceProvider.php
  ポリシーマッピング
  認証/認可サービスを登録処理します。

Eloquentモデル

• ユーザーモデル
  app\User
  • fillable 値を代入するフィールドを設定、初期値は 'name', 'email', 'password'
  • hidden データを取得しないフィールドを指定、初期値は password', 'remember_token
  • casts キャストが必要なフィールドを指定、初期値は 'email_verified_at' => 'datetime'

使用テーブル

マイグレーションで追加されるテーブル

• users テーブル

  `id` ID,プライマリーキー `name` ユーザー名 `email` メールアドレス,ユニーク `email_verified_at` メールアドレスを確認した日時 `password` パスワード `remember_token` 自動ログイン用トークン `created_at` 作成日時 `updated_at` 更新日時

  1 2 3 4 5 6 7 8

  `id` ID,プライマリーキー `name` ユーザー名 `email` メールアドレス,ユニーク `email_verified_at` メールアドレスを確認した日時 `password` パスワード `remember_token` 自動ログイン用トークン `created_at` 作成日時 `updated_at` 更新日時

• password_resets テーブル

  `email` メールアドレス `token` パスワードリセットトークン `created_at` 作成日時

  1 2 3

  `email` メールアドレス `token` パスワードリセットトークン `created_at` 作成日時

認証UIファイル

php artisan ui vue --authコマンドで生成されるファイルです。

コンパイルファイル

npm run dev で生成されるファイルです。

言語設定

• タイムゾーンと言語設定
  config/app.php の timezone と locale を変更します。

  'timezone' => 'Asia/Tokyo' 'locale' => 'ja',

  1 2	'timezone' => 'Asia/Tokyo' 'locale' => 'ja',

• 日本語化設定
  インストーラーをダウンロードして、インストールします。

  php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');" php -f install-ja-lang.php php -r "unlink('install-ja-lang.php');"

  1 2 3

  php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');" php -f install-ja-lang.php php -r "unlink('install-ja-lang.php');"

  resources/lang/ja/ ディレクトリと下記ファイルが生成されます。

  • auth.php
  • pagination.php
  • passwords.php
  • validation.php

• フィールドの日本語化設定
  resources/lang/ja/xxx.php 各ファイルで設定していきます。

  resources/lang/ja/xxx.php

  1	resources/lang/ja/xxx.php

まとめ

Laravel7 ですとベースの認証機能が laravel コマンドで追加されるので、ありがたいですね。
laravel コマンドは最新のバージョンでインストールされるので、laravel6 は composer create-project でプロジェクト作成するなど異なってきますので、注意が必要です。

参考リンク

Authentication 7.x
Authentication 6.x
Laravel 7.x 認証
Laravel 6.x 認証
auth.php言語ファイル 7.x Laravel
auth.php言語ファイル 6.x Laravel

関連リンク

http://vistylee.com/docker-laravel/
http://vistylee.com/laravel-artisan/