使用Go语言fsnotify库监听JSON配置文件变更的问题

你的代码存在几个关键问题导致监控失效，以下是具体分析和修复：

1. Watcher被提前关闭 #

setFileWatcher函数中，defer w.Close()会在函数返回时立即执行，导致Watcher刚创建就被关闭，后台goroutine里的事件循环直接退出，根本无法持续监控文件变更。

2. 事件监听不完整 #

多数编辑器修改文件时，并非直接写入原文件，而是通过创建临时文件→替换原文件的方式，此时触发的是fsnotify.Rename或fsnotify.Remove事件，而非fsnotify.Write，只监听Write会漏掉这些场景。

3. 缺少程序阻塞逻辑 #

setFileWatcher执行完成后直接返回，若主程序没有其他阻塞逻辑，整个进程会直接退出，监控自然无法生效。

修复后的代码示例 #

import (
    "fmt"
    "os"
    "syscall"
    "os/signal"

    "github.com/fsnotify/fsnotify"
)

func waitForChangeEventLoop(w *fsnotify.Watcher, filePath string) {
    for {
        select {
        case err, ok := <-w.Errors:
            if !ok {
                return
            }
            fmt.Printf("监控错误: %v\n", err)
        case e, ok := <-w.Events:
            if !ok {
                return
            }

            // 处理文件写入事件
            if e.Has(fsnotify.Write) {
                fmt.Printf("文件 %s 已变更\n", filePath)
                // 此处可添加重新加载JSON配置的逻辑
            }

            // 处理文件被替换/删除的场景（编辑器常见操作）
            if e.Has(fsnotify.Remove) || e.Has(fsnotify.Rename) {
                fmt.Printf("文件 %s 被替换/删除，重新添加监控\n", filePath)
                // 先移除旧监控（避免重复监听）
                _ = w.Remove(filePath)
                // 重新添加文件监控
                if err := w.Add(filePath); err != nil {
                    fmt.Printf("重新添加监控失败: %v\n", err)
                }
            }
        }
    }
}

func setFileWatcher(filePath string) error {
    w, err := fsnotify.NewWatcher()
    if err != nil {
        return err
    }

    // 启动事件循环goroutine
    go waitForChangeEventLoop(w, filePath)

    // 添加目标文件监控
    if err := w.Add(filePath); err != nil {
        _ = w.Close()
        return err
    }

    // 阻塞当前goroutine，直到收到退出信号（如Ctrl+C）
    sigChan := make(chan os.Signal, 1)
    signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
    <-sigChan

    // 收到退出信号后关闭Watcher
    fmt.Println("正在停止监控...")
    return w.Close()
}

// 主函数示例
func main() {
    gConfiguredCollectorsPath := "./config.json"
    if err := setFileWatcher(gConfiguredCollectorsPath); err != nil {
        fmt.Printf("启动监控失败: %v\n", err)
        os.Exit(1)
    }
}

关键修复点说明 #

• 避免Watcher提前关闭：将w.Close()移到收到退出信号后执行，确保监控期间Watcher始终处于活跃状态。
• 完善事件覆盖：新增对Remove和Rename事件的处理，当文件被编辑器替换时自动重新添加监控，覆盖主流编辑场景。
• 添加阻塞逻辑：通过监听系统中断信号，让监控函数持续阻塞，保证程序不会启动后立即退出。
• 错误可视化：增加错误信息打印，便于排查监控过程中出现的异常。

内容的提问来源于stack exchange，提问作者yonatan cohen