Go 每日一库之 fsnotify

简介

上一篇文章Go 每日一库之 viper中，我们介绍了 viper 可以监听文件修改进而自动重新加载。其内部使用的就是fsnotify这个库，它是跨平台的。今天我们就来介绍一下它。

快速使用

先安装：

$ go get github.com/fsnotify/fsnotify

后使用：

package mainimport ("log""github.com/fsnotify/fsnotify"
)func main() {watcher, err := fsnotify.NewWatcher()if err != nil {log.Fatal("NewWatcher 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
}

fsnotify的使用比较简单：

先调用NewWatcher创建一个监听器；
然后调用监听器的Add增加监听的文件或目录；
如果目录或文件有事件产生，监听器中的通道Events可以取出事件。如果出现错误，监听器中的通道Errors可以取出错误信息。

上面示例中，我们在另一个 goroutine 中循环读取发生的事件及错误，然后输出它们。

编译、运行程序。在当前目录创建一个新建文本文档.txt，然后重命名为file1.txt文件，输入内容some test text，然后删除它。观察控制台输出：

2020/01/20 08:41:17 新建文本文档.txt CREATE
2020/01/20 08:41:25 新建文本文档.txt RENAME
2020/01/20 08:41:25 file1.txt CREATE
2020/01/20 08:42:28 file1.txt REMOVE

其实，重命名时会产生两个事件，一个是原文件的RENAME事件，一个是新文件的CREATE事件。

注意，fsnotify使用了操作系统接口，监听器中保存了系统资源的句柄，所以使用后需要关闭。

事件

上面示例中的事件是fsnotify.Event类型：

// fsnotify/fsnotify.go
type Event struct {Name stringOp   Op
}

事件只有两个字段，Name表示发生变化的文件或目录名，Op表示具体的变化。Op有 5 中取值：

// fsnotify/fsnotify.go
type Op uint32const (Create Op = 1 << iotaWriteRemoveRenameChmod
)

在快速使用中，我们已经演示了前 4 种事件。Chmod事件在文件或目录的属性发生变化时触发，在 Linux 系统中可以通过chmod命令改变文件或目录属性。

事件中的Op是按照位来存储的，可以存储多个，可以通过&操作判断对应事件是不是发生了。

if event.Op & fsnotify.Write != 0 {fmt.Println("Op has Write")
}

我们在代码中不需要这样判断，因为Op的String()方法已经帮我们处理了这种情况了：

// fsnotify.go
func (op Op) String() string {// Use a buffer for efficient string concatenationvar buffer bytes.Bufferif op&Create == Create {buffer.WriteString("|CREATE")}if op&Remove == Remove {buffer.WriteString("|REMOVE")}if op&Write == Write {buffer.WriteString("|WRITE")}if op&Rename == Rename {buffer.WriteString("|RENAME")}if op&Chmod == Chmod {buffer.WriteString("|CHMOD")}if buffer.Len() == 0 {return ""}return buffer.String()[1:] // Strip leading pipe
}

应用

fsnotify的应用非常广泛，在 godoc 上，我们可以看到哪些库导入了fsnotify。只需要在fsnotify文档的 URL 后加上?imports即可：

https://godoc.org/github.com/fsnotify/fsnotify?importers。有兴趣打开看看，要 fq。

上一篇文章中，我们介绍了调用viper.WatchConfig就可以监听配置修改，自动重新加载。下面我们就来看看WatchConfig是怎么实现的：

// viper/viper.go
func WatchConfig() { v.WatchConfig() }func (v *Viper) WatchConfig() {initWG := sync.WaitGroup{}initWG.Add(1)go func() {watcher, err := fsnotify.NewWatcher()if err != nil {log.Fatal(err)}defer watcher.Close()// we have to watch the entire directory to pick up renames/atomic saves in a cross-platform wayfilename, err := v.getConfigFile()if err != nil {log.Printf("error: %v\n", err)initWG.Done()return}configFile := filepath.Clean(filename)configDir, _ := filepath.Split(configFile)realConfigFile, _ := filepath.EvalSymlinks(filename)eventsWG := sync.WaitGroup{}eventsWG.Add(1)go func() {for {select {case event, ok := <-watcher.Events:if !ok { // 'Events' channel is closedeventsWG.Done()return}currentConfigFile, _ := filepath.EvalSymlinks(filename)// we only care about the config file with the following cases:// 1 - if the config file was modified or created// 2 - if the real path to the config file changed (eg: k8s ConfigMap replacement)const writeOrCreateMask = fsnotify.Write | fsnotify.Createif (filepath.Clean(event.Name) == configFile &&event.Op&writeOrCreateMask != 0) ||(currentConfigFile != "" && currentConfigFile != realConfigFile) {realConfigFile = currentConfigFileerr := v.ReadInConfig()if err != nil {log.Printf("error reading config file: %v\n", err)}if v.onConfigChange != nil {v.onConfigChange(event)}} else if filepath.Clean(event.Name) == configFile &&event.Op&fsnotify.Remove&fsnotify.Remove != 0 {eventsWG.Done()return}case err, ok := <-watcher.Errors:if ok { // 'Errors' channel is not closedlog.Printf("watcher error: %v\n", err)}eventsWG.Done()return}}}()watcher.Add(configDir)initWG.Done()   // done initializing the watch in this go routine, so the parent routine can move on...eventsWG.Wait() // now, wait for event loop to end in this go-routine...}()initWG.Wait() // make sure that the go routine above fully ended before returning
}

其实流程是相似的：

首先，调用NewWatcher创建一个监听器；
调用v.getConfigFile()获取配置文件路径，抽出文件名、目录，配置文件如果是一个符号链接，获得链接指向的路径；
调用watcher.Add(configDir)监听配置文件所在目录，另起一个 goroutine 处理事件。

WatchConfig不能阻塞主 goroutine，所以创建监听器也是新起 goroutine 进行的。代码中有两个sync.WaitGroup变量，initWG是为了保证监听器初始化，eventsWG是在事件通道关闭，或配置被删除了，或遇到错误时退出事件处理循环。

然后就是核心事件循环：

有事件发生时，判断变化的文件是否是在 viper 中设置的配置文件，发生的是否是创建或修改事件（只处理这两个事件）；
如果配置文件为符号链接，若符合链接的指向修改了，也需要重新加载配置；
如果需要重新加载配置，调用v.ReadInConfig()读取新的配置；
如果注册了事件回调，以发生的事件为参数执行回调。

总结

fsnotify的接口非常简单直接，所有系统相关的复杂性都被封装起来了。这也是我们平时设计模块和接口时可以参考的案例。

参考

fsnotify API 设计
fsnotify GitHub 仓库

我

我的博客

欢迎关注我的微信公众号【GoUpUp】，共同学习，一起进步~

本文由博客一文多发平台 OpenWrite 发布！

Go 每日一库之 fsnotify相关推荐

Go 每日一库之 viper
简介上一篇文章介绍 cobra 的时候提到了 viper,今天我们就来介绍一下这个库. viper 是一个配置解决方案,拥有丰富的特性: 支持 JSON/TOML/YAML/HCL/envfile/ ...
go get 失败 no go files in_Go 每日一库之 dig
简介今天我们来介绍 Go 语言的一个依赖注入(DI)库--dig.dig 是 uber 开源的库.Java 依赖注入的库有很多,相信即使不是做 Java 开发的童鞋也听过大名鼎鼎的 Spring.相 ...
go float64 比较_Go 每日一库之 plot
Go 每日一库之 plot 简介本文介绍 Go 语言的一个非常强大.好用的绘图库--plot.plot内置了很多常用的组件,基本满足日常需求.同时,它也提供了定制化的接口,可以实现我们的个性化需求. ...
go get 的不再src目录中_Go 每日一库之 sqlc：根据 sql 生成代码
简介在 Go 语言中编写数据库操作代码真的非常痛苦!database/sql标准库提供的都是比较底层的接口.我们需要编写大量重复的代码.大量的模板代码不仅写起来烦,而且还容易出错.有时候字段类型修改 ...
go 默认http版本_【每日一库】超赞的 Go 语言 INI 文件操作
点击上方蓝色"Go语言中文网"关注我们,领全套Go资料,每天学习 Go 语言如果你使用 INI 作为系统的配置文件,那么一定会使用这个库吧.没错,它就是号称地表最强大.最方便 ...
go get如何删除_Go 每日一库之 xorm
简介 Go 标准库提供的数据库接口database/sql比较底层,使用它来操作数据库非常繁琐,而且容易出错.因而社区开源了不少第三方库,如上一篇文章中的sqlc工具,还有各式各样的 ORM (Obj ...
go 根据输入类型执行对应的方法_Go 每日一库之 sqlc
简介在 Go 语言中编写数据库操作代码真的非常痛苦!database/sql标准库提供的都是比较底层的接口.我们需要编写大量重复的代码.大量的模板代码不仅写起来烦,而且还容易出错.有时候字段类型修改 ...
Go 每日一库之 zap
转载地址:Go 每日一库之 zap - SegmentFault 思否简介在很早之前的文章中,我们介绍过 Go 标准日志库log和结构化的日志库logrus.在热点函数中记录日志对日志库的执行性能 ...
每日一库之Go 强大而灵活的电子邮件库：email
发送邮件是一个很常见的需求:用户邮箱验证.邮箱召回等.Go 语言标准库自带 net/smtp 库,实现了 smtp 协议,用于发送邮件.然而这个库比较原始,使用不方便,而且官方声明不再增加新功能.于是 ...

Go 每日一库之 fsnotify

简介

快速使用

事件

应用

总结

参考

我

Go 每日一库之 fsnotify相关推荐

最新文章

热门文章