ThinkPHP6.0 event(事件)的使用方法

新版的事件系统可以看成是5.1版本行为系统的升级版，事件系统相比行为系统强大的地方在于事件本身可以是一个类，并且可以更好的支持事件订阅者。

事件相比较中间件的优势是事件比中间件更加精准定位（或者说粒度更细），并且更适合一些业务场景的扩展。例如，我们通常会遇到用户注册或者登录后需要做一系列操作，通过事件系统可以做到不侵入原有代码完成登录的操作扩展，降低系统的耦合性的同时，也降低了BUG的可能性。

TP6.0 文档中关于事件写了很多,有定义事件,有事件监听,还有事件订阅,实在让人头大

在网上翻了多篇博文,最终发现,它们是事件的不同实现方式 /(ㄒoㄒ)/~~

 

1.事件绑定

事件绑定不如其他两种方法使用方便,这里就暂不介绍了

 

2.事件监听

2-1.手动注册事件监听

我们可以手动注册一个事件监听

<?php
namespace app\controller;

use think\facade\Event;

class Index
{
	public function __construct(){
		Event::listen('first', function($param){
			echo $param . '+';
		});
	}
	
    public function index()
    {
    	event('first', 'first success');
        return 111;
    }
}

2-2.使用监听类实现监听

首先我们通过命令行快速生成一个监听类

php think make:listener TestListener

修改 TestListener.php 文件代码

<?php
declare (strict_types = 1);

namespace app\listener;

class TestListener
{
    /**
     * 事件监听处理
     *
     * @return mixed
     */
    public function handle($event)
    {
        //
        echo "testListner监听成功";
    }    
}

然后我们在index控制器中注册监听事件

<?php
namespace app\controller;

use think\facade\Event;

class Index
{
    public function index()
    {
    	Event::listen('test', 'app\listener\TestListener');
    	event('test');
    	
        return 111;
    }
}

此时我们访问index控制器下的index方法就可以看到监听成功的返回了

当然我们有更简便的方法注册监听类!

修改event.php文件,添加事件监听

<?php
// 事件定义文件
return [
    'bind'      => [
    ],

    'listen'    => [
        'AppInit'  => [],
        'HttpRun'  => [],
        'HttpEnd'  => [],
        'LogLevel' => [],
        'LogWrite' => [],
        
        'test' => ['app\listener\TestListener']
    ],

    'subscribe' => [
    ],
];

 

3.事件订阅

可以通过事件订阅机制，在一个监听器中监听多个事件

首先我们通过命令行生成一个订阅类 TestSub.php

<?php
declare (strict_types = 1);

namespace app\subscribe;

class TestSub
{
	public function onTestSub1(){
		echo("testSub1");
	}
	
	public function onTestSub2(){
		echo("testSub2");
	}
}

然后调用这两个事件

<?php
namespace app\controller;

use think\facade\Event;
use think\facade\Db;

class Index
{
    public function index()
    {
    	event('TestSub1');
    	event('TestSub2');
        return 111;
    }
}

此时访问该接口就可以看到这两个事件的结果了

 

4.一些小心得

事件可以被主方法捕获异常！！！

主方法开启事务后,事件中若出现数据库错误,主方法可以捕获该异常并进行回滚等操作

 

首先,我们在 TestSub.php,对两个事件都进行数据库操作,其中一个数据库操作会报错

<?php
declare (strict_types = 1);

namespace app\subscribe;

class TestSub
{
	public function onTestSub1(){
		echo("testSub1");
		
		$data = ['id' => '1', 'username' => 'haha1'];
		\think\facade\Db::name('test')->save($data);
		
		echo("testSub11");
	}
	
	public function onTestSub2(){
		echo("testSub2");
		
		$data = ['id' => '1', 'username' => 'haha1'];
		//test1表并不存在
		\think\facade\Db::name('test1')->save($data);
		
		
		echo("testSub22");
	}
}

然后调用这两个事件,并开启事务

<?php
namespace app\controller;

use think\facade\Event;
use think\facade\Db;

class Index
{
    public function index()
    {
    	Db::startTrans();
		try {
    		event('TestSub1');
    		event('TestSub2');
    		
		    // 提交事务
		    Db::commit();
    	
        	return 111;
		} catch (\Exception $e) {
		    // 回滚事务
		    Db::rollback();
		    echo($e);
    	
        	return 222;
		}
    }
}

此时调用此方法,就会抛出异常,并且所有数据库操作都不会提交