Laravel自定义用户提供者？用户提供者怎样实现？（提供者.用户.自定义.Laravel...）

wufei123 发布于 2025-09-11 阅读（1）
自定义用户提供者可集成非Eloquent模型与多种数据源，如NoSQL、API、LDAP或文件，通过实现UserProvider和Authenticatable接口，灵活处理用户检索与密码验证，解决认证问题需确保接口方法正确实现并合理配置。

laravel自定义用户提供者？用户提供者怎样实现？

自定义 Laravel 用户提供者允许你使用非 Eloquent 模型或数据库表来验证用户。它通过实现 

Illuminate\Contracts\Auth\UserProvider
接口来完成。这为你提供了极大的灵活性，尤其是在需要与遗留系统或外部认证服务集成时。

解决方案

要创建一个自定义用户提供者，你需要完成以下步骤：

  1. 创建用户模型： 如果你还没有，创建一个代表用户的类。这个类不需要继承 Eloquent 模型，但它必须实现 

    Illuminate\Contracts\Auth\Authenticatable
    接口。
    namespace App\Models;

use Illuminate\Contracts\Auth\Authenticatable;

class CustomUser implements Authenticatable
{
    protected $id;
    protected $username;
    protected $password;
    protected $attributes = [];

    public function __construct(array $attributes = [])
    {
        $this->attributes = $attributes;
        if (isset($attributes['id'])) {
            $this->id = $attributes['id'];
        }
        if (isset($attributes['username'])) {
            $this->username = $attributes['username'];
        }
        if (isset($attributes['password'])) {
            $this->password = $attributes['password'];
        }
    }

    public function getAuthIdentifierName()
    {
        return 'id';
    }

    public function getAuthIdentifier()
    {
        return $this->id;
    }

    public function getAuthPassword()
    {
        return $this->password;
    }

    public function getRememberToken()
    {
        return $this->attributes['remember_token'] ?? null;
    }

    public function setRememberToken($value)
    {
        $this->attributes['remember_token'] = $value;
    }

    public function getRememberTokenName()
    {
        return 'remember_token';
    }

    public function setAttribute($key, $value) {
        $this->attributes[$key] = $value;
    }

    public function getAttribute($key) {
        return $this->attributes[$key] ?? null;
    }

    public function __get($key) {
        return $this->getAttribute($key);
    }

    public function __set($key, $value) {
        $this->setAttribute($key, $value);
    }
}

  2. 创建用户提供者： 创建一个类来实现 

    Illuminate\Contracts\Auth\UserProvider
    接口。这个类负责从你的数据源检索用户，并验证他们的凭据。
    namespace App\Providers;

use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\UserProvider;
use App\Models\CustomUser; // 替换为你的用户模型
use Illuminate\Support\Facades\Hash;

class CustomUserProvider implements UserProvider
{
    protected $model;

    public function __construct(string $model)
    {
        $this->model = $model;
    }

    public function retrieveById($identifier)
    {
        // 从你的数据源检索用户，例如数据库、API等
        // 这里只是一个示例，你需要根据你的实际情况进行修改
        $user = $this->getUserFromDataSource(['id' => $identifier]);
        if ($user) {
            return new $this->model($user);
        }

        return null;
    }

    public function retrieveByToken($identifier, $token)
    {
        // 从你的数据源检索用户，并验证令牌
        // 同样，这里只是一个示例
        $user = $this->getUserFromDataSource(['id' => $identifier, 'remember_token' => $token]);

        if ($user) {
            return new $this->model($user);
        }

        return null;
    }

    public function updateRememberToken(Authenticatable $user, $token)
    {
        // 更新用户的记住我令牌
        // 同样，这里只是一个示例
        $this->updateUserRememberToken($user->getAuthIdentifier(), $token);
    }

    public function retrieveByCredentials(array $credentials)
    {
        // 从你的数据源检索用户，基于提供的凭据
        // 同样，这里只是一个示例
        if (empty($credentials) ||
            (count($credentials) === 1 &&
             array_key_exists('password', $credentials))) {
            return null;
        }

        $query = [];
        foreach ($credentials as $key => $value) {
            if (! str_contains($key, 'password')) {
                $query[$key] = $value;
            }
        }

        $user = $this->getUserFromDataSource($query);

        if ($user) {
            return new $this->model($user);
        }

        return null;
    }

    public function validateCredentials(Authenticatable $user, array $credentials)
    {
        // 验证用户提供的凭据是否正确
        // 同样，这里只是一个示例
        $plain = $credentials['password'];

        return Hash::check($plain, $user->getAuthPassword());
    }

    // 模拟从数据源获取用户数据
    private function getUserFromDataSource(array $credentials)
    {
        // 替换为你的实际数据源逻辑
        // 例如，从数据库查询、调用API等
        $users = [
            [
                'id' => 1,
                'username' => 'testuser',
                'password' => Hash::make('password'),
                'remember_token' => null,
            ],
            [
                'id' => 2,
                'username' => 'anotheruser',
                'password' => Hash::make('anotherpassword'),
                'remember_token' => null,
            ],
        ];

        foreach ($users as $user) {
            $match = true;
            foreach ($credentials as $key => $value) {
                if ($user[$key] != $value) {
                    $match = false;
                    break;
                }
            }
            if ($match) {
                return $user;
            }
        }

        return null;
    }

