Go語言fsnotify接口實現(xiàn)監(jiān)測文件修改

更新時間：2022年06月27日 14:30:06 作者：Go語言由淺入深

這篇文章主要為大家介紹了Go語言fsnotify接口實現(xiàn)監(jiān)測文件修改的示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

引言

在開發(fā)過程中，經(jīng)常需要觀察本地文件系統(tǒng)的更改。經(jīng)過谷歌了幾個小時后，到了一個簡單的工具來做這件事。

該工具就是fsnotify是一個Go跨平臺文件系統(tǒng)通知工具。它提供了一個簡單的接口來監(jiān)測本地文件系統(tǒng)中的更改。

本文我們就來看看如何使用這個工具。

安裝工具

$ go get github.com/fsnotify/fsnotify

關(guān)鍵類型

我們先來了解下fsnotify工具的所有類型。

Event結(jié)構(gòu)體

Event結(jié)構(gòu)體表示單個文件系統(tǒng)通知。

函數(shù)String()返回一個“file: REMOVE|WRITE|…”格式字符串表示事件的字符串。

type Event struct {
    Name string    //文件或目錄的相對路徑
    Op      Op       //文件更改事件
}
func (e Event) String() string

Op類型

該工具描述了一組文件操作。它們是可以觸發(fā)通知的通用文件操作。

type Op uint32
const (
    Create Op = 1 &lt;&lt; iota
    Write
    Remove
    Rename
    Chmod
)

Watcher結(jié)構(gòu)體

Watcher結(jié)構(gòu)體是該工具的核心。包含兩個channel和三個函數(shù)。

type Watcher struct {
    Events chan Event
    Errors chan error
    ...
}
func (w *Watcher) Add(name string) error
func (w *Watcher) Remove(name string) error 
func NewWatcher() (*Watcher, error)

Channel

Events 通道
Errors 通道

函數(shù)

Add：非遞歸監(jiān)測文件或目錄的變化。
Remove：停止監(jiān)測文件或目錄。
Close：關(guān)閉所有文件或目錄的監(jiān)測以及關(guān)閉Events通道。

Watcher工廠函數(shù)

函數(shù)NewWatcher通過底層操作系統(tǒng)調(diào)用創(chuàng)建watcher對象，并等待事件通知。

func NewWatcher() (*Watcher, error)

完整例子

import (
    "log"
    "github.com/fsnotify/fsnotify"
)
func main() {
    watcher, err := fsnotify.NewWatcher()
    if err != nil {
        log.Fatal("new watcher failed: ", err)
    }
    defer watcher.Close()
    done := make(chan bool)
    go func() {
        defer close(done)
        for {
            select {
            case event, ok := <-watcher.Events:
                if !ok {
                    return
                }
                log.Printf("%s %s\n", event.Name, event.Op)
            case err, ok := <-watcher.Errors:
                if !ok {
                    return
                }
                log.Println("error: ", err)
            }
        }
    }()
    err = watcher.Add("./")
    if err != nil {
        log.Fatal("add failed:", err)
    }
    <-done
}

上面的代碼通過啟動一個goroutine在后臺監(jiān)測目錄或文件的變化，調(diào)用函數(shù)watcher.Add("./")添加監(jiān)測的目錄是當前目錄，也就是main.go文件所在目錄。
運行程序后，如果你修改下當前main.go文件會產(chǎn)生如下結(jié)果：

Output

2022/06/09 07:01:15 main.go~ CREATE
2022/06/09 07:01:15 main.go WRITE|CHMOD
2022/06/09 07:01:15 main.go~ CREATE
2022/06/09 07:01:15 main.go CHMOD
2022/06/09 07:01:15 main.go WRITE
2022/06/09 07:01:15 main.go~ REMOVE
2022/06/09 07:01:16 main.go CHMOD

上面的輸出過程可以發(fā)現(xiàn)，修改文件并保存會觸發(fā)以下動作：