这篇文章主要介绍了详细解读PHP的Yii框架中登陆功能的实现,包括通过cookie实现自动登录的功能,需要的朋友可以参考下。

Yii的登陆机制

Yii 生成应用时已经提供了最基础的用户登陆机制。我们用 Yii 生成一个新的应用，进入 protected/components 目录，我们可以看到 UserIdentity.php 文件，里面的 UserIdentity 类里面只有一个 public 函数如下：

1. public function authenticate()  
2. {  
3.   $users=array(  
4.     // username => password  
5.     'demo'=>'demo',  
6.     'admin'=>'admin',  
7.   );  
8.   if(!isset($users[$this->username]))  
9.     $this->errorCode=self::ERROR_USERNAME_INVALID;  
10.   elseif($users[$this->username]!==$this->password)  
11.     $this->errorCode=self::ERROR_PASSWORD_INVALID;  
12.   else 
13.     $this->errorCode=self::ERROR_NONE;  
14.   return !$this->errorCode;  
15. }  

这个类在 components 里面，会在应用一开始的时候就加载，用于最基础的用户验证，可以看到，该函数一开始只是简单地定义了两个用户 demo 和 admin,而密码也只是 demo 和 admin，如果所以如果你的用户很有限的话，可以直接在这里面修改添加用户就行，多的话我们后面再说。函数下面的 if else 分别是用于检查用户名和密码是否有效，出错的时候生成 ERROR_USERNAME_INVALID，ERROR_PASSWORD_INVALID 这些错误。总的来说，这里进行了真正的用户名密码验证，并进行登陆后的基本逻辑处理。

单看这个类还是看不出登陆控制流程的。遵循 Model/ Control/ View 的原则，我们可以看到登陆流程在这三方面的体现。首先进入 Models 文件夹，你可以看到一个 LoginForm 的类文件，这个类继承了 CFormModel ，为表单模型的派生类，封装了关于登陆的数据及业务逻辑。比较核心的函数如下：

1. /**  
2.  * Authenticates the password.  
3.  * This is the 'authenticate' validator as declared in rules().  
4.  */ 
5. public function authenticate($attribute,$params)  
6. {  
7.   $this->_identity=new UserIdentity($this->username,$this->password);  
8.   if(!$this->_identity->authenticate())  
9.     $this->addError('password','用户名或密码错误');  
10. }  
11.    
12. /**  
13.  * Logs in the user using the given username and password in the model.  
14.  * @return boolean whether login is successful  
15.  */ 
16. public function login()  
17. {  
18.   if($this->_identity===null)  
19.   {  
20.     $this->_identity=new UserIdentity($this->username,$this->password);  
21.     $this->_identity->authenticate();  
22.   }  
23.   if($this->_identity->errorCode===UserIdentity::ERROR_NONE)  
24.   {  
25.     $duration=$this->rememberMe ? 3600*24*30 : 0; // 30 days  
26.     Yii::app()->user->login($this->_identity,$duration);  
27.     return true;  
28.   }  
29.   else 
30.     return false;  
31. }  

这里的 authenticate 利用 UserIdentity 类对用户名密码进行验证，而 login 函数通过检测用户身份是否已经设置及错误码是否为空，最后进行 Yii 提供的 login 函数进行登陆。$duration 可以设置身份的有效期。

再看 Control，在 siteControler 里面有一个 action 是关于登录的，就是 actionLogin, 函数如下：

1. /**  
2.  * Displays the login page  
3.  */ 
4. public function actionLogin()  
5. {  
6.   if (!defined('CRYPT_BLOWFISH')||!CRYPT_BLOWFISH)  
7.     throw new CHttpException(500,"This application requires that PHP was compiled with Blowfish support for crypt().");  
8.    
9.   $model=new LoginForm;  
10.    
11.   // if it is ajax validation request  
12.   if(isset($_POST['ajax']) && $_POST['ajax']==='login-form')  
13.   {  
14.     echo CActiveForm::validate($model);  
15.     Yii::app()->end();  
16.   }  
17.    
18.   // collect user input data  
19.   if(isset($_POST['LoginForm']))  
20.   {  
21.     $model->attributes=$_POST['LoginForm'];  
22.     // validate user input and redirect to the previous page if valid  
23.     if($model->validate() && $model->login())  
24.       $this->redirect(Yii::app()->user->returnUrl);  
25.   }  
26.   // display the login form  
27.   $this->render('login',array('model'=>$model));  
28. } 

