go监听系统文件变动--fsnotify包的使用

姜泳

2023-12-01

Go 的 fsnotify 的使用

简单介绍一下go中监控文件发生变动的fsnotify包的使用

1、上手使用mynotify.go

逻辑：

使用fsnotify包创建一个“监听器”
设置要监听的文件目录

package main

import (
    "log"
    "github.com/fsnotify/fsnotify"
)

func main() {
    // 创建文件/目录监听器
    watcher, err := fsnotify.NewWatcher()
    if err != nil {
        log.Fatal(err)
    }
    defer watcher.Close()
    done := make(chan bool)
    go func() {
        for {
            select {
            case event, ok := <-watcher.Events:
                if !ok {
                    return
                }
                // 打印监听事件
                log.Println("event:", event)
            case _, ok := <-watcher.Errors:
                if !ok {
                    return
                }
            }
        }
    }()
    // 监听系统的根目录目录
    err = watcher.Add("/root")
    if err != nil {
        log.Fatal(err)
    }
    <-done
}

2、测试

2.1 将mynotify.go编译执行

root@kube-master:~/my-go# go build .
root@kube-master:~/my-go# ./mynotify

2.2 再开启一个shell，创建文件测试

root@kube-master:~# touch mytest.go
root@kube-master:~# rm -f mytest.go 
root@kube-master:~# touch mytest.go
root@kube-master:~# vim mytest.go 
root@kube-master:~# rm -f mytest.go

2.3 观察运行监听程序的shell

2021/08/24 09:19:13 event: "/root/.mytest.go.swp": CREATE
2021/08/24 09:19:13 event: "/root/.mytest.go.swx": REMOVE
2021/08/24 09:19:13 event: "/root/.mytest.go.swp": REMOVE
2021/08/24 09:19:13 event: "/root/.mytest.go.swp": CREATE
2021/08/24 09:19:13 event: "/root/.mytest.go.swp": WRITE
2021/08/24 09:19:13 event: "/root/.mytest.go.swp": CHMOD
2021/08/24 09:19:17 event: "/root/.mytest.go.swp": WRITE
2021/08/24 09:19:33 event: "/root/.mytest.go.swp": WRITE
2021/08/24 09:19:43 event: "/root/4913": REMOVE
2021/08/24 09:19:43 event: "/root/mytest.go": RENAME
2021/08/24 09:19:43 event: "/root/mytest.go~": CREATE
2021/08/24 09:19:43 event: "/root/mytest.go": CREATE
2021/08/24 09:19:43 event: "/root/mytest.go": WRITE
2021/08/24 09:19:43 event: "/root/mytest.go": WRITE
2021/08/24 09:19:43 event: "/root/mytest.go": CHMOD
2021/08/24 09:19:43 event: "/root/mytest.go": CHMOD
2021/08/24 09:19:43 event: "/root/.mytest.go.swp": WRITE
2021/08/24 09:19:43 event: "/root/mytest.go~": REMOVE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": CREATE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": WRITE
2021/08/24 09:19:43 event: "/root/.viminfo": REMOVE
2021/08/24 09:19:43 event: "/root/.viminfo.tmp": RENAME
2021/08/24 09:19:43 event: "/root/.viminfo": CREATE
2021/08/24 09:19:44 event: "/root/.mytest.go.swp": REMOVE
2021/08/24 09:20:05 event: "/root/mytest.go": REMOVE

3、深层原理

fsnotify 是跨平台的实现，奇伢这里只讲 Linux 平台的实现机制。fsnotify 本质上就是对系统能力的一个浅层封装，主要封装了操作系统提供的两个机制：

inotify 机制
epoll 机制；

3.1\ inotify 机制

什么是 inotify 机制？
这是一个内核用于通知用户空间程序文件系统变化的机制。
划重点：其实 inotify 机制的诞生源于一个通用的需求，由于IO/硬件管理都在内核，但用户态是有获悉内核事件的强烈需求，比如磁盘的热插拔，文件的增删改。这里就诞生了三个异曲同工的机制：hotplug 机制、udev 管理机制、inotify 机制。

2 epoll 机制

回到 Go 的 fsnotify 库的实现原理，fsnotify 利用的第二个系统机制就是 epoll 。inotify fd 通过 inotify_init1 创建出来之后，会把 inotify fd 注册进 epoll 管理，监听 inotify fd 的可读事件。
inotify fd 的可读事件能是啥？
就是它监听的文件或者路径发生的增删改的事件嘛，这些事件就是内核 inotify 报上来的。
报上来之后，epoll 监控到 inotify fd 可读，用户通过 read 调用，把 inotify fd 里面的“数据”读出来。这个读出来的所谓的“数据”就是一个个文件事件。

内部细节移步参考：
Go 存储基础 — “文件”被偷偷修改？来，给它装个监控
 深度epoll剖析