NSFilePresenter: что это, протокол NSFileCoordinator и методы отслеживания

Что такое NSFilePresenter?

NSFilePresenter — это протокол Foundation, предназначенный для отслеживания изменений файлов и директорий в операционных системах Apple. Протокол определяет набор методов, которые объект-наблюдатель реализует для получения уведомлений о событиях файловой системы.

Основная задача протокола — обеспечить безопасный доступ к файлам в многопоточных сценариях. В iOS и macOS несколько процессов и потоков могут одновременно обращаться к одному файлу через NSFileCoordinator, и NSFilePresenter гарантирует, что каждый участник получает актуальное состояние данных.

Протокол включён в Foundation начиная с iOS 5.0 и macOS 10.7. Он применяется в приложениях, работающих с документами, базами данных и любыми файлами, которые могут изменяться одновременно из разных источников — например, при синхронизации через iCloud или при совместном редактировании.

Где применяется NSFilePresenter

Документ-ориентированные приложения — основная область использования NSFilePresenter. Приложения, работающие с UIDocument или NSDocument, автоматически регистрируют себя как презентеры через NSFileCoordinator. Это позволяет корректно обрабатывать конфликты при редактировании одного файла из нескольких окон или устройств.

iCloud синхронизация — второй ключевой сценарий. Когда файл изменяется на одном устройстве, iCloud синхронизирует его на всех подключённых устройствах. NSFilePresenter уведомляет приложение об этих изменениях, позволяя своевременно обновить интерфейс.

Многопоточные редакторы — третий сценарий. В приложениях, где фоновые очереди загружают и сохраняют данные одновременно с работой пользователя, NSFilePresenter предотвращает состояние гонки при записи и чтении файлов.

Как работает NSFilePresenter?

Механизм работы NSFilePresenter основан на модели делегирования: объект реализует методы протокола, регистрируется через NSFileCoordinator и получает вызовы при каждом изменении отслеживаемого файла. Система сама определяет, когда произошло изменение и какие методы нужно вызвать.

Процесс начинается с того, что объект создаёт экземпляр NSFileCoordinator и вызывает метод координатора, передавая URL файла. Координатор проверяет, зарегистрированы ли для этого URL какие-либо презентеры. Если да, он блокирует доступ на чтение или запись и уведомляет презентеров о предстоящем изменении через методы протокола.

После завершения операции координатор снимает блокировку и вызывает финальные уведомления. Важно, что презентер не управляет потоком выполнения — он только реагирует на события. За координацию полностью отвечает NSFileCoordinator.

Жизненный цикл уведомления

Фаза подготовки — перед выполнением операции координатор вызывает метод accommodatePresentedItemDeletion или accommodatePresentedSubitemDeletion. Презентер может обработать ситуацию или отменить операцию, вернув ошибку. Эта фаза позволяет приложению корректно завершить работу с файлом перед его изменением.

Фаза уведомления — после завершения операции координатор вызывает presentedItemDidChange или presentedSubitemDidChange. Презентер получает сигнал о том, что файл изменился, и может перечитать его содержимое. Для перемещения файла вызывается presentedItemDidMoveToURL с новым расположением.

Фаза завершения — координатор снимает все блокировки и освобождает ресурсы. Презентер может продолжать работу с обновлёнными данными. Все три фазы выполняются синхронно в одном потоке, поэтому методы протокола должны отрабатывать быстро, без длительных операций ввода-вывода.

Основные методы протокола

Протокол NSFilePresenter содержит несколько обязательных и опциональных методов. Единственное обязательное свойство — presentedItemURL, возвращающее URL отслеживаемого файла или директории. Без этого свойства объект не может быть зарегистрирован как презентер.

Обязательные методы

presentedItemURL — свойство типа URL?, которое должно возвращать путь к отслеживаемому файлу. Если объект отслеживает несколько файлов, свойство возвращает URL основного элемента. Для директорий возвращается URL самой директории.

presentedItemDidChange — вызывается после изменения содержимого отслеживаемого файла. В этом методе презентер обновляет своё внутреннее состояние и перезагружает данные. Этот метод не получает информацию о том, что именно изменилось — только факт изменения.

Опциональные методы

