NSFileCoordinator — điều phối truy cập tệp trong iOS

NSFileCoordinator là gì?

NSFileCoordinator là một cơ chế đồng bộ hóa truy cập tệp ở cấp hệ điều hành, được Apple giới thiệu trong iOS 5 và macOS 10.7 Lion. Không giống như các khóa truyền thống (NSLock, pthread_mutex), bộ điều phối hoạt động ở cấp hệ thống tệp và có thể điều phối truy cập giữa các tiến trình khác nhau, không chỉ giữa các luồng của cùng một ứng dụng.

Sự cần thiết của NSFileCoordinator xuất phát từ kiến trúc Sandbox trong iOS: mỗi tiến trình (ứng dụng, phần mở rộng, dịch vụ hệ thống) chạy trong một môi trường cách ly với quyền truy cập tệp riêng của nó. Khi nhiều tiến trình cố gắng đọc và ghi cùng một tệp đồng thời (ví dụ: trong quá trình đồng bộ hóa iCloud Drive), nếu không có bộ điều phối, các điều kiện cạnh tranh sẽ xảy ra: tiến trình A đọc tệp trong khi tiến trình B đã ghi đè một phần lên nó.

Theo WWDC 2023, Apple khuyến nghị mạnh mẽ sử dụng NSFileCoordinator cho tất cả các thao tác tệp trong vùng chứa Ubiquity (iCloud Drive) và khi làm việc với File Provider Extension. Bỏ qua việc điều phối là một trong những nguyên nhân phổ biến gây hỏng dữ liệu và lỗi không thể tái tạo trong các ứng dụng iOS.

Các loại ý định điều phối

Ý định điều phối (NSFileCoordinator.ReadingIntent / WritingIntent) là một đối tượng khai báo loại thao tác mà một luồng hoặc tiến trình dự định thực hiện. Bộ điều phối sử dụng các ý định này để xác định thứ tự truy cập và giải quyết xung đột.

Quy tắc điều phối: nhiều lần đọc đồng thời được phép (nếu không có ghi đang hoạt động), ghi là độc quyền — không được phép đọc hoặc ghi trong thao tác ghi. Điều này tuân theo mô hình khóa độc giả-người viết, nhưng có hỗ trợ bổ sung cho điều phối liên tiến trình thông qua launchd và XPC.

Sắc thái quan trọng: NSFileCoordinator không ngăn chặn truy cập tệp qua NSData hoặc FileManager thông thường — nó chỉ điều phối các thao tác được bọc rõ ràng trong các khối điều phối. Nếu một luồng khác truy cập trực tiếp vào tệp mà không có bộ điều phối, chính các điều kiện cạnh tranh mà bộ điều phối được thiết kế để ngăn chặn sẽ xảy ra.

NSFileCoordinator hoạt động: ví dụ mã

Mẫu cơ bản sử dụng NSFileCoordinator bao gồm ba bước: tạo một phiên bản của bộ điều phối, khai báo một ý định (đọc hoặc ghi) và thực hiện thao tác bên trong một khối điều phối. Bộ điều phối đảm bảo rằng không có bộ điều phối nào khác làm việc đồng thời với cùng một tệp.

import Foundation

let coordinator = NSFileCoordinator()
let fileURL = getDocumentURL()

// Safe reading
let readIntent = NSFileCoordinator
    .ReadingIntent(url: fileURL)
var content: Data?
var readError: NSError?

coordinator.coordinate(with: readIntent) { error in
    if let error = error {
        readError = error
        return
    }
    content = try? Data(contentsOf: fileURL)
}

// Safe writing
let writeIntent = NSFileCoordinator
    .WritingIntent(url: fileURL)

coordinator.coordinate(with: writeIntent) { error in
    guard error == nil else { return }
    do {
        try newData.write(to: fileURL)
    } catch {
        Logger.storage.error(
            "Write failed: \(error)"
        )
    }
}

Thao tác hàng loạt — bộ điều phối có thể xử lý nhiều tệp trong một thao tác duy nhất bằng cách sử dụng một mảng các ý định. Điều này thuận tiện cho việc di chuyển, sao chép hoặc xóa một tập hợp các tệp như một giao dịch duy nhất. Nếu một trong các ý định không thể thực hiện được, toàn bộ thao tác sẽ bị hủy với một lỗi.

let coordinator = NSFileCoordinator()
let readIntent = NSFileCoordinator
    .ReadingIntent(url: sourceURL)
let writeIntent = NSFileCoordinator
    .WritingIntent(url: destURL)

