Laravel自定义认证守卫？守卫如何配置使用？

auth.php

users

Illuminate\Contracts\Auth\UserProvider

api_keys

ApiKeyUserProvider

Illuminate\Contracts\Auth\Guard

user()

// app/Auth/MyCustomGuard.php
<?php

namespace App\Auth;

use Illuminate\Auth\GuardHelpers;
use Illuminate\Contracts\Auth\Guard;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Http\Request;

class MyCustomGuard implements Guard
{
    use GuardHelpers; // 提供了 check(), guest(), id() 等方法的默认实现

    protected UserProvider $provider;
    protected Request $request;

    public function __construct(UserProvider $provider, Request $request)
    {
        $this->provider = $provider;
        $this->request = $request;
    }

    public function user()
    {
        // 如果用户已经设置，直接返回
        if (! is_null($this->user)) {
            return $this->user;
        }

        // 从请求中获取你的自定义凭证，比如一个特殊的HTTP头
        $customToken = $this->request->header('X-My-Custom-Token');

        if (! $customToken) {
            return null;
        }

        // 使用用户提供者根据凭证查找用户
        $user = $this->provider->retrieveByCredentials(['token' => $customToken]);

        // 如果找到了用户，并且凭证也验证通过（这里假设token本身就是凭证）
        if ($user && $this->provider->validateCredentials($user, ['token' => $customToken])) {
            $this->setUser($user); // 设置当前认证用户
        }

        return $this->user;
    }

    public function validate(array $credentials = [])
    {
        // 这个方法通常用于尝试登录时验证凭证，对于无状态API可能不常用
        // 但如果你的守卫需要支持登录，可以实现它
        $user = $this->provider->retrieveByCredentials($credentials);

        if ($user && $this->provider->validateCredentials($user, $credentials)) {
            $this->setUser($user);
            return true;
        }

        return false;
    }
}

app/Providers/AuthServiceProvider.php

boot()

// app/Providers/AuthServiceProvider.php
use App\Auth\MyCustomGuard;
use App\Auth\MyCustomUserProvider; // 如果你创建了自定义用户提供者
use Illuminate\Support\Facades\Auth;

public function boot()
{
    $this->registerPolicies();

    // 注册自定义用户提供者（如果需要）
    Auth::provider('my_custom_provider', function ($app, array $config) {
        return new MyCustomUserProvider();
    });

    // 注册自定义守卫
    Auth::extend('my_custom_guard_driver', function ($app, $name, array $config) {
        // 创建一个自定义守卫实例，并传入用户提供者和当前请求
        // $config['provider'] 会指向 auth.php 中配置的 provider 名称
        return new MyCustomGuard(Auth::createUserProvider($config['provider']), $app['request']);
    });
}

config/auth.php

// config/auth.php
'guards' => [
    // ...
    'my_custom_auth' => [ // 你的自定义守卫名称
        'driver' => 'my_custom_guard_driver', // 对应 Auth::extend 中的名称
        'provider' => 'my_custom_provider', // 对应 Auth::provider 中的名称
    ],
],

'providers' => [
    // ...
    'my_custom_provider' => [ // 你的自定义用户提供者名称
        'driver' => 'my_custom_provider', // 对应 Auth::provider 中的名称
        // 'model' => App\Models\MyCustomUser::class, // 如果是EloquentProvider
    ],
],

X-API-Key