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
目录
相关文章
|
8天前
|
监控 算法 Go
Golang深入浅出之-Go语言中的服务熔断、降级与限流策略
【5月更文挑战第4天】本文探讨了分布式系统中保障稳定性的重要策略:服务熔断、降级和限流。服务熔断通过快速失败和暂停故障服务调用来保护系统;服务降级在压力大时提供有限功能以保持整体可用性;限流控制访问频率,防止过载。文中列举了常见问题、解决方案,并提供了Go语言实现示例。合理应用这些策略能增强系统韧性和可用性。
36 0
|
22小时前
|
存储 编译器 Go
Go语言学习12-数据的使用
【5月更文挑战第5天】本篇 Huazie 向大家介绍 Go 语言数据的使用,包含赋值语句、常量与变量、可比性与有序性
17 6
Go语言学习12-数据的使用
|
2天前
|
Java Go
一文带你速通go语言指针
Go语言指针入门指南:简述指针用于提升效率,通过地址操作变量。文章作者sharkChili是Java/CSDN专家,维护Java Guide项目。文中介绍指针声明、取值,展示如何通过指针修改变量值及在函数中的应用。通过实例解析如何使用指针优化函数,以实现对原变量的直接修改。作者还邀请读者加入交流群深入探讨,并鼓励关注其公众号“写代码的SharkChili”。
9 0
|
2天前
|
存储 缓存 Java
来聊聊go语言的hashMap
本文介绍了Go语言中的`map`与Java的不同设计思想。作者`sharkChili`是一名Java和Go开发者,同时也是CSDN博客专家及JavaGuide项目的维护者。文章探讨了Go语言`map`的数据结构,包括`count`、`buckets指针`和`bmap`,解释了键值对的存储方式,如何利用内存对齐优化空间使用,并展示了`map`的初始化、插入键值对以及查找数据的源码过程。此外,作者还分享了如何通过汇编查看`map`操作,并鼓励读者深入研究Go的哈希冲突解决和源码。最后,作者提供了一个交流群,供读者讨论相关话题。
10 0
|
3天前
|
Java Go
Go语言学习11-数据初始化
【5月更文挑战第3天】本篇带大家通过内建函数 new 和 make 了解Go语言的数据初始化过程
17 1
Go语言学习11-数据初始化
|
3天前
|
自然语言处理 安全 Java
速通Go语言编译过程
Go语言编译过程详解:从词法分析(生成token)到句法分析(构建语法树),再到语义分析(类型检查、推断、匹配及函数内联)、生成中间码(SSA)和汇编码。最后,通过链接生成可执行文件。作者sharkchili,CSDN Java博客专家,分享技术细节,邀请读者加入交流群。
22 2
|
4天前
|
Java Linux Go
一文带你速通Go语言基础语法
本文是关于Go语言的入门介绍,作者因其简洁高效的特性对Go语言情有独钟。文章首先概述了Go语言的优势,包括快速上手、并发编程简单、设计简洁且功能强大,以及丰富的标准库。接着,文章通过示例展示了如何编写和运行Go代码,包括声明包、导入包和输出语句。此外,还介绍了Go的语法基础,如变量类型(数字、字符串、布尔和复数)、变量赋值、类型转换和默认值。文章还涉及条件分支(if和switch)和循环结构(for)。最后,简要提到了Go函数的定义和多返回值特性,以及一些常见的Go命令。作者计划在后续文章中进一步探讨Go语言的其他方面。
10 0
|
5天前
|
JavaScript 前端开发 Go
Go语言的入门学习
【4月更文挑战第7天】Go语言,通常称为Golang,是由Google设计并开发的一种编程语言,它于2009年公开发布。Go的设计团队主要包括Robert Griesemer、Rob Pike和Ken Thompson,这三位都是计算机科学和软件工程领域的杰出人物。
13 1
|
5天前
|
Go
|
6天前
|
分布式计算 Java Go
Golang深入浅出之-Go语言中的分布式计算框架Apache Beam
【5月更文挑战第6天】Apache Beam是一个统一的编程模型,适用于批处理和流处理,主要支持Java和Python,但也提供实验性的Go SDK。Go SDK的基本概念包括`PTransform`、`PCollection`和`Pipeline`。在使用中,需注意类型转换、窗口和触发器配置、资源管理和错误处理。尽管Go SDK文档有限,生态系统尚不成熟,且性能可能不高,但它仍为分布式计算提供了可移植的解决方案。通过理解和掌握Beam模型,开发者能编写高效的数据处理程序。
134 1