0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

5つのiOSアプリの記録を「記 -Shirushi-」に集約する。App GroupsでLife Timelineを実装した話

0
Posted at

【完成_261022】人生をつなぐ記録のタイムライン.png

個人開発している「記 -Shirushi-」に、ほかのアプリで保存した記録を表示する機能を追加しました。

例えば、ホンヨムで本を読み始めた時刻や掃除!で掃除を終えた時刻。これらを「記」のメイン画面に取り込み、もともとのメモやチェックインと一緒に確認できるようにするものです。

連携元には、筋トレ!、うんき、生徒ミルも加えました。現在は5つのアプリに対応するコードを実装しています。

もともと「記」は、一日の行動をあとから確認できるアプリを作りたいと思って開発を始めたものです。その後、用途ごとに別のアプリを作るようになり、それぞれに記録が蓄積されていきました。

そこで今回、App Groupsを使ってアプリ間で記録を受け渡す仕組みを実装しました。

最初に作りたかったのは、一日の行動を確認するアプリだった

「記」の開発を始めたころから考えていたのは、あとから一日を確認できる仕組みでした。

最初はメモやチェックイン、位置情報の記録から着手しました。その後、MapKitを使った移動経路の再生やApple Watchへの対応など、実装する機能を増やしています。

その一方で、別の用途に使うアプリも作ってきました。

読書を管理する「ホンヨム」には、読み始めた日やページの進捗が残ります。「掃除!」なら、どこを掃除したのか、いつ完了したのかを確認できます。筋トレ!にも運動の履歴が保存されます。

それぞれのアプリで記録する内容は違いますが、どれも自分が何をしていたかを示す情報です。

だったら、それらも「記」で確認できるようにすればいい。

以前から考えていたタイムラインの使い方を、ほかのアプリにも広げることにしました。

現在、連携元として定義しているのは次の5つです。

アプリ Life Timelineに渡すイベントの例
ホンヨム 読書開始・ページ進捗・読了
掃除! 掃除の完了
筋トレ! トレーニングの記録
うんき アプリで記録したイベント
生徒ミル 生徒に関する活動イベント

「記」のメイン画面。撮影用のダミーデータを使用し、5つのアプリの記録を表示したシミュレーター画面。

この画面では、読書の記録や掃除の完了、運動の履歴などを発生日時の順に並べています。

ただし、5つのアプリすべてについて過去履歴の反映まで検証が終わったわけではありません。連携元によって実機での確認状況が異なるため、引き続き検証を進めています。

アプリ同士の受け渡しにはApp Groupsを使った

iOSでは、アプリごとにデータの保存領域が分かれています。

例えば、ホンヨムがSwiftDataに保存した読書履歴を、「記」から直接読み取ることはできません。

そこで利用したのが、App Groupsです。

App Groupsを使うと、同じグループに属するアプリ間で共有コンテナを利用できます。今回設定した識別子は次のとおりです。

group.com.sakumori.life-timeline

各アプリは自分の記録からイベントを生成し、共有コンテナへJSONファイルとして書き出します。「記」はそのファイルを読み込み、タイムラインへ表示する構成にしました。

共有ファイルは、アプリごとに分けています。

アプリ 共有ファイル
ホンヨム honyomu.json
掃除! souji.json
筋トレ! kintore.json
うんき unki.json
生徒ミル student-mill.json

各アプリが更新するのは、自分の共有ファイルだけです。

「記」はファイル名から読み込み対象を決め、JSONに記載された送信元IDと照合します。

この構成なら、例えばホンヨムが読書記録を更新するときに、掃除!が書き出したJSONを変更する必要はありません。

また、読書履歴の本体は引き続きホンヨムが管理します。Life Timelineは共有された情報を表示するため、元の記録を編集する処理は持たせていません。

受け渡す情報は共通のイベント形式にした

アプリごとに保存しているデータの構造は異なります。

ホンヨムでは書籍や読書履歴を扱い、掃除!では掃除する場所や完了状況を管理しています。これらのデータをそのまま「記」で扱うと、連携元が増えるたびにアプリ固有のモデルに対応しなければなりません。

