[Android] 実験人形

（画像は、小池一夫原作、叶精作作画による『実験人形ダミー・オスカー 1 (グループゼロ) 』より引用）

記念すべき100エントリ目なので、口絵で出オチｗ

さて、『Glaeja』がver.2.7.0でLocaleやTaskerのプラグインに対応したわけなんですが、この実装のときに日本語の情報がなくってちょっと往生しました。

Taskerのサイトには情報があるんですが英語ですし、「詳細はLocaleのサイト読め」となっています。

で、Localeのサイトのほうも英語なのは当然として、置いてあるサンプルコードがエラー処理とか、HoneyComb以降のUI対応とか丁寧に書かれすぎてて、逆にわかりにくいものになっちゃってます。

というわけで、Locale/Taskerのプラグイン（Setting/Action）に対応するための実装に関する簡単な解説を日本語で書いておきます。

これを読んで、みんなももっと Locale/Taskerに対応しちゃえばイイとおもいます。



Locale/Taskerには、２種類のプラグイン（Localeではconditionとsetting、Taskerではconditionとaction）がありますが、以下に記すのはTaskerの"action"プラグインの実装についてです。

はじめに．

Locale/Taskerでは、ある条件になった場合に実行するTaskアクションとして、「他アプリに情報を渡して処理させる」という機能があり、これをLocaleでは“setting”プラグイン、Taskerでは“action”プラグインと呼んでいます。

プラグインとは名乗っていますが、その実装はただのアプリで、Locale/TaskerとはIntentを介して、設定や情報の授受をおこなっています。処理の流れを下図に示します。

要するに、

• 設定を行なうための"Activity"
• Taskアクションを受信する"BroascastReceiver"
• これらを識別させるための"IntentFilter"（の記載された"AndroidManifest.xml"）

の３つを含むアプリを作成すればイイわけです。

設定用Activity．

設定用の"Activity"で決められているのは、起動呼び出しの際のIntentFilterだけです。これは、Locale/Taskerから

"com.twofortyfouram.locale.intent.action.EDIT_SETTING"

というアクションで呼び出されることに決められていますので、"AndroidManifest.xml"に、

こんな感じでIntentFilterを記述しておく必要があります。

何をどのように設定するかについては決められていません、どうやろうと（ある程度は）自由です。
決められているのは、設定されたものをLocale/Taskerへ返す方法（Intentへの詰め込み方）と、その制約です。

これは、

• 設定終了時にsetResult()で返すIntentが、
• Taskアクション実行時に（ほぼそのままの形で）Broadcastされる

ためです。つまり「どんな項目を詰め込もうが解釈するのは自分のReceiverなので問題ない」というわけです。

Intentへの詰め込み方について、参考のため『Glaeja』のコードの該当部分を以下に記します。

public static final String EXTRA_STRING_BLURB = "com.twofortyfouram.locale.intent.extra.BLURB";
 public static final String EXTRA_BUNDLE = "com.twofortyfouram.locale.intent.extra.BUNDLE";
 public static final String BUNDLE_EXTRA_STRING_VARNAME = "com.gmail.kanitawa.glaeja.locale.extras.VAR_NAME";
 public static final String BUNDLE_EXTRA_STRING_VARCONTENT = "com.gmail.kanitawa.glaeja.locale.extras.VAR_TEXT";
 public static final String BUNDLE_EXTRA_VARIABLE_REPLACE_KEYS = "net.dinglisch.android.tasker.extras.VARIABLE_REPLACE_KEYS";

 @Override
 public void finish() {
  if (mIsCancelled) { setResult(RESULT_CANCELED);
  } else {
   final String var_name = ((EditText) findViewById(R.id.locale_VarName)).getText().toString();
   final String var_content = ((EditText) findViewById(R.id.locale_VarContent)).getText().toString();
   final String blurb = var_name + " = " + var_content;

   if (0 == var_name.length()) { setResult(RESULT_CANCELED);
   } else {
    final Intent resultIntent = new Intent();
    final Bundle resultBundle = new Bundle();

    resultBundle.putString(BUNDLE_EXTRA_STRING_VARNAME, var_name);
    resultBundle.putString(BUNDLE_EXTRA_STRING_VARCONTENT, var_content);
    resultBundle.putString(BUNDLE_EXTRA_VARIABLE_REPLACE_KEYS, BUNDLE_EXTRA_STRING_VARCONTENT);

    resultIntent.putExtra(EXTRA_BUNDLE, resultBundle);

    if (blurb.length() > 50) { resultIntent.putExtra(EXTRA_STRING_BLURB, blurb.substring(0, 50));
    } else { resultIntent.putExtra(EXTRA_STRING_BLURB, blurb); }

    setResult(RESULT_OK, resultIntent);
   }
  }
  super.finish();
 }

