Laravelのミドルウェアの作成方法と２つの適用方法【初心者のためのLaravel入門講座】

Laravelでは、自分でミドルウェアを設定できます。

ミドルウェアの適用するには、ルート設定に書く方法や、コントローラのコンストラクタに書く方法があります。

それぞれの方法の手順を解説していきます。

Junko

「ミドルウェアって何？」と思ったら、まずは下記記事をご覧ください。マンガ入りで解説しています。

Laravelのミドルウェアをマンガで解説【初心者のためのLaravel入門講座】

ミドルウェアとは、条件を満たしていない訪問者がページにアクセスできなくしたりするシステム。ただ、初めてミドルウェアを耳にする時には、これだけだとイマイチよく分からないですよね。 Junko 40代でプログ...

今回作成するLaravelのミドルウェア
Laravelミドルウェアの作成：ルート設定に書く
Laravelミドルウェアの作成：コントローラーのコンストラクタに書く
さいごに

今回作成するLaravelのミドルウェア

今回は、特定のユーザー以外は入れないページを設定してみます。

次のような設計にします。

ユーザーidが1のユーザーのみ、testページにアクセスできるようにする
他のユーザーがtestページにアクセスしようとした場合、もしログインしていなければログインページに、ログイン済みならトップページにリダイレクトする

なお、実行にあたってはLaravelの認証機能が必要になります。

もしまだ認証機能を付けていない場合には、前回の記事を参考にしながらインストールをしておいてくださいね。

10分程度で終わります。

Laravelミドルウェアの作成：ルート設定に書く

それでは、実際にLaravelを操作しながら、ミドルウェアを実装してみましょう。

①新しくミドルウェアを作成する

php artisan コマンドで新しくミドルウェアを作成します。

php artisan make:middleware TestMiddleware

1	php artisan make:middleware TestMiddleware

②Kernel.phpファイルにミドルウェアのパスを入力する

app/Http フォルダの中のKernel.phpファイルに、作成したミドルウェアについて登録しておきます。

'TestMiddleware'=>\App\Http\Middleware\TestMiddleware::class,

1	'TestMiddleware'=>\App\Http\Middleware\TestMiddleware::class,

入力後のファイルは、次のようになります。

③データベースを準備しておく

まずはユーザー登録画面より、ユーザーを1人登録しておいてください。

ユーザー登録画面は、トップページ右上のRegisterをクリックすると表示されます。

【トップページ】

【ユーザー登録ページ（/register)】

データベースのusersテーブルを開きます。登録したユーザーのidが１であることを確認しておきます。

④ユーザーモデルファイルを編集する

app/Modelsフォルダの中のUser.phpを開きます。次のコードを追加します。

    public function test(){ 
        if($this->id=='1'){ 
            return true; 
        } return false; 
    }

public function test(){

if($this->id=='1'){

return true;

} return false;

}

コードの意味

もしユーザーのidが【1】であれば、trueとします。
そうでなければ、falseとします。

⑤ミドルウェアファイルを編集する

先ほど作成したミドルウェアファイルを編集します。

app/Http/Middleware の中のTestMiddleware.phpファイルを開き、一番上に次のコードをいれます。

use Illuminate\Support\Facades\Auth;

1	use Illuminate\Support\Facades\Auth;

入力後のファイルは、次のようになります。

次に、下記のコードを追加します。

    public function handle($request, Closure $next)
    {
        $user = Auth::user();
        if(!$user->test()){
            return redirect('/');
        }

        return $next($request);
    }

public function handle($request, Closure $next)

{

$user = Auth::user();

if(!$user->test()){

return redirect('/');

}

return $next($request);

}

コードの意味

$userは、認証済みユーザー（ログイン済みユーザー）とします。
もし$userが（ユーザーモデルに記した）testの条件を満たしていなければ、redirect処理をします。トップページを表示してください。
もしtestの条件を満たしていたら、リクエストを実行してください。

⑥ルートファイルを編集する

routesフォルダの中のweb.phpファイルを開きます。

下記のコードを入力します。

Route::get('/test', function(){
    return "ミドルウェアの実験成功";
})->middleware('auth', 'TestMiddleware');

Route::get('/test', function(){

return "ミドルウェアの実験成功";

})->middleware('auth', 'TestMiddleware');

コードの意味

/test ページにアクセスがあれば、AuthミドルウェアとTestMiddlewareを実施してください。
もしミドルウェアを通過したら、「ミドルウェアの実験成功」と返してください。

/testにアクセスしたユーザーは、まずミドルウェアのチェックを受けることになります。

最初にauthミドルウェアのチェックを受けます。これによって、ログインしていなければログイン画面にリダイレクトします。

Junko

authミドルウェアは、前回記事で解説しています。

ログイン済みだった場合は、TestMiddlewareのチェックを受けます。TestMiddlewareは、idが1番のユーザーしか通さないように設定しています。そのため、idが1以外のユーザーがアクセスすると、トップページにリダイレクトします。

idが１のユーザーがアクセスした場合、「ミドルウェアの実験成功」メッセージが表示されます。

⑦ミドルウェアの実験をしてみる

準備が整ったら、実験をしてみましょう。

idが【1】のユーザーとして、Laravelのトップページからログインしまず。

/test ページを開き、下記のメッセージが表示されていれば成功です！

他の条件でもテストしてみてください。

ログインしていない状態で/testにアクセスした場合は、ログイン画面が表示されます。

idが１でないユーザーとしてログインして、/testにアクセスした場合は、トップページが表示されます。

Laravelミドルウェアの作成：コントローラーのコンストラクタに書く

次にミドルウェアを適用する2つ目の方法を解説します。

上記の【Laravelミドルウェアの作成：ルート設定に書く】と途中まで同じです。

手順⑥から変わってくるので、そこから解説していきますね。

⑥ルートファイルを編集する（コンストラクタ編）

routesフォルダの中のweb.phpファイルを開きます。

下記のコードを入力します。

Route::get('/test2', 'App\Http\Controllers\TestController@index')->middleware('auth');

1	Route::get('/test2', 'App\Http\Controllers\TestController@index')->middleware('auth');

コードの意味

/test ページにアクセスがあれば、Authミドルウェアを実施してから、TestControllerのindexメソッドを実行します。

次にTestControllerのindexメソッドを書いていきます。

⑦ コントローラーファイルを作成する（コンストラクタ編）

次のようにコマンドを入力して、TestControllerを作成します。

php artisan make:controller TestController

1	php artisan make:controller TestController

⑧コントローラーファイルを編集する（コンストラクタ編）

app/Http/Controllers ファイルから、TestContoller.phpファイルを開きます。

次のように入力します。

class TestController extends Controller
{
    public function __construct(){
        $this->middleware('TestMiddleware');
    }

    public function index(){
        return "ミドルウェアの実験成功2";
    }
}