NSFilePresenter: apa itu, protokol NSFileCoordinator dan metode pelacakan

Apa itu NSFilePresenter?

NSFilePresenter — adalah protokol Foundation yang dirancang untuk melacak perubahan file dan direktori di sistem operasi Apple. Protokol mendefinisikan serangkaian metode yang diimplementasikan oleh objek pengamat untuk menerima pemberitahuan tentang peristiwa sistem file.

Tugas utama protokol adalah memastikan akses aman ke file dalam skenario multi-thread. Di iOS dan macOS, beberapa proses dan thread dapat mengakses file yang sama secara bersamaan melalui NSFileCoordinator, dan NSFilePresenter menjamin bahwa setiap peserta menerima status data terbaru.

Protokol ini disertakan dalam Foundation sejak iOS 5.0 dan macOS 10.7. Ini digunakan dalam aplikasi yang bekerja dengan dokumen, basis data, dan file apa pun yang dapat diubah secara bersamaan dari sumber berbeda — misalnya, saat sinkronisasi melalui iCloud atau pengeditan bersama.

Di mana NSFilePresenter Digunakan

Aplikasi Berorientasi Dokumen — area penggunaan utama NSFilePresenter. Aplikasi yang bekerja dengan UIDocument atau NSDocument secara otomatis mendaftarkan diri sebagai presenter melalui NSFileCoordinator. Ini memungkinkan penanganan konflik dengan benar saat mengedit file yang sama dari beberapa jendela atau perangkat.

Sinkronisasi iCloud — skenario kunci kedua. Ketika file berubah di satu perangkat, iCloud menyinkronkannya di semua perangkat yang terhubung. NSFilePresenter memberi tahu aplikasi tentang perubahan ini, memungkinkan pembaruan antarmuka tepat waktu.

Editor Multi-Thread — skenario ketiga. Dalam aplikasi di mana antrian latar memuat dan menyimpan data bersamaan dengan pekerjaan pengguna, NSFilePresenter mencegah kondisi balapan saat menulis dan membaca file.

Bagaimana NSFilePresenter Bekerja?

Mekanisme Kerja NSFilePresenter didasarkan pada model delegasi: objek mengimplementasikan metode protokol, mendaftar melalui NSFileCoordinator dan menerima panggilan pada setiap perubahan file yang dilacak. Sistem sendiri menentukan kapan perubahan terjadi dan metode mana yang harus dipanggil.

Proses dimulai dengan objek membuat instance NSFileCoordinator dan memanggil metode koordinator dengan melewatkan URL file. Koordinator memeriksa apakah ada presenter yang terdaftar untuk URL ini. Jika ya, ia memblokir akses baca atau tulis dan memberi tahu presenter tentang perubahan yang akan datang melalui metode protokol.

Setelah operasi selesai, koordinator melepaskan kunci dan memanggil pemberitahuan akhir. Penting bahwa presenter tidak mengelola alur eksekusi — ia hanya bereaksi terhadap peristiwa. Koordinasi sepenuhnya menjadi tanggung jawab NSFileCoordinator.

Siklus Hidup Pemberitahuan

Fase Persiapan — sebelum menjalankan operasi, koordinator memanggil metode accommodatePresentedItemDeletion atau accommodatePresentedSubitemDeletion. Presenter dapat menangani situasi atau membatalkan operasi dengan mengembalikan kesalahan. Fase ini memungkinkan aplikasi menyelesaikan pekerjaan dengan file dengan benar sebelum perubahannya.

Fase Pemberitahuan — setelah operasi selesai, koordinator memanggil presentedItemDidChange atau presentedSubitemDidChange. Presenter menerima sinyal bahwa file telah berubah dan dapat membaca ulang kontennya. Untuk pemindahan file, presentedItemDidMoveToURL dipanggil dengan lokasi baru.

Fase Penyelesaian — koordinator melepaskan semua kunci dan membebaskan sumber daya. Presenter dapat melanjutkan pekerjaan dengan data yang diperbarui. Ketiga fase dieksekusi secara sinkron dalam thread yang sama, oleh karena itu metode protokol harus bekerja cepat, tanpa operasi input-output yang lama.

Metode Utama Protokol

Protokol NSFilePresenter berisi beberapa metode wajib dan opsional. Satu-satunya properti wajib adalah presentedItemURL, yang mengembalikan URL file atau direktori yang dilacak. Tanpa properti ini, objek tidak dapat didaftarkan sebagai presenter.

Metode Wajib

presentedItemURL — properti bertipe URL? yang harus mengembalikan jalur ke file yang dilacak. Jika objek melacak banyak file, properti mengembalikan URL elemen utama. Untuk direktori, URL direktori itu sendiri dikembalikan.