そこで、タイムラインの表示に使う情報を共通の形式へ変換することにしました。

ホンヨムの送信処理では、次の構造体を定義しています。

private struct Event: Encodable {
    let id: String
    let title: String
    let occurredAt: Date
    let priority: String
}

private struct Envelope: Encodable {
    let schemaVersion: Int
    let sourceID: String
    let generatedAt: Date
    let events: [Event]
}

Eventには、イベントの識別子と表示用タイトル、発生日時、優先度を持たせています。

複数のイベントはEnvelopeへまとめます。こちらには送信元のsourceIDとschemaVersionを付け、受信側でファイルの内容を確認できるようにしました。

読書開始のイベントを生成する

ホンヨムでは、書籍のstartedAtに値がある場合、読書開始のイベントを生成します。

if let date = item.startedAt {
    events.append(
        Event(
            id: "book-start:\(item.id.uuidString.lowercased())",
            title: "読み始めた:\(item.title)",
            occurredAt: date,
            priority: "contextual"
        )
    )
}

イベントIDには、書籍のUUIDを利用しました。

例えば、同じ本について共有ファイルを再生成しても、元のUUIDが変わらなければイベントIDは同じになります。

ページ進捗のイベントも生成する

読書開始日だけでは、どこまで読み進めたのか分かりません。

そこで、ページ進捗の記録もイベントへ変換します。

if let entries = try? context.fetch(
    FetchDescriptor<ReadingEntry>()
) {
    for entry in entries {
        guard let page = entry.page,
              page > 0,
              let book = booksByID[entry.bookID] else {
            continue
        }

        events.append(
            Event(
                id: "reading-entry:\(entry.id.uuidString.lowercased())",
                title: "\(book.title):\(page)ページまで読んだ",
                occurredAt: entry.recordedAt,
                priority: "contextual"
            )
        )
    }
}

この処理では、ReadingEntryからページ数と記録日時を取得しています。

書籍名はbooksByIDから参照し、例えば「走れメロス:38ページまで読んだ」というタイトルを生成します。

ページ数が0以下の場合や、対応する書籍が見つからない場合には、イベントを作成しません。

JSONを書き出す

イベントの生成が終わったら、EnvelopeをJSONへ変換します。

let envelope = Envelope(
    schemaVersion: 1,
    sourceID: "jp.sakumori.honyomu",
    generatedAt: now,
    events: events
)

guard let data = try? JSONEncoder().encode(envelope) else {
    return
}

try? data.write(
    to: container.appendingPathComponent("honyomu.json"),
    options: .atomic
)

ファイルの書き込みには.atomicを指定しました。

これにより、書き込みの途中で受信側が不完全なファイルを読み込む事態を避けられます。

共有コンテナに保存するのは、タイムラインで使うイベント情報です。ホンヨムの書籍データを丸ごと複製する仕組みにはしていません。

「記」で読み取るときには内容を検証する

JSONファイルが共有コンテナに存在していても、その内容を無条件に表示するわけにはいきません。

例えば、送信元IDが想定と異なっていたり、イベントの発生日時が未来になっていたりする可能性があります。

「記」では、LinkedLifeEvents.swiftに受信処理を実装しました。

ユーザーがアプリ連携を有効にしている場合、対応する共有ファイルを読み込み、次の条件を確認します。

  • ファイルサイズは2MB以内
  • schemaVersionは1
  • sourceIDは読み込み対象のアプリIDと一致
  • イベントIDは空欄ではない
  • タイトルは2,000文字以内
  • 発生日時は有効で、未来の日時ではない

同じJSON内に同一IDのイベントが複数含まれていた場合は、2件目以降を除外します。

また、イベントIDには送信元IDを付けています。異なるアプリで同じイベントIDが使われても、タイムライン上では別のイベントとして扱えるようにするためです。

読み込みが終わったイベントは、次の処理で発生日時の新しい順に並べ替えます。

