À propos de l'implémentation de la fonction de connexion dans le framework Yii de PHP

Cet article présente principalement l'interprétation détaillée de l'implémentation de la fonction de connexion dans le framework Yii de PHP, y compris la fonction de connexion automatique via les cookies. Les amis dans le besoin peuvent se référer au

Yii. mécanisme de connexion

Yii fournit déjà le mécanisme de connexion utilisateur le plus basique lors de la génération d'applications. Nous utilisons Yii pour générer une nouvelle application et entrons dans le répertoire protected/components. Nous pouvons voir le fichier UserIdentity.php. Il n'y a qu'une seule fonction publique dans la classe UserIdentity comme suit :

.

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; 
}

Cette classe est en composants et sera chargée au début de l'application. Elle est utilisée pour la vérification utilisateur la plus élémentaire. Vous pouvez voir que la fonction définit simplement deux utilisateurs en même temps. début. démo et administrateur, et les mots de passe sont uniquement démo et administrateur. Si vos utilisateurs sont très limités, vous pouvez directement modifier et ajouter des utilisateurs ici. S'il y en a plus, nous en reparlerons plus tard. Le if else sous la fonction est utilisé pour vérifier si le nom d'utilisateur et le mot de passe sont valides. Lorsqu'une erreur se produit, ERROR_USERNAME_INVALID et ERROR_PASSWORD_INVALID sont générés. En général, la vérification réelle du nom d'utilisateur et du mot de passe est effectuée ici, et un traitement logique de base après la connexion est effectué.
Vous ne pouvez pas voir le processus de contrôle de connexion simplement en regardant cette classe. Suivant les principes Modèle/Contrôle/Vue, nous pouvons voir le processus de connexion reflété dans ces trois aspects. Entrez d'abord dans le dossier Models et vous pourrez voir un fichier de classe LoginForm. Cette classe hérite de CFormModel et est une classe dérivée du modèle de formulaire qui encapsule les données de connexion et la logique métier. Les fonctions principales sont les suivantes :

/** 
 * 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; 
}

L'authentification utilise ici la classe UserIdentity pour vérifier le nom d'utilisateur et le mot de passe, tandis que la fonction de connexion détecte l'identité de l'utilisateur Si elle a été définie et si le code d'erreur est vide, et enfin utilisez la fonction de connexion fournie par Yii pour vous connecter. $duration peut définir la période de validité de l'identité.
En regardant à nouveau Control, il y a une action dans siteControler qui est liée à la connexion, qui est actionLogin. La fonction est la suivante :

/** 
 * 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)); 
}

<🎜. >

Cette connexion L'action est basée sur LoginForm pour POSTER le formulaire afin de vérifier la connexion ou d'afficher une nouvelle page de connexion.

Enfin, le fichier de vue est login.php dans le dossier du site. C'est l'interface de connexion que vous voyez.

En faisant le tri, nous pouvons voir clairement le traitement de la logique de connexion de l'utilisateur de Yii. Après avoir entré le nom d'utilisateur et le mot de passe sur l'interface de connexion, le formulaire POST les données sur le site/connexion instancie un modèle de formulaire LoginForm, et effectuer une détection de connexion basée sur la fonction de validation et la fonction de connexion dans le modèle Validate vérifiera les données du formulaire conformément aux règles de la règle. La vérification du mot de passe nécessite la fonction d'authentification, et la vérification des fonctions d'authentification et de connexion est toutes deux. basé sur la fonction d'authentification de UserIdentity. Par conséquent, si nous modifions la logique de connexion, LgoinForm et loginaction n'ont pas besoin d'être modifiés, et il suffit fondamentalement de modifier directement la fonction d'authentification de UserIdentity.

L'analyse ci-dessus est le code de traitement logique pour la connexion de l'utilisateur généré automatiquement par Yii. Cela a l'air plutôt bien, n'est-ce pas ? Cependant, notre système doit généralement prendre en charge l'accès de nombreux utilisateurs. Il est évidemment irrationnel de simplement lister les noms d'utilisateur et les mots de passe dans le code. Bien sûr, il est plus mature de demander à la base de données de nous aider à le gérer. Supposons que nous créions une table admin dans notre propre base de données selon l'instruction Mysql suivante :

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='管理员表';

Une fois la création de la table Mysql terminée, nous utiliserons gii pour générer le modèle d'administration, nous pouvons alors revenir à UserIdentity.php dans notre composant d'origine et réécrire la fonction d'authentification pour implémenter notre propre vérification de nom d'utilisateur et de mot de passe. Pour des raisons de sécurité, le mot de passe est crypté avec sha1 deux fois, donc le mot de passe collecté est crypté avec sha1 deux fois, puis dans l'administrateur que nous avons créé, nous trouvons s'il existe un utilisateur correspondant au nom d'utilisateur saisi dans le formulaire, puis comparons le mot de passe crypté. Si une fois que tout est réussi, les informations communes de l'utilisateur peuvent être définies dans le champ utilisateur de l'utilisateur de Yii à l'aide de la fonction setState, telle que $this->setState('nick', $user->nick); phrase, vous pouvez directement utiliser Yii:app()->user->nick pour accéder au surnom de l'utilisateur actuellement connecté sans interroger la base de données. Et $user->login_time = date('Y-m-d H:i:s'); met à jour l'heure de connexion de l'utilisateur et l'enregistre dans la base de données via save dans la phrase suivante.

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; 
}

Et si vous souhaitez modifier l'interface de connexion, alors allez dans le login.php dans le dossier site dans la vue et jouez avec Modifiez-le comme vous le souhaitez, afin que notre propre processus de connexion soit terminé. N'est-il pas extrêmement pratique d'avoir 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中的用户信息包含有三个值：

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里面再判断了

 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信息。

以上就是本文的全部内容，希望对大家的学习有所帮助，更多相关内容请关注PHP中文网！

相关推荐：

如何实现修改yii2.0用户登录使用的user表为其它的表

关于php向访客和爬虫显示不同的内容代码

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!