自定义 Laravel 中间件 'auth:api'-php教程-PHP中文网

自定义 Laravel 中间件 'auth:api'

聖光之護

发布： 2025-07-17 16:28:12

原创

258人浏览过

自定义 laravel 中间件 'auth:api'

本文将指导你如何自定义 Laravel 的 auth:api 中间件，以实现更灵活的 API 认证机制，例如根据特定的 Bearer Token 进行身份验证。我们将探讨如何创建自定义中间件，并将其集成到 Laravel 的 HTTP 内核中，从而保护你的 API 端点。

在 Laravel 中，中间件充当 HTTP 请求进入应用程序和响应离开应用程序之间的中介。auth:api 中间件负责验证 API 请求的身份。要自定义此中间件，你需要创建自己的中间件类并替换默认的 auth:api。

步骤 1: 创建自定义中间件

首先，使用 Artisan 命令生成一个新的中间件类：

php artisan make:middleware CustomApiAuth

登录后复制

这将在 app/Http/Middleware 目录下创建一个名为 CustomApiAuth.php 的文件。

步骤 2: 实现自定义认证逻辑

打开 CustomApiAuth.php 文件，并修改 handle 方法以包含你的自定义认证逻辑。以下是一个示例，演示如何验证特定的 Bearer Token：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;

class CustomApiAuth
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function handle(Request $request, Closure $next): Response
    {
        $token = $request->bearerToken();

        if ($token !== 'your_secret_token') {
            return response('Unauthorized.', 401);
        }

        return $next($request);
    }
}

登录后复制

代码解释:

$request->bearerToken()：获取请求中的 Bearer Token。
if ($token !== 'your_secret_token')：检查 Token 是否与预期的值匹配。
return response('Unauthorized.', 401)：如果 Token 无效，则返回 401 Unauthorized 响应。
return $next($request)：如果 Token 有效，则将请求传递给下一个中间件或控制器。

重要提示: your_secret_token 应该替换为你实际的密钥。最佳实践是将密钥存储在 .env 文件中，并使用 config() 助手函数来访问它，例如：config('app.api_token')。

百度文心百中

百度大模型语义搜索体验中心

查看详情

步骤 3: 注册自定义中间件

打开 app/Http/Kernel.php 文件。在这个文件中，你需要将你的自定义中间件添加到 $routeMiddleware 数组中。

    protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
        'can' => \Illuminate\Auth\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'throttle:api' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
        'custom.api.auth' => \App\Http\Middleware\CustomApiAuth::class, // 添加你的自定义中间件
    ];

登录后复制

步骤 4: 使用自定义中间件

现在，你可以在路由中使用你的自定义中间件。

Route::middleware('custom.api.auth')->get('/api/protected', function () {
    return 'This is a protected API endpoint.';
});

登录后复制

或者，如果你正在使用 Dingo API，你可以像这样使用它：

$api = app('Dingo\Api\Routing\Router');

$api->version('v1', ['middleware' => 'custom.api.auth'], function ($api) {
    $api->get('protected', 'App\Http\Controllers\ApiController@protectedMethod');
});

登录后复制

注意事项和总结: