学了两年半，Yii2的内置事件知多少？

ivhong

2019-06-21

书接上回，我将代码提交到服务器后被小X经理一顿批，她是这样说的。

小X： 你丫不知道yii2自己就有登陆后的事件么？
我：不知道啊，咋的吧？
小X：改！????，然后统计个yii2预定义事件表给我。
我：哦，好的。???

好吧，算咱技术不到家，那就赶紧改吧，先回顾下上一篇我都干了啥，我是在会员登陆后触发了一个事件，既然说有内置的，那就找找吧。

我知道登陆功能是使用yiiwebUser这个类，那应该去那里去找它们。它在@app/vendor/yiisoft/yii2/web/User.php

5分钟以后~

果然，我找到了那个事件，还用了3分钟分析了如何使用，现在把我的研究成果和大家分享下。

对于yii2系统的登陆，yiiwebUser类一共提供了4个事件，如下

const EVENT_BEFORE_LOGIN = 'beforeLogin';
const EVENT_AFTER_LOGIN = 'afterLogin';
const EVENT_BEFORE_LOGOUT = 'beforeLogout';
const EVENT_AFTER_LOGOUT = 'afterLogout';

分别是登陆前后、注销前后，我要使用的是EVENT_AFTER_LOGIN事件，那么如何去使用那？

既然是登陆，还是先看下yiiwebUser中的login方法，看看是否有蛛丝马迹

public function login(IdentityInterface $identity, $duration = 0){

    if ($this->beforeLogin($identity, false, $duration)) {
        $this->switchIdentity($identity, $duration);
        $id = $identity->getId();
        $ip = Yii::$app->getRequest()->getUserIP();
        if ($this->enableSession) {
            $log = "User '$id' logged in from $ip with duration $duration.";
        } else {
            $log = "User '$id' logged in from $ip. Session not enabled.";
        }
        Yii::info($log, __METHOD__);
        $this->afterLogin($identity, false, $duration);
    }

    return !$this->getIsGuest();
}

我看到了 $this->afterLogin($identity, false, $duration)，似乎这个方法是登陆后做了一些事情，那就继续看吧

protected function afterLogin($identity, $cookieBased, $duration){

    $this->trigger(self::EVENT_AFTER_LOGIN, new UserEvent([
        'identity' => $identity,
        'cookieBased' => $cookieBased,
        'duration' => $duration,
    ]));
}

OMG，真的发现了，原来这个方法触发了EVENT_AFTER_LOGIN事件，并且还很贴心的将identity等信息传递给了绑定EVENT_AFTER_LOGIN事件的每一位观察者。

于是思路来了㊙️㊙️㊙️㊙️㊙️㊙️

我只需要在login前绑定EVENT_AFTER_LOGIN事件，然后afterLogin会自动触发所有订阅者。

重构开始

use yii\web\User;
class UserController extends Controller {
    
    public function __construct(){
        //    绑定事件
        $this->on(User::EVENT_AFTER_LOGIN,['app\models\OLog','add']); 
        $this->on(User::EVENT_AFTER_LOGIN,['app\models\Admin','sendMail']); 
        $this->on(User::EVENT_AFTER_LOGIN,['app\models\User','notifyFirend']); 
    }
    
    public function actionIndex(){
        .....
        //    login                
    }
}

我之前定义的EVENT_USER_LOGIN自然可以删除了，上面看到afterLogin方法触发事件的时候已经传递了一个UserEvent，里面含有登陆的详细信息了，我上一篇自己定义的那个UserLoginEvent也就可以删除了。

使用系统自带的事件，真心省了太多代码了，感谢yii2开发团队，感谢你们八倍祖主。

对于登陆主题就重构完了，现在我还需要改下订阅者的代码，毕竟传递给订阅者的$event不一样了，拿一个订阅者举例吧

// User app\models\User.php
class User {
    static public function notifyFirend($event){
        $userId = $event->userId;
        echo "告诉了朋友们我登陆了";
    }
}

我要对其进行小手术，diu一下，手术后的样子如下

// User app\models\User.php
class User {
    static public function notifyFirend($event){
        $userId = $event->identity->id;
        echo "告诉了朋友们我登陆了";
    }
}

ok~
到此为止我们对登陆逻辑的事件处理就完成了，去掉了自定义的事件，绑定了 User::EVENT_AFTER_LOGIN 内置事件。