LocalBroadcastManager 只能做应用内通信,比系统 BroadcastReceiver 更安全、效率更高,也是官方推荐的应用内广播。系统广播走 Binder;名字里的 Local 容易让人以为它底层也是 Binder。点进源码会发现:更安全高效的实现其实很眼熟——Handler。
用法和普通 BroadcastReceiver 差不多。更多可见 BroadcastReceiver 详细介绍。
一、怎么用
1. 自定义 BroadcastReceiver 子类
public class LocalBroadcastReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
localMsg.setText(intent.getStringExtra(MSG_KEY));
}
}
2. 注册接收器
LocalBroadcastReceiver localReceiver = new LocalBroadcastReceiver();
LocalBroadcastManager.getInstance(context).registerReceiver(localReceiver, new IntentFilter(ACTION_LOCAL_SEND));
3. 发送广播
LocalBroadcastManager.getInstance(context).sendBroadcast(new Intent(ACTION_LOCAL_SEND));
4. 取消注册
LocalBroadcastManager.getInstance(context).unregisterReceiver(localReceiver);
二、构造函数:单例 + 主线程 Handler
源码见 LocalBroadcastManager.java。单例,构造函数私有。基于主线程 Looper 建 Handler,handleMessage 里处理广播,核心是后面的 executePendingBroadcasts()。双检锁写法可再提高效率。
public static LocalBroadcastManager getInstance(Context context) {
synchronized (mLock) {
if (mInstance == null) {
mInstance = new LocalBroadcastManager(context.getApplicationContext());
}
return mInstance;
}
}
private LocalBroadcastManager(Context context) {
mAppContext = context;
mHandler = new Handler(context.getMainLooper()) {
@Override
public void handleMessage(Message msg) {
switch (msg.what) {
case MSG_EXEC_PENDING_BROADCASTS:
executePendingBroadcasts();
break;
default:
super.handleMessage(msg);
}
}
};
}
三、注册:两张表
HashMap<BroadcastReceiver, ArrayList<IntentFilter>> mReceivers
= new HashMap<BroadcastReceiver, ArrayList<IntentFilter>>();
HashMap<String, ArrayList<ReceiverRecord>> mActions
= new HashMap<String, ArrayList<ReceiverRecord>>();
public void registerReceiver(BroadcastReceiver receiver, IntentFilter filter) {
synchronized (mReceivers) {
ReceiverRecord entry = new ReceiverRecord(filter, receiver);
ArrayList<IntentFilter> filters = mReceivers.get(receiver);
if (filters == null) {
filters = new ArrayList<IntentFilter>(1);
mReceivers.put(receiver, filters);
}
filters.add(filter);
for (int i=0; i<filter.countActions(); i++) {
String action = filter.getAction(i);
ArrayList<ReceiverRecord> entries = mActions.get(action);
if (entries == null) {
entries = new ArrayList<ReceiverRecord>(1);
mActions.put(action, entries);
}
entries.add(entry);
}
}
}
-
mReceivers:以 BroadcastReceiver 为 key、IntentFilter 链表为 value。方便 unregisterReceiver,同时当对象锁,限制注册/发送/反注册并发
-
mActions:以 Action 为 key、注册该 Action 的 BroadcastReceiver 链表为 value。发送后快速找到能接收的 Receiver
四、发送:match 后丢给 Handler
public boolean sendBroadcast(Intent intent) {
synchronized (mReceivers) {
final String action = intent.getAction();
final String type = intent.resolveTypeIfNeeded(mAppContext.getContentResolver());
final Uri data = intent.getData();
final String scheme = intent.getScheme();
final Set<String> categories = intent.getCategories();
……
ArrayList<ReceiverRecord> entries = mActions.get(intent.getAction());
if (entries != null) {
if (debug) Log.v(TAG, "Action list: " + entries);
ArrayList<ReceiverRecord> receivers = null;
for (int i=0; i<entries.size(); i++) {
ReceiverRecord receiver = entries.get(i);
if (receiver.broadcasting) {
if (debug) {
Log.v(TAG, " Filter's target already added");
}
continue;
}
int match = receiver.filter.match(action, type, scheme, data,
categories, "LocalBroadcastManager");
if (match >= 0) {
if (debug) Log.v(TAG, " Filter matched! match=0x" +
Integer.toHexString(match));
if (receivers == null) {
receivers = new ArrayList<ReceiverRecord>();
}
receivers.add(receiver);
receiver.broadcasting = true;
} else {
……
}
}
if (receivers != null) {
for (int i=0; i<receivers.size(); i++) {
receivers.get(i).broadcasting = false;
}
mPendingBroadcasts.add(new BroadcastRecord(intent, receivers));
if (!mHandler.hasMessages(MSG_EXEC_PENDING_BROADCASTS)) {
mHandler.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);
}
return true;
}
}
}
return false;
}
按 Action 从 mActions 取出 ReceiverRecord,循环用 filter.match 比对 action、type、scheme、data、categories。匹配则放入 receivers,再发 what 为 MSG_EXEC_PENDING_BROADCASTS 的消息给 Handler。match 规则见 Intent Filter 介绍。
五、executePendingBroadcasts
private void executePendingBroadcasts() {
while (true) {
BroadcastRecord[] brs = null;
synchronized (mReceivers) {
final int N = mPendingBroadcasts.size();
if (N <= 0) {
return;
}
brs = new BroadcastRecord[N];
mPendingBroadcasts.toArray(brs);
mPendingBroadcasts.clear();
}
for (int i=0; i<brs.length; i++) {
BroadcastRecord br = brs[i];
for (int j=0; j<br.receivers.size(); j++) {
br.receivers.get(j).receiver.onReceive(mAppContext, br.intent);
}
}
}
}
把 mPendingBroadcasts 转成数组,循环每个 receiver 调 onReceive,广播核心逻辑就结束了。
六、取消注册
public void unregisterReceiver(BroadcastReceiver receiver) {
synchronized (mReceivers) {
ArrayList<IntentFilter> filters = mReceivers.remove(receiver);
if (filters == null) {
return;
}
for (int i=0; i<filters.size(); i++) {
IntentFilter filter = filters.get(i);
for (int j=0; j<filter.countActions(); j++) {
String action = filter.getAction(j);
ArrayList<ReceiverRecord> receivers = mActions.get(action);
if (receivers != null) {
for (int k=0; k<receivers.size(); k++) {
if (receivers.get(k).receiver == receiver) {
receivers.remove(k);
k--;
}
}
if (receivers.size() <= 0) {
mActions.remove(action);
}
}
}
}
}
}
从 mReceivers 和 mActions 里删掉对应项。
七、结论
| 对比 |
系统 BroadcastReceiver |
LocalBroadcastManager |
| 通信 |
Binder 跨进程 |
进程内 Handler |
| 范围 |
可跨应用 |
仅应用内 |
| 安全 / 效率 |
需权限、开销大 |
更安全、更快 |
| 匹配 |
系统 IntentFilter |
同样用 IntentFilter.match |
-
核心实现其实是 Handler,只是借用了 IntentFilter 的 match;BroadcastReceiver 换成别的接口也行,只是沿用现成概念
-
因为是 Handler 做的应用内通信,自然更安全、效率更高——不是 Binder
一句话总结:LocalBroadcastManager 不是 Binder,是主线程 Handler + IntentFilter.match 的应用内投递。