掌握 Laravel 中间件的基础知识

PHPz
PHPz 原创
2023-08-31 10:50:02 721浏览

掌握 Laravel 中间件的基础知识

在本文中,我们将深入探讨 Laravel 框架,以了解中间件的概念。本文的前半部分首先介绍中间件及其实际用途。

随着我们继续,我们将介绍如何在 Laravel 应用程序中创建自定义中间件。创建自定义中间件后,我们将探索可用于将其注册到 Laravel 的选项,以便可以在请求处理流程中实际调用它。

我希望您认为自己熟悉基本的 Laravel 概念和用于生成脚手架代码的 Artisan 命令行工具。当然,最新 Laravel 应用程序的有效安装允许您立即运行本文中提供的示例。

Laravel 中的中间件是什么?

我们可以将中间件视为一种机制,允许您连接到 Laravel 应用程序的典型请求处理流程。典型的 Laravel 路由处理会经历请求处理的某些阶段,而中间件是应用程序必须经过的层之一。

那么挂钩 Laravel 请求处理流程到底有什么意义呢?想一想需要在应用程序引导的早期阶段执行的事情。例如,需要在早期对用户进行身份验证,以决定是否允许他们访问当前路由。

我能想到的一些可以通过中间件实现的事情是:

  • 记录请求
  • 重定向用户
  • 更改/清理传入参数
  • 操纵 Laravel 应用程序生成的响应
  • 还有更多

事实上,默认的 Laravel 应用程序已经附带了一些重要的中间件。例如,有中间件可以检查站点是否处于维护模式。另一方面,有中间件来清理输入请求参数。正如我前面提到的,用户认证也是通过中间件本身来实现的。

我希望到目前为止的解释可以帮助您对中间件这个术语更有信心。如果您仍然感到困惑,请不要担心,因为我们将从下一节开始构建一个自定义中间件,这将帮助您准确理解如何在现实世界中使用中间件。

如何创建自定义中间件

在本节中,我们将创建自定义中间件。但我们的自定义中间件到底要完成什么任务呢?

最近,我遇到了客户的一个自定义要求,即如果用户从任何移动设备访问该网站,他们应该被重定向到相应的子域 URL,并且所有查询字符串参数保持不变。我相信这是演示如何在这个特定场景中使用 Laravel 中间件的完美用例。

在这种情况下我们想要使用中间件的原因是需要挂钩应用程序的请求流。在我们的自定义中间件中,我们将检查用户代理,如果用户使用移动设备,则他们将被重定向到相应的移动 URL。

讨论完所有理论后,让我们开始实际开发,这是理解新概念的最佳方式,不是吗?

作为 Laravel 开发人员,如果您希望创建任何自定义功能,您最终将在大部分时间使用 Artisan 工具来创建基本模板代码。让我们用它为我们的自定义中间件创建基本模板代码。

转到命令行并转到项目的文档根目录。运行以下命令创建自定义中间件模板 MobileRedirect

php artisan make:middleware MobileRedirect

这应该使用以下代码创建一个文件 app/Http/Middleware/MobileRedirect.php

<?php
 
namespace App\Http\Middleware;
 
use Closure;
 
class MobileRedirect
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        return $next($request);
    }
}

您通常会注意到 handle 方法的实现,该方法充当中间件的主干,并且您要实现的中间件的主要逻辑应该位于此处.

借此机会介绍一下Laravel自带的中间件类型。主要有前中间件和后中间件两种。

顾名思义,before 中间件是在实际处理请求和构建响应之前运行的中间件。另一方面,后中间件在应用程序处理请求之后运行,并且此时已经构建了响应。

在我们的例子中,我们需要在处理请求之前重定向用户,因此它将被开发为前置中间件。

继续并使用以下内容修改文件 app/Http/Middleware/MobileRedirect.php

<?php
 
namespace App\Http\Middleware;
 
use Closure;
 
class MobileRedirect
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        // check if the request is from mobile device
        if ($request->mobile == "1") {
            return redirect('mobile-site-url-goes-here');
        }
 
        return $next($request);
    }
}