    // 模拟更新用户记住我令牌
    private function updateUserRememberToken($id, $token)
    {
        // 替换为你的实际数据源更新逻辑
        // 例如，更新数据库记录、调用API等
        // 这里只是一个示例，没有实际更新操作
    }
}

  3. 注册用户提供者： 在 

    config/auth.php
    文件中，注册你的自定义用户提供者。
    'providers' => [
    'users' => [
        'driver' => 'custom',
        'model' => App\Models\CustomUser::class, // 替换为你的用户模型
    ],
],

  4. 配置认证守卫： 在 

    config/auth.php
    文件中，配置你的认证守卫以使用你的自定义用户提供者。
    'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'api' => [
        'driver' => 'token',
        'provider' => 'users',
        'hash' => false,
    ],
],

自定义用户提供者可以处理哪些类型的用户数据源？

自定义用户提供者最大的优势在于其灵活性。它可以处理几乎任何类型的用户数据源，包括：

  • 非关系型数据库 (NoSQL): 例如 MongoDB, Redis 等。你可以编写用户提供者来从这些数据库中检索用户数据。
  • 外部 API: 如果你的用户数据存储在外部 API 中，你可以使用用户提供者来调用 API 并验证用户。
  • LDAP 服务器: 用户提供者可以连接到 LDAP 服务器并验证用户凭据。
  • 平面文件: 虽然不常见，但你甚至可以使用用户提供者从平面文件中读取用户数据。

关键在于 

retrieveById
, 
retrieveByToken
, 
retrieveByCredentials
和 
validateCredentials
方法的实现。 这些方法定义了如何从你的数据源检索用户以及如何验证他们的凭据。

如何处理用户密码的加密和验证？

Laravel 提供了 

Hash
facade 来处理密码的加密和验证。 你应该始终使用 
Hash::make()
来加密用户密码，并使用 
Hash::check()
来验证密码。 PIA PIA

全面的AI聚合平台，一站式访问所有顶级AI模型

PIA226 查看详情 PIA

在 

CustomUserProvider
类的 
validateCredentials
方法中，你可以使用 
Hash::check()
来验证用户提供的密码是否与存储在数据源中的加密密码匹配。
public function validateCredentials(Authenticatable $user, array $credentials)
{
    $plain = $credentials['password'];

    return Hash::check($plain, $user->getAuthPassword());
}

确保在用户注册或更新密码时使用 

Hash::make()
来加密密码。

使用自定义用户提供者进行身份验证时，常见的错误以及如何解决？

在使用自定义用户提供者时，可能会遇到一些常见的错误：

  1. Target [Illuminate\Contracts\Auth\Authenticatable] is not instantiable
    : 这通常意味着你的用户模型没有正确实现 
    Illuminate\Contracts\Auth\Authenticatable
    接口，或者你没有正确地将你的用户模型绑定到容器中。 检查你的用户模型是否实现了所有必需的方法，并确保在 
    config/auth.php
    文件中正确配置了 
    model
    选项。

  2. Call to undefined method
    : 这通常意味着你的用户模型缺少 
    Illuminate\Contracts\Auth\Authenticatable
    接口中定义的方法。 确保你的用户模型实现了 
    getAuthIdentifierName
    , 
    getAuthIdentifier
    , 
    getAuthPassword
    , 
    getRememberToken
    , 
    setRememberToken
    , 和 
    getRememberTokenName
    方法。

  3. 身份验证失败： 这可能是由于多种原因造成的。 首先，确保你的 

    retrieveByCredentials
    方法正确地从你的数据源检索用户。 然后，确保你的 
    validateCredentials
    方法正确地验证用户提供的凭据。 使用 
    dd()
    函数来调试这些方法，以确保它们按预期工作。

  4. Class 'App\Providers\CustomUserProvider' not found
    : 这通常意味着你没有正确地注册你的用户提供者。 确保你在 
    config/app.php
    文件的 
    providers
    数组中注册了你的用户提供者。

  5. Remember Me 功能不起作用： 确保你的用户模型实现了 

    getRememberToken
    , 
    setRememberToken
    , 和 
    getRememberTokenName
    方法，并且你的 
    updateRememberToken
    方法正确地更新了数据源中的 remember token。

总而言之，自定义用户提供者为 Laravel 身份验证提供了极大的灵活性。 通过正确实现 

Illuminate\Contracts\Auth\UserProvider
和 
Illuminate\Contracts\Auth\Authenticatable
接口，你可以将 Laravel 身份验证与任何类型的用户数据源集成。

以上就是Laravel自定义用户提供者？用户提供者怎样实现？的详细内容，更多请关注知识资源分享宝库其它相关文章！

相关标签： laravel php word redis go mongodb cad app ai 用户注册 red php laravel Token 继承 接口 class undefined redis mongodb nosql 数据库 大家都在看： Laravel表单请求？自定义请求类如何使用？ Laravel事务处理？数据库事务如何使用？ Laravel失败队列？失败任务怎样处理？ Laravel自定义命令？Artisan命令怎样开发？ Laravel模型最后记录？最后数据怎样获取？

标签:  提供者 自定义 用户 

相关阅读

发表评论:

◎欢迎参与讨论，请在这里发表您的看法、交流您的观点。

最近发表

标签列表