Intent anywhere

1. はじめに

たまたま抱えていた問題が解決したタイミングで「Android Advent Calendar 2012」の案内が飛んでいたので思わずエントリーしてしまいました。ということで12月29日担当します@awwa500です。よろしくお願いいたします。

2. 概要

CGIからのIntentの送信について書きます。ネタは薄いです。

3. きっかけ

Androidのアプリ開発を初めて3年ちょっとくらいになりますが、Intentの仕組みを知った当時、衝撃を受けました。Intentが世界を変える、とまで思ったのはそれほど大げさではありません。
ところが、そんな信念を打ち砕かんとする事態が発生しました。今回はその辺の話を書いてみようと思います。

4. Intentは最強だよね

IntentについてググるとTechBoosterさんのブログがヒットします。Intentを使えば画面遷移も、アプリ間連携も、サービスの利用も、とにかくいろいろとできるわけです。

Intentで画面遷移する(明示的Intent)
Intentで画面遷移する(暗黙的Intent)
Serviceを使う(1) LocalServiceによる常駐型アプリ
JNIを介してNativeなコードからもIntentを投げることもできます。
Android: How to broadcast intent from native code?
IntentServiceと組み合わせるとキューも簡単に実装できちゃいます。
IntentServiceを使って非同期処理を行う
コマンドラインからもIntentを投げることもできちゃいます。
ターミナルからIntentを投げる

だんだんTechBoosterさんのリンク集みたいになってきましたね。このまま終わってしまってもいい感じになってきました。

5. 挫折

というわけで、どんな状況でもIntentがなんとかしてくれると思っていました。でもこれまでの情報では解決できない事態になりました。例えば、たまにAndroid上でApacheを動かしたくなることがありますよね？（ちょっとこの設定に無理があるような気がしますが、まあ、あるんです）このApacheが駆動するCGIと通常のAndroidアプリケーションを連携させたかったのです。でも、CGIなのでJNIEnvを参照できないためJNIは使えません。でも、amコマンドがあるじゃないか。CGIからamコマンド叩けば大丈夫、そう思っていました。

でもダメでした。orz
※CGIからamコマンドを叩いてIntentをbroadcastした時のLogCat
D/AndroidRuntime(1542): >>>>>> AndroidRuntime START com.android.internal.os.RuntimeInit <<<<<<
D/AndroidRuntime(1542): CheckJNI is OFF
E/dalvikvm(1542): ERROR: must specify non-'.' bootclasspath
W/dalvikvm(1542): CreateJavaVM failed: dvmClassStartup failed
E/AndroidRuntime(1542): JNI_CreateJavaVM failed

JavaVMの生成に失敗しています。エラーメッセージから察するにbootclasspath周りが期待した通りになっていないようです。 Intentを愛するものとしては由々しき事態です。

6. ところでamって？

ところでamコマンドの実体ってどうなってるんでしょう？amコマンドが何をやっているのか見てみる事にします。amコマンド自体はシェルスクリプトです（というか、今回初めて見ました）。中ではam.jarのAmクラスを指定して起動しているようです。

※Emulatorイメージ内の/system/bin/amの内容。 
# Script to start "am" on the device, which has a very rudimentary
# shell.
#
base=/system
export CLASSPATH=$base/framework/am.jar
exec app_process $base/bin com.android.commands.am.Am "$@"

