在 Objective-C 中观察文件或文件夹

Question

侦听文件夹或文件以查看其是否已保存或是否已添加新文件的最佳方法是什么？

Answer 1

如果您只想监视目录但不处理单个文件的监视，那么 FSEvents API 是理想的选择。 Stu Connolly 有一个很棒的 FSEvents C API 的 Objective-C 包装器，称为 SCEvents，您可以在这里获取它：

http://stuconnolly.com/blog/scevents-011/

FSEvents 的好处是您只需要监视一个文件夹，您就会收到该子文件夹层次结构中任何位置发生的任何更改的通知文件夹。

如果您需要文件级通知，则需要使用 kqueues。 Uli Kusterer 有一个很棒的 Objective-C 包装器：

http://zathras.de/angelweb/sourcecode.htm #UKKQueue

这两种方法都比直接使用 C API 容易得多，C API 没有特别详细的文档记录，而且有点迟钝。

如果您需要支持 Tiger，则需要使用 kqueues，因为 FSEvents API 在 10.4 中尚未正式提供。

Answer 2

尝试使用 FSEvents，尽管它是 C API

OS 10.5 或更高版本

Answer 3

如果您确实需要使用 kqueue （如其他答案中所述）Google Toolbox for Mac 有 不错的 Objective-C 包装器，到目前为止我使用过没有任何问题。

Answer 4

现在，您可以使用 GCD (Grand Central Dispatch) 来监视文件夹。您也许可以使用相同的技术来监视文件，但即使它仅适用于文件夹，您也可以记下文件的修改日期，并在每次文件夹更改时检查更改。

这是我编写的一个 Swift 类，用于使用 GCD 监视文件夹：

import Foundation

@objc public class DirectoryWatcher : NSObject {
    override public init() {
        super.init()
    }
    
    deinit {
        stop()
    }
    
    public typealias Callback = (_ directoryWatcher: DirectoryWatcher) -> Void
    
    @objc public convenience init(withPath path: String, callback: @escaping Callback) {
        self.init()
        if !watch(path: path, callback: callback) {
            assert(false)
        }
    }
    
    private var dirFD : Int32 = -1 {
        didSet {
            if oldValue != -1 {
                close(oldValue)
            }
        }
    }
    private var dispatchSource : DispatchSourceFileSystemObject?
    
    @objc public func watch(path: String, callback: @escaping Callback) -> Bool {
        // Open the directory
        dirFD = open(path, O_EVTONLY)
        if dirFD < 0 {
            return false
        }
        
        // Create and configure a DispatchSource to monitor it
        let dispatchSource = DispatchSource.makeFileSystemObjectSource(fileDescriptor: dirFD, eventMask: .write, queue: DispatchQueue.main)
        dispatchSource.setEventHandler {[unowned self] in
            callback(self)
        }
        dispatchSource.setCancelHandler {[unowned self] in
            self.dirFD = -1
        }
        self.dispatchSource = dispatchSource

        // Start monitoring
        dispatchSource.resume()
        
        // Success
        return true
    }

    @objc public func stop() {
        // Leave if not monitoring
        guard let dispatchSource = dispatchSource else {
            return
        }
        
        // Don't listen to more events
        dispatchSource.setEventHandler(handler: nil)
        
        // Cancel the source (this will also close the directory)
        dispatchSource.cancel()
        self.dispatchSource = nil
    }
}

像 Apple 的 DirectoryWatcher 示例一样使用它，如下所示：

let directoryWatcher = DirectoryWatcher(withPath: "/path/to/the/folder/you/want/to/monitor/", callback: {
    print("the folder changed")
})

销毁对象将停止监视，或者您可以显式停止它

directoryWatcher.stop()

它应该与 Objective C 兼容，它们的编写方式（未经测试） ）。使用它会像这样：

DirectoryWatcher *directoryWatcher = [DirectoryWatcher.alloc initWithPath: @"/path/to/the/folder/you/want/to/monitor/" callback: ^(DirectoryWatcher *directoryWatcher) {
    NSLog(@"the folder changed")
}];

停止它是类似的

[directoryWatcher stop];

Answer 5

如果您要更改文件或文件夹，我相信 Spotlight 搜索引擎将更新其数据库以反映您的更改。

因此，您可以设置一个线程来侦听 kMDQueryDidUpdateNotification 通过 针对该文件或文件夹的 Spotlight 查询。

当您收到这些通知时，您可以触发一个选择器来执行您想要的操作。

Answer 6

不确定什么是最好的方法，但一种方法是启动一个 NSThread，它会定期（例如每秒）检查目录中文件的创建日期，然后让一个与该线程关联的委托来执行某些操作添加新文件时