Go 语言跨平台文件监听库 fsnotify 怎么使用?

简介: Go 语言跨平台文件监听库 fsnotify 怎么使用?

介绍

Go 语言作为静态编译型语言,每次修改配置文件后,我们都需要重新编译,修改的配置信息才可以生效,而动态编译型语言修改配置文件可以自动生效,相对来说更方便一些。

但是,我们可以使用三方开源库 fsnotify,这是一款非常流行的文件系统监听库,很多开源的三方库也都使用该库实现监听文件变更,比如我们之前介绍的非常流行的管理配置信息开源库 viper

fsnotify 源码解读

NewWatcher 函数:

fsnotify 提供了 NewWatcher 函数,使用该函数可以创建一个监听器。

// NewWatcher creates a new Watcher.
func NewWatcher() (*Watcher, error) {
 // 省略代码 ...
 w := &Watcher{
  // 省略代码 ...
  Events:       make(chan Event),
  Errors:       make(chan error),
  // 省略代码 ...
 }
 go w.readEvents()
 return w, nil
}

阅读 NewWatcher 函数的源码,我们可以发现,该函数返回一个 *Watcher

并且我们可以发现该结构体的两个公开字段 EventsErrors 分别是 Event 类型和 error 类型的 channel

事件:

Event 类型的字段 Events

type Event struct {
 Name string
 Op Op
}
type Op uint32
const (
 Create Op = 1 << iota
 Write
 Remove
 Rename
 Chmod
)

阅读上面这段代码,我们可以发现 Event 包含两个字段,分别表示事件名称和操作类型,其中,事件操作类型有 5 个,分别是 CreateWriteRemoveRenameChmod

我们可以启动一个协程,使用 for ... select 监听 watcherEventsErrors 通道并输出事件信息和错误信息。

Event 包含 2 个方法,分别是 HasStringHas 用于判断事件是否包含给定操作,源码如下:

// Has reports if this event has the given operation.
func (e Event) Has(op Op) bool { return e.Op.Has(op) }

监听器:

Watcher 包含 4 个公共方法,分别是 AddCloseRemoveWatchList

  • Add - 用于指定监听目录或监听文件,需要注意的是,指定目录仅能监听该目录中的所有文件,无法监听该目录中子目录的文件。
  • Close - 删除所有监听,并关闭 Events 通道。
  • Remove - 停止监视指定目录或指定文件的变更,需要注意的是,指定目录仅代表当前目录,指定目录中的子目录需单独停止监听。删除未被监听的目录或文件,将会返回错误。
  • WatchList - 返回尚未被删除的所有使用 Add 添加的目录或文件。

03

fsnotify 使用示例

在了解完 fsnotify 源码之后,我们再介绍一下 fsnotify 的使用示例。