该 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 的表：

1. drop table if exists `admin`;  
2. create table `admin` (  
3.   `admin_id` int unsigned not null auto_increment comment '主键',  
4.   `username` varchar(32) not null comment '登录名',  
5.   `psw` char(40) not null comment '登录密码（两次sha1）',  
6.   `nick` varchar(64) not null comment '昵称',  
7.   `add_time` datetime not null comment '创建时间',  
8.   `login_time` datetime null comment '最近登录时间',  
9.   unique key(`username`),  
10.   primary key (`admin_id`)  
11. ) 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 保存到数据库中。

1. public function authenticate()  
2. {  
3.   if(strlen($this->password) > 0)  
4.     $this->password = sha1(sha1($this->password));  
5.   $user = Admin::model()->findByAttributes(array('username' => $this->username));  
6.   if($user == null)  
7.     $this->errorCode=self::ERROR_USERNAME_INVALID;  
8.   elseif( !($user instanceof Admin) || ($user->psw != $this->password) )  
9.     $this->errorCode=self::ERROR_PASSWORD_INVALID;  
10.   else 
11.   {  
12.     $this->setState('admin_id', $user->admin_id);  
13.     $this->setState('nick', $user->nick);  
14.     $this->setState('username', $user->username);  
15.     $user->login_time = date('Y-m-d H:i:s');  
16.     $user->save();  
17.     $this->errorCode=self::ERROR_NONE;  
18.   }  
19.   return !$this->errorCode;  
20. }  

而如果你想要修改登陆的界面，那就进入 view 里面 site 文件夹中的 login.php ，尽情地折腾让它变成你想要的样子，这样我们自己的登陆流程也完成了。有了 Yii 是不是方便极了~

设置自动登陆

自动登录的原理很简单。主要就是利用cookie来实现的

在第一次登录的时候，如果登录成功并且选中了下次自动登录，那么就会把用户的认证信息保存到cookie中，cookie的有效期为1年或者几个月。

在下次登录的时候先判断cookie中是否存储了用户的信息，如果有则用cookie中存储的用户信息来登录。

配置User组件

首先在配置文件的components中设置user组件

1. 'user' => [ 
2.   'identityClass' => 'app\models\User', 
3.   'enableAutoLogin' => true, 
4. ], 

我们看到enableAutoLogin就是用来判断是否要启用自动登录功能，这个和界面上的下次自动登录无关。

只有在enableAutoLogin为true的情况下，如果选择了下次自动登录，那么就会把用户信息存储起来放到cookie中并设置cookie的有效期为3600*24*30秒，以用于下次登录，现在我们来看看Yii中是怎样实现的。

一、第一次登录存cookie

1、login 登录功能

1. public function login($identity, $duration = 0) 
2. { 
3.   if ($this->beforeLogin($identity, false, $duration)) { 
4.     $this->switchIdentity($identity, $duration); 
5.     $id = $identity->getId(); 
6.     $ip = Yii::$app->getRequest()->getUserIP(); 
7.     Yii::info("User '$id' logged in from $ip with duration $duration.", __METHOD__); 
8.     $this->afterLogin($identity, false, $duration); 
9.   } 
10.  
11.   return !$this->getIsGuest(); 
12. } 

在这里，就是简单的登录，然后执行switchIdentity方法，设置认证信息。

2、switchIdentity设置认证信息

