本文實例講述了Yii2框架實現登錄、退出及自動登錄功能的方法。分享給大家供大家參考,具體如下:
自動登錄的原理很簡單。主要就是利用cookie來實現的
在第一次登錄的時候,如果登錄成功并且選中了下次自動登錄,那么就會把用戶的認證信息保存到cookie中,cookie的有效期為1年或者幾個月。
在下次登錄的時候先判斷cookie中是否存儲了用戶的信息,如果有則用cookie中存儲的用戶信息來登錄,
配置User組件
首先在配置文件的components中設置user組件
'user' => [ 'identityClass' => 'app\models\User', 'enableAutoLogin' => true, ],
我們看到enableAutoLogin就是用來判斷是否要啟用自動登錄功能,這個和界面上的下次自動登錄無關。
只有在enableAutoLogin為true的情況下,如果選擇了下次自動登錄,那么就會把用戶信息存儲起來放到cookie中并設置cookie的有效期為3600*24*30秒,以用于下次登錄
現在我們來看看Yii中是怎樣實現的。
一、第一次登錄存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(); }
在這里,就是簡單的登錄,然后執行switchIdentity方法,設置認證信息。
2、switchIdentity設置認證信息
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)); } }
這個方法比較重要,在退出的時候也需要調用這個方法。
這個方法主要有三個功能
① 設置session的有效期
② 如果cookie的有效期大于0并且允許自動登錄,那么就把用戶的認證信息保存到cookie中
③ 如果允許自動登錄,刪除cookie信息。這個是用于退出的時候調用的。退出的時候傳遞進來的$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接口中的。我們也知道在設置User組件的時候,這個User Model是必須要實現IdentityInterface接口的。所以,可以在User Model中得到前兩個值,第三值就是cookie的有效期。
二、自動從cookie登錄
從上面我們知道用戶的認證信息已經存儲到cookie中了,那么下次的時候直接從cookie里面取信息然后設置就可以了。
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是自動登錄過程中最重要的屬性。