次にAmクラスのコードを見てみます。引数をActivityManagerNative経由でIntent発行しているようです。
※Androidソースの/frameworks/base/cmds/am配下を潜った先のAm.javaの内容。
自分自身をnewしてrun()を呼び出しています。
public static void main(String[] args) {
    try {
        (new Am()).run(args);
    } catch (IllegalArgumentException e) {
        showUsage();
        System.err.println("Error: " + e.getMessage());
    } catch (Exception e) {
        e.printStackTrace(System.err);
        System.exit(1);
    }
}
run()では引数をみて、それぞれの処理を実行しています。今回見たいのは"broadcast"です。
private void run(String[] args) throws Exception {
    if (args.length < 1) {
        showUsage();
        return;
    }

    mAm = ActivityManagerNative.getDefault();
    if (mAm == null) {
        System.err.println(NO_SYSTEM_ERROR_CODE);
        throw new AndroidException("Can't connect to activity manager; is the system running?");
    }

    mArgs = args;
    String op = args[0];
    mNextArg = 1;

    if (op.equals("start")) {
        runStart();
    } else if (op.equals("startservice")) {
        // :
    } else if (op.equals("broadcast")) {
        sendBroadcast();
        // :
    }
    // :
sendBroadcast()では、Intentを生成してbroadcastしています。なんか思ったより普通ですね。 
private void sendBroadcast() throws Exception {
Intent intent = makeIntent();
    IntentReceiver receiver = new IntentReceiver();
    System.out.println("Broadcasting: " + intent);
    mAm.broadcastIntent(null, intent, null, receiver, 0, null, null, null, true, false);
    receiver.waitForFinish();
}

7. 解決

ここで改めてCGIからamコマンド起動時のエラーメッセージに立ち戻ります。bootclasspathが期待した状態になっていない。確かにCGIにしてみたらそんな環境変数のことなんか知らないはずです。
それなら環境変数を設定してやればいいはず、ということで、printenvした結果をamシェルスクリプトの冒頭に挿入したファイルを作成します。たぶん必要なのはBOOTCLASSPATH周りだけだと思いますが、諸事情(確認が面倒)により全部挿入します。雑ですみません。

※anywhere-amと名付けます。（anywhereと言いつつ、printenvした環境でしか動作する保証はありませんが）
# Script to start "am" on the device, which has a very rudimentary
# shell.
#
base=/system
export CLASSPATH=$base/framework/am.jar

export LD_LIBRARY_PATH=/vendor/lib:/system/lib
export HOSTNAME=android
export BOOTCLASSPATH=/system/framework/core.jar:/system/framework/core-junit.jar:/system/framework/bouncycastle.jar:/system/framework/ext.jar:/system/framework/framework.jar:/system/framework/android.policy.jar:/system/framework/services.jar:/system/framework/apache-xml.jar
export PATH=/sbin:/vendor/bin:/system/sbin:/system/bin:/system/xbin
export LOOP_MOUNTPOINT=/mnt/obb
export ANDROID_DATA=/data
export ANDROID_ROOT=/system
export SHELL=/system/bin/sh
export MKSH=/system/bin/sh
export USER=root
export ANDROID_PROPERTY_WORKSPACE=8,32768
export EXTERNAL_STORAGE=/mnt/sdcard
export ANDROID_ASSETS=/system/app
export TERM=vt100
export RANDOM=6011
export ASEC_MOUNTPOINT=/mnt/asec
export HOME=/data
export ANDROID_BOOTLOGO=1
export PS1=$(precmd)$USER@$HOSTNAME:${PWD:-?} #

exec app_process $base/bin com.android.commands.am.Am "$@" > /dev/null 2>> logs/am.log

#echo "end am shell"

anywhere-amコマンドをassetsに格納→インストール時にfilesに展開→chmodで実行権限付与とかすればアプリに組み込んで利用可能になります。もちろんarmビルドしたApacheもassetsに突っ込んで同様に展開します。
あとはBroadcastReceiver側の実装を普通にやって実行するだけです。
ちなみに、環境変数は/init.rcに書かれています。ここから必要な分だけロードするのが正攻法なんでしょうね。

8.おまけ

ところで、上記の流れの後でJava側からCGIに結果を返すにはどうすればいいのでしょう？さすがにIntentを投げ返すわけにもいかず、悩んだ末にIntentより最強のファイル渡しにしました。CGIがIntentを投げた後、特定のフォルダを見張っていて、Java側から結果をファイルに書き出す、というちょっとアレな方法です。Intentで解決できなくて悔しいです。他に何かいい方法ないですかね？
CGIの状態を気にしなくても良いのであればApacheにリクエストを投げつけても良いと思います。

Intentよりファイル渡しが最強みたいなオチになっちゃいましたね。まぁ、いいか。

9.最後に

楽しいイベントに参加させて頂きありがとうございました。主催の@youten_redoさんに感謝です。
また、本投稿の薄いネタを補強していただいたTechBoosterさんにも感謝です。
明日は@shonanshachuさん。今日の裏は@takkeさんです。



それでは良いお年を。

コメント

コメントを投稿

このブログの人気の投稿

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
続きを読む