1. public function switchIdentity($identity, $duration = 0) 
2. { 
3.   $session = Yii::$app->getSession(); 
4.   if (!YII_ENV_TEST) { 
5.     $session->regenerateID(true); 
6.   } 
7.   $this->setIdentity($identity); 
8.   $session->remove($this->idParam); 
9.   $session->remove($this->authTimeoutParam); 
10.   if ($identity instanceof IdentityInterface) { 
11.     $session->set($this->idParam, $identity->getId()); 
12.     if ($this->authTimeout !== null) { 
13.       $session->set($this->authTimeoutParam, time() + $this->authTimeout); 
14.     } 
15.     if ($duration > 0 && $this->enableAutoLogin) { 
16.       $this->sendIdentityCookie($identity, $duration); 
17.     } 
18.   } elseif ($this->enableAutoLogin) { 
19.     Yii::$app->getResponse()->getCookies()->remove(new Cookie($this->identityCookie)); 
20.   } 
21. } 

这个方法比较重要，在退出的时候也需要调用这个方法。

这个方法主要有三个功能

设置session的有效期

如果cookie的有效期大于0并且允许自动登录，那么就把用户的认证信息保存到cookie中，如果允许自动登录，删除cookie信息。这个是用于退出的时候调用的。退出的时候传递进来的$identity为null

1. protected function sendIdentityCookie($identity, $duration) 
2. { 
3.   $cookie = new Cookie($this->identityCookie); 
4.   $cookie->value = json_encode([ 
5.     $identity->getId(), 
6.     $identity->getAuthKey(), 
7.     $duration, 
8.   ]); 
9.   $cookie->expire = time() + $duration; 
10.   Yii::$app->getResponse()->getCookies()->add($cookie); 
11. } 

存储在cookie中的用户信息包含有三个值：

1. $identity->getId() 
2. $identity->getAuthKey() 
3. $duration 

getId()和getAuthKey()是在IdentityInterface接口中的。我们也知道在设置User组件的时候，这个User Model是必须要实现IdentityInterface接口的。所以，可以在User Model中得到前两个值，第三值就是cookie的有效期。

二、自动从cookie登录

从上面我们知道用户的认证信息已经存储到cookie中了，那么下次的时候直接从cookie里面取信息然后设置就可以了。

1、AccessControl用户访问控制

Yii提供了AccessControl来判断用户是否登录，有了这个就不需要在每一个action里面再判断了

1. public function behaviors() 
2.  { 
3.    return [ 
4.      'access' => [ 
5.        'class' => AccessControl::className(), 
6.        'only' => ['logout'], 
7.        'rules' => [ 
8.          [ 
9.            'actions' => ['logout'], 
10.            'allow' => true, 
11.            'roles' => ['@'], 
12.          ], 
13.        ], 
14.      ], 
15.    ]; 
16.  } 

2、getIsGuest、getIdentity判断是否认证用户

isGuest是自动登录过程中最重要的属性。

在上面的AccessControl访问控制里面通过IsGuest属性来判断是否是认证用户，然后在getIsGuest方法里面是调用getIdentity来获取用户信息，如果不为空就说明是认证用户，否则就是游客（未登录）。

1. public function getIsGuest($checkSession = true) 
2.  { 
3.    return $this->getIdentity($checkSession) === null; 
4.  } 
5.  public function getIdentity($checkSession = true) 
6.  { 
7.    if ($this->_identity === false) { 
8.      if ($checkSession) { 
9.        $this->renewAuthStatus(); 
10.      } else { 
11.        return null; 
12.      } 
13.    } 
14.  
15.    return $this->_identity; 
16.  } 

3、renewAuthStatus 重新生成用户认证信息

1. protected function renewAuthStatus() 
2.  { 
3.    $session = Yii::$app->getSession(); 
4.    $id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null; 
5.  
6.    if ($id === null) { 
7.      $identity = null; 
8.    } else { 
9.      /** @var IdentityInterface $class */ 
10.      $class = $this->identityClass; 
11.      $identity = $class::findIdentity($id); 
12.    } 
13.  
14.    $this->setIdentity($identity); 
15.  
16.    if ($this->authTimeout !== null && $identity !== null) { 
17.      $expire = $session->get($this->authTimeoutParam); 
18.      if ($expire !== null && $expire < time()) { 
19.        $this->logout(false); 
20.      } else { 
21.        $session->set($this->authTimeoutParam, time() + $this->authTimeout); 
22.      } 
23.    } 
24.  
25.    if ($this->enableAutoLogin) { 
26.      if ($this->getIsGuest()) { 
27.        $this->loginByCookie(); 
28.      } elseif ($this->autoRenewCookie) { 
29.        $this->renewIdentityCookie(); 
30.      } 
31.    } 
32.  } 