return result.sorted {
    $0.occurredAt > $1.occurredAt
}

こうして、ホンヨムの読書記録も掃除!の完了記録も、発生日時を基準に表示できます。

なお、「記」が扱うLinkedLifeEventは表示用のデータです。元アプリの記録を書き換える処理はありません。

読書履歴を修正するならホンヨムで、掃除の完了記録を変更するなら掃除!で操作することになります。

実機で確認すると、ホンヨムの読書進捗が表示されなかった

App Groupsを使った連携の実装後、TestFlightで動作を確認しました。

ホンヨムで本を読み始めた記録は、Life Timelineに表示されました。ところが、ページ進捗や一部の過去履歴が出てきません。

ホンヨムには記録が残っているのに、「記」では確認できない状態です。

そこで、ホンヨムが共有ファイルを生成する処理を調べることにしました。

すると、当時のLife Timeline向けエクスポートでは、読書開始日と読了日だけを書き出していることが分かりました。

通常のバックアップにはページ進捗も含まれていたため、元データが失われていたわけではありません。Life Timelineに渡すイベントを生成する処理が不足していました。

そこで、ReadingEntryやReadingLogから進捗・履歴のイベントを生成する処理を追加しています。

現在のコードには反映しましたが、過去履歴の取り込みや共有ファイルの更新タイミングについては、引き続き実機で確認しているところです。

今回の調査では、App Groupsの設定が正しくても、期待する記録が表示されるとは限らないことを確認できました。

データが表示されない場合には、まず元アプリに記録が存在するかを確認します。

そのうえで、イベントが生成されているか、JSONに書き込まれているか、「記」が読み取れているかを順番に調べる必要があります。

表示されなかった原因が送信側にあるのか、受信側にあるのかで、修正する箇所も変わってきます。

ホンヨムの読書進捗が表示されなかった問題については、別の記事でもう少し詳しく扱う予定です。

今後は履歴の更新と端末間同期が課題になる

現在の実装では、各アプリが共有コンテナへ書き出したJSONを「記」が読み込んでいます。

この方式で考えておかなければならないのが、元データを変更した場合の扱いです。

例えば、ホンヨムで読書履歴を削除したとします。

次に共有ファイルを生成した際、そのイベントもJSONから取り除かれる必要があります。しかし、元アプリでの変更をいつ共有ファイルへ反映するかについては、まだ確認すべき点が残っています。

イベントIDの扱いも重要です。

同じ読書履歴を再出力するたびに別のIDを生成してしまうと、受信側では同一の記録かどうか判断しにくくなります。

ホンヨムでは書籍や読書記録のUUIDからイベントIDを作る方式を採用しました。ただし、現行の重複排除は主に同一JSON内を対象としています。

更新や削除の履歴まで扱うなら、そのための設計が別途必要になります。

もう一つ考えているのが、端末間の同期です。

App Groupsで共有できるのは、同じ端末内にあるアプリのデータです。

例えば、iPhoneを2台使っている場合、一方の端末で生成した共有ファイルが、もう一方へ自動的に届くわけではありません。

端末をまたいでLife Timelineを利用するには、CloudKitなどを使った同期方法も検討する必要があります。

また、「記」ではHealthKitから歩数やワークアウトなどを読み取る開発も進めています。服薬記録についても検討しており、取得権限や扱える記録の種類を確認しているところです。

まとめ

今回、App Groupsの共有コンテナを利用して、5つのアプリから「記」のLife Timelineへイベントを渡す仕組みを実装しました。

各アプリが共通形式のJSONを書き出し、「記」が送信元やイベントの内容を検証してから時系列に並べています。

実機での連携確認では、ホンヨムのページ進捗が共有されていない問題も見つかりました。送信処理は修正しましたが、過去履歴の取り込みや更新時の整合性は引き続き検証が必要です。

次は、ホンヨムの読書進捗がLife Timelineに届かなかった原因を、SwiftDataとエクスポート処理から詳しく追ってみようと思います。

参考資料

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?