本文的原始鏈接在我的博客網(wǎng)站上 https://yohunl.com/iosjian-kong-jian-ce-jian-ting-wen-jian-wen-jian-jia-de-bian-hua-jian-ce-wen-jian-bian-hua/
我們有些時候,需要監(jiān)測一個文件/文件夾的變化,例如在某個文件被修改的時候,可以獲取到通知,或者我們有個播放列表是掃描某個文件夾下的所有文件,那么當(dāng)這個目錄新添或者刪除一些文件后,我們的播放列表要同步更新,這種情況下,我們都需要監(jiān)聽文件/文件夾的變化
本文的demo已經(jīng)上傳到github上了,地址是MonitorFilesChange
Demo的演示效果:
Demo的演示說明:
有兩個tab,第一個,是下文的第一種方法,這里用它來監(jiān)控Documents文件夾,右邊的按鈕, 每點擊一次,就創(chuàng)建一個文件到Documents文件夾下,監(jiān)控會收到通知,刷新列表,顯示目錄下的文件名. 第二個tab是第二種方法的演示,演示寫入內(nèi)容到一個文件中,textview展示寫入的內(nèi)容.
由于在UNIX系統(tǒng)中,文件夾和文件其實對系統(tǒng)來說,只是屬性不同而已,地位是一樣的,在下文中,我可能會用文件,也可能會用文件夾,其實都是適用的.
監(jiān)控文件
碰到這樣的一個需求,首先你的反應(yīng)肯定是,這還不簡單,我直接開一個定時器,每隔5s就重新掃描一下指定的文件夾/文件,這不就結(jié)了.....
其實這樣也沒有錯,只是多開了一個定時器,效率低一些而已.但還是解決了問題的,對這種方式,假如文件夾中文件很多,效率就更低了,每次重新拿到列表后,還得做字符串的匹配等等...,這種方式,我就不多說了,任何一個開發(fā)者分分鐘都可以寫出這個低效的代碼.
這是一個常見的需求,官方其實提供了兩種思路來解決這個問題
方法一
官方給出的示例demo Classes_DirectoryWatcher
大體上的思路是:
- 根據(jù)文件/文件夾的路徑，調(diào)用open函數(shù)打開文件夾递胧，得到文件句柄俱病。
- 通過kqueue()函數(shù)創(chuàng)建一個kqueue隊列來處理系統(tǒng)事件（文件創(chuàng)建或者刪除）凭峡，得到queueId
- 創(chuàng)建一個kevent結(jié)構(gòu)體，設(shè)置相關(guān)屬性冲粤，連同kqueue的ID一起傳給kevent()函數(shù)，完成系統(tǒng)對kevent的關(guān)聯(lián)页眯。
- 調(diào)用CFFileDescriptorCreateRunloopSouce創(chuàng)建一個接收系統(tǒng)事件的runloop source梯捕，同時設(shè)置文件描述符的回調(diào)函數(shù)（回調(diào)函數(shù)采用C語言標(biāo)準(zhǔn)的回調(diào)函數(shù)格式）， 并加到默認的runloopMode中窝撵。
- 啟用回調(diào)函數(shù)傀顾。
- 關(guān)閉kqueue，關(guān)閉文件夾
這樣操作后,當(dāng)文件/文件夾有變化,系統(tǒng)會觸發(fā)相應(yīng)的回調(diào),你收到回調(diào)了,就可以進行各種處理了
其核心代碼如下:
- (void)kqueueFired
{
int kq;
struct kevent event;
struct timespec timeout = { 0, 0 };
int eventCount;
kq = CFFileDescriptorGetNativeDescriptor(self->kqref);
assert(kq >= 0);
eventCount = kevent(kq, NULL, 0, &event, 1, &timeout);
assert( (eventCount >= 0) && (eventCount < 2) );
if (self.fileChangeBlock) {
self.fileChangeBlock(eventCount);
}
CFFileDescriptorEnableCallBacks(self->kqref, kCFFileDescriptorReadCallBack);
}
static void KQCallback(CFFileDescriptorRef kqRef, CFOptionFlags callBackTypes, void *info)
{
MonitorFileChangeUtils *helper = (MonitorFileChangeUtils *)(__bridge id)(CFTypeRef) info;
[helper kqueueFired];
}
- (void) beginGeneratingDocumentNotificationsInPath: (NSString *) docPath
{
int dirFD;
int kq;
int retVal;
struct kevent eventToAdd;
CFFileDescriptorContext context = { 0, (void *)(__bridge CFTypeRef) self, NULL, NULL, NULL };
dirFD = open([docPath fileSystemRepresentation], O_EVTONLY);
assert(dirFD >= 0);
kq = kqueue();
assert(kq >= 0);
eventToAdd.ident = dirFD;
eventToAdd.filter = EVFILT_VNODE;
eventToAdd.flags = EV_ADD | EV_CLEAR;
eventToAdd.fflags = NOTE_WRITE;
eventToAdd.data = 0;
eventToAdd.udata = NULL;
retVal = kevent(kq, &eventToAdd, 1, NULL, 0, NULL);
assert(retVal == 0);
self->kqref = CFFileDescriptorCreate(NULL, kq, true, KQCallback, &context);
rls = CFFileDescriptorCreateRunLoopSource(NULL, self->kqref, 0);
assert(rls != NULL);
CFRunLoopAddSource(CFRunLoopGetCurrent(), rls, kCFRunLoopDefaultMode);
CFRelease(rls);
CFFileDescriptorEnableCallBacks(self->kqref, kCFFileDescriptorReadCallBack);
}
方法二:GCD方式
大體思路是:
首先是使用O_EVTONLY模式打開文件/文件夾,然后創(chuàng)建一個GCD的source,當(dāng)然了,其unsigned long mask參數(shù)要選VNODE系列的,例如要檢測文件的些人,可以用DISPATCH_VNODE_WRITE
核心代碼:
- (void)__beginMonitoringFile
{
_fileDescriptor = open([[_fileURL path] fileSystemRepresentation],
O_EVTONLY);
dispatch_queue_t defaultQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
_source = dispatch_source_create(DISPATCH_SOURCE_TYPE_VNODE,
_fileDescriptor,
DISPATCH_VNODE_ATTRIB | DISPATCH_VNODE_DELETE | DISPATCH_VNODE_EXTEND | DISPATCH_VNODE_LINK | DISPATCH_VNODE_RENAME | DISPATCH_VNODE_REVOKE | DISPATCH_VNODE_WRITE,
defaultQueue);
dispatch_source_set_event_handler(_source, ^ {
unsigned long eventTypes = dispatch_source_get_data(_source);
[self __alertDelegateOfEvents:eventTypes];
});
dispatch_source_set_cancel_handler(_source, ^{
close(_fileDescriptor);
_fileDescriptor = 0;
_source = nil;
// If this dispatch source was canceled because of a rename or delete notification, recreate it
if (_keepMonitoringFile) {
_keepMonitoringFile = NO;
[self __beginMonitoringFile];
}
});
dispatch_resume(_source);
}
參考文檔
handling-filesystem-events-with-gcd
Monitoring-Files-With-GCD-Being-Edited-With-A-Text-Editor
gcd-zhi-jian-ting-wen-jian
GCDWorkQueues
iMonitorMyFiles
