はじめに
この記事はプログラミング初学者による備忘録用の記事であり、少しでも他の初学者のお役に立てればと思い書いています。
今回はLaravelを使い開発練習を行う中で、traitは便利だなと思い、気になったので基礎的な部分を調べてみました。
間違いなどがございましたら、ご指摘のほどよろしくお願い致します。
traitとは
私なりの解釈として、traitとは必要な機能だけをクラス内でuse traitと指定することで、適宜クラスに実装(インポート)できる、単にいくつかの機能をまとめたものであると思います。
Laravelでログイン機能周りのコードを読む限り複数のクラスで使う機能はトレイトにまとめて実装しようという流れなのかなと、、、(間違っていればご指摘下さい)
トレイトは、PHP のような単一継承言語でコードを再利用するための仕組みのひとつです。 トレイトは、単一継承の制約を減らすために作られたもので、 いくつかのメソッド群を異なるクラス階層にある独立したクラスで再利用できるようにします。 トレイトとクラスを組み合わせた構文は複雑さを軽減させてくれ、 多重継承や Mixin に関連するありがちな問題を回避することもできます。
traitの優先順位
基本的に親クラスよりもトレイトで追加したメソッドやプロパティが優先されます。
優先順位は
現在のクラスのメソッド>トレイトのメソッド> 継承したメソッド
traitの注意点
複数のトレイトで同じメソッド名が定義され、それらを同時に継承するとFatal errorになります。
対処法1
複数のトレイトで同名のメソッドが定義されている場合のFatal errorを回避するには、insteadofキーワードを使います。
class … {
use traitA,traitB {
traitA::重複したメソッド名 insteadof traitB;
}
}
上記のように書くことで、「traitA::重複したメソッドを、traitBの代わりに使う」という意味になります。
対処法2
また、エイリアスを使い、重複したメソッド名いずれかにエイリアスを追加することで、エラーを回避することができる。
class … {
use traitA,traitB {
traitA::重複したメソッド名 as 追加したいエイリアス名
}
}
traitの使い方
traitの恩恵を受けることができる基本的な使い方として以下があると思います。
クラスに機能を追加するパーツとして使うことでクラスをスマートにする
(他にも便利な使い方があると思いますが理解不足なので書きません…)
Laravelのログイン機能に関するコントローラーを読むと分かりやすいと思ったので使ってみたいと思います。
<?php
namespace App\Http\Controllers\Auth;
//略
use Illuminate\Foundation\Auth\AuthenticatesUsers;
class LoginController extends Controller
{
use AuthenticatesUsers; //traitを使用
//略
<?php
namespace Illuminate\Foundation\Auth;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Validation\ValidationException;
trait AuthenticatesUsers
{
use RedirectsUsers, ThrottlesLogins; //traitを使用
/**
* Show the application's login form.
*
* @return \Illuminate\Http\Response
*/
public function showLoginForm()
{
return view('auth.login');
}
/**
* Handle a login request to the application.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response|\Illuminate\Http\JsonResponse
*
* @throws \Illuminate\Validation\ValidationException
*/
public function login(Request $request)
{
/**
* 1. バリデーション(形式のチェック)
**/
$this->validateLogin($request);
/**
* 2. ログイン試行回数を超過していればロックアウトを返す
**/
if (
method_exists($this, 'hasTooManyLoginAttempts') &&
$this->hasTooManyLoginAttempts($request)
) {
$this->fireLockoutEvent($request);
return $this->sendLockoutResponse($request);
}
/**
* 3. 認証OKならログイン成功をレスポンス(トップページにリダイレクト)
**/
if ($this->attemptLogin($request)) {
return $this->sendLoginResponse($request);
}
/**
* 4. 認証NGであればログイン試行回数を1増やしてログイン画面をレスポンス
**/
$this->incrementLoginAttempts($request);
return $this->sendFailedLoginResponse($request);
}
上記のように、コントローラーのクラス内でトレイトを使うことでファットなコントローラーを避けることができ、また、他のクラスと機能を共通化するときに、共通化する部分をトレイトとして切り離すことで、必要なときに引っ張り出すことが可能になると思います。
おわりに
トレイトを使うことで、ファットなコントローラーやモデルを避けることができそうです。
他にも便利な使い方がありそうなのでもう少し深掘ってみたいと思います。
トレイトを使いこなせるとコードの可読性も爆上がりしそうですね^ ^