golang全局事件触发器插件库go-trigger的使用

简介

Go Trigger是一个Golang的全局事件触发器。你可以定义一个事件并为其指定任务，然后从任何地方触发它。

安装

$ go get -u github.com/sadlil/go-trigger

如何使用

1. 全局事件

导入包到你的代码中。使用trigger.On方法添加事件，使用trigger.Fire方法调用事件处理器。所有这样添加的事件都是全局事件，可以从任何地方调用Fire。

package main

import (
  "github.com/sadlil/go-trigger"
  "fmt"
)

func main() {
  // 添加一个事件
  trigger.On("first-event", func() {
    // 在这里执行任务
    fmt.Println("Done")
  })
  // 触发事件
  trigger.Fire("first-event")
}

你也可以从另一个包中定义事件：

trigger.On("second-event", packagename.FunctionName)
trigger.Fire("second-event")

可以定义带参数和返回类型的事件：

func TestFunc(a, b int) int {
    return a + b
}

// 调用方式
trigger.On("third-event", TestFunc)
values, err := trigger.Fire("third-event", 5, 6)

// 重要：你需要使用类型转换返回值
// values[0].Int()

你可以在一个包中定义事件，在另一个包中触发它。事件和触发器都是全局的。定义在任何地方，触发在任何地方。

//---------------------------------------------
package a

func AFunction(one, two int) int {
    return one + two
}

//---------------------------------------------
package b
import (
    "yourdirectory/a"
    "github.com/sadlil/go-trigger"
)

func() {
    trigger.On("new-event", a.AFunction)
}

//---------------------------------------------
package c
import (
    "github.com/sadlil/go-trigger"
)

func() {
    values, err := trigger.Fire("new-event", 10, 10) 
    // 这里不需要导入包a
    fmt.Println(values[0].Int())
}

可以使用FireBackground()在后台运行事件：

func main() {
  trigger.On("first-event", func() {
    for i := 1; i <= 1000; i++ {
      fmt.Println(i)
    }
  })
  channel, err := trigger.FireBackground("first-event")
  fmt.Println("Event runs")
  // 读取返回的通道
  values := <- channel
  
  trigger.FireBackground("first-event")
  fmt.Println("Running 2nd Event")
}

2. 本地事件

Trigger实例不会影响全局事件。所有添加到本地事件实例的事件只能通过该触发器实例调用。这是可插拔Trigger接口的实现。

创建一个本地触发器实例：

package main

import (
  "github.com/sadlil/go-trigger"
  "fmt"
)

func main() {
  t := trigger.New()
  t.On("first-event", func() {
    // 在这里执行任务
    fmt.Println("Done")
  })
  t.Fire("first-event")
  
  // t2是另一个与t1分离的触发器实例
  t2 := trigger.New()
  t2.On("first-event", func() {
    // 在这里执行任务
    fmt.Println("Done")
  })
  t2.Fire("first-event")
}

可用方法

On(event string, task interface{}) error
  - 添加一个事件。task必须是函数。如果事件重复则抛出错误。
   
Fire(event string, params ...interface{}) ([]reflect.Value, error)
  - 触发指定事件的任务。params是参数，[]是任务的返回值。Fire触发事件并等待它结束，直到执行后续代码。
  
FireBackground(event string, params ...interface{}) (chan []reflect.Value, error)
  - 触发指定事件的任务。与Fire不同，它在go routine中后台运行事件。它触发事件但不等待事件结束。它将事件的返回值写入通道并返回reflect.Values的通道。你可以通过读取通道获取返回值(例如 ret := <- returned channel)。
  
  - 由于FireBackground不等待事件首先结束，如果你的程序退出，它将停止任何未完成的运行事件。因此请确保你的后台事件在程序结束前退出。

Clear(event string) error
  - 从事件列表中删除一个事件。如果未找到事件则抛出错误。
  
ClearEvents()
  - 从事件列表中删除所有事件。
  
HasEvent(event string) bool
  - 检查事件是否存在。如果事件列表中有该键的事件则返回true。否则返回false。
  
Events() []string
  - 返回所有添加的事件。
  
EventCount() int
  - 返回事件的计数。如果没有找到则返回0。

开发中的特性

1. 一个事件的多个事件处理器

许可证

Licenced under MIT Licence

任何建议和错误报告都将非常感激。