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
目录
相关文章
|
3天前
|
编译器 Go
揭秘 Go 语言中空结构体的强大用法
Go 语言中的空结构体 `struct{}` 不包含任何字段,不占用内存空间。它在实际编程中有多种典型用法:1) 结合 map 实现集合(set)类型;2) 与 channel 搭配用于信号通知;3) 申请超大容量的 Slice 和 Array 以节省内存;4) 作为接口实现时明确表示不关注值。此外,需要注意的是,空结构体作为字段时可能会因内存对齐原因占用额外空间。建议将空结构体放在外层结构体的第一个字段以优化内存使用。
|
3天前
|
存储 缓存 监控
企业监控软件中 Go 语言哈希表算法的应用研究与分析
在数字化时代,企业监控软件对企业的稳定运营至关重要。哈希表(散列表)作为高效的数据结构,广泛应用于企业监控中,如设备状态管理、数据分类和缓存机制。Go 语言中的 map 实现了哈希表,能快速处理海量监控数据,确保实时准确反映设备状态,提升系统性能,助力企业实现智能化管理。
22 3
|
2天前
|
运维 监控 算法
监控局域网其他电脑:Go 语言迪杰斯特拉算法的高效应用
在信息化时代,监控局域网成为网络管理与安全防护的关键需求。本文探讨了迪杰斯特拉(Dijkstra)算法在监控局域网中的应用,通过计算最短路径优化数据传输和故障检测。文中提供了使用Go语言实现的代码例程,展示了如何高效地进行网络监控,确保局域网的稳定运行和数据安全。迪杰斯特拉算法能减少传输延迟和带宽消耗,及时发现并处理网络故障,适用于复杂网络环境下的管理和维护。
|
3天前
|
存储 缓存 安全
Go 语言中的 Sync.Map 详解:并发安全的 Map 实现
`sync.Map` 是 Go 语言中用于并发安全操作的 Map 实现,适用于读多写少的场景。它通过两个底层 Map(`read` 和 `dirty`)实现读写分离,提供高效的读性能。主要方法包括 `Store`、`Load`、`Delete` 等。在大量写入时性能可能下降,需谨慎选择使用场景。
|
4天前
|
SQL 安全 Java
阿里双十一背后的Go语言实践:百万QPS网关的设计与实现
解析阿里核心网关如何利用Go协程池、RingBuffer、零拷贝技术支撑亿级流量。 重点分享: ① 如何用gRPC拦截器实现熔断限流; ② Sync.Map在高并发读写中的取舍。
golang操作文件
1、读取文件信息: /* 读取文件信息 */ func readFile(path string) string { fi, err := os.Open(path) if err != nil { panic(err) } defer fi.
1409 0
|
8天前
|
存储 Go
Go 语言入门指南:切片
Golang中的切片(Slice)是基于数组的动态序列,支持变长操作。它由指针、长度和容量三部分组成,底层引用一个连续的数组片段。切片提供灵活的增减元素功能,语法形式为`[]T`,其中T为元素类型。相比固定长度的数组,切片更常用,允许动态调整大小,并且多个切片可以共享同一底层数组。通过内置的`make`函数可创建指定长度和容量的切片。需要注意的是,切片不能直接比较,只能与`nil`比较,且空切片的长度为0。
Go 语言入门指南:切片
|
11天前
|
算法 安全 Go
公司局域网管理系统里的 Go 语言 Bloom Filter 算法,太值得深挖了
本文探讨了如何利用 Go 语言中的 Bloom Filter 算法提升公司局域网管理系统的性能。Bloom Filter 是一种高效的空间节省型数据结构,适用于快速判断元素是否存在于集合中。文中通过具体代码示例展示了如何在 Go 中实现 Bloom Filter,并应用于局域网的 IP 访问控制,显著提高系统响应速度和安全性。随着网络规模扩大和技术进步,持续优化算法和结合其他安全技术将是企业维持网络竞争力的关键。
26 2
公司局域网管理系统里的 Go 语言 Bloom Filter 算法,太值得深挖了
|
7天前
|
开发框架 前端开发 Go
eino — 基于go语言的大模型应用开发框架(二)
本文介绍了如何使用Eino框架实现一个基本的LLM(大语言模型)应用。Eino中的`ChatModel`接口提供了与不同大模型服务(如OpenAI、Ollama等)交互的统一方式,支持生成完整响应、流式响应和绑定工具等功能。`Generate`方法用于生成完整的模型响应,`Stream`方法以流式方式返回结果,`BindTools`方法为模型绑定工具。此外,还介绍了通过`Option`模式配置模型参数及模板功能,支持基于前端和用户自定义的角色及Prompt。目前主要聚焦于`ChatModel`的`Generate`方法,后续将继续深入学习。
98 6

热门文章

最新文章