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' environmentconfig['bootstrap'][] = 'debug';
config['modules']['debug'] = [
'class' => 'yii\debug\Module',
];config['bootstrap'][] = 'gii';
config['modules']['gii'] = [
'class' => 'yii\gii\Module',
];
}
returnconfig;
?>
在上述配置中,用户的身份类配置为 app\models\User。 身份类必须实现 yii\web\IdentityInterface 接口,具有以下方法:
- findIdentity() – 使用指定的用户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;
publicusername;
public password;
publicauthKey;
public accessToken;
private staticusers = [
'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 asuser) {
if (strcasecmp(user['username'],username) === 0) {
return new static(user);
}
}
return null;
}
/**
* @inheritdoc
*/
public function getId() {
returnthis->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 − 打开以下网址: http://localhost:8080/index.php?r=site/login 使用管理员账号和密码登录网站。
步骤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 浏览器中输入地址 http://localhost:8080/index.php?r=site/auth ,您将看到关于 管理员 用户的详细信息。
步骤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 neededidentity = 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 http://localhost: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 - 在成功登出后触发