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

使用方式

  1. import "github.com/gogf/gf/v2/os/gfsnotify"

接口文档

https://pkg.go.dev/github.com/gogf/gf/v2/os/gfsnotify

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

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

添加监听

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/os/gctx"
  4. "github.com/gogf/gf/v2/os/gfsnotify"
  5. "github.com/gogf/gf/v2/os/glog"
  6. )
  7. func main() {
  8. // /home/john/temp 是一个目录,当然也可以指定文件
  9. path := "/home/john/temp"
  10. ctx := gctx.New()
  11. _, err := gfsnotify.Add(path, func(event *gfsnotify.Event) {
  12. if event.IsCreate() {
  13. glog.Debug(ctx, "创建文件 : ", event.Path)
  14. }
  15. if event.IsWrite() {
  16. glog.Debug(ctx, "写入文件 : ", event.Path)
  17. }
  18. if event.IsRemove() {
  19. glog.Debug(ctx, "删除文件 : ", event.Path)
  20. }
  21. if event.IsRename() {
  22. glog.Debug(ctx, "重命名文件 : ", event.Path)
  23. }
  24. if event.IsChmod() {
  25. glog.Debug(ctx, "修改权限 : ", event.Path)
  26. }
  27. glog.Debug(ctx, event)
  28. }, true)
  29. // 移除对该path的监听
  30. // gfsnotify.Remove(path)
  31. if err != nil {
  32. glog.Fatal(ctx, err)
  33. } else {
  34. select {}
  35. }
  36. }

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

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

移除监听

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

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

使用示例1:

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/os/gctx"
  4. "github.com/gogf/gf/v2/os/gfsnotify"
  5. "github.com/gogf/gf/v2/os/glog"
  6. "github.com/gogf/gf/v2/os/gtimer"
  7. "time"
  8. )
  9. func main() {
  10. ctx := gctx.New()
  11. c1, err := gfsnotify.Add("/home/john/temp/log", func(event *gfsnotify.Event) {
  12. glog.Debug(ctx, "callback1")
  13. })
  14. if err != nil {
  15. panic(err)
  16. }
  17. c2, err := gfsnotify.Add("/home/john/temp/log", func(event *gfsnotify.Event) {
  18. glog.Debug(ctx, "callback2")
  19. })
  20. if err != nil {
  21. panic(err)
  22. }
  23. // 5秒后移除c1的回调函数注册,仅剩c2
  24. gtimer.SetTimeout(5*time.Second, func() {
  25. gfsnotify.RemoveCallback(c1.Id)
  26. glog.Debug(ctx, "remove callback c1")
  27. })
  28. // 10秒后移除c2的回调函数注册,所有的回调都移除,不再有任何打印信息输出
  29. gtimer.SetTimeout(10*time.Second, func() {
  30. gfsnotify.RemoveCallback(c2.Id)
  31. glog.Debug(ctx, "remove callback c2")
  32. })
  33. select {}
  34. }

使用示例2:

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/os/gctx"
  4. "github.com/gogf/gf/v2/os/gfsnotify"
  5. "github.com/gogf/gf/v2/os/glog"
  6. "github.com/gogf/gf/v2/os/gtimer"
  7. "time"
  8. )
  9. func main() {
  10. ctx := gctx.New()
  11. callback, err := gfsnotify.Add("/home/john/temp", func(event *gfsnotify.Event) {
  12. glog.Debug(ctx, "callback")
  13. })
  14. if err != nil {
  15. panic(err)
  16. }
  17. // 在此期间创建文件、目录、修改文件、删除文件
  18. // 20秒后移除回调函数注册,所有的回调都移除,不再有任何打印信息输出
  19. gtimer.SetTimeout(20*time.Second, func() {
  20. gfsnotify.RemoveCallback(callback.Id)
  21. glog.Debug(ctx, "remove callback")
  22. })
  23. select {}
  24. }

fs.inotify.max_user_instances与fs.inotify.max_user_watches

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

  • fs.inotify.max_user_instances:表示当前用户可创建的inotify监控实例数量,即gfsnotify.New方法创建的Watcher对象数量,一个Watcher对象对应系统的一个inotify实例,系统默认数量为:128

  • fs.inotify.max_user_watches:表示一个inotify实例可添加的监控文件队列大小,往同一个inotify添加的监控文件超过该数量限制则会失败,并且会有系统错误日志,系统默认数量往往为:8192(有的系统该数值会比较大一些);