File Providerを使用したiOSにおけるデスクトップクラスの同期の実現

File Providerを使用したiOSにおけるデスクトップクラスの同期の実現

File Provider Extensionを作成し、iPhoneやiPadのApp内でファイルをより高速かつ効率的に同期する方法を紹介します。File Providerチームの協力のもと、iOSに対応した最新のFile Providerを構築する方法について学びましょう。ファイルのシームレスな同期、アップロード、ダウンロードに対応するAppの設計方法を紹介し、ファイルプロバイダをステートレス化して、予期しない状況にも対応できるよう強化する方法を説明します。このセッションを最大限活用するには、macOSのFile Providerの使用経験があることが推奨されます。

リソース
関連ビデオ

WWDC21
- macOSにおけるFileProviderを使用したファイルのクラウドへの同期
ダウンロード

こんにちは Johannes Fortmannです Cloud File Providerチームに所属しています本日は新しいFile Provider APIの使用方法について説明します iOS 16に追加されたこのAPIではデスクトップクラスの同期がiOSで実現しますまずAPIを紹介しその後にファイルプロバイダの目的について簡単におさらいします次に Appを設計するにあたっての最適なアプローチについて説明し iOSで特に重要となるベストプラクティスも紹介します最後に iOS上で実行するプロバイダの簡単なデモをお見せします Big Surには Macとファイルを同期するための宣言型APIが導入されましたこのAPIは多くのクラウドベンダーが採用しており成功を収めています私のチームでは継続的にこのAPIの改良に取り組んでおり iOS 16にも対応できたことを嬉しく思いますこのAPIを使用すると「デスクトップクラスの同期環境」と呼ばれるものが iOS向けAppで実現しますこれが何を意味するのか？ iOSのAppがよりパワフルになるにしたがいファイルシステムの共有エリアへのアクセス機能がさらに重要になりますこうしたパワフルなAppではユーザーはあらゆる種類のファイルシステムオブジェクトにアクセスできることを求めます Appからフォルダにアクセスしたり新しいファイルを作成したりできる必要がありますこうした機能を実装すると同時に一貫性を維持する必要もありますこの一貫性とは何を意味するか？ iOSではこれまで消費電力に関する懸念からバックグラウンドでの実行時間が制限されてきましたところがそれと同時にユーザーからは変更内容がバックグラウンドでアップロードされることも求められますこの問題を解消するため最新のFile Provider APIが導入されました基本的なレベルではデベロッパが App Extensionを実装しこれによってアイテムの列挙コンテンツのフェッチとアップロードリモートでの変更があった場合にアイテムリストの更新を処理しますデベロッパが提供する情報を公開する作業や一貫性を維持する作業はシステムが担いますシステムが行う重要なタスクの1つはエラーを追跡し必要に応じて再試行することですコンテンツのフェッチなどの一部の処理の場合再試行はユーザーが必要に応じて自ら行いますユーザーはダウンロードが完了するのを積極的に待ち多くの場合進捗状況バーを目で追っています一方アップロードの場合スケジュール管理が必要になりますシステムがディスク上のアイテムの状態を追跡することにより更新されたコンテンツが確実にアップロードされます進捗状況とエラーが追跡され必要に応じてアップロードが再試行されますアップロード中における一貫性の維持も複雑なトピックですシステムはファイルコンテンツのクローンを管理しアップロード中でもそのファイルに正常にアクセスでき正確なデータが表示されるようにしますこの処理の際システムは同時に複数のAppが同じファイルにアクセスした場合にもローカルバージョンの一貫性が維持されリモートサーバからの同期が反映されるようにしますこれは APFSの機能およびファイルコーディネーションを使用して透過的に処理されますモバイルデバイスではストレージ容量が大きな制約となっていますシステムはAPFSの機能を使用してローカルファイルの状態の変更を詳細に追跡しますこれによりディスクの使用率と最近使用されていないという状態に基づきローカルでの変更履歴がないファイルを透過的に退避させることができます完全にアップロードされたファイルは「設定」のストレージ管理のパネルで Appに対してカウントされませんここまではシステムとExtensionについてお話しました次はこれらとAppとの関係についてお話します関心の分離を厳格に適用することをおすすめしますシステムはディスク上の構造を管理しタスクのスケジュールを管理する役割を担います Extensionはそれらのタスクを実行して上下双方向の同期を行う役割を担いますシステムはファイル階層に関するすべての状態および同期を必要とするアイテムを追跡しますこれは Extensionを大幅に軽量化できることを意味します Extensionでアイテム固有の状態を追跡する必要は一切ありません App側で同期を処理する必要もありません理論的には Appはサーバと一切通信する必要がありません Appはその代わりに Extensionとやり取りしますこれには2つのメカニズムが使われます Appはシステム上のほかのAppが行うのと同様に Extensionと間接的にやり取りできますあらゆる管理対象アイテムのファイルの URLをフェッチするためのAPIがありますこれにはルートも含まれますこれによりこれらの場所はファイルシステムの標準的なAPIを使用してアクセス可能になりますもう1つは Extensionへの直接的な XPCサービス接続を Appでリクエストする方法ですこれは特にファイルシステムの操作として表現できないタスクを処理する場合に便利な方法ですファイルの共有や競合の解消などがこれに該当します両メカニズムとも File Provider UI Extensionで使用することができ統合ポイントをファイルApp内に追加することができます次にステートレスプロバイダで特に重要となる 3つの点について説明しますまずはアップロードについてですすでにお話したようにシステムはアップロードを管理しアップロードの実行にかかる時間を Extensionに付与しますここで重要なのはアップロードが実際に進行していることをシステムが継続的に認識できるよう進捗状況を報告することですアップロードタスクが進行していない場合タスクはキャンセルされますその場合はアップロードをきちんと停止するための猶予時間がシステムから与えられますがキャンセルに時間がかかりすぎた場合は Extensionが終了されますそれではコードを見てみましょうキャンセルハンドラを実装するにはタスク固有メソッドからの進捗の戻り値にそれをセットするだけですアップロードの場合これはmodifyItemになりますハンドラでは実行していた実際のアップロード処理をキャンセルしますもちろん完了ハンドラを呼び出してキャンセルエラーが発生したことを通知する必要もあります便宜上このコード例では非同期タスクキャンセルを使用していますが手動で完了ハンドラを呼び出すことも可能です次は下方同期パスについて説明しますユーザーがファイルを操作した際にメインのAppが実行中でない場合は変更内容をサーバから受け取れませんその場合にもリモートでの変更をシステムに通知するにはプッシュ通知を実装する必要があります PushKitを使用するとファイルプロバイダが特定のプッシュタイプを利用できるようになりますこのようなプッシュ通知は Extensionから直接登録できますサーバで適切に定義されたペイロードを使用してプッシュ通知を送信しますシステムがプッシュ通知を受信し必要に応じて現在の状態を更新しますほかのタイプのタスクと同様にバッテリーの状態やユーザーがファイルを開いているなど状況に応じてシステムが実際の更新を遅らせる場合もありますこの最後の点は強調しておきたいと思いますシステムは Extensionが報告したフォルダ階層を管理しますこのことによりシステムはフォルダ階層全体を供給できますここでExtensionはほかに何もする必要がありません最新のファイルプロバイダの場合これはデフォルトで有効になっていますではこの機能で可能となるワークフローについて簡単なデモをお見せしますデバイスにこのセッションのサンプルコードを用意しましたサンプルコードをiOSに移植してサーバへのログインを処理する iOS Appを作成しましたただしExtensionは macOSバージョンからほとんど変更していません今 iPadでこのサンプルコードを実行しています右側ではファイルAppが開きすでにファイルが同期していますまたフォルダ選択機能の利点を活かしたAppも作成しましたこのAppはフォルダ内のすべての画像にセピアフィルタを適用しますこのようなAppではフォルダへのアクセス機能が有効ですこれは個々のアイテムに対する個別操作を必要とせずフォルダ内のすべてのアイテムを操作できるためですデスクトップクラスの同期環境ではフォルダをファイルAppからバッチエディタに簡単にドラッグできますではフォルダとファイルを表示してこの流れを見てみましょうボタンを押すとすべての写真がダウンロードされ加工されます加工が終わるとファイルは自動的にアップロードされます Extensionによって報告されるアップロードの進捗状況はファイルAppの下部に表示されるためユーザーは状況を把握できますこのような機能を Appに実装する方法を見てみましょうまずはアイテムのドラッグ機能を実装しますドラッグを開始可能にするため onDragメソッドを実装しますこのメソッドから NSItemProviderが返されますドラッグするファイルのタイプを用いてファイル表示方法を itemProviderに登録しますこの例ではフォルダです getUserVisibleURLメソッドを使用して URLをフェッチしますドラッグ先にはonDropを実装しビューをドロップターゲットとしてマークします次にファイルのURLを適切なアイテムプロバイダから読み込みますこれはこのSandbox外に存在するファイルとなります Appからこのファイルにアクセスするには URLのセキュリティ範囲を消費してリリースする必要があります次はこれ以降の手順についてですサンプルコードを更新して iOS Appを追加しましたこれをダウンロードしてシンプルなステートレスプロバイダのセットアップを実験してみてください一から始める場合は更新されたXcodeテンプレートを必ず使用してくださいこれには作業を開始するための基礎が用意されていますファイルプロバイダやその実装方法について詳しく学びたい場合は WWDC21の「macOSにおけるFileProviderを使用したファイルのクラウドへの同期」を参照してくださいご視聴ありがとうございました皆さんの成果と iOSデバイス対応の信頼性の高いプロバイダを楽しみにしています

