1.  
  2. 主页
  3.  / 
  4. Go 每日一库
  5.  / 
  6. Go 每日一库之 fsnotify 使用详解

Go 每日一库之 fsnotify 使用详解

简介

viper 可以监听文件修改进而自动重新加载。

其内部使用的就是fsnotify这个库,它是跨平台的。

今天我们就来介绍一下它。

快速使用

先安装:

后使用:

fsnotify的使用比较简单:

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

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

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

观察控制台输出:

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

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

事件

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

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

快速使用中,我们已经演示了前 4 种事件。

Chmod事件在文件或目录的属性发生变化时触发,在 Linux 系统中可以通过chmod命令改变文件或目录属性。

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

我们在代码中不需要这样判断,因为OpString()方法已经帮我们处理了这种情况了:

应用

fsnotify的应用非常广泛,在 godoc 上,我们可以看到哪些库导入了fsnotify

只需要在fsnotify文档的 URL 后加上?imports即可。

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

viper模块中调用viper.WatchConfig就可以监听配置修改,自动重新加载。

下面我们就来看看WatchConfig是怎么实现的:

其实流程是相似的:

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

WatchConfig不能阻塞主 goroutine,所以创建监听器也是新起 goroutine 进行的。

代码中有两个sync.WaitGroup变量,initWG是为了保证监听器初始化,eventsWG是在事件通道关闭,或配置被删除了,或遇到错误时退出事件处理循环。

然后就是核心事件循环:

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

总结

fsnotify的接口非常简单直接,所有系统相关的复杂性都被封装起来了。

这也是我们平时设计模块和接口时可以参考的案例。

参考

  1. fsnotify API 设计
  2. fsnotify GitHub 仓库
这篇文章对您有用吗?

我们要如何帮助您?

发表评论

邮箱地址不会被公开。 必填项已用*标注