accommodatePresentedItemDeletion — вызывается перед удалением файла. Презентер может сохранить текущее состояние, закрыть файловые дескрипторы или отменить операцию, вернув NSError. Если метод возвращает ошибку, операция удаления не выполняется.

presentedItemDidMoveToURL — вызывается после перемещения или переименования файла. Метод получает новый URL, и презентер должен обновить ссылку на файл. Без реализации этого метода презентер продолжит указывать на старый, несуществующий путь.

NSFilePresenter и NSFileCoordinator

NSFileCoordinator и NSFilePresenter — неразрывная пара. NSFileCoordinator управляет доступом к файлам и вызывает методы презентера. Презентер не работает напрямую с файловой системой — все операции проходят через координатор, который гарантирует атомарность изменений.

Координатор регистрирует презентера через метод addFilePresenter класса NSFileCoordinator. После добавления презентер начинает получать уведомления. Удаление происходит через removeFilePresenter. Система хранит слабую ссылку на презентера, поэтому объект должен быть жив на протяжении всего периода отслеживания.

По данным Apple WWDC 2022, NSFileCoordinator использует механизм координации на уровне ядра, что обеспечивает минимальную задержку при блокировках. В новейших версиях iOS координатор оптимизирован для работы с Sandbox и расширениями приложений.

Правила координации

Intention — каждая операция чтения или записи должна быть обёрнута в блок координации: чтение через coordinateReadingItemAtURL, запись через coordinateWritingItemAtURL. Координатор автоматически блокирует файл для других участников на время выполнения блока.

Batch coordination — для операций с несколькими файлами используется batch-координация. Координатор атомарно блокирует все указанные файлы, выполняет операцию и снимает блокировки. Это критически важно при перемещении или копировании наборов документов.

Пример реализации NSFilePresenter

Создадим класс DocumentPresenter, который реализует протокол NSFilePresenter и отслеживает изменения файла документа. Класс содержит ссылку на файл, внутренние данные и флаг актуальности.

import Foundation

class DocumentPresenter: NSObject, NSFilePresenter {
    var presentedItemURL: URL? {
        return self.fileURL
    }

    var presentedItemOperationQueue: OperationQueue {
        return self.queue
    }

    private let fileURL: URL
    private let queue = OperationQueue()

    func presentedItemDidChange() {
        self.reloadData()
    }

    func accommodatePresentedItemDeletion() throws {
        try self.saveCurrentState()
    }

    private func reloadData() {
        let coordinator = NSFileCoordinator(filePresenter: self)
        var error: NSError?
        coordinator.coordinate(readingItemAt: self.fileURL,
                               options: [],
                               error: &error)
        { readURL in
            guard let data = try? Data(contentsOf: readURL)
            else { return }
            self.processData(data)
        }
    }

    private func processData(_: Data) {
        // Obrabotka dannykh dokumenta
    }
}

Класс реализует presentedItemDidChange для перезагрузки данных при изменении файла и accommodatePresentedItemDeletion для сохранения состояния перед удалением. Операционная очередь гарантирует, что все уведомления обрабатываются последовательно.

Регистрация презентера выполняется через NSFileCoordinator.addFilePresenter при открытии документа. Важно передать координатору корректные опции чтения — withoutChanges для операций без модификации или immediatelyAvailable для сценариев с немедленным доступом.

Типичные ошибки при работе

Первая распространённая ошибка — отсутствие реализации presentedItemOperationQueue. Если не указать очередь, уведомления могут приходить в произвольном потоке, вызывая гонку данных. Всегда используйте последовательную OperationQueue для обработки уведомлений.

Вторая ошибка — блокировка в методах презентера. Методы протокола вызываются синхронно из координатора. Если презентер выполняет длительную операцию (запись в БД, сетевой запрос), он блокирует координатор для всех остальных участников. Выносите тяжёлые операции в фоновые очереди.

Третья ошибка — игнорирование accommodatePresentedItemDeletion. Если презентер не реализует этот метод и не возвращает ошибку, файл может быть удалён без сохранения текущего состояния. Всегда сохраняйте данные в этом методе, если они ещё не записаны на диск.

Четвёртая ошибка — циклическая координация. Когда презентер внутри метода уведомления снова вызывает координатор для того же файла, возникает deadlock. Проверяйте флаг isCoordinatedOperation перед запуском координации внутри обработчика.