coordinator.coordinate(
    with: [readIntent, writeIntent]
) { error in
    try? FileManager.default
        .copyItem(at: sourceURL, to: destURL)
}

Điều phối không đồng bộ — bắt đầu từ iOS 15, NSFileCoordinator hỗ trợ các phương thức không đồng bộ với trình xử lý hoàn thành, cho phép điều phối mà không chặn luồng gọi. Điều này rất quan trọng đối với luồng UI, nơi việc chờ đồng bộ để điều phối có thể làm đóng băng giao diện trong nhiều giây.

Giao thức NSFilePresenter và thông báo

NSFilePresenter là một giao thức mà một đối tượng triển khai để nhận thông báo về các thay đổi đối với tệp được điều phối bởi NSFileCoordinator. Nếu ứng dụng của bạn hiển thị nội dung của một tệp có thể bị thay đổi bởi một tiến trình khác (ví dụ: iCloud Drive đồng bộ hóa phiên bản mới), việc triển khai NSFilePresenter cho phép cập nhật giao diện kịp thời.

class DocumentPresenter: NSFilePresenter {
    let presentedItemURL: URL?
    let presentedItemOperationQueue: OperationQueue

    init(url: URL) {
        presentedItemURL = url
        presentedItemOperationQueue = OperationQueue()
    }

    func presentedItemDidChange() {
        DispatchQueue.main.async {
            NotificationCenter.default
                .post(name: .documentDidChange,
                      object: self)
        }
    }

    func presentedItemDidMove(to newURL: URL) {
        Logger.storage.info(
            "File moved to: \(newURL.lastPathComponent)"
        )
    }

    func accommodatePresentedItemDeletion(
        completionHandler: @escaping (Error?) -> Void
    ) {
        Logger.storage.warn("File deleted externally")
        completionHandler(nil)
    }
}

Các phương thức của giao thức: presentedItemDidChange được gọi khi nội dung tệp thay đổi, presentedItemDidMove(to:) — sau khi di chuyển tệp, accommodatePresentedItemDeletion — trước khi xóa tệp bởi một tiến trình khác (cho phép ứng dụng đóng tệp một cách an toàn). Ngoài ra, giao thức hỗ trợ quản lý phiên bản thông qua presentedItemDidGainVersion: và presentedItemDidLoseVersion:.

Quan trọng: NSFilePresenter phải được đăng ký trong hệ thống thông qua NSFileCoordinator.addFilePresenter:. Nếu không đăng ký, các thông báo sẽ không được gửi. Việc đăng ký được thực hiện một lần khi khởi động ứng dụng và không yêu cầu đăng ký lại khi trình trình bày được tạo lại.

Các phương pháp hay nhất về điều phối tệp

Luôn sử dụng bộ điều phối cho các tệp trong vùng chứa Ubiquity (iCloud Drive) và các thư mục có thể truy cập bởi phần mở rộng. Ngay cả khi ứng dụng hiện tại là đơn luồng, các bản cập nhật trong tương lai hoặc thay đổi hệ thống có thể thêm truy cập song song, và việc thiếu điều phối sẽ dẫn đến các lỗi khó tìm.

Giảm thiểu thời gian trong khối điều phối. Trong khi khối đang thực thi, các tiến trình khác không thể truy cập vào tệp. Các thao tác dài bên trong khối (xử lý dữ liệu phức tạp, yêu cầu mạng) chặn toàn bộ hệ thống truy cập tệp. Chỉ thực hiện đọc hoặc ghi dữ liệu bên trong khối và xử lý bên ngoài nó.

Tránh deadlock: không gọi bộ điều phối từ bên trong khối của bộ điều phối khác cho cùng một tệp — điều này sẽ gây ra deadlock lẫn nhau. Sử dụng các thao tác hàng loạt (mảng ý định) thay vì các lệnh gọi lồng nhau. Nếu cần lồng nhau, hãy sử dụng các hàng đợi khác nhau hoặc các URL khác nhau.

Theo objc.io (2024), các lỗi điển hình khi làm việc với NSFileCoordinator bao gồm: thiếu xử lý lỗi trong trình xử lý hoàn thành (dẫn đến các thao tác không hoàn chỉnh); chỉ điều phối cho ghi mà không cho đọc; sử dụng API đồng bộ cũ trên luồng UI; bỏ qua giao thức NSFilePresenter khi làm việc với iCloud Drive. Lỗi cuối cùng là nguy hiểm nhất: ứng dụng hiển thị dữ liệu cũ mà không nhận ra rằng tệp đã được sửa đổi.