PHP の Yii フレームワークにおけるログイン関数の実装の詳細な解釈、yii Framework_PHP チュートリアル
- WBOYオリジナル
- 2016-07-13 09:44:14947ブラウズ
PHPのYiiフレームワークにおけるログイン関数の実装、yiiフレームワークのログインメカニズムの詳細な解釈
Yii
Yii は、アプリケーション生成時に最も基本的なユーザー ログイン メカニズムをすでに提供しています。 Yii を使用して新しいアプリケーションを生成し、protected/components ディレクトリに入ります。 UserIdentity クラスには次のように public 関数が 1 つだけあります。
リーリー
このクラスを見ただけではログイン制御のプロセスはわかりません。モデル/コントロール/ビューの原則に従って、ログイン プロセスがこれら 3 つの側面に反映されていることがわかります。まず Models フォルダーに入ると、LoginForm クラス ファイルが表示されます。このクラスは CFormModel を継承し、ログイン データとビジネス ロジックをカプセル化するフォーム モデルの派生クラスです。比較のためのコア関数は次のとおりです:
リーリー
もう一度 Control を見ると、siteControler にログインに関連するアクションがあり、それが actionLogin です。その機能は次のとおりです。
リーリー
ログイン アクションは LoginForm に基づいて、ログインするための POST フォームを確認するか、新しいログイン ページをレンダリングします。
最後に、ビュー ファイルはサイト フォルダー内の login.php です。これが表示されるログイン インターフェイスです。
これを整理すると、ログイン インターフェイスでユーザー名とパスワードを入力した後、フォームが LoginForm フォーム モデルをインスタンス化し、検証に基づいてデータを送信する、Yii のユーザー ログイン ロジックの処理が明確にわかります。モデル内の関数とログイン関数は、ルールのルールに従ってフォーム データを検証します。パスワードの検証には認証関数が必要であり、認証関数とログイン関数の検証は両方とも認証関数に基づいています。ユーザーアイデンティティの。したがって、ログインロジックを変更する場合、LgoinFormやloginactionは変更する必要はなく、基本的にはUserIdentityの認証機能を直接変更するだけで十分です。
上記の解析は、Yii が自動生成したユーザーログインのロジック処理コードです。なかなか良い感じですね。ただし、通常、私たちのシステムは多くのユーザーによるアクセスをサポートする必要があります。コード内にユーザー名とパスワードを単にリストするのは明らかに非合理的です。もちろん、データベースに管理を依頼する方がより成熟しています。次の Mysql ステートメントに従って、独自のデータベースに admin テーブルを作成するとします。 リーリー
Mysql テーブルの作成が完了したら、gii を使用して管理モデルを生成します。次に、元のコンポーネントの UserIdentity.php に戻り、認証関数を書き換えて独自のユーザー名とパスワードの検証を実装します。セキュリティ上の理由から、パスワードは sha1 で 2 回暗号化されているため、収集したパスワードを sha1 で 2 回暗号化し、作成した Admin にフォームに入力したユーザー名に該当するユーザーが存在するかどうかを確認し、比較します。暗号化されたパスワード。すべてが完了したら、$this->setState('nick', $user->nick); などの setState 関数を使用して、ユーザーの共通情報を Yii のユーザーのユーザーフィールドに設定できます。文では、 Yii:app()->user->nick を使用して、データベースにクエリせずに、現在ログインしているユーザーのニックネームに直接アクセスできます。そして $user->login_time = date('Y-m-d H:i:s'); はユーザーのログイン時刻を更新し、次の文の save を通じてデータベースに保存します。リーリー
そして、ログインインターフェイスを変更したい場合は、ビュー内のサイトフォルダーにあるlogin.phpに移動し、好みのものにするためにいじってください。このようにして、独自のログインプロセスが完了します。あるとすごく便利じゃないですか～
自動ログインを設定する
自動ログインの原理は非常に簡単です。主に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中的用户信息包含有三个值：
- $identity->getId()
- $identity->getAuthKey()
- $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信息。