Golang轻量级I/O事件通知库event使用指南

event是一个轻量级的Go语言I/O事件通知库，它提供了一种简单的方式来监控文件描述符上的I/O事件。下面我将详细介绍如何使用这个库。

安装

首先安装event库：

go get github.com/smallnest/event

基本使用

1. 创建事件循环

package main

import (
	"fmt"
	"github.com/smallnest/event"
	"os"
	"time"
)

func main() {
    // 创建事件循环
    loop, err := event.NewEventLoop()
    if err != nil {
        fmt.Println("Failed to create event loop:", err)
        return
    }
    defer loop.Close()
    
    // 启动事件循环
    go loop.Run()
    
    // 在这里添加事件监控...
}

2. 监控文件描述符

func watchFile(loop *event.EventLoop) {
    // 打开文件
    file, err := os.Open("test.txt")
    if err != nil {
        fmt.Println("Failed to open file:", err)
        return
    }
    defer file.Close()
    
    // 添加读事件监控
    err = loop.AddRead(file.Fd(), func(fd uintptr, extra interface{}) {
        fmt.Printf("File %d is readable\n", fd)
        
        // 读取文件内容
        buf := make([]byte, 1024)
        n, err := file.Read(buf)
        if err != nil {
            fmt.Println("Read error:", err)
            return
        }
        fmt.Printf("Read %d bytes: %s\n", n, string(buf[:n]))
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to add read event:", err)
    }
}

3. 监控定时器事件

func watchTimer(loop *event.EventLoop) {
    // 添加定时器
    timerID, err := loop.AddTimer(2*time.Second, true, func(fd uintptr, extra interface{}) {
        fmt.Println("Timer fired!")
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to add timer:", err)
        return
    }
    
    // 5秒后删除定时器
    time.AfterFunc(5*time.Second, func() {
        loop.DeleteTimer(timerID)
        fmt.Println("Timer removed")
    })
}

高级特性

1. 监控网络socket

func watchSocket(loop *event.EventLoop) {
    // 创建TCP监听
    ln, err := net.Listen("tcp", ":8080")
    if err != nil {
        fmt.Println("Listen error:", err)
        return
    }
    defer ln.Close()
    
    // 监控监听socket的可读事件(新连接)
    err = loop.AddRead(ln.(*net.TCPListener).Fd(), func(fd uintptr, extra interface{}) {
        conn, err := ln.Accept()
        if err != nil {
            fmt.Println("Accept error:", err)
            return
        }
        fmt.Println("New connection from:", conn.RemoteAddr())
        
        // 监控新连接的读事件
        go handleConnection(loop, conn.(*net.TCPConn))
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to monitor listener:", err)
    }
}

func handleConnection(loop *event.EventLoop, conn *net.TCPConn) {
    defer conn.Close()
    
    err := loop.AddRead(conn.Fd(), func(fd uintptr, extra interface{}) {
        buf := make([]byte, 1024)
        n, err := conn.Read(buf)
        if err != nil {
            fmt.Println("Read error:", err)
            loop.Delete(fd) // 移除监控
            return
        }
        fmt.Printf("Received %d bytes: %s\n", n, string(buf[:n]))
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to monitor connection:", err)
    }
}

2. 事件优先级

event库支持设置事件优先级：

// 添加高优先级读事件
err := loop.AddReadWithPriority(file.Fd(), event.HighPriority, func(fd uintptr, extra interface{}) {
    // 处理高优先级事件
}, nil)

注意事项

1. 事件回调函数应该尽量快速执行，避免阻塞事件循环
2. 在回调函数中删除当前事件是安全的
3. 跨goroutine调用EventLoop的方法需要自己处理同步问题
4. 文件描述符关闭后会自动从事件循环中移除

完整示例

package main

import (
	"fmt"
	"github.com/smallnest/event"
	"os"
	"time"
)

func main() {
    loop, err := event.NewEventLoop()
    if err != nil {
        fmt.Println("Failed to create event loop:", err)
        return
    }
    defer loop.Close()
    
    go loop.Run()
    
    // 监控文件
    watchFile(loop)
    
    // 监控定时器
    watchTimer(loop)
    
    // 运行10秒
    time.Sleep(10 * time.Second)
}

func watchFile(loop *event.EventLoop) {
    file, err := os.Open("test.txt")
    if err != nil {
        fmt.Println("Failed to open file:", err)
        return
    }
    defer file.Close()
    
    err = loop.AddRead(file.Fd(), func(fd uintptr, extra interface{}) {
        buf := make([]byte, 1024)
        n, err := file.Read(buf)
        if err != nil {
            fmt.Println("Read error:", err)
            return
        }
        fmt.Printf("Read %d bytes: %s\n", n, string(buf[:n]))
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to add read event:", err)
    }
}

func watchTimer(loop *event.EventLoop) {
    timerID, err := loop.AddTimer(2*time.Second, true, func(fd uintptr, extra interface{}) {
        fmt.Println("Timer fired!")
    }, nil)
    
    if err != nil {
        fmt.Println("Failed to add timer:", err)
        return
    }
    
    time.AfterFunc(5*time.Second, func() {
        loop.DeleteTimer(timerID)
        fmt.Println("Timer removed")
    })
}

event库是一个轻量级的解决方案，适合需要简单I/O事件通知的场景。对于更复杂的应用，可以考虑使用更全面的库如gnet或evio。