这一部分先通过session来判断用户，因为用户登录后就已经存在于session中了。然后再判断如果是自动登录，那么就通过cookie信息来登录。

4、通过保存的Cookie信息来登录 loginByCookie

1. protected function loginByCookie() 
2.  { 
3.    $name = $this->identityCookie['name']; 
4.    $value = Yii::$app->getRequest()->getCookies()->getValue($name); 
5.    if ($value !== null) { 
6.      $data = json_decode($value, true); 
7.      if (count($data) === 3 && isset($data[0], $data[1], $data[2])) { 
8.        list ($id, $authKey, $duration) = $data; 
9.        /** @var IdentityInterface $class */ 
10.        $class = $this->identityClass; 
11.        $identity = $class::findIdentity($id); 
12.        if ($identity !== null && $identity->validateAuthKey($authKey)) { 
13.          if ($this->beforeLogin($identity, true, $duration)) { 
14.            $this->switchIdentity($identity, $this->autoRenewCookie ? $duration : 0); 
15.            $ip = Yii::$app->getRequest()->getUserIP(); 
16.            Yii::info("User '$id' logged in from $ip via cookie.", __METHOD__); 
17.            $this->afterLogin($identity, true, $duration); 
18.          } 
19.        } elseif ($identity !== null) { 
20.          Yii::warning("Invalid auth key attempted for user '$id': $authKey", __METHOD__); 
21.        } 
22.      } 
23.    } 
24.  } 

先读取cookie值，然后$data = json_decode($value, true);反序列化为数组。

这个从上面的代码可以知道要想实现自动登录，这三个值都必须有值。另外，在User Model中还必须要实现findIdentity、validateAuthKey这两个方法。

登录完成后，还可以再重新设置cookie的有效期，这样便能一起有效下去了。

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

三、退出 logout

1. public function logout($destroySession = true) 
2.  { 
3.    $identity = $this->getIdentity(); 
4.    if ($identity !== null && $this->beforeLogout($identity)) { 
5.      $this->switchIdentity(null); 
6.      $id = $identity->getId(); 
7.      $ip = Yii::$app->getRequest()->getUserIP(); 
8.      Yii::info("User '$id' logged out from $ip.", __METHOD__); 
9.      if ($destroySession) { 
10.        Yii::$app->getSession()->destroy(); 
11.      } 
12.      $this->afterLogout($identity); 
13.    } 
14.  
15.    return $this->getIsGuest(); 
16.  } 
17.  
18.  
19.  public function switchIdentity($identity, $duration = 0) 
20.  { 
21.    $session = Yii::$app->getSession(); 
22.    if (!YII_ENV_TEST) { 
23.      $session->regenerateID(true); 
24.    } 
25.    $this->setIdentity($identity); 
26.    $session->remove($this->idParam); 
27.    $session->remove($this->authTimeoutParam); 
28.    if ($identity instanceof IdentityInterface) { 
29.      $session->set($this->idParam, $identity->getId()); 
30.      if ($this->authTimeout !== null) { 
31.        $session->set($this->authTimeoutParam, time() + $this->authTimeout); 
32.      } 
33.      if ($duration > 0 && $this->enableAutoLogin) { 
34.        $this->sendIdentityCookie($identity, $duration); 
35.      } 
36.    } elseif ($this->enableAutoLogin) { 
37.      Yii::$app->getResponse()->getCookies()->remove(new Cookie($this->identityCookie)); 
38.    } 
39.  } 

退出的时候先把当前的认证设置为null，然后再判断如果是自动登录功能则再删除相关的cookie信息。

Tags: Yii框架

分享到：