SyncAdapterのススメ



SyncAdapterの練習用にSmartTrainingにSyncAdapter機能を実装してみました。これを基にざっくりSyncAdapterについてまとめてみました。細かい実装方法は面倒なのでここでは載せませんので、以下のキーワードから自分で調べてください。(と、突き放す。)　宝くじでも当たって仕事しなくて良くなるくらい暇になったらもっと細かい実装方法についても書くかもしれません。
  • SyncAdapterの定義
    • SampleSyncAdapterのように、クラウド上のデータと端末上のデータを相互に連携するための一連の仕組みを指します。
  • SyncAdapterの概要
    • アプリケーション内データとクラウド上データの連携をサポートしてくれる仕組み。
    • 端末のアカウント設定(AccountManager)と連動する。
    • API Level 5以上で利用可。
  • SyncAdapterがやってくれること
    • Syncのトリガを提供してくれる。
    • Sync中にシステムSyncアイコンを表示してくれる。
  • SyncAdapterがやってくれないこと
    • Sync処理(Syncロジック)そのもの
    • 認証処理そのもの
  • メリット
    • アカウント管理を端末のアカウント設定と統合できる。
    • システムSyncアイコンが使える。
      • 同期中の状態をユーザに通知するのにNotificationではちょっと主張が強すぎる。通知領域以外で、バックグラウンドでタスクが実行されていることを表現するのに適している。
    • Sync開始したときに通信不可状態だった場合、通信が復活したら自動的にsyncをしてくれる。
      • 個人的にはこれがSyncAdapterを実装する最大のモチベーション。
      • 一応、ネットワークの状態監視とキュー管理を自前で作れないことはないけど。
  • デメリット
    • 実装しなければいけないことがわりと多い。一般的には以下の実装が必要。
      • SyncAdapter
      • SyncService
      • Authenticator
      • DataProvider
      • SyncServiceのXML定義
      • AuthenticatorのXML定義
      • Syncロジック
      • 認証画面
  • SyncAdapterに必要な実装
    • SyncAdapter
      • Sync動作のエントリポイント(onPerformSync())
      • extends AbstractThreadedSyncAdapter
    • SyncService
      • SyncAdapterのインスタンス生成とそのバインドの返却
      • SampleSyncAdapterサンプルの実装がそのまま使える。
    • Authenticator
      • 認証情報の管理(アカウントの追加、tokenの取得、認証情報の更新など)
      • extends AbstractAccountAuthenticator
    • ContentProvider
      • ローカルデータへのアクセス手段(query, insert, update, delete...)を提供
      • Sync動作はContentResolver単位(≒Authority単位)でトリガをひくため、複数のテーブル、DBなどを1回のSyncで実行するためにはトリガの単位とAuthorityの単位を一致させておく必要がある(Authority設計上の注意)。
    • sync-adapterのXML定義
      • OSにSyncAdapterを認識させるための定義
      • 端末設定の「アカウントと同期」に表示されるようになる。
      • 設定によっては非表示にすることもできる。
    • account-authenticatorのXML定義
      • OSにAuthenticatorを認識させるための定義
      • 端末設定の「アカウントと同期」に表示されるようになる。
      • 設定によっては非表示にすることもできる。
    • Syncロジック
      • アプリケーション固有の実装が必要。
    • 認証画面
      • ユーザに認証情報を入力させるためのUI。
      • 他の認証サービスに相乗りすることもできる。その場合は不要。
    • Syncを利用するアプリケーション
      • Syncのトリガをひく(ContentResolver#requestSync())
  • 必須ではないが関連する実装項目
    • BatchOperation
      • 同期処理をバックグラウンドで実行してくれるための仕組み。
      • ArrayListにoperationを追加しておく。
  • その他テクニック
結構大変だったけど、実装して良かったよ。

いじょうだ。

コメント

コメントを投稿

このブログの人気の投稿

Execノードを使う

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はExecノードです。Execノードを使うと外部のコマンドを実行することができます。コマンドが出力した、標準出力や標準エラー出力などをノードから出力できます。 標準出力の内容を出力する 最初に確認するサンプルは「 flows > node-red > function > exec > 01 - Get standard output from external command 」です。 Execノードのプロパティを見ると以下の通りになっています。 実行コマンドは「 echo 」 msg.payload で受け取った値を引数として利用 出力モードは「 コマンド終了時 - execモード 」 コマンド終了時に結果を出力します Execノードには出力ポートが3つあります。 標準出力 標準エラー出力 返却コード 実行すると、標準出力には「 Hello World! 」、返却コードには「 {code : 0} 」が出力されます。この挙動は特に説明することはないかと思います。 標準エラー出力の内容を出力する 次に確認するサンプルは「 flows > node-red > function > exec > 02 - Get error output from external command 」です。外部コマンドのエラーをポートに出力します。中身は先程のサンプルフローとほぼ同じですが、Execノードで存在しないコマンドを実行しています。 実行すると、以下のログが出力されます。これも説明不要かと思います。 実行中に出力する 最後に確認するサンプルは「 flows > node-red > function > exec > 03 - Run external command in spawn mode 」です。出力がコマンド実行中に行われるのがこれまでのサンプルと違う点です。 コマンドはwhieループ内で2秒おきに「 Hello 」を標準出力に出力し続けます。Spawnモードで実行するとループ内でechoコマンドが実行されるたびにログが出力されます。サービスっぽい挙動をす
続きを読む

Joinノードを使う（その4）

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はJoinノードの4回目です。終わらねぇ。 確認するサンプルは、 前回 に引き続き「 読み込み > サンプル > flows > node-red > sequence > join > 02 - Manual join mode 」です。 メッセージを結合してkey/valueオブジェクトにする 5段目のフローから見ていきます。ざっくりとした流れは以下のとおりです。 DataノードでCSVデータを送信する CsvノードでCSVデータをJSONオブジェクトに変換する msg.payloadには以下のような値が指定されたメッセージ4つに分解される { name: "Apple", price: 100 } Changeノードでmsg.payload内の値を以下のプロパティに設定する msg.topic = "Apple"（msg.payload.nameの値） msg.payload = 100（msg.payload.priceの値） Joinノードで、2個の受信メッセージごとにmsg.topicの値をキーとしてkey/valueオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadにJSONオブジェクトが指定されていることを確認できます。 メッセージを結合して結合オブジェクトにする 先ほどは結合した値がkey/valueオブジェクトでしたが、6段目のフローでは単純にオブジェクト結合します。ざっくりとした流れは以下のとおりです。 DataノードでJSON配列を送信する nameをキーに持つオブジェクトとpriceをキーに持つオブジェクトを交互に含んでいます（実際、こんなに都合の良いデータが生成されることはあるんだろうか） Splitノードで配列データを個別のメッセージに分割します Joinノードで、2個の受信メッセージごとにオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadに2個ずつのオブジェクトがJSONオブジェクトに結合されたものが指定されていることを確認できます。ちなみに、Joinノード
続きを読む

SendGridのX-SMTPAPIヘッダの使い方（Section Tags、Substitution Tags編）

イメージ
前回に引き続き SendGrid についてです。 今回は SMTP API を使ってみました。 SMTP APIについて SendGridのSMTP APIは基本的には普通のSMTPプロトコルに則ったものですが、X-SMTPAPIヘッダというカスタムヘッダを使うことで機能を拡張することができます。 X-SMTPAPIヘッダについて X-SMTPAPIヘッダはSMTPプロトコルの拡張ヘッダです。 X-SMTPAPI: { "category": "newuser" } みたいな感じでJSON形式でパラメータを与えることで機能を拡張します。 Section TagsとSubstitution Tagsについて 今回はSMTP APIで使える機能のうちSection TagsとSubstitution Tagsを使ってみました。 Section TagsとSubsitution Tagsは送信メールの内容を宛先毎に特定の文字列を置換するための機能です。toと合わせて使うことで機能します。 例えば、X-SMTPAPIヘッダの値を以下のような形にします。 { "to": ["test1@xxx.xxx", "test2@yyy.yyy"], "sub": { "-body-": [ "-bodyFemale-", "-bodyMale-" ], "-favorite-": [ "バナナ", "カツオ" ], " "-nickname-": [ "ミキ", "サブロー" ] }, "section": { " "-bodyFemale-": "-nickname-さん！女性向けの商品のご紹介です。", "-bodyMale": "-nickn
続きを読む