presentedItemDidChange — dipanggil setelah perubahan konten file yang dilacak. Dalam metode ini, presenter memperbarui status internal dan memuat ulang data. Metode ini tidak menerima informasi tentang apa yang sebenarnya berubah — hanya fakta perubahan.

Metode Opsional

accommodatePresentedItemDeletion — dipanggil sebelum penghapusan file. Presenter dapat menyimpan status saat ini, menutup deskriptor file, atau membatalkan operasi dengan mengembalikan NSError. Jika metode mengembalikan kesalahan, operasi penghapusan tidak dilakukan.

presentedItemDidMoveToURL — dipanggil setelah pemindahan atau penggantian nama file. Metode menerima URL baru, dan presenter harus memperbarui referensi ke file. Tanpa implementasi metode ini, presenter akan terus menunjuk ke jalur lama yang tidak ada.

NSFilePresenter dan NSFileCoordinator

NSFileCoordinator dan NSFilePresenter — pasangan yang tidak terpisahkan. NSFileCoordinator mengelola akses ke file dan memanggil metode presenter. Presenter tidak bekerja langsung dengan sistem file — semua operasi melalui koordinator yang menjamin atomicitas perubahan.

Koordinator mendaftarkan presenter melalui metode addFilePresenter dari kelas NSFileCoordinator. Setelah ditambahkan, presenter mulai menerima pemberitahuan. Penghapusan dilakukan melalui removeFilePresenter. Sistem menyimpan referensi lemah ke presenter, oleh karena itu objek harus tetap hidup selama periode pelacakan.

Menurut Apple WWDC 2022, NSFileCoordinator menggunakan mekanisme koordinasi di tingkat kernel, yang memastikan latensi minimal saat penguncian. Dalam versi terbaru iOS, koordinator dioptimalkan untuk bekerja dengan Sandbox dan ekstensi aplikasi.

Aturan Koordinasi

Intention — setiap operasi baca atau tulis harus dibungkus dalam blok koordinasi: baca melalui coordinateReadingItemAtURL, tulis melalui coordinateWritingItemAtURL. Koordinator secara otomatis mengunci file untuk peserta lain selama eksekusi blok.

Koordinasi Batch — untuk operasi dengan banyak file, digunakan koordinasi batch. Koordinator secara atomik mengunci semua file yang ditentukan, menjalankan operasi, dan melepaskan kunci. Ini sangat penting saat memindahkan atau menyalin set dokumen.

Contoh Implementasi NSFilePresenter

Mari buat kelas DocumentPresenter yang mengimplementasikan protokol NSFilePresenter dan melacak perubahan file dokumen. Kelas berisi referensi ke file, data internal, dan flag aktualitas.

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) {
        // Pemrosesan data dokumen
    }
}

Kelas mengimplementasikan presentedItemDidChange untuk memuat ulang data saat file berubah dan accommodatePresentedItemDeletion untuk menyimpan status sebelum penghapusan. Antrian operasi menjamin bahwa semua pemberitahuan diproses secara berurutan.

Pendaftaran presenter dilakukan melalui NSFileCoordinator.addFilePresenter saat membuka dokumen. Penting untuk memberikan opsi baca yang benar ke koordinator — withoutChanges untuk operasi tanpa modifikasi atau immediatelyAvailable untuk skenario dengan akses segera.

Kesalahan Umum dalam Bekerja

Kesalahan umum pertama — kurangnya implementasi presentedItemOperationQueue. Jika Anda tidak menentukan antrian, pemberitahuan dapat datang di thread sembarang, menyebabkan perlombaan data. Selalu gunakan OperationQueue sekuensial untuk memproses pemberitahuan.

Kesalahan kedua — memblokir dalam metode presenter. Metode protokol dipanggil secara sinkron dari koordinator. Jika presenter melakukan operasi panjang (menulis ke database, permintaan jaringan), ia memblokir koordinator untuk semua peserta lain. Pindahkan operasi berat ke antrian latar.

Kesalahan ketiga — mengabaikan accommodatePresentedItemDeletion. Jika presenter tidak mengimplementasikan metode ini dan tidak mengembalikan kesalahan, file dapat dihapus tanpa menyimpan status saat ini. Selalu simpan data dalam metode ini jika belum ditulis ke disk.

Kesalahan keempat — koordinasi siklik. Ketika presenter di dalam metode pemberitahuan memanggil koordinator lagi untuk file yang sama, terjadi deadlock. Periksa flag isCoordinatedOperation sebelum memulai koordinasi di dalam handler.