目次
概要
ユーザーデータを端末内の SQLite DB にだけ保存しているアプリでは、ユーザーが端末を買い替えたり、複数の端末で一緒に使おうとしたときに、データを移す手段がありません。
アカウントの仕組みや同期サーバーを自前で作る代わりに、ユーザーの Google ドライブ に DB ファイルを置いておく方法を選びました。この方法には次のようなメリットがあります。
- 別途サーバーや会員登録が必要ない。ユーザーはすでに持っている Google アカウントでログインするだけでよい。
- データはユーザー自身のドライブの保存容量に保存される。
- ファイル 1 つを丸ごとアップロード・ダウンロードする構造なので、テーブルごとの同期ロジックを作る必要がない。
最初はユーザーが設定画面で「アップロード」/「ダウンロード」ボタンを押す手動方式から始め、その後、アプリを使っている間に自動で同期される 自動同期 を追加しました。この記事では、この 2 つの段階をどのように実装したか、そして実際に運用しながらどんな問題に出会い補強したかを整理します。
全体の構成
使用したパッケージは次のとおりです。
| パッケージ | 用途 |
|---|---|
google_sign_in (7.x) | Google ログインとドライブの権限(スコープ)の取得 |
googleapis | Drive API v3 クライアント |
connectivity_plus | オフライン・Wi-Fi の判定 (自動同期) |
ドライブには次のパスにファイルを 1 つ保存します。
マイドライブ
└── <上位フォルダ>/
└── <アプリフォルダ>/
└── <バックアップファイル> ← 暗号化した SQLite DB ファイル
上位フォルダの下にアプリごとのフォルダを 1 階層挟んでおくと、後で同じ方法で別のアプリを作ってもファイルが混ざりません。
全体の流れはシンプルです。
- アップロード: ローカル DB をコピー → 暗号化 → ドライブにアップロード
- ダウンロード: ドライブからダウンロード → 復号 → 整合性チェック → ローカル DB を置き換え
ログインと権限の取得
google_sign_in はバージョン 7 から API が大きく変わり、ログイン(認証) と スコープの権限(認可) を別々に要求します。アプリでは次の順序で呼び出します。
final _scopes = [drive.DriveApi.driveFileScope];
await GoogleSignIn.instance.initialize(serverClientId: serverClientId);
// 1. 以前ログインしたことがあれば、UI なしで静かにログインする。
GoogleSignInAccount? user =
await GoogleSignIn.instance.attemptLightweightAuthentication();
// 2. だめならアカウント選択画面を表示する。
user ??= await GoogleSignIn.instance.authenticate(scopeHint: _scopes);
// 3. ドライブの権限も同様に、静かに → だめなら同意画面の順。
var authorization =
await user.authorizationClient.authorizationForScopes(_scopes);
authorization ??= await user.authorizationClient.authorizeScopes(_scopes);
(理解しやすいように簡略化したコードです。実際のコードでは、各呼び出しにタイムアウトと例外処理が付いています。)
スコープは drive.file (DriveApi.driveFileScope) 1 つだけを要求します。このスコープは アプリ自身が作成したファイルとフォルダにだけ アクセスできる権限なので、ユーザーのほかのドライブファイルを見たり変更したりすることはできません。同意画面でユーザーが感じる負担が少なく、アプリとしても必要な分だけの権限を持つことになります。
ユーザーがアカウント選択や同意画面を閉じると、GoogleSignInException が canceled コードで投げられます。これはエラーではないので、エラーメッセージを出さずに静かに終了します。
DriveApi クライアントを作る
googleapis の DriveApi は http.Client を受け取ります。ログインしたアカウントから認証ヘッダーを受け取り、すべてのリクエストにそのヘッダーを付ける小さなクライアントを作って渡します。
class GoogleAuthClient extends http.BaseClient {
final Map<String, String> header;
final http.Client httpClient = http.Client();
GoogleAuthClient({required this.header});
@override
Future<http.StreamedResponse> send(http.BaseRequest request) {
request.headers.addAll(header);
return httpClient.send(request);
}
}
final header = await user.authorizationClient
.authorizationHeaders([drive.DriveApi.driveFileScope]);
final driveApi = drive.DriveApi(GoogleAuthClient(header: header!));
ここで 1 つ覚えておきたい点があります。このヘッダーには 作成時に受け取ったアクセストークンが固定 されているため、時間が経ってトークンが期限切れになると Drive API が 401 を返します。アプリを長く開いたままにしていると実際にこの状況が起きますが、その対処は後の 運用しながら補強したこと で扱います。
アップロード: DB ファイルをドライブに上げる
アップロードは次の順序で進めます。
// 1. WAL に残っている変更をメインの DB ファイルに反映する。
await dbHelper.walCheckpoint();
// 2. 使用中の DB を直接上げず、一時ファイルにコピーしてから暗号化する。
await fileHelper.copyFile(dbPath, tempPath);
await fileHelper.encryptFile(tempPath, key);
// 3. 上位フォルダとアプリフォルダを探し、なければ作る。
final syncFolder = await driveHelper.getFolderInfo(folderName: rootFolderName) ??
await driveHelper.createFolder(folderName: rootFolderName);
final appFolder = await driveHelper.getFolderInfo(
folderName: appFolderName,
folderId: syncFolder.id,
) ??
await driveHelper.createFolder(folderName: appFolderName, folderId: syncFolder.id);
// 4. ファイルをアップロードしながら、最終変更時刻を appProperties に一緒に付ける。
await driveHelper.uploadFile(
file: File(tempPath),
folderId: appFolder.id,
appProperties: {'localUpdatedAt': localUpdatedAtMs.toString()},
);
// 5. 一時ファイルを削除する。
await fileHelper.deleteFile(tempPath);
いくつかのポイントを見ていきます。
WAL チェックポイント。 SQLite を WAL モードで使っていると、最近の変更の一部が -wal ファイルにだけあり、メインの DB ファイルにはまだ反映されていないことがあります。メインファイルだけをコピーすると最近の変更が抜けてしまうので、コピーの前に PRAGMA wal_checkpoint で反映しておきます。
フォルダの検索。 ドライブは同じ名前のファイル・フォルダを複数許可するため、「パス」で探すことはできず、クエリで検索する必要があります。
final query = "name='$folderName' "
"and mimeType='application/vnd.google-apps.folder' "
"and trashed=false "
"and '$parentId' in parents";
final result = await driveApi.files.list(q: query);
trashed=false を付け忘れると、ユーザーがゴミ箱に入れたフォルダを見つけてその中にアップロードしてしまうので注意が必要です。
appProperties。 Drive のファイルには、アプリ専用のキー・バリュー型メタデータである appProperties を付けられます。ここに「この DB が最後に変更された時刻」を入れておくと、後でファイルをダウンロードせずにメタデータだけを取得して、どちらが新しいかを判断できます。自動同期の核となる値です。
ダウンロード: 受け取ったファイルを検証して置き換える
ダウンロードはアップロードの逆順ですが、受け取ったファイルをすぐには使わない という点が重要です。
// 1. フォルダ → ファイルの順に探し、一時パスにダウンロードする。
final media = await driveApi.files.get(
fileId,
downloadOptions: drive.DownloadOptions.fullMedia,
) as drive.Media;
// media.stream を一時ファイル(tempPath)に保存する。
// 2. 復号する。
await fileHelper.decryptFile(tempPath, key);
// 3. 正常な DB かどうかを検査する。
if (!await dbHelper.isDatabaseValid(tempPath)) {
throw 'DownloadedDBCorrupt';
}
// 4. 検査を通過したときだけ、既存の DB を閉じて置き換える。
await dbHelper.replaceDatabase(tempPath);
検査では SQLite の PRAGMA quick_check でファイルが壊れていないかを確認し、アプリに必要なテーブルとカラムがあるかも一緒に確認します。通信中にファイルが途切れていたり、非常に古いバージョンのバックアップだったりする場合はここで弾かれ、その場合も既存のローカル DB はそのまま残ります。ユーザーデータを上書きする処理なので、置き換えは必ず検証の 後に 行われるよう順序を守る必要があります。
自動同期: 何を比較するか
手動方式ではユーザーが方向(アップロード/ダウンロード)を決めてくれますが、自動同期ではアプリが自分で判断しなければなりません。「ローカルとドライブのどちらが新しいか?」を判断するために、次の 4 つの時刻を使います。
| 記号 | 意味 | 保存場所 |
|---|---|---|
| L | ローカルのユーザーデータを最後に変更した時刻 | ローカル DB の sync_metadata テーブル |
| S | 最後に同期に成功した時刻 | ローカル DB の sync_metadata テーブル |
| R | ドライブのファイルの appProperties.localUpdatedAt | ドライブ |
| R0 | 前回の同期時に見た R の値 | ローカル DB の sync_metadata テーブル |
これらの値で「ローカルが変わったか?」と「リモートが変わったか?」をそれぞれ判断します。
final localChanged = L > S; // 前回の同期以降にローカルが変わった
final remoteChanged = R != null && (R0 == null || R > R0); // 別の端末が新しくアップロードした
この 2 つの値といくつかの例外的な状況を組み合わせると、判断は次のように整理できます。
| 状況 | 判断 |
|---|---|
| ドライブにファイルがなく、ローカルにデータがある | アップロード (初回アップロード) |
| ドライブにファイルがあり、この端末に同期履歴がない | ダウンロード (新しい端末) |
| リモートだけが変わった | ダウンロード |
| ローカルだけが変わった | アップロード |
| 両方が変わった (競合) | より新しい方が勝つ (Last-Write-Wins) |
| 何も変わっていない | 何もしない |
この判断は、I/O をまったく持たない純粋関数(decideAction)として切り出しました。入力の組み合わせごとにユニットテストを書きやすく、同期ロジックの中で最も間違えやすい部分を、ネットワークと切り離して検証できます。
なぜドライブの modifiedTime を使わなかったのか? 最初は、ドライブのファイルの更新時刻とローカルの変更時刻を比較すればよさそうに思えましたが、この方法では「自分がたった今アップロードしたもの」と「別の端末がアップロードしたもの」を区別できません。アップロードが終わると、リモートファイルの更新時刻は常に最新になるからです。そこで、アップロード時にローカルの変更時刻(L)を appProperties として一緒にアップロードし、最後に見た値(R0)を覚えておく方法を選びました。ファイルとメタデータが 1 回のリクエストで一緒にアップロードされるので、両者がずれることもありません。
競合ポリシーはシンプルに。 両方が変わったときにテーブルごとにマージする方法も検討しましたが、性質の異なるデータごとにマージルールを作るのはコストとリスクが大きすぎました。1 人が複数の端末を交互に使う状況では、同時に両方を変更することはまれなので、「より新しい方が勝つ」というシンプルなルールを使い、競合が起きたらどちらを残したかをスナックバーで知らせる程度にとどめました。
新しい端末では確認する。 ただし、1 つのケースだけは自動で処理しません。新しい端末ですでにアプリを使ってデータを貯めた後に自動同期をオンにすると、ルール上は「新しい端末 → ダウンロード」となり、その端末で貯めたデータが消えてしまいます。この場合に限り、「ドライブのデータを使う / この端末のデータを使う / 後で」から選ぶダイアログを表示します。
自動同期: いつ実行するか
最初はバックグラウンドで定期的に同期する方法も考えましたが、あきらめました。
- iOS のバックグラウンドタスク(
BGTaskScheduler)は、実行タイミングを OS が決め、実行も保証されない。 - Android も Doze モードやバッテリー最適化により、定期タスクの信頼性が低い。
- メッセンジャーのようにリアルタイムな反映が必須なデータではない。
そこで アプリがフォアグラウンドにあるときだけ、次の 4 つのタイミングで同期を実行します。
| トリガー | デバウンス |
|---|---|
| アプリ起動直後 | なし (1 回) |
| バックグラウンドからフォアグラウンドへの復帰 | 30 秒 |
| ユーザーデータの変更 | 5 秒 |
| モバイル通信/オフライン → Wi-Fi への切り替え | 30 秒 (フォアグラウンド復帰と共有) |
データ変更のトリガーは、DB にユーザーデータを書き込む処理の最後で L の値を更新するときに一緒に呼び出します。ユーザーが連続して操作すると変更が次々に発生するので、5 秒のデバウンスで最後の変更の後に 1 回だけ同期されるようにしました。
ほかにも、次のルールを設けました。
- 同時実行の防止: すでに同期が進行中なら、新しいトリガーは進行中の処理の結果を一緒に待つ。ユーザーが手動でアップロード/ダウンロードしている間は、自動同期は譲る。
- リトライ: サーバーエラーのような一時的な失敗だけ、2 秒、4 秒の間隔で最大 3 回試行する。ログアウト・オフラインのような結果はリトライしない。
- Wi-Fi 限定オプション: デフォルトでオンにしておき、モバイル通信では自動同期しない。その代わり Wi-Fi に接続した瞬間にすぐ同期されるので、大きく遅れることはない。
- 自動経路ではログイン UI を表示しない: ユーザーが何も押していないのにアカウント選択画面が出ると戸惑ってしまう。自動同期は静かなログイン(
attemptLightweightAuthentication)だけを試み、失敗したら画面上部に「ログインが必要」の状態を表示し、ユーザーが自分でタップして再ログインできるようにする。
運用しながら補強したこと
基本機能は上の内容で動きますが、実際のユーザーの端末では思ったよりさまざまな失敗が起きました。Crashlytics に届くエラーを見ながら補強した内容のうち、代表的なものを整理します。
401: トークンが期限切れになったら 1 回だけ再認証
前述のとおり、認証ヘッダーのトークンは期限切れになります。Drive API が 401 を返したらセッションを破棄し、静かなログインでトークンを取り直してから、同じリクエストをちょうど 1 回だけ 再試行します。再試行でも 401 なら、そのセッションは本当に無効になったとみなし、次の手動操作のときにユーザーに再ログインしてもらいます。
再認証したら別のアカウントだった
Android では、静かなログインでも状況によってアカウント選択シートが表示されることがあります。このときユーザーが別のアカウントを選ぶと、A アカウントのデータを B アカウントのドライブにアップロードしたり、B アカウントのバックアップで A のデータを上書きしたりする事故が起こり得ます。
そこで、各ドライブリクエストの前に「処理を開始したときのアカウント」と「今ログインしているアカウント」が同じかを確認し、違えば処理を止めます。また、最初に同期に成功したアカウントを覚えておき、自動同期が別のアカウントで動こうとしたら止めます。アカウントが入れ替わることはデータ消失に直結するので、この部分は最も慎重に扱いました。
403 を理由ごとに分ける
403 は原因が複数あるため、ステータスコードだけでは対応を決められません。Drive API のエラー(DetailedApiRequestError)の errors[].reason を見て、次のように分けました。
DriveFailureKind classifyDriveFailure(Object e) {
if (e is drive.DetailedApiRequestError) {
if (e.status == 403) {
final reasons = [for (final d in e.errors) d.reason];
if (reasons.isNotEmpty &&
reasons.every((r) => r == 'storageQuotaExceeded')) {
return DriveFailureKind.storageQuotaExceeded;
}
if (reasons.isNotEmpty &&
reasons.every((r) => r == 'userRateLimitExceeded' ||
r == 'rateLimitExceeded')) {
return DriveFailureKind.rateLimited;
}
return DriveFailureKind.other;
}
if (e.status == 429 || (e.status ?? 0) >= 500) {
return DriveFailureKind.transient;
}
}
return DriveFailureKind.other;
}
- 保存容量の不足(
storageQuotaExceeded): リトライしても意味がない。ユーザーにドライブの容量が足りないことを 1 回だけ知らせ、そのセッションでは自動アップロードを止める。データが変わるたびに失敗の通知が繰り返されないようにするためだ。 - リクエスト上限の超過・サーバーエラー: 一時的な失敗とみなしてリトライする。エラーの報告も、最後の試行が失敗したときだけ行う。
- それ以外の 403: 未知のエラーは隠さず、そのまま報告する。
この分類は、エラーレスポンスに errors 配列が入っていることを前提にしています。現在のアップロードは multipart 方式なので入っていますが、アップロード方式を resumable に変えるとレスポンスの形式が変わる可能性があるため、あわせて確認が必要です。
ネイティブ呼び出しにタイムアウトを付ける
まれに、google_sign_in のネイティブ呼び出しが応答せずに止まったままになるケースがありました。こうなると同期ボタンがずっとローディング状態のまま残ってしまいます。そこで、initialize・静かなログイン・権限の確認のような UI のない呼び出しには 15 秒、ユーザーがアカウントを選ぶ対話的な呼び出しには 60 秒のタイムアウトを付け、どの段階で止まったかをエラーに含めて報告するようにしました。
iOS でのバックグラウンド中の接続変更イベント
connectivity_plus の接続変更ストリームを購読し続けていると、iOS でアプリがバックグラウンドにある間にイベントが届き、問題が起きるケースがありました。アプリが paused 状態になったら購読を解除し、resumed に戻ったときに再び購読する方法で回避しました。そもそも自動同期はフォアグラウンドでしか動かないので、バックグラウンドでの接続の変化を受け取る必要はありません。
まとめ
- Google ドライブに DB ファイル 1 つをアップロード・ダウンロードする方式なら、サーバーなしでも端末間のデータ移行と同期を作れる。
- 権限は
drive.fileスコープだけを要求し、アプリが作成したファイルにだけアクセスする。 - アップロード前には WAL チェックポイントを行い、ダウンロードしたファイルは整合性チェックを通過してから置き換える。
- どちらが新しいかは、ファイルをダウンロードせずに
appPropertiesに付けた変更時刻で判断する。modifiedTimeだけでは、自分がアップロードしたものと他の端末がアップロードしたものを区別できない。 - 比較ロジックは I/O のない純粋関数として切り出し、組み合わせごとにテストする。
- 自動同期はフォアグラウンドの決まったタイミングだけで、デバウンスと回数を制限したリトライを設けて実行する。自動経路ではログイン UI を表示しない。
- 実際の運用では、トークンの期限切れ(401)、アカウントの入れ替わり、保存容量の不足(403)、止まったネイティブ呼び出しのように、正常な流れの外の状況を扱うコードの方がずっと多くなる。特にアカウントが混ざる状況はデータ消失に直結するので、最も慎重に防ぐのがよい。
私のブログが役に立ちましたか?下にコメントを残してください。それは私にとって大きな大きな力になります!
アプリ広報
Dekuが開発したアプリを使ってみてください。Dekuが開発したアプリはFlutterで開発されています。興味がある方はアプリをダウンロードしてアプリを使ってくれると本当に助かります。