func main() {
 // 创建一个监听器
 watcher, err := fsnotify.NewWatcher()
 if err != nil {
  log.Fatal(err)
 }
 // 关闭监听器
 defer watcher.Close()
 // 开始监听事件
 go func() {
  for {
   select {
   case event, ok := <-watcher.Events:
    if !ok {
     return
    }
    if event.Has(fsnotify.Write) {
     // 自动加载文件内容
     f, _ := os.Open("log.txt")
     _, _ = io.Copy(os.Stdout, f)
    }
  }
 }()
 // 添加监听目录
 err = watcher.Add("./")
 if err != nil {
  log.Fatal(err)
 }
 // 永久阻塞 main goroutine
 <-make(chan struct{})
}

阅读上面这段示例代码,我们可以发现,使用 fsnotify 非常简单。

首先,使用 NewWatcher 函数创建一个 watcher,然后,使用 Add 方法添加监听目录或文件,最后,使用 defer 调用 Close 方法,关闭监听器,释放系统资源。

示例代码中,启动一个 goroutine 循环输出事件通道中的事件,发现 Write 操作类型的事件时,将 log.txt 中的文件内容拷贝到标准输出。

我们可以在运行该程序后,修改  log.txt 中的内容,终端将会打印该文件修改后的最新内容。

我们可以使用该特性,自动监听应用程序的配置文件,避免修改配置信息后,还需要重新编译并启动应用才可以生效。

04

总结

本文我们介绍了跨平台文件监听库 fsnotify,它主要用于自动监听文件中的内容变更。

我们通过 fsnotify 源码和示例代码,介绍了该库支持的功能和使用方式。

建议感兴趣的读者朋友们,继续阅读该库的官方文档和源码,了解在不同系统平台中使用的注意事项,并有效运用在自己的项目中。

推荐阅读:

参考资料:

  1. https://pkg.go.dev/github.com/fsnotify/fsnotify
  2. https://github.com/fsnotify/fsnotify
目录
相关文章
|
4天前
|
监控 Linux PHP
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
52 20
|
2天前
|
存储 监控 算法
探秘员工泄密行为防线:基于Go语言的布隆过滤器算法解析
在信息爆炸时代,员工泄密行为对企业构成重大威胁。本文聚焦布隆过滤器(Bloom Filter)这一高效数据结构,结合Go语言实现算法,帮助企业识别和预防泄密风险。通过构建正常操作“指纹库”,实时监测员工操作,快速筛查可疑行为。示例代码展示了如何利用布隆过滤器检测异常操作,并提出优化建议,如调整参数、结合日志分析系统等,全方位筑牢企业信息安全防线,守护核心竞争力。
|
10天前
|
Go C语言
Go语言入门:分支结构
本文介绍了Go语言中的条件语句,包括`if...else`、`if...else if`和`switch`结构,并通过多个练习详细解释了它们的用法。`if...else`用于简单的条件判断;`if...else if`处理多条件分支;`switch`则适用于基于不同值的选择逻辑。特别地,文章还介绍了`fallthrough`关键字,用于优化重复代码。通过实例如判断年龄、奇偶数、公交乘车及成绩等级等,帮助读者更好地理解和应用这些结构。
34 14
|
24天前
|
存储 监控 算法
内网监控系统之 Go 语言布隆过滤器算法深度剖析
在数字化时代,内网监控系统对企业和组织的信息安全至关重要。布隆过滤器(Bloom Filter)作为一种高效的数据结构,能够快速判断元素是否存在于集合中,适用于内网监控中的恶意IP和违规域名筛选。本文介绍其原理、优势及Go语言实现,提升系统性能与响应速度,保障信息安全。
28 5
|
9天前
|
监控 关系型数据库 MySQL
【01】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-硬件设备实时监控系统运营版发布-本产品基于企业级开源项目Zabbix深度二开-分步骤实现预计10篇合集-自营版
【01】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-硬件设备实时监控系统运营版发布-本产品基于企业级开源项目Zabbix深度二开-分步骤实现预计10篇合集-自营版
19 0
|
9月前
|
开发框架 安全 中间件
Go语言开发小技巧&易错点100例(十二)
Go语言开发小技巧&易错点100例(十二)
90 1
|
2月前
|
开发框架 Go 计算机视觉
纯Go语言开发人脸检测、瞳孔/眼睛定位与面部特征检测插件-助力GoFly快速开发框架
开发纯go插件的原因是因为目前 Go 生态系统中几乎所有现有的人脸检测解决方案都是纯粹绑定到一些 C/C++ 库,如 OpenCV 或 dlib,但通过 cgo 调用 C 程序会引入巨大的延迟,并在性能方面产生显著的权衡。此外,在许多情况下,在各种平台上安装 OpenCV 是很麻烦的。使用纯Go开发的插件不仅在开发时方便,在项目部署和项目维护也能省很多时间精力。
|
3月前
|
Go 数据安全/隐私保护 开发者
Go语言开发
【10月更文挑战第26天】Go语言开发
54 3
|
3月前
|
Java 程序员 Go
Go语言的开发
【10月更文挑战第25天】Go语言的开发
47 3
|
6月前
|
JSON 中间件 Go
go语言后端开发学习(四) —— 在go项目中使用Zap日志库
本文详细介绍了如何在Go项目中集成并配置Zap日志库。首先通过`go get -u go.uber.org/zap`命令安装Zap,接着展示了`Logger`与`Sugared Logger`两种日志记录器的基本用法。随后深入探讨了Zap的高级配置,包括如何将日志输出至文件、调整时间格式、记录调用者信息以及日志分割等。最后,文章演示了如何在gin框架中集成Zap,通过自定义中间件实现了日志记录和异常恢复功能。通过这些步骤,读者可以掌握Zap在实际项目中的应用与定制方法
232 1
go语言后端开发学习(四) —— 在go项目中使用Zap日志库