Yii - 身份驗證

驗證使用者身份的過程稱為身份驗證。它通常使用使用者名稱和密碼來判斷使用者是否為其自稱的使用者。

要使用 Yii 身份驗證框架，您需要：

配置使用者應用程式元件。
實現 yii\web\IdentityInterface 介面。

基本應用程式模板帶有一個內建的身份驗證系統。它使用使用者應用程式元件，如下面的程式碼所示：

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this
               //is required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         //other components...
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // configuration adjustments for 'dev' environment
      $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

在上述配置中，使用者的身份類配置為 app\models\User。

身份類必須實現yii\web\IdentityInterface，其中包含以下方法：

findIdentity() - 使用指定的 User ID 查詢身份類的例項。
findIdentityByAccessToken() - 使用指定的訪問令牌查詢身份類的例項。
getId() - 返回使用者的 ID。
getAuthKey() - 返回用於驗證基於 Cookie 的登入的金鑰。
validateAuthKey() - 實現驗證基於 Cookie 的登入金鑰的邏輯。

基本應用程式模板中的 User 模型實現了所有上述功能。使用者資料儲存在$users屬性中：

<?php
   namespace app\models;
   class User extends \yii\base\Object implements \yii\web\IdentityInterface {
      public $id;
      public $username;
      public $password;
      public $authKey;
      public $accessToken;
      private static $users = [
         '100' => [
            'id' => '100',
            'username' => 'admin',
            'password' => 'admin',
            'authKey' => 'test100key',
            'accessToken' => '100-token',
         ],
         '101' => [
            'id' => '101',
            'username' => 'demo',
            'password' => 'demo',
            'authKey' => 'test101key',
            'accessToken' => '101-token',
         ],
      ];
      /**
      * @inheritdoc
      */
      public static function findIdentity($id) {
         return isset(self::$users[$id]) ? new static(self::$users[$id]) : null;
      }
      /**
      * @inheritdoc
      */
      public static function findIdentityByAccessToken($token, $type = null) {
         foreach (self::$users as $user) {
            if ($user['accessToken'] === $token) {
               return new static($user);
            }
         }
         return null;
      }
      /**
      * Finds user by username
      *
      * @param string $username
      * @return static|null
      */
      public static function findByUsername($username) {
         foreach (self::$users as $user) {
            if (strcasecmp($user['username'], $username) === 0) {
               return new static($user);
            }
         }
         return null;
      }
      /**
      * @inheritdoc
      */
      public function getId() {
         return $this->id;
      }
      /**
      * @inheritdoc
      */
      public function getAuthKey() {
         return $this->authKey;
      }
      /**
      * @inheritdoc
      */
      public function validateAuthKey($authKey) {
         return $this->authKey === $authKey;
      }
      /**
      * Validates password 
      *
      * @param string $password password to validate
      * @return boolean if password provided is valid for current user
      */
      public function validatePassword($password) {
         return $this->password === $password;
      }
   }
?>

步驟 1 - 前往 URL https://:8080/index.php?r=site/login 並使用 admin 作為登入名和密碼登入網站。

步驟 2 - 然後，向 SiteController 新增一個名為actionAuth()的新函式。

public function actionAuth(){
   // the current user identity. Null if the user is not authenticated.
   $identity = Yii::$app->user->identity;
   var_dump($identity);
   // the ID of the current user. Null if the user not authenticated.
   $id = Yii::$app->user->id;
   var_dump($id);
   // whether the current user is a guest (not authenticated)
   $isGuest = Yii::$app->user->isGuest;
   var_dump($isGuest);
}

步驟 3 - 在 Web 瀏覽器中鍵入地址https://:8080/index.php?r=site/auth，您將看到有關admin使用者的詳細資訊。

步驟 4 - 要登入和登出使用者，您可以使用以下程式碼。

public function actionAuth() {
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest);
   // find a user identity with the specified username.
   // note that you may want to check the password if needed
   $identity = User::findByUsername("admin");
   // logs in the user
   Yii::$app->user->login($identity);
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest);
   Yii::$app->user->logout();
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest);
}

首先，我們檢查使用者是否已登入。如果返回值為false，則透過Yii::$app → user → login()呼叫登入使用者，並使用Yii::$app → user → logout()方法登出使用者。

步驟 5 - 前往 URL https://:8080/index.php?r=site/auth，您將看到以下內容。

yii\web\User類引發以下事件：

EVENT_BEFORE_LOGIN - 在yii\web\User::login()的開頭引發
EVENT_AFTER_LOGIN - 成功登入後引發
EVENT_BEFORE_LOGOUT - 在yii\web\User::logout()的開頭引發
EVENT_AFTER_LOGOUT - 成功登出後引發

列印頁面