Searching...

[TOC]

gfsnotify能监控指定文件/目录的改变,如文件的增加、删除、修改、重命名等操作。

使用方式:

import "gitee.com/johng/gf/g/os/gfsnotify"

方法列表

godoc.org/github.com/johng-cn/gf/g/os/gfsnotify

func Add(path string, callbackFunc func(event *Event), recursive ...bool) (callback *Callback, err error)
func Remove(path string) error
func RemoveCallback(callbackId int) error

type Event
    func (e *Event) IsChmod() bool
    func (e *Event) IsCreate() bool
    func (e *Event) IsRemove() bool
    func (e *Event) IsRename() bool
    func (e *Event) IsWrite() bool
    func (e *Event) String() string

type Watcher
    func New() (*Watcher, error)
    func (w *Watcher) Add(path string, callbackFunc func(event *Event), recursive ...bool) (callback *Callback, err error)
    func (w *Watcher) Close()
    func (w *Watcher) Remove(path string) error
    func (w *Watcher) RemoveCallback(callbackId int) error

推荐使用gfsnotify模块提供的AddRemove模块方法,用于添加监控和取消监控。推荐原因见随后章节说明。

此外也可能通过New方法创建一个监控管理对象之后再进行监控管理。其中,添加监控的时候需要给定触发监控时的回调函数,参数类型为*gfsnotify.Event对象指针。

添加监听

package main

import (
    "gitee.com/johng/gf/g/os/gfsnotify"
    "gitee.com/johng/gf/g/os/glog"
)

func main() {
    // /home/john/temp 是一个目录,当然也可以指定文件
    path := "/home/john/temp"
    _, err := gfsnotify.Add(path, func(event *gfsnotify.Event) {
        if event.IsCreate() {
            glog.Println("创建文件 : ", event.Path)
        }
        if event.IsWrite() {
            glog.Println("写入文件 : ", event.Path)
        }
        if event.IsRemove() {
            glog.Println("删除文件 : ", event.Path)
        }
        if event.IsRename() {
            glog.Println("重命名文件 : ", event.Path)
        }
        if event.IsChmod() {
            glog.Println("修改权限 : ", event.Path)
        }
        glog.Println(event)
    })
    
    // 移除对该path的监听
    // gfsnotify.Remove(path)

    if err != nil {
        glog.Fatalln(err)
    } else {
        select {}
    }
}

其中/home/john参数为一个目录,gfsnotify.Add方法默认为递归监控,也就是说当目录下的文件(包括子目录下的文件)发生变化时,也会收到文件监控信息回调。

当我们在/home/john目录下创建/删除/修改文件时,可以看到gfsnotify监控到了文件的修改并输出了对应的事件信息。

移除监听

移除监听我们可以使用Remove方法,会移除对整个文件/目录的监听。

当对同一个文件/目录存在多个监听回调时,我们可以通过RemoveCallback方法移除指定的回调。方法参数callbackId是在添加监听时返回的Callback对象的唯一ID。

使用示例1:

package main

import (
    "gitee.com/johng/gf/g/os/gfsnotify"
    "gitee.com/johng/gf/g/os/glog"
    "gitee.com/johng/gf/g/os/gtime"
    "time"
)

func main() {
    c1, err := gfsnotify.Add("/home/john/temp/log", func(event *gfsnotify.Event) {
        glog.Println("callback1")
    })
    if err != nil {
        panic(err)
    }
    c2, err := gfsnotify.Add("/home/john/temp/log", func(event *gfsnotify.Event) {
        glog.Println("callback2")
    })
    if err != nil {
        panic(err)
    }
    // 5秒后移除c1的回调函数注册,仅剩c2
    gtime.SetTimeout(5*time.Second, func() {
        gfsnotify.RemoveCallback(c1.Id)
        glog.Println("remove callback c1")
    })
    // 10秒后移除c2的回调函数注册,所有的回调都移除,不再有任何打印信息输出
    gtime.SetTimeout(10*time.Second, func() {
        gfsnotify.RemoveCallback(c2.Id)
        glog.Println("remove callback c2")
    })

    select {}
}

使用示例2:

package main

import (
    "gitee.com/johng/gf/g/os/gfsnotify"
    "gitee.com/johng/gf/g/os/glog"
    "gitee.com/johng/gf/g/os/gtime"
    "time"
)

func main() {
    callback, err := gfsnotify.Add("/home/john/temp", func(event *gfsnotify.Event) {
        glog.Println("callback")
    })
    if err != nil {
        panic(err)
    }

    // 在此期间创建文件、目录、修改文件、删除文件

    // 20秒后移除回调函数注册,所有的回调都移除,不再有任何打印信息输出
    gtime.SetTimeout(20*time.Second, func() {
        gfsnotify.RemoveCallback(callback.Id)
        glog.Println("remove callback")
    })

    select {}
}

fs.inotify.max_user_instances与fs.inotify.max_user_watches

*nix系统下,gfsnotify模块使用的是系统的inotify特性来实现的文件/目录监控,因此该功能在使用时会受到系统的两个内核函数限制: