より優れたドキュメントベースのアプリを構築

iPadOSの最新機能を使用して、ドキュメントベースのアプリを向上する方法を学びましょう。UIDocumentと既存のデスクトップクラスのiPadやドキュメントベースのAPIを活用して、アプリに新機能を追加する方法をご紹介します。データモデルをUIDocumentに変換する方法、UIDocumentViewControllerを使用したドキュメントの提示補法、最新のAPIへのアプリの移行方法、ベストプラクティスについて説明します。

リソース

関連ビデオ

WWDC23

UIKitの新機能

WWDC22

WWDC20

SwiftUIでドキュメントベースのAppを構築する

Tech Talks

Uniform Type Identifierの再導入

ダウンロード

♪ ♪

皆さんこんにちは私はMichael Ochsですこの動画ではより優れたドキュメントベースのアプリを構築する方法を説明しますドキュメントベースのアプリは特にiPadの生産性向上ツールで重要な役割を果たしますドキュメントベースのアプリは 3種類あります Filesアプリのようなドキュメントの検索を可能にするもの Quick Lookのようなコンテンツの閲覧を可能にするものそしてPages、Keynote Numbersなどコンテンツの編集や作成を可能にするものですこの動画ではビューアーと編集のアプリに焦点を置きますしかしここで話す内容は閲覧アプリにも適用されます iPadOS 17には多数の機能をアプリで自動的に有効にする新しいビューコントローラーが導入されています iPadOS 16で導入されたデスクトップクラスのiPad APIと既存のドキュメントベースのAPIとうまく連携しますこの新しいビューコントローラーはモジュラー方式で構築されていますシステムデフォルトも優れていますが個々の動作をカスタマイズすることもできます

デスクトップクラスの iPad APIについては WWDC22 「Meet desktop-class iPad」と「Build a desktop-class iPad app」をご覧ください

SwiftUI開発に関しては DocumentGroupが追加のコードなしでこれらすべての機能に対応するようになりましたこのSwiftUIに関しては WWDC20「Build document-based apps in SwiftUI」と WWDC22「SwiftUI on iPad: Add toolbars, titles, and more」をご覧ください UIKitでは機能がオプトインされています UIDocumentViewControllerはコンテンツのビューコントローラーの新規ベースクラスで UIDocumentと連携しナビゲーションバーを自動的に構成しますこれは共有やドキュメントのDrag サポートの取り消しや再実行などの機能を有効にしますまた自動リネームもサポートしますこの動画ではUIDocumentの使用方法と UIDocumentViewControllerでドキュメントを提示する方法を説明しますその後どの機能が内蔵されているかそれらをカスタマイズする方法について説明します最後は既存のアプリを移行して UIDocumentを活用するためのベストプラクティスの一部をご紹介しますまずはドキュメントの作成です

すべてのドキュメントベースアプリのコアとなるのはUIDocumentですこれはアプリがサポートする各ファイルタイプのサブクラスとなるはずの抽象基底クラスですすべてのUIDocumentsは URLにより裏付けされていますディスク上のファイルが最も一般的ですがデータベースとカスタムURLスキームを使用してドキュメントを保存し読み込むこともできます UIDocumentの読み込みと保存操作は非同期型であるため必要に応じて長い読み込みと書き込みが可能になりますそのため UIDocumentはスレッドセーフでロックと待ち行列を通じてアクセスを調整します

UIDocumentサブクラスを実装する際に 2つの主要な責任を果たす必要がありますドキュメントの読み込みと保存とドキュメントの内容へのアクセスの提供です読み込みと保存はすべてのドキュメントで類似しています内容へのアクセスはドキュメントの種類やアプリで使用される方法によって異なりますたとえば Markdownエディタのドキュメントモデルには単一のテキストプロパティのみ存在する場合がありますまたはドキュメントの個々の部分の更新を可能にするより複雑なインターフェースを公開できる場合もあります内容へのアクセスについてより詳細にお話しする前に読み込みと保存について説明しましょう簡単なファイルベースのドキュメントは 2つの便利なメソッドでオーバーライドできますドキュメントが開かれると loadFromContents:ofType:がファイルの内容と共に呼び出されますドキュメントが保存されると contentsForType:が呼び出されドキュメントの現在の内容を取得します通常のファイルのドキュメントの内容はデータオブジェクトでそれ以外はすべて FileWrapperとなりますファイルタイプとその機能の詳細については Tech Talksの「Uniform Type Identifiers -- a reintroduction」をご覧くださいこの例ではドキュメントは通常のマークダウンファイルに対処するのでデータオブジェクトを予期します完全に制御したい場合は saveToURL:forSaveOperation:の代わりに readFromURL:とオーバーライドすれば URLへの完全アクセスを取得し自由に読み込みと書き込みができるようになりますこれはドキュメントをデータベースに保存する場合やドキュメントの読み込みと書き込みに特別な要件がある場合に便利です操作の保存は非同期ですが読み込みはメソッドが返された時点で完了するはずであることに注意してくださいドキュメントの読み込みと保存については以上ですではドキュメントの内容へのアクセスが可能であることを確実にしましょうドキュメントの内容へのアクセスを提供するための簡単な方法はその内容にプロパティを作成する方法ですこの例では完全なMarkdown記法が含まれている単一のテキストプロパティを追加しましたこのプロパティは先程のスライドで説明したようにドキュメントを初めて読み込む際に設定されますアプリはユーザーがドキュメントを編集するたびにテキストを更新します UIDocumentが保存が必要であることを理解するためにプロパティが更新されるたびに updateChangeCount:を呼び出します updateChangeCount:を呼び出すと UIDocumentはドキュメントを保存する必要があることを記録し適切なタイミングで自動的に保存します