6:04 - Implement a Progress Cancellation Handler

// Implementing a progress cancellation handler

public func modifyItem(_ item: ..., completionHandler: (..., Error?) -> Void) -> Progress {
    let progress = Progress()
    let uploadTask = Task {
        do {
            // ...
            try Task.checkCancellation()
            // ...
        } catch let error {
            completionHandler(nil, [], false, error)
        }
    }

    progress.cancellationHandler = {
        uploadTask.cancel()
    }
    return progress
}

6:53 - Register for Push Notifications

// Registering for push notifications

import PushKit

let pushRegistry = PKPushRegistry(queue: queue)

pushRegistry.delegate = self
pushRegistry.desiredPushTypes = Set([PKPushType.fileProvider])

...

// On the server: push
//
// {
//    "container-identifier" = "NSFileProviderWorkingSetContainerItemIdentifier"
//    "domain" = "<domain identifier>"
// }
//
// with topic "<your application identifier>.pushkit.fileprovider"

8:53 - Drag and Drop: Implement Dragging

// Sending out drags

var body: some View {
    Text("🥐")
    .onDrag {
        let itemProvider = NSItemProvider()
        itemProvider.registerFileRepresentation(for: .folder,
                                                openInPlace: true) { completionHandler in
            self.manager.getUserVisibleURL(for: folderItemID) { fileURL, error in
                guard let fileURL = fileURL else {
                    completionHandler(nil, false, error)
                    return
                }
                completionHandler(fileURL, true, nil)
            }
            return Progress()  
        }
        return itemProvider
    }
}

9:24 - Drag and Drop: Implement Dropping

// Receiving drops

var body: some View {
    Text("🥬")
    .onDrop(of: [.folder], isTargeted: $dropTarget) { providers in
        guard let prov = providers.first(where: { provider in
            !provider.registeredContentTypes(conformingTo: .folder).isEmpty
        }) else {
            return false
        }
        prov.loadFileRepresentation(for: .folder, openInPlace: true) { url, inPlace, err in
            guard let url = url else { return }
            Task {
                url.startAccessingSecurityScopedResource()
                // use URL
                url.stopAccessingSecurityScopedResource()
            }
        }
        return true
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC21