title: 事件系统

事件系统

事件机制是一种很好的应用解耦方式。CatLib事件系统让我们可以订阅和监听程序中出现的各种事件。事件系统结合服务容器，将提供更加优秀的事件处理方式。

应用程序已经默认提供了事件系统，供给全局事件使用。如果您要定义私有范围的事件可以这么做：

var dispatcher = new Dispatcher();

名词定义

载荷是指程序调用所附带的上下文信息。不同的调用者所提供的上下文信息各不相同。

注册普通监听器

通过 On 命令您可以注册一个事件的监听器，监听器函数会通过服务容器调用，自动解析并且注入合适的参数。

dispatcher.On("event.name" , (IContainer container)=>{
    //todo
});

除了通过Lambda注册外事件监听器外还能够通过对象方法来注册，一共接收3个参数:

第一个参数为: 监听的事件名
第二个参数为: 事件调用的对象
第三个参数为: 事件调用对象的函数名（可选项）

如果您没有传入第三个参数作为函数名，CatLib事件系统会通过字符串方法分析，来分析事件名，并提取出一个函数名，这一特性在有完整的事件名规范时将会大大简化代码。

class MyClass
{
    public void CallEvent()
    {
        Console.WriteLine("hello world")
    }
}

var cls = new MyClass();
dispatcher.On("MyEvent.CallEvent" , cls); // 分析得出的函数名 : CallEvent

注册通配符监听器

CatLib事件系统允许使用通配符*对事件进行匹配。它让你在一个监听器中可以监听到多个事件。

注意：通配符事件每次事件调用都会被依次检查，您应该控制他们在项目中的数量。

dispatcher.On("event.*" , ()=>{ });
// event.catlib            // 触发事件
// event.catlib.version    // 触发事件
// ev.catlib               // 不触发

触发事件

如果要触发事件，您可以通过Trigger来触发事件。这个函数将会把事件分发到它所有已经注册的监听器上。

dispatcher.Trigger("event.name", userParams);

触发单次事件

通过TriggerHalt您可以限定这次事件的触发只要监听器返回了有效处理结果（不为null）那么就自动终止事件传递。

dispatcher.TriggerHalt("event");

返回处理结果

您可以通过return一个对象，这个对象将会被返回给调用者。

dispatcher.Listen("event" , ()=>{
    return "call complete";
});
dispatcher.Listen("event.*" , ()=>{
    return "call all";
});

dispatcher.TriggerHalt("event");  // call complete
dispatcher.Trigger("event.name"); // object[]{ "call complete" , "call all" }

判断监听器是否存在

您可以通过HasListeners来判断事件监听器是否存在。

该方法接收两个参数：

第一个参数为：事件名
第二个参数为：是否进行严格匹配（可选）, 如果进行严格匹配那么将禁用通配符匹配。

dispatcher.Listen("event.*" , ()=>{
    return "call complete";
});

dispatcher.HasListeners("event.name", false); // true
dispatcher.HasListeners("event.name", true);  // false
dispatcher.HasListeners("event.*", true);     // true

终止事件传递

CatLib事件系统支持返回一个false来终止事件的传递。

dispatcher.Listen("event" , ()=>{
    return false;
});

解除事件监听

您可以通过Off方法来解除事件监听器，该方法支持三种解除方式：

如果传入的是字符串(string)将会解除对应事件名的所有事件
如果传入的是事件对象(IEvent)那么解除对应事件
如果传入的是其他实例(object)会解除该实例下的所有事件

var handler = dispatcher.On("event.*" , (payload)=>{
    //todo
});
dispatcher.Off(handler);