要するに、

1. 設定した項目をBundleに詰め込んで、
2. そのBundleを"com.twofortyfouram.locale.intent.extra.BUNDLE"というkeyでIntentに詰め込む

わけです。
ここでは、

• 『Glaeja』で取り扱う変数名として"com.gmail.kanitawa.glaeja.locale.extras.VAR_NAME"
• 上記変数名に代入する文字列として"com.gmail.kanitawa.glaeja.locale.extras.VAR_TEXT"

の２つと、22行目で、

• "net.dinglisch.android.tasker.extras.VARIABLE_REPLACE_KEYS"

というkeyで、Bundleに入れた代入する文字列のkey名（"com.gmail.kanitawa.glaeja.locale.extras.VAR_TEXT"）の３つを詰め込んでいます。

設定した項目をBundleに詰め込むときのkeyは任意です。後でReceiverで受信したときに自分で取り出すわけですから。ただし、

• ParcelableではなくSerializableなオブジェクトを使え
• Android標準のオブジェクトを使え
• トータルで100KB以下にしろ

という制約があります。さらにTaskerでは、

• int, long, float, double, boolean, String, String[] しか使えない
  

という制約が加わります。…まぁこんだけ使えりゃ問題ありませんね。

最後の"net.dinglisch.android.tasker.extras.VARIABLE_REPLACE_KEYS"は、Taskerで拡張されたもので、
このkeyを持つ文字列に、Bundleに入れた別のkey名を加えておくと、そのkey名の文字列に"%"で始まるTaskerのVariableが含まれていた場合、変数値に置換してから、Taskアクション実行時のIntentとしてBroadcastしてくれます。
複数のkeyを置換させたい場合には、それらを空白文字で区切っておきます。

この場合ですと、エディットテキスト"R.id.locale_VarContent"に"%"で始まるTaskerのVariable名を記述すると、Taskアクション実行時にそれが値に書き換えられてくれる、というわけです。

26・27行目で、返すIntentにExtraとして"com.twofortyfouram.locale.intent.extra.BLURB"というkeyで文字列を加えています。

これは、Locale/Taskerの設定画面に表示するための説明文ですので、適切な文字列を作って入れておきましょう（必須ではないっぽいので無くても構わないと思いますが…）。

受信用BroadcastReceiver．

Taskアクションで発行されるIntentは、

"com.twofortyfouram.locale.intent.action.FIRE_SETTING"

というアクションで発行されますので、これを受信する"BroascastReceiver"は"AndroidManifest.xml"に、

こんな感じで登録してください。

ここで大事なのは、Locale/TaskerのアクションPlugin選択時に候補として現れるためには、Receiverが"AndroidManifest.xml"にIntentFilter付きで登録されている必要がある、ということです。つまり、Service等で無名関数を使ってダイナミックにregisterReceiver()してはいけません。

"BroascastReceiver"自体の実装は簡単です。参考のため『Glaeja』のコードの該当部分を以下に記します。

public class FireReceiver extends BroadcastReceiver {

 @Override
 public void onReceive(Context context, Intent intent) {
  String action = intent.getAction();
  if (action.equalsIgnoreCase(EditActivity.ACTION_FIRE_SETTING)) {
   final Bundle bundle = intent.getBundleExtra(EditActivity.EXTRA_BUNDLE);

   final String var_name = bundle.getString(EditActivity.BUNDLE_EXTRA_STRING_VARNAME);
   final String var_content = bundle.getString(EditActivity.BUNDLE_EXTRA_STRING_VARCONTENT);

   // 抽出したvar_nameとvar_contentをGlaejaに登録して描画更新させる処理

   }
  }
 }
}

6行目でお約束のアクションチェックをした後、7行目でIntentからBundleを取り出し、9・10行目で詰め込んである変数名と内容文字列を抽出しています。
実際の『Glaeja』では、この後に抽出した変数名とその内容文字列を保存し、全ウィジェットの描画更新をさせています。

---

さて、これで簡単な解説は終わりです。

Localeの開発者ページからダウンロードできるサンプルコードでは、エラーチェックやら何やら色々な処理が加えられています。
そのうちのいくつかを簡単に解説すると、

• BundleScrubber：誤って、SerializeできないオブジェクトがBundleに含まれていた場合に、データを変な形で取り出さないようにキチンと削除するためのクラス
• BreadCrumber：設定Activityのタイトルを、いわゆる「パン屑リスト」タイプにするための文字列生成クラス

ですかね。

「あぁ、そういうものなのか」と頭においた上でサンプルコードを読めば、ちょっとは読み易いかもしれません。


いずれにせよ、プラグイン開発するんなら、やはり一度は原文を読んでおくべきだと思います。