Implementierungsmethode für automatische Anmeldung und Anmelde- und Exit-Funktionen des Yii2-Frameworks

Das Prinzip der automatischen Anmeldung ist sehr einfach. Dies wird hauptsächlich durch die Verwendung von Cookies erreicht.

Wenn die Anmeldung zum ersten Mal erfolgreich ist und die automatische Anmeldung beim nächsten Mal ausgewählt wird, werden die Authentifizierungsinformationen des Benutzers und die Gültigkeitsdauer des Cookies im Cookie gespeichert beträgt 1 Jahr oder Monat.

Stellen Sie bei der nächsten Anmeldung zunächst fest, ob die Benutzerinformationen im Cookie gespeichert sind. Wenn ja, verwenden Sie die im Cookie gespeicherten Benutzerinformationen, um sich anzumelden.

Konfigurieren Sie die Benutzerkomponente

Legen Sie zunächst die Benutzerkomponente in den Komponenten der Konfigurationsdatei fest

'user' => [
 'identityClass' => 'app\models\User',
 'enableAutoLogin' => true,
],

Wir sehen enableAutoLogin Wird verwendet, um zu bestimmen, ob die automatische Anmeldefunktion aktiviert werden soll. Dies hat nichts mit der nächsten automatischen Anmeldung auf der Schnittstelle zu tun.

Nur ​​wenn enableAutoLogin wahr ist und Sie sich beim nächsten Mal für die automatische Anmeldung entscheiden, werden die Benutzerinformationen in einem Cookie gespeichert und die Gültigkeitsdauer des Cookies wird auf 3600* gesetzt. 24 *30 Sekunden für die nächste Anmeldung

Jetzt schauen wir uns an, wie es in Yii implementiert wird.

1. Cookies speichern, wenn Sie sich zum ersten Mal anmelden

1. Anmeldefunktion

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

Melden Sie sich hier einfach an und führen Sie dann die Methode switchIdentity aus, um die Authentifizierungsinformationen festzulegen.

2. switchIdentity legt Authentifizierungsinformationen fest

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

Diese Methode ist wichtiger und muss beim Beenden aufgerufen werden.

Diese Methode hat hauptsächlich drei Funktionen

① Legen Sie die Gültigkeitsdauer der Sitzung fest

② Wenn die Gültigkeitsdauer des Cookies größer als 0 ist und eine automatische Anmeldung zulässig ist, Speichern Sie dann die Authentifizierungsinformationen des Benutzers unter

③ im Cookie. Wenn die automatische Anmeldung zulässig ist, löschen Sie die Cookie-Informationen. Dies wird beim Verlassen aufgerufen. Die beim Beenden übergebene $identity ist 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);
}

Die im Cookie gespeicherten Benutzerinformationen enthalten drei Werte:

$identity->getId()<code>$identity->getId()<br/>$identity->getAuthKey()<br/>$duration$identity->getAuthKey()

$duration

getId() und getAuthKey() sind in IdentityInterface

in der Schnittstelle. Wir wissen auch, dass beim Einrichten der Benutzerkomponente das Benutzermodell die IdentityInterface-Schnittstelle implementieren muss. Daher können Sie die ersten beiden Werte im Benutzermodell abrufen und der dritte Wert ist die Gültigkeitsdauer des Cookies.

2. Automatisch über Cookie anmelden

Aus dem oben Gesagten wissen wir, dass die Authentifizierungsinformationen des Benutzers im Cookie gespeichert wurden, also als nächstes Zeit Holen Sie sich einfach die Informationen direkt aus dem Cookie und setzen Sie sie.

1. AccessControl-Benutzerzugriffskontrolle

Yii bietet AccessControl, um festzustellen, ob der Benutzer angemeldet ist. Dadurch ist es nicht nötig, bei jeder Aktion erneut zu urteilen

public function behaviors()
{
  return [
   'access' => [
    'class' => AccessControl::className(),
    'only' => ['logout'],
    'rules' => [
     [
      'actions' => ['logout'],
      'allow' => true,
      'roles' => ['@'],
     ],
    ],
   ],
  ];
}

2. getIsGuest und getIdentity bestimmen, ob der Benutzer authentifiziert werden soll

isGuest ist das wichtigste Attribut bei der automatischen Anmeldung Verfahren.

Verwenden Sie in der oben genannten AccessControl-Zugriffskontrolle das Attribut IsGuest, um zu bestimmen, ob es sich um einen authentifizierten Benutzer handelt, und rufen Sie dann getIdentity in der getIsGuest-Methode < auf 🎜> Rufen Sie die Benutzerinformationen ab. Wenn diese nicht leer sind, bedeutet dies, dass es sich um einen authentifizierten Benutzer handelt, andernfalls handelt es sich um einen Besucher (nicht angemeldet).

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 regeneriert Benutzerauthentifizierungsinformationen

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

Dies Der Teil ermittelt zunächst den Benutzer über die Sitzung, da der Benutzer nach der Anmeldung bereits in der Sitzung vorhanden ist. Stellen Sie dann fest, ob es sich um eine automatische Anmeldung handelt, und melden Sie sich dann über die Cookie-Informationen an.

4. Melden Sie sich über die gespeicherten Cookie-Informationen loginByCookie an

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

Lesen Sie zuerst den Cookie-Wert und dann $data = json_decode($value, true); In Array deserialisieren.

Aus dem obigen Code können wir erkennen, dass diese drei Werte Werte haben müssen, um eine automatische Anmeldung zu erreichen. Darüber hinaus müssen auch die beiden Methoden findIdentity und validateAuthKey im User Model implementiert sein.

Nach dem Anmelden können Sie die Gültigkeitsdauer des Cookies zurücksetzen, sodass es immer gültig ist.

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

3. Abmelden beenden

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

Setzen Sie beim Beenden zunächst die aktuelle Authentifizierung auf Null, stellen Sie dann fest, ob es sich um eine automatische Anmeldefunktion handelt, und löschen Sie dann die relevanten Cookie-Informationen.

Das obige ist der detaillierte Inhalt vonImplementierungsmethode für automatische Anmeldung und Anmelde- und Exit-Funktionen des Yii2-Frameworks. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!