Laravel 中自定义用户登录的数据表

做项目的时候，用户认证几乎是必不可少的，如果我们的项目由于一些原因不得不使用 users 之外的用户表进行认证，那么就需要多做一点工作来完成这个功能。

现在假设我们只需要修改登录用户的表，表名和表结构都与框架默认的表users不同，文档没有教我们如何去做，但是别慌，稍微看下框架实现用户认证的源码就能轻松实现。

首先，自定义一张表用来登录，表结构和模拟数据如下：

表 admins

从配置文件入手

用户认证相关的配置都保存在config/auth.php文件中，先来看看配置文件的内容：

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Authentication Defaults
    |--------------------------------------------------------------------------
    |
    | This option controls the default authentication "guard" and password
    | reset options for your application. You may change these defaults
    | as required, but they're a perfect start for most applications.
    |
    */

    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],

    /*
    |--------------------------------------------------------------------------
    | Authentication Guards
    |--------------------------------------------------------------------------
    |
    | Next, you may define every authentication guard for your application.
    | Of course, a great default configuration has been defined for you
    | here which uses session storage and the Eloquent user provider.
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | Supported: "session", "token"
    |
    */

    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'passport',
            'provider' => 'users',
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | User Providers
    |--------------------------------------------------------------------------
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | If you have multiple user tables or models you may configure multiple
    | sources which represent each model / table. These sources may then
    | be assigned to any extra authentication guards you have defined.
    |
    | Supported: "database", "eloquent"
    |
    */

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Resetting Passwords
    |--------------------------------------------------------------------------
    |
    | You may specify multiple password reset configurations if you have more
    | than one user table or model in the application and you want to have
    | separate password reset settings based on the specific user types.
    |
    | The expire time is the number of minutes that the reset token should be
    | considered valid. This security feature keeps tokens short-lived so
    | they have less time to be guessed. You may change this as needed.
    |
    */

    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],

];

默认使用的守卫是web，而web守卫使用的认证驱动是session，用户提供器是users。假设我们的需求只是将用户的提供器由users改为admins，那么我们需要做两步操作：

• 修改默认的用户提供器，将provider=>'users'改为provider=>'admins'

  'guards' => [
      'web' => [
          'driver' => 'session',
          'provider' => 'users',
      ],
  ],

• 配置admins提供器，假设依旧使用eloquent作为驱动，并创建好了admins表的模型

  'providers' => [
      'admins' => [
          'driver' => 'eloquent',
          'model' => App\Admin::class
      ]
  ],

使用Auth门面的attempt方法进行登录

SessionGuard 中的attempt方法：

//Illuminate\Auth\SessionGuard
 public function attempt(array $credentials = [], $remember = false)
    {
        $this->fireAttemptEvent($credentials, $remember);

        $this->lastAttempted = $user = $this->provider->retrieveByCredentials($credentials);

        // If an implementation of UserInterface was returned, we'll ask the provider
        // to validate the user against the given credentials, and if they are in
        // fact valid we'll log the users into the application and return true.
        if ($this->hasValidCredentials($user, $credentials)) {
            $this->login($user, $remember);

            return true;
        }

        // If the authentication attempt fails we will fire an event so that the user
        // may be notified of any suspicious attempts to access their account from
        // an unrecognized user. A developer may listen to this event as needed.
        $this->fireFailedEvent($user, $credentials);

        return false;
    }

该方法中调用 UserProvider 接口的retrieveByCredentials方法检索用户，根据我们的配置，UserProvider接口的具体实现应该是EloquentUserProvider，因此，我们定位到EloquentUserProvider的retrieveByCredentials方法：

//Illuminate\Auth\EloquentUserProvider
public function retrieveByCredentials(array $credentials)
    {
        if (empty($credentials) ||
           (count($credentials) === 1 &&
            array_key_exists('password', $credentials))) {
            return;
        }

        // First we will add each credential element to the query as a where clause.
        // Then we can execute the query and, if we found a user, return it in a
        // Eloquent User "model" that will be utilized by the Guard instances.
        $query = $this->createModel()->newQuery();

        foreach ($credentials as $key => $value) {
            if (Str::contains($key, 'password')) {
                continue;
            }

            if (is_array($value) || $value instanceof Arrayable) {
                $query->whereIn($key, $value);
            } else {
                $query->where($key, $value);
            }
        }

        return $query->first();
    }

该方法会使用传入的参数（不包含password）到我们配置的数据表中搜索数据，查询到符合条件的数据之后返回对应的用户信息，然后attempt方法会进行密码校验，校验密码的方法为：

//Illuminate\Auth\SessionGuard
/**
     * Determine if the user matches the credentials.
     *
     * @param  mixed  $user
     * @param  array  $credentials
     * @return bool
     */
    protected function hasValidCredentials($user, $credentials)
    {
        return ! is_null($user) && $this->provider->validateCredentials($user, $credentials);
    }

进一步查看EloquentUserProvider中的validateCredentials方法

//Illuminate\Auth\EloquentUserProvider
public function validateCredentials(UserContract $user, array $credentials)
{
    $plain = $credentials['password'];

    return $this->hasher->check($plain, $user->getAuthPassword());
}

通过validateCredentials可以看出，提交的认证数据中密码字段名必须是password，这个无法自定义。同时可以看到，入参$user必须实现Illuminate\Contracts\Auth\Authenticatable接口（UserContract是别名）。

修改 Admin 模型

Admin模型必须实现Illuminate\Contracts\Auth\Authenticatable接口，可以借鉴一下User模型，让Admin直接继承Illuminate\Foundation\Auth\User 就可以，然后重写getAuthPassword方法，正确获取密码字段：

// App\Admin
public function getAuthPassword()
{
    return $this->login_pass;
}

不出意外的话，这个时候就能使用admins表进行登录了。

总结

laravel提供了很强的扩展性，几乎一切都可以个性化定制，但是需要我们耐心看看源代码和文档，代码注释很详细，这里只是简单的介绍了一下自定义用户登录的表，实际业务需求往往很复杂，需要定制的功能会更多，但是只要按照框架的规范开发，一切都很简单。

本作品采用《CC 协议》，转载必须注明作者和本文链接