Android中ResultReceiver使用

做过Android开发的相信很多人都想过一个组件之间通信回调的问题。

例如使用一个IntentService开新工作线程处理一些耗时任务后，如何通知到启动它的Activity？

有一种办法是自己定义类，继承Parcelable接口，或者是Serializable接口。
Android为我们提供了一种封装好的工具——"ResultReceiver"

来看一下它的构造函数：

/**
 * Create a new ResultReceive to receive results.  Your
 * {@link #onReceiveResult} method will be called from the thread running
 * <var>handler</var> if given, or from an arbitrary thread if null.
 */
public ResultReceiver(Handler handler) {
    mLocal = true;
    mHandler = handler;
}

只需要传入一个Handler，并且这个Handler是 可以为null的。这个Handler的作用只有一个，就是控制回调函数执行在创建Handler的线程。如果在Activity主线程创建的handler实例，则回调也会在主线程执行。就可以直接在回调中操作UI。

最关键的函数：

/**
 * Deliver a result to this receiver.  Will call {@link #onReceiveResult},
 * always asynchronously if the receiver has supplied a Handler in which
 * to dispatch the result.
 * @param resultCode Arbitrary result code to deliver, as defined by you.
 * @param resultData Any additional data provided by you.
 */
public void send(int resultCode, Bundle resultData) {
    if (mLocal) {
        if (mHandler != null) {
            mHandler.post(new MyRunnable(resultCode, resultData));
        } else {
            onReceiveResult(resultCode, resultData);
        }
        return;
    }
    
    if (mReceiver != null) {
        try {
            mReceiver.send(resultCode, resultData);
        } catch (RemoteException e) {
        }
    }
}

当我们的耗时任务执行完，我们将调用这个send方法。这里可以看到。若是实例化时handler传Null，则直接在调用send方法的线程中执行onReceiveResult回调。若是handler不为空，就用handler来post。来看一下这个MyRunnable做了什么。

class MyRunnable implements Runnable {
    final int mResultCode;
    final Bundle mResultData;
    
    MyRunnable(int resultCode, Bundle resultData) {
        mResultCode = resultCode;
        mResultData = resultData;
    }
    
    public void run() {
        onReceiveResult(mResultCode, mResultData);
    }
}

其实只做了一件事，就是调用 onReceiveResult。这里也印证了我上面说的“这个Handler的作用只有一个，就是控制回调函数执行在创建Handler的线程”

最后来看看onReceiveResult是什么。

/**
 * Override to receive results delivered to this object.
 * 
 * @param resultCode Arbitrary result code delivered by the sender, as
 * defined by the sender.
 * @param resultData Any additional data provided by the sender.
 */
protected void onReceiveResult(int resultCode, Bundle resultData) {
}

原来就是一个空函数，看英文注释可以知道，这个是用来给使用者自己Override的，来执行自己的逻辑。

那么流程就是：Activity在启动service时传递ResultReceiver实例给service，然后service执行结束后，调用resulrReceiver.send( , );
然后在onReceiveResult里面处理回调逻辑。

附上demo：

Activity部分

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

    private static Handler handler = new Handler(){
    };
    private ResultReceiver mResultReceiver = new ResultReceiver(handler){
        @Override
        protected void onReceiveResult(int resultCode, Bundle resultData) {
            Toast.makeText(MainActivity.this, "receive " + resultCode, Toast.LENGTH_LONG).show();
        }
    };

    public void onClick(View view){
        Intent intent = new Intent(MainActivity.this, MyIntentService.class);
        intent.putExtra("result_receiver", mResultReceiver);
        startService(intent);
    }

}

Service部分

public class MyIntentService extends IntentService {

    public MyIntentService(){
        super("default");
    }
    /**
     * Creates an IntentService.  Invoked by your subclass's constructor.
     *
     * @param name Used to name the worker thread, important only for debugging.
     */
    public MyIntentService(String name) {
        super(name);
    }

    @Override
    protected void onHandleIntent(Intent intent) {
        Log.d("Sam", "handleIntent");
        ResultReceiver receiver = (ResultReceiver) intent.getExtras().get("result_receiver");
        if (receiver != null){
            receiver.send(19, null);
        }
    }

}

代码的执行结果就是按下按钮则弹出Toast： receive 19