Yii的登陸機制
Yii 生成應用時已經提供了最基礎的用戶登陸機制。我們用 Yii 生成一個新的應用，進入 protected/components 目錄，我們可以看到 UserIdentity.php 文件，裡面的 UserIdentity 類裡面只有一個 public 函數如下：
public function authenticate()
{
$users=array(
// username => password
'demo'=>'demo',
'admin'=>'admin',
);
if(!isset($users[$this->username]))
$this->errorCode=self::ERROR_USERNAME_INVALID;
elseif($users[$this->username]!==$this->password)
$this->errorCode=self::ERROR_PASSWORD_INVALID;
else
$this->errorCode=self::ERROR_NONE;
return !$this->errorCode;
}
這個類在 components 裡面，會在應用一開始的時候就加載，用於最基礎的用戶驗證，可以看到，該函數一開始只是簡單地定義了兩個用戶 demo 和 admin,而密碼也只是 demo 和 admin，如果所以如果你的用戶很有限的話，可以直接在這裡面修改添加用戶就行，多的話我們後面再說。函數下面的 if else 分別是用於檢查用戶名和密碼是否有效，出錯的時候生成 ERROR_USERNAME_INVALID，ERROR_PASSWORD_INVALID 這些錯誤。總的來說，這裡進行了真正的用戶名密碼驗證，並進行登陸後的基本邏輯處理。
單看這個類還是看不出登陸控制流程的。遵循 Model/ Control/ View 的原則，我們可以看到登陸流程在這三方面的體現。首先進入 Models 文件夾，你可以看到一個 LoginForm 的類文件，這個類繼承了 CFormModel ，為表單模型的派生類，封裝了關於登陸的數據及業務邏輯。比較核心的函數如下：
/**
* Authenticates the password.
* This is the 'authenticate' validator as declared in rules().
*/
public function authenticate($attribute,$params)
{
$this->_identity=new UserIdentity($this->username,$this->password);
if(!$this->_identity->authenticate())
$this->addError('password','用戶名或密碼錯誤');
}
/**
* Logs in the user using the given username and password in the model.
* @return boolean whether login is successful
*/
public function login()
{
if($this->_identity===null)
{
$this->_identity=new UserIdentity($this->username,$this->password);
$this->_identity->authenticate();
}
if($this->_identity->errorCode===UserIdentity::ERROR_NONE)
{
$duration=$this->rememberMe ? 3600*24*30 : 0; // 30 days
Yii::app()->user->login($this->_identity,$duration);
return true;
}
else
return false;
}
這裡的 authenticate 利用 UserIdentity 類對用戶名密碼進行驗證，而 login 函數通過檢測用戶身份是否已經設置及錯誤碼是否為空，最後進行 Yii 提供的 login 函數進行登陸。$duration 可以設置身份的有效期。
再看 Control，在 siteControler 裡面有一個 action 是關於登錄的，就是 actionLogin, 函數如下：
/**
* Displays the login page
*/
public function actionLogin()
{
if (!defined('CRYPT_BLOWFISH')||!CRYPT_BLOWFISH)
throw new CHttpException(500,"This application requires that PHP was compiled with Blowfish support for crypt().");
$model=new LoginForm;
// if it is ajax validation request
if(isset($_POST['ajax']) && $_POST['ajax']==='login-form')
{
echo CActiveForm::validate($model);
Yii::app()->end();
}
// collect user input data
if(isset($_POST['LoginForm']))
{
$model->attributes=$_POST['LoginForm'];
// validate user input and redirect to the previous page if valid
if($model->validate() && $model->login())
$this->redirect(Yii::app()->user->returnUrl);
}
// display the login form
$this->render('login',array('model'=>$model));
}
該 login 的 action 是基於 LoginForm 將 POST 的表單進行驗證登陸或者渲染一個新的登錄頁面。
最後， view 的文件是 site 文件夾的 login.php ，這就是你所看到的登陸界面了。
梳理一下，我們可以清楚地看到 Yii 的用戶登陸邏輯處理，當你在 login 界面輸入用戶名密碼之後，表單將數據 POST 到 site/login 的動作，loign 實例化了一個 LoginForm 表單模型，並根據 model 裡面的 validate 函數 和 login 函數 進行登陸檢測，validate 會根據 rule 的規則驗證表單數據，其中 password 的驗證需要 authenticate 函數，而 authenticate 和 login 函數的驗證都是基於 UserIdentity 的 authenticate 函數。所以，如果我們更改登錄的邏輯，LgoinForm 和 loginaction 都可以不用修改，直接改 UserIdentity 的 authenticate 函數就基本可以了。
以上的分析是 Yii 自動生成的關於用戶登陸的邏輯處理代碼，看起來已經很像樣了不是嗎？但我們的系統一般要支持很多用戶訪問，在代碼裡簡單地羅列用戶名和密碼明顯是不理智的，更為成熟的當然是請數據庫來幫我們管理。假設我們在自己的數據庫裡面按下面的 Mysql 語句創建一個 admin 的表：
drop table if exists `admin`; create table `admin` ( `admin_id` int unsigned not null auto_increment comment '主鍵', `username` varchar(32) not null comment '登錄名', `psw` char(40) not null comment '登錄密碼（兩次sha1）', `nick` varchar(64) not null comment '昵稱', `add_time` datetime not null comment '創建時間', `login_time` datetime null comment '最近登錄時間', unique key(`username`), primary key (`admin_id`) ) engine=innodb default charset=utf8 comment='管理員表';
Mysql 建表完成後我們就用 gii 生成 admin 的 Model，然後我們可以回到我們最初 Component 裡面的 UserIdentity.php 重寫 authenticate 函數來實現我們自己的用戶名密碼驗證。為了安全起見，密碼采用兩次 sha1 加密，所以將采集到的密碼兩次 sha1 加密，然後在我們創建的 Admin 裡面查找是否存在與表單輸入的 username 對應的用戶，然後比對加密過的密碼，如果都通過後就可以把這個用戶的常用信息由 setState 函數設置為 Yii 的 user 的用戶字段，比如 $this->setState('nick', $user->nick); 這一句之後，以後可以直接通過 Yii:app()->user->nick 來訪問當前登陸用戶的昵稱，而不用去查詢數據庫。而 $user->login_time = date('Y-m-d H:i:s'); 是進行更新用戶登陸時間，並通過下一句的 save 保存到數據庫中。
public function authenticate()
{
if(strlen($this->password) > 0)
$this->password = sha1(sha1($this->password));
$user = Admin::model()->findByAttributes(array('username' => $this->username));
if($user == null)
$this->errorCode=self::ERROR_USERNAME_INVALID;
elseif( !($user instanceof Admin) || ($user->psw != $this->password) )
$this->errorCode=self::ERROR_PASSWORD_INVALID;
else
{
$this->setState('admin_id', $user->admin_id);
$this->setState('nick', $user->nick);
$this->setState('username', $user->username);
$user->login_time = date('Y-m-d H:i:s');
$user->save();
$this->errorCode=self::ERROR_NONE;
}
return !$this->errorCode;
}
而如果你想要修改登陸的界面，那就進入 view 裡面 site 文件夾中的 login.php ，盡情地折騰讓它變成你想要的樣子，這樣我們自己的登陸流程也完成了。有了 Yii 是不是方便極了~
設置自動登陸
自動登錄的原理很簡單。主要就是利用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中的用戶信息包含有三個值：
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是自動登錄過程中最重要的屬性。
在上面的AccessControl訪問控制裡面通過IsGuest屬性來判斷是否是認證用戶，然後在getIsGuest方法裡面是調用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來判斷用戶，因為用戶登錄後就已經存在於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);反序列化為數組。
這個從上面的代碼可以知道要想實現自動登錄，這三個值都必須有值。另外，在User Model中還必須要實現findIdentity、validateAuthKey這兩個方法。
登錄完成後，還可以再重新設置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));
}
}
退出的時候先把當前的認證設置為null，然後再判斷如果是自動登錄功能則再刪除相關的cookie信息。
