Yii2框架實現(xiàn)登錄、退出及自動登錄功能的方法詳解

更新時間：2017年10月24日 12:17:26 作者：LoveJulin

這篇文章主要介紹了Yii2框架實現(xiàn)登錄、退出及自動登錄功能的方法,結(jié)合實例形式詳細分析了Yii2框架實現(xiàn)登錄、退出及自動登錄功能的原理、實現(xiàn)方法與相關(guān)操作注意事項,需要的朋友可以參考下

本文實例講述了Yii2框架實現(xiàn)登錄、退出及自動登錄功能的方法。分享給大家供大家參考，具體如下：

自動登錄的原理很簡單。主要就是利用cookie來實現(xiàn)的

在第一次登錄的時候，如果登錄成功并且選中了下次自動登錄，那么就會把用戶的認證信息保存到cookie中，cookie的有效期為1年或者幾個月。

在下次登錄的時候先判斷cookie中是否存儲了用戶的信息，如果有則用cookie中存儲的用戶信息來登錄，

配置User組件

首先在配置文件的components中設(shè)置user組件

'user' => [
 'identityClass' => 'app\models\User',
 'enableAutoLogin' => true,
],

我們看到enableAutoLogin就是用來判斷是否要啟用自動登錄功能，這個和界面上的下次自動登錄無關(guān)。

只有在enableAutoLogin為true的情況下，如果選擇了下次自動登錄，那么就會把用戶信息存儲起來放到cookie中并設(shè)置cookie的有效期為3600*24*30秒，以用于下次登錄

現(xiàn)在我們來看看Yii中是怎樣實現(xiàn)的。

一、第一次登錄存cookie

1、login 登錄功能

public function login($identity, $duration = 0)
{
  if ($this->beforeLogin($identity, false, $duration)) {
   $this->switchIdentity($identity, $duration);
   $id = $identity->getId();
   $ip = Yii::$app->getRequest()->getUserIP();
   Yii::info("User '$id' logged in from $ip with duration $duration.", __METHOD__);
   $this->afterLogin($identity, false, $duration);
  }
  return !$this->getIsGuest();
}

在這里，就是簡單的登錄，然后執(zhí)行switchIdentity方法，設(shè)置認證信息。

2、switchIdentity設(shè)置認證信息

public function switchIdentity($identity, $duration = 0)
{
  $session = Yii::$app->getSession();
  if (!YII_ENV_TEST) {
   $session->regenerateID(true);
  }
  $this->setIdentity($identity);
  $session->remove($this->idParam);
  $session->remove($this->authTimeoutParam);
  if ($identity instanceof IdentityInterface) {
   $session->set($this->idParam, $identity->getId());
   if ($this->authTimeout !== null) {
    $session->set($this->authTimeoutParam, time() + $this->authTimeout);
   }
   if ($duration > 0 && $this->enableAutoLogin) {
    $this->sendIdentityCookie($identity, $duration);
   }
  } elseif ($this->enableAutoLogin) {
   Yii::$app->getResponse()->getCookies()->remove(new Cookie($this->identityCookie));
  }
}

這個方法比較重要，在退出的時候也需要調(diào)用這個方法。

這個方法主要有三個功能

① 設(shè)置session的有效期

② 如果cookie的有效期大于0并且允許自動登錄，那么就把用戶的認證信息保存到cookie中

③ 如果允許自動登錄，刪除cookie信息。這個是用于退出的時候調(diào)用的。退出的時候傳遞進來的$identity為null

protected function sendIdentityCookie($identity, $duration)
{
  $cookie = new Cookie($this->identityCookie);
  $cookie->value = json_encode([
   $identity->getId(),
   $identity->getAuthKey(),
   $duration,
  ]);
  $cookie->expire = time() + $duration;
  Yii::$app->getResponse()->getCookies()->add($cookie);
}

存儲在cookie中的用戶信息包含有三個值：

$identity->getId() $identity->getAuthKey() $duration

getId()和getAuthKey()是在IdentityInterface接口中的。我們也知道在設(shè)置User組件的時候，這個User Model是必須要實現(xiàn)IdentityInterface接口的。所以，可以在User Model中得到前兩個值，第三值就是cookie的有效期。

二、自動從cookie登錄

從上面我們知道用戶的認證信息已經(jīng)存儲到cookie中了，那么下次的時候直接從cookie里面取信息然后設(shè)置就可以了。

1、AccessControl用戶訪問控制

Yii提供了AccessControl來判斷用戶是否登錄，有了這個就不需要在每一個action里面再判斷了

public function behaviors()
{
  return [
   'access' => [
    'class' => AccessControl::className(),
    'only' => ['logout'],
    'rules' => [
     [
      'actions' => ['logout'],
      'allow' => true,
      'roles' => ['@'],
     ],
    ],
   ],
  ];
}

2、getIsGuest、getIdentity判斷是否認證用戶

isGuest是自動登錄過程中最重要的屬性。

在上面的AccessControl訪問控制里面通過IsGuest屬性來判斷是否是認證用戶，然后在getIsGuest方法里面是調(diào)用getIdentity來獲取用戶信息，如果不為空就說明是認證用戶，否則就是游客（未登錄）。

