[android] AIDLによるプロセス間通信 – Callback編

ホーム > Android, Android Programming > [android] AIDLによるプロセス間通信 – Callback編

[android] AIDLによるプロセス間通信 – Callback編

2009 年 7 月 20 日 mt コメントをどうぞコメント

前回に続いてAIDLのお話です。今回はCallbackしてみます。

流れとしては、

ActivityでServiceをBind
ServiceのCallback登録Interfaceをコール
Serviceに実装したCallback登録Interfaceで、受け取ったCallback情報をリストに登録
Callbackリストを参照して登録されているCallback Interfaceをコール
Activityに実装したCallback Interfaceでなんかする

みたいな感じです。

図にするとこんな感じ。

2009072001

で、コードです。
まずはCallback登録用のInterface。


package jp.xfutures.android.sample;

import jp.xfutures.android.sample.ISampleServiceCallback;

oneway interface ISampleService {
    /**
     * Callback Interfaceを登録する.
     */
    void registerCallback(ISampleServiceCallback callback);

    /**
     * Callback Interfaceを登録解除する.
     */
     void unregisterCallback(ISampleServiceCallback callback);
}

Serviceからの応答を受けないときは、onewayを指定すると良いかも。
次にCallback Interface。


package jp.xfutures.android.sample;

oneway interface ISampleServiceCallback {
    /**
     * 画面を更新するかも.
     */
    void update(String value);
}

Serviceです。
onCreate()でタイマーを仕掛けて、1秒間隔でCallbackを叩くタスクが起動するようにしています。

ISimpleServiceの実装では、registerCallback()でRemoteCallbackListにアイテムを登録、unregisterCallback()で解除します。
こいつはこれだけです。

onCreate()で仕掛けたタイマータスクでCallbackListからアイテムを取得し、実行していきます。
beginBroadcast()でCallback処理を開始、getBroadcastItem()で登録されているアイテムを取得、finishBroadcast()でCallback処理終了です。


package jp.xfutures.android.sample;

import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;

import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.os.RemoteCallbackList;
import android.os.RemoteException;

public class SampleService extends Service {

    /** Callback Interfaceのリスト. */
    private final RemoteCallbackList<ISampleServiceCallback> callbackList
        = new RemoteCallbackList<ISampleServiceCallback>();

    /** たいまー. */
    private Timer timer = new Timer();

    @Override
    public void onCreate() {
        super.onCreate();

        // Callback Interfaceを叩くタイマータスクを実行する
        timer.schedule(task, 0, 1000);

    }

    @Override
    public IBinder onBind(Intent intent) {
        if(ISampleService.class.getName().equals(intent.getAction())){
            // ISampleServiceの実装クラスのインスタンスを返す
            return sampleSerciceIf;
        }
        return null;
    }

    /**
     * ISampleServiceの実装.
     */
    private ISampleService.Stub sampleSerciceIf = new ISampleService.Stub(){
        @Override
        public void registerCallback(ISampleServiceCallback callback)
                throws RemoteException {
            // Callbackリストに登録.
            callbackList.register(callback);
        }

        @Override
        public void unregisterCallback(ISampleServiceCallback callback)
                throws RemoteException {
            // Callbackリストから登録解除.
            callbackList.unregister(callback);
        }
    };

    /**
     * Callback Interfaceを叩くタスク.
     */
    private TimerTask task = new TimerTask(){
        @Override
        public void run() {
            // Callbackリストの処理を開始
            int n = callbackList.beginBroadcast();

            // 全アイテム分ループ
            for(int i = 0; i < n; i++){
                try{
                    // Callback Interfaceを叩く
                    callbackList.getBroadcastItem(i).update(
                            String.valueOf(new Date().getSeconds())
                    );
                }
                catch(RemoteException e){
                    // なんかヤバイ
                }
            }

            // 終わり
            callbackList.finishBroadcast();
        }
    };
}

最後にActivityです。
ServiceConnection.onServiceConnected()でISampleService.registerCallback()を叩いてISampleServiceCallbackを登録します。
あとは、ISampleServiceCallback実装にCallback処理を記述するだけです。今回は単純にServiceから受け取った文字列を表示するだけ。


package jp.xfutures.android.sample;

import android.app.Activity;
import android.content.ComponentName;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.Handler;
import android.os.IBinder;
import android.os.Message;
import android.os.RemoteException;
import android.widget.TextView;

public class SampleActivity extends Activity {

    /** SampleServiceのインターフェイス. */
    private ISampleService sampleServiceIf;

    /**
     * Activityができたよ.
     */
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);

        // SampleSericeにbindする
        Intent intent = new Intent(ISampleService.class.getName());
        bindService(
                intent,
                sampleServiceConn,
                BIND_AUTO_CREATE
        );
    }

    /**
     * Activityがヤラれたよ.
     */
    @Override
    protected void onDestroy() {
        super.onDestroy();

        // unbindService()を叩いてもすぐにunbindされないみたいなので、
        // 先にCallbackの登録を解除しておく
        try{
            sampleServiceIf.unregisterCallback(callback);
        }
        catch(RemoteException e){
           // ムリ・・・
        }

        // SampleServiceからunbindする
        unbindService(sampleServiceConn);
    }

    /**
     * Serviceに接続・切断したときにアレするやつ.
     */
    private ServiceConnection sampleServiceConn = new ServiceConnection(){
        /**
         * サービスに接続したときに叩かれるメソッド.
         */
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            // サービスIFを取得する
            // このIFを使ってサービスとやり取りする
            sampleServiceIf = ISampleService.Stub.asInterface(service);

            try{
                sampleServiceIf.registerCallback(callback);
            }
            catch(RemoteException e){
                // もう、だめ・・・
            }
        }

        /**
         * サービスから切断したときに叩かれるメソッド.
         */
        @Override
        public void onServiceDisconnected(ComponentName name) {
            sampleServiceIf = null;
        }
    };

    /**
     * 画面更新用のHandler.
     */
    private Handler handler = new Handler(){
        @Override
        public void handleMessage(Message msg) {
            // 受け取ったメッセージを出すだけ
            TextView textView = (TextView)findViewById(R.id.TextView01);
            textView.setText((String)msg.obj);
        }
    };

    /**
     * Callback Interfaceの実装.
     * 画面からこれが叩かれる.
     */
    private ISampleServiceCallback callback = new ISampleServiceCallback.Stub(){
        @Override
        public void update(String value) throws RemoteException {
            // 受け取った文字列を画面に設定する.
            handler.sendMessage(Message.obtain(handler, 0, value));
        }
    };
}

まとめ。
AndroidSample2009072001.zip