为了简单起见,我们只检查 mobile 查询字符串参数是否存在,如果将其设置为 TRUE,则用户将被重定向到相应的移动设备站点网址。当然,如果您希望实时检测,您会希望使用用户代理检测库。

此外,您还希望将 mobile-site-url-goes-here 路由替换为正确的路由或 URL,因为它只是用于演示目的的占位符。

按照我们的自定义逻辑,调用 $next($request) 允许在应用程序链中进一步处理请求。在我们的例子中需要注意的重要一点是,我们将移动检测逻辑放置在 $next($request) 调用之前,有效地使其成为一个 before 中间件。

这样,我们的自定义中间件就几乎准备好进行测试了。目前,Laravel 无法了解我们的中间件。为此,您需要向 Laravel 应用程序注册您的中间件,这正是我们下一节的主题。

在进入下一部分之前,我想演示一下后中间件的外观,以防万一有人对此感到好奇。

<?php
 
namespace App\Http\Middleware;
 
use Closure;
 
class CustomMiddleWare
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $response = $next($request);
        
        /* your custom logic goes here */
        
        return $response;
    }
}

正如您已经注意到的,中间件的自定义逻辑在 Laravel 应用程序处理请求后执行。此时,您还可以访问 $response 对象,如果您愿意,它允许您操作它的某些方面。

这就是 after 中间件的故事。

我们的自定义中间件正在运行

本节描述了向 Laravel 应用程序注册中间件的过程,以便在请求处理流程中实际调用它。

继续打开文件 app/Http/Kernel.php 并查找以下代码片段。

/**
 * The application's global HTTP middleware stack.
 *
 * These middleware are run during every request to your application.
 *
 * @var array
 */
protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
];

如您所见,$middleware 保存了 Laravel 默认安装附带的中间件数组。此处列出的中间件将根据每个 Laravel 请求执行,因此它是放置我们自己的自定义中间件的理想选择。

继续添加我们的自定义中间件,如以下代码片段所示。

protected $middleware = [
    \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
    \App\Http\Middleware\MobileRedirect::class,
];

现在,尝试使用查询字符串 mobile=1 访问任何 Laravel 路由,这应该会触发我们的中间件代码!

这就是您应该注册需要在每个请求上运行的中间件的方式。但是,有时您希望仅针对特定路由运行中间件。让我们检查一下如何使用 $routeMiddleware 来实现这一点。

在我们当前示例的上下文中,我们假设如果用户访问您网站上的任何特定路由,他们将被重定向到移动网站。在这种情况下,您不想将中间件包含在 $middleware 列表中。

相反,您希望将中间件直接附加到路由定义,如下所示。

Route::get('/hello-world', 'HelloWorldController@index')->middleware(\App\Http\Middleware\MobileRedirect::class);

事实上,我们可以更进一步,为我们的中间件创建一个别名,这样您就不必使用内联类名。

打开文件 app/Http/Kernel.php 并查找 $routeMiddleware ,它保存了别名到中间件的映射。让我们将我们的条目包含到该列表中,如以下代码片段所示。

protected $routeMiddleware = [
    'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'mobile.redirect' => \App\Http\Middleware\MobileRedirect::class
];

修改后的路由定义如下所示。

Route::get('/hello-world', 'HelloWorldController@index')->middleware('mobile.redirect');

这就是向 Laravel 应用程序注册中间件的故事。这非常简单,不是吗?

事实上,我们已经读到了本文的结尾,我希望您能充分享受它。

结论

探索任何框架中的架构概念总是令人兴奋的事情,这就是我们在本文中探索 Laravel 框架中的中间件时所做的事情。

从中间件的基本介绍开始,我们将注意力转移到在 Laravel 应用程序中创建自定义中间件的主题。文章的后半部分讨论了如何向 Laravel 注册自定义中间件,这也是探索附加中间件的不同方式的机会。

希望这次旅程富有成效,并且本文能够帮助您丰富您的知识。另外,如果您希望我在即将发表的文章中提出特定主题,您可以随时给我留言。

今天就这样,如果有任何疑问,请随时使用下面的提要来提出您的疑问!

以上就是掌握 Laravel 中间件的基础知识的详细内容,更多请关注php中文网其它相关文章!

声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn核实处理。