public function getIsGuest($checkSession = true)
{
  return $this->getIdentity($checkSession) === null;
}
public function getIdentity($checkSession = true)
{
  if ($this->_identity === false) {
   if ($checkSession) {
    $this->renewAuthStatus();
   } else {
    return null;
   }
  }
  return $this->_identity;
}

3、renewAuthStatus 重新生成用戶認證信息

protected function renewAuthStatus()
{
  $session = Yii::$app->getSession();
  $id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null;
  if ($id === null) {
   $identity = null;
  } else {
   /** @var IdentityInterface $class */
   $class = $this->identityClass;
   $identity = $class::findIdentity($id);
  }
  $this->setIdentity($identity);
  if ($this->authTimeout !== null && $identity !== null) {
   $expire = $session->get($this->authTimeoutParam);
   if ($expire !== null && $expire < time()) {
    $this->logout(false);
   } else {
    $session->set($this->authTimeoutParam, time() + $this->authTimeout);
   }
  }
  if ($this->enableAutoLogin) {
   if ($this->getIsGuest()) {
    $this->loginByCookie();
   } elseif ($this->autoRenewCookie) {
    $this->renewIdentityCookie();
   }
  }
}

這一部分先通過session來判斷用戶，因為用戶登錄后就已經(jīng)存在于session中了。然后再判斷如果是自動登錄，那么就通過cookie信息來登錄。

4、通過保存的Cookie信息來登錄 loginByCookie

protected function loginByCookie()
{
  $name = $this->identityCookie['name'];
  $value = Yii::$app->getRequest()->getCookies()->getValue($name);
  if ($value !== null) {
   $data = json_decode($value, true);
   if (count($data) === 3 && isset($data[0], $data[1], $data[2])) {
    list ($id, $authKey, $duration) = $data;
    /** @var IdentityInterface $class */
    $class = $this->identityClass;
    $identity = $class::findIdentity($id);
    if ($identity !== null && $identity->validateAuthKey($authKey)) {
     if ($this->beforeLogin($identity, true, $duration)) {
      $this->switchIdentity($identity, $this->autoRenewCookie ? $duration : 0);
      $ip = Yii::$app->getRequest()->getUserIP();
      Yii::info("User '$id' logged in from $ip via cookie.", __METHOD__);
      $this->afterLogin($identity, true, $duration);
     }
    } elseif ($identity !== null) {
     Yii::warning("Invalid auth key attempted for user '$id': $authKey", __METHOD__);
    }
   }
  }
}

先讀取cookie值，然后$data = json_decode($value, true);反序列化為數(shù)組。

這個從上面的代碼可以知道要想實現(xiàn)自動登錄，這三個值都必須有值。另外，在User Model中還必須要實現(xiàn)findIdentity、validateAuthKey這兩個方法。

登錄完成后，還可以再重新設(shè)置cookie的有效期，這樣便能一起有效下去了。

$this->switchIdentity($identity, $this->autoRenewCookie ? $duration : 0);

三、退出 logout

public function logout($destroySession = true)
{
  $identity = $this->getIdentity();
  if ($identity !== null && $this->beforeLogout($identity)) {
   $this->switchIdentity(null);
   $id = $identity->getId();
   $ip = Yii::$app->getRequest()->getUserIP();
   Yii::info("User '$id' logged out from $ip.", __METHOD__);
   if ($destroySession) {
    Yii::$app->getSession()->destroy();
   }
   $this->afterLogout($identity);
  }
  return $this->getIsGuest();
}
public function switchIdentity($identity, $duration = 0)
{
  $session = Yii::$app->getSession();
  if (!YII_ENV_TEST) {
   $session->regenerateID(true);
  }
  $this->setIdentity($identity);
  $session->remove($this->idParam);
  $session->remove($this->authTimeoutParam);
  if ($identity instanceof IdentityInterface) {
   $session->set($this->idParam, $identity->getId());
   if ($this->authTimeout !== null) {
    $session->set($this->authTimeoutParam, time() + $this->authTimeout);
   }
   if ($duration > 0 && $this->enableAutoLogin) {
    $this->sendIdentityCookie($identity, $duration);
   }
  } elseif ($this->enableAutoLogin) {
   Yii::$app->getResponse()->getCookies()->remove(new Cookie($this->identityCookie));
  }
}

退出的時候先把當(dāng)前的認證設(shè)置為null，然后再判斷如果是自動登錄功能則再刪除相關(guān)的cookie信息。

更多關(guān)于Yii相關(guān)內(nèi)容感興趣的讀者可查看本站專題：《Yii框架入門及常用技巧總結(jié)》、《php優(yōu)秀開發(fā)框架總結(jié)》、《smarty模板入門基礎(chǔ)教程》、《php面向?qū)ο蟪绦蛟O(shè)計入門教程》、《php字符串(string)用法總結(jié)》、《php+mysql數(shù)據(jù)庫操作入門教程》及《php常見數(shù)據(jù)庫操作技巧匯總》

希望本文所述對大家基于Yii框架的PHP程序設(shè)計有所幫助。

您可能感興趣的文章: