gohooks

README

Golang Hooks

参考 wordpress 的 hooks 机制实现的 golang hooks（the wordpress filter/action system in golang）

非线程安全

Installation

$ go get -u github.com/gokit/gohooks

Quick start

1. 获取 hooks 全局单例实例

package instance

import "github.com/gokit/gohooks"

func main()  {
	hooks := gohooks.Instance()
	// ...
}

1. 获取一个新的 hooks 实例

package instance

import "github.com/gokit/gohooks"

func main()  {
	hooks := gohooks.NewInstance()
	// ...
}

1. 添加 Filter

package filter

import (
	"fmt"
	"github.com/gokit/gohooks"
)

func main()  {
	hooks := gohooks.Instance()

	hooks.AddFilter("increase", func(data interface{}, params ...interface{}) (interface{}, error) {
    
    		switch data := data.(type) {
    		case int:
    			return data + 1, nil
    		}
    
    		return data, nil
	}, gohooks.DefaultPriority)
    
	data, e :=hooks.ApplyFilter("increase", 1)
    
	fmt.Println(data, e)
}

1. 添加 Action

package main

import (
	"fmt"
	"github.com/gokit/gohooks"
)

func main() {
	hooks := gohooks.Instance()

	hooks.AddAction("test", func(params ...interface{}) {

		fmt.Println(params)

	}, gohooks.DefaultPriority)

	hooks.DoAction("test", 1, 2, 3, 4)
}

1. 其他接口

// 获取全局 hooks 单例
gohooks.Instance()
// 获取新的 hooks 实例
gohooks.NewInstance()
// 添加 Filter
hooks.AddFilter(tag, filter, priority)
// 移除 Filter
hooks.RemoveFilter(tag, filter, priority)
// 移除所有 Filter
hooks.RemoveAllFilter(tag, priority)
// 添加 Filter
hooks.HasFilter(tag, filter)
// 添加 Action
hooks.AddAction(tag, action, priority)
// 移除 Action
hooks.RemoveAction(tag, action, priority)
// 移除所有 Action
hooks.RemoveAllAction(tag, priority)
// 添加 Action
hooks.HasAction(tag, action)

Documentation

Index

• Constants
• func AddAction(tag string, action Action, priority int) bool
• func AddFilter(tag string, filter Filter, priority int) bool
• func ApplyFilter(tag string, data interface{}, params ...interface{}) (interface{}, error)
• func DoAction(tag string, params ...interface{})
• func HasAction(tag string, action Action) ([]int, bool)
• func HasFilter(tag string, filter Filter) ([]int, bool)
• func Instance() *hooks
• func NewInstance() *hooks
• func RemoveAction(tag string, action Action, priority int) bool
• func RemoveAllAction(tag string, priority int) bool
• func RemoveAllFilter(tag string, priority int) bool
• func RemoveFilter(tag string, filter Filter, priority int) bool
• type Action
• type Filter

Constants

const AllPriority = 0

移除所有 Filter 和 Action 时用到的排序值

const DefaultPriority = 10

默认排序

Functions

func AddAction

func AddAction(tag string, action Action, priority int) bool

添加 Action priority 建议使用大于 0 的值

func AddFilter

func AddFilter(tag string, filter Filter, priority int) bool

添加 Filter priority 建议使用大于 0 的值

func ApplyFilter

func ApplyFilter(tag string, data interface{}, params ...interface{}) (interface{}, error)

执行 Filter

func DoAction

func DoAction(tag string, params ...interface{})

执行 Action

func HasAction

func HasAction(tag string, action Action) ([]int, bool)

判断 hooks 中是否已经存在指定的 Action，如果存在则返回其 priority 列表

func HasFilter

func HasFilter(tag string, filter Filter) ([]int, bool)

判断 hooks 中是否已经存在指定的 Filter，如果存在则返回其 priority 列表

func Instance

func Instance() *hooks

获取 hooks 的单例

func NewInstance

func NewInstance() *hooks

新建一个 hooks 实例

func RemoveAction

func RemoveAction(tag string, action Action, priority int) bool

移除指定 tag 中指针相同并且排序相同的 Action priority 为 0 则忽略 priority 并移除 tag 下所有匹配的 Action

func RemoveAllAction

func RemoveAllAction(tag string, priority int) bool

移除指定 tag 中 指定 priority 的 Action priority 为 0 则忽略 priority 并移除 tag 下所有匹配的 Action

func RemoveAllFilter

func RemoveAllFilter(tag string, priority int) bool

移除指定 tag 中 指定 priority 的 Filter priority 为 0 则忽略 priority 并移除 tag 下所有匹配的 Filter

func RemoveFilter

func RemoveFilter(tag string, filter Filter, priority int) bool

移除指定 tag 中指针相同并且排序相同的 Filter priority 为 0 则忽略 priority 并移除 tag 下所有匹配的 Filter

Types

type Action

type Action func(...interface{})

Action 接口

type Filter

type Filter func(interface{}, ...interface{}) (interface{}, error)

Filter 接口 - 对输入的参数进行过滤，返回值将作为下一个 Filter 的第一个入参