次は新しいUIDocumentViewControllerでドキュメントを提示する方法についてです

UIDocumentと同様に UIDocumentViewControllerもサブクラスであるべき抽象基底のクラスですドキュメントの開閉と保存を管理し関連のドキュメントからの情報を使ってナビゲーションアイテムを入力しますこれにはタイトルナビゲーションアイテムのタイトルメニュー UIDocumentPropertiesオブジェクト名前変更デリゲートが含まれます UIDocumentViewControllerは取り消しや再実行などの一般的なアクションの主要なコマンドも提供します UIDocumentViewControllerのサブクラスの実装方法を見てみましょう

サブクラスでオーバーライドされるように設計されているメソッドが2つありますビューコントローラーに関連するドキュメントが開かれた場合やすでに開いているドキュメントがビューコントローラーに割当てられた場合 documentDidOpenが呼び出されますビューコントローラーのビューに入力してこのメソッドのドキュメントの内容を表示します documentDidOpenが呼び出されビューコントローラーのビューが読み込まれるまでの時間は保証されていないことに注意してください堅牢なコードを書くための良い方法はビュー構成を独自のメソッドに移動させ documentDidOpenとviewDidLoadの両方から呼び出す方法ですビューを構成する前にビューが読み込まれドキュメントが開いていることを確認してください

オーバライドする2つ目のメソッドは navigationItemDidUpdateです UIDocumentViewControllerがナビゲーションアイテムに変更を加えるとこのメソッドが呼び出されますここにナビゲーションアイテムのカスタマイゼーションを追加します UIDocumentViewControllerは変更を最小限に抑えて変更を最大限に維持するように最善の努力を払いますまた UIDocumentViewControllerは undoRedoItemGroupを提供します取り消しと再実行のボタンを表示する場合はこのグループをナビゲーションバーに追加しドキュメントにUndoマネージャーが割当てられているかを確認してください UIDocumentViewControllerは Undoマネージャーの可用性に基づいてこのグループの「非公開」プロパティに変更を加え必要に応じてグループ内でボタンを有効または無効にします

UIDocumentViewControllerは自動的にドキュメントを開閉しますしかしビューコントローラー以外からドキュメントにアクセスする場合は openDocumentWithCompletionHandlerを呼び出します UIDocumentViewControllerは documentDidOpenなど必要なすべてのコールバックを行い準備ができたら completionHandlerを呼び出します

最後になりますが UIDocumentViewControllerはドキュメントプロパティを提供しますこのプロパティは常にビューコントローラーに関連するドキュメントを参照します初期化中にドキュメントを提供できますがこれはあくまでもオプションですビューコントローラーに関連するドキュメントがない場合は自動的にエンプティステートを表示しますエンプティステートの構成の詳細については「What's new in UIKit」をご覧くださいまた UIDocumentViewControllerはルートビューコントローラーとしても使用できます検索ビューコントローラーが階層内にない場合 UIDocumentViewControllerはドキュメントピッカーを開くドキュメントボタンをナビゲーションバーに追加しますこれにはアプリのinfo.plistの関連するファイルタイプの UIDocumentClassキーを表しそのファイルタイプに一致するUIDocument サブクラスを設定する必要があります

iPadOS 17では UIDocumentは UINavigationItemRenameDelegateに従いユーザーがタイトルメニューから名前の変更を呼び出したときに基礎的なファイル変更を独自で処理します UIDocumentViewControllerを使用している場合自動的に名前の変更が行われますがそれ以外の場合はドキュメントをナビゲーションアイテムの名前変更デリゲートとして手動で設定できます

これまでのすべての情報を活用すると iPadOS 17ですばらしいドキュメントベースのアプリを作成できます次は既存のアプリを移行する方法です

新しいUIDocumentViewControllerを使用するために簡単にアプリを移行できますこれは3つの手順を踏むだけで完了しますまずコンテンツビューコントローラーのベースクラスをアップデートします次に既存のコードを新しいコールバックに移動します最後に必要なくなったコードを削除しますデスクトップクラスの iPadアプリの動画で使用するマークダウンエディタを変換する方法を見てみましょう詳しくなくても心配無用ですまず既存のコードの関連部分について説明します

上部にはビューコントローラーの定義それを定義するドキュメントプロパティ初期のドキュメントを設定しドキュメントにコールバックを追加する initメソッドがあります

まずベースクラスを UIDocumentViewControllerに変更します

このクラスは UIDocumentViewControllerから継承するのでコンパイラエラーが発生しますなぜならプロパティドキュメントは異なるタイプでスーパークラスにすでに存在するからですそのプロパティ名を「MarkdownDocument」のようにより具体的なものに変更します次にジェネリックドキュメントプロパティを変換する計算プロパティをこのビューコントローラーで使用される特定のクラスにします最後はInitializerに対処しますドキュメントにコールバックを割り当てる必要がある唯一のコードですドキュメントはこのビューコントローラーの生存期間中に変更することができるのでドキュメントが変更されるたびに実行されるよう移動します

これを行う簡単な方法はドキュメントプロパティをオーバーライドし didSetコールバックを追加する方法ですこれでベースクラスが最新のものになったので新しいコールバックに対処します viewDidLoadでナビゲーションバーにボタンを追加しツールバーのカスタマイズが可能になるように構成します UIDocumentViewControllerに関してはこれをnavigationItemDidUpdateという新しいコールバックに移動します

次にクラスにはすでに didOpenDocumentメソッドがありますこれはUIDocumentViewControllerのものとほぼ同じですがメソッドの名前を変更してドキュメントがオプションになったことに調整します

次は私たちが最も楽しむ部分コードの削除ですエディタビューコントローラーは UINavigationItemRenameDelegateに従いますしかしこれはもう必要ありません UIDocumentがすべての名前の変更を自動的に行いますですのでデリゲート定義コードのあるデリゲートメソッド renameDelegateの割当をすべて削除します

次にその他のnavigationItem カスタマイゼーションを削除します「style」と「backAction」はどちらもドキュメントビューコントローラーにより自動的に構成されるのでこれを完全に削除することができます

UIDocumentPropertiesオブジェクトを作成するために使用される updateDocumentPropertiesメソッドもありますこのメソッドはさまざまな場所から呼び出されますしかしこれも必要がなくなりました UIDocumentViewControllerがこれをすべて行ってくれるのでこれとすべてのコールサイトを削除できますこれですべて完了ですエディタビューコントローラーはアプリに固有の機能のみに対処しますドキュメント管理の基本的なタスクの管理やナビゲーションバーのデフォルト構成は行わなくなります代わりにアプリに固有な重要な要素に集中できるようになりますドキュメントベースのアプリを次のレベルに引き上げユーザーにすばらしい体験を提供するための情報は以上です

UIDocumentを使用するためにデータモデルを変換します次にコンテンツビューコントローラーを変換して新しいUIDocumentViewController ベースクラスを使用しますその後ビューコントローラーを確認し必要のなくなったコードをすべて削除しますご視聴ありがとうございます ♪ ♪

3:54 - Loading a document

override func load(fromContents contents: Any, ofType typeName: String?) throws {
    // Load your document from contents
    guard let data = contents as? Data,
          let text = String(data: data, encoding: .utf8) else {
        throw DocumentError.readError
    }
    self.text = text
}

4:08 - Saving a document

override func contents(forType typeName: String) throws -> Any {
    // Encode your document with an instance of NSData or NSFileWrapper
    guard let data = self.text?.data(using: .utf8) else {
        throw DocumentError.writeError
    }
    return data
}

4:34 - Manually saving and loading a document

override func save(to url: URL,
                   for saveOperation: UIDocument.SaveOperation,
                   completionHandler: ((Bool) -> Void)? = nil) {
    self.performAsynchronousFileAccess {
        // Set up file coordination and write file to URL
   }
}

override func read(from url: URL) throws {
    // Set up file coordination and read file from URL
}

5:08 - Defining document that require saving

class Document: UIDocument {
    var text: String? {
        didSet {
            if oldValue != nil && oldValue != text {
                self.updateChangeCount(.done)
            }
        }
    }
}

6:30 - Updating the view hierarchy for a document

override func documentDidOpen() {
    configureViewForCurrentDocument()
}

override func viewDidLoad() {
    super.viewDidLoad()
    configureViewForCurrentDocument()
}

func configureViewForCurrentDocument() {
    guard let document = markdownDocument,
          !document.documentState.contains(.closed)
            && isViewLoaded else { return }
    // Configure views for document
}

7:17 - Updating navigation items for a document

override func navigationItemDidUpdate() {
    // Customize navigation item
}

8:01 - Manually opening a document

documentController.openDocument { success in
    if success {
        self.present(documentController, animated: true)
    }
}

9:20 - Renaming a UIDocument without UIDocumentViewController
```
navigationItem.renameDelegate = document
```

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

より優れたドキュメントベースのアプリを構築

関連する章

リソース

関連ビデオ

WWDC23

WWDC22

WWDC20

Tech Talks