Go-Observable 项目教程

Go-Observable 项目教程

go-observableIt allows you to send and receive events with a tiny simple API项目地址:https://gitcode.com/gh_mirrors/go/go-observable

1. 项目的目录结构及介绍

go-observable/
├── LICENSE
├── README.md
├── go.mod
├── go.sum
├── observable.go
└── observable_test.go

• LICENSE: 项目的许可证文件。
• README.md: 项目说明文档，包含项目的基本介绍、安装方法和使用示例。
• go.mod: Go 模块文件，定义了项目的依赖关系。
• go.sum: 依赖包的校验文件。
• observable.go: 项目的主要实现文件，包含事件发送和接收的逻辑。
• observable_test.go: 项目的测试文件，包含单元测试和性能测试。

2. 项目的启动文件介绍

项目的启动文件是 observable.go，它定义了 Observable 结构体和相关的方法。以下是文件的主要内容：

package observable

import (
	"sync"
)

type Observable struct {
	events map[string][]func(interface{})
	mutex  sync.RWMutex
}

func New() *Observable {
	return &Observable{
		events: make(map[string][]func(interface{})),
	}
}

func (o *Observable) On(event string, fn func(interface{})) {
	o.mutex.Lock()
	defer o.mutex.Unlock()
	o.events[event] = append(o.events[event], fn)
}

func (o *Observable) Emit(event string, payload interface{}) {
	o.mutex.RLock()
	defer o.mutex.RUnlock()
	if handlers, ok := o.events[event]; ok {
		for _, handler := range handlers {
			go handler(payload)
		}
	}
}

• Observable 结构体: 用于存储事件和对应的处理函数。
• New 函数: 创建一个新的 Observable 实例。
• On 方法: 订阅一个事件，并绑定处理函数。
• Emit 方法: 触发一个事件，并执行所有绑定的处理函数。

3. 项目的配置文件介绍

该项目没有显式的配置文件，所有的配置和初始化都在代码中完成。如果需要自定义配置，可以通过修改 observable.go 文件中的代码来实现。

例如，可以添加一个配置结构体来存储一些全局配置：

type Config struct {
	MaxHandlers int
}

var defaultConfig = Config{
	MaxHandlers: 10,
}

func SetConfig(config Config) {
	defaultConfig = config
}

通过这种方式，可以在项目启动前设置一些全局配置。

go-observableIt allows you to send and receive events with a tiny simple API项目地址:https://gitcode.com/gh_mirrors/go/go-observable