LocalBroadcastManager原理解析

最近看到阿里巴巴的android手册中提倡应用内用LocalBroadcastManager来发送本地广播。所以就分析一下其源码。

单例模式
public static LocalBroadcastManager getInstance(Context context) {
        synchronized (mLock) {
            if (mInstance == null) {
                mInstance = new LocalBroadcastManager(context.getApplicationContext());
            }
            return mInstance;
        }
    }
/**
构造函数里创建了一个handler
**/
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);
                }
            }
        };
    }

注册BroadcastReceiver
public void registerReceiver(BroadcastReceiver receiver, IntentFilter filter) {
        synchronized (mReceivers) {
            ReceiverRecord entry = new ReceiverRecord(filter, receiver);
            ArrayList<ReceiverRecord> filters = mReceivers.get(receiver);
            if (filters == null) {//mReceivers中没有该receiver，先向map中put一个空list
                filters = new ArrayList<>(1);
                mReceivers.put(receiver, filters);
            }
            filters.add(entry);//向mReceivers中receiver对应的list中添加receiverrecord
            for (int i=0; i<filter.countActions(); i++) {//遍历注册的IntentFilter的action（一个IntentFilter中可能会有多个action），向action对应的list中添加receiverrecord
                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);
            }
        }
    }

如图 该函数主要用两个map来存储信息，第一个mRecivers以receiver为key value是ReceiverRecord列表。ReceiverRecord成员变量就是注册的receiver和intentfilter。（这里用list储存，一个receiver可以有多个intentfilter）。第二个mActions以intentfilter中的action为key，同样list为value存储注册的receiver和intentfilter（这里用list，多个recevier可以同时监听某一个action）

取消注册，围绕注册时的两个变量去移除相应数据
 public void unregisterReceiver(BroadcastReceiver receiver) {
        synchronized (mReceivers) {
            final ArrayList<ReceiverRecord> filters = mReceivers.remove(receiver);
            if (filters == null) {
                return;
            }
            for (int i=filters.size()-1; i>=0; i--) {//遍历receiver对应的每个ReceiverRecord
                final ReceiverRecord filter = filters.get(i);
                filter.dead = true;//标记死亡，无法再响应
                for (int j=0; j<filter.filter.countActions(); j++) {//遍历每个ReceiverRecord中的的IntentFilter中的action
                    final String action = filter.filter.getAction(j);
                    final ArrayList<ReceiverRecord> receivers = mActions.get(action);
                    if (receivers != null) {
                        for (int k=receivers.size()-1; k>=0; k--) {
                            final ReceiverRecord rec = receivers.get(k);
                            if (rec.receiver == receiver) {
                                rec.dead = true;
                                receivers.remove(k);
                            }
                        }
                        if (receivers.size() <= 0) {
                            mActions.remove(action);
                        }
                    }
                }
            }
        }
    }

发送广播：工作根据IntenFilter匹配规则从注册的BroadcastReceiver中匹配receiver
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();
            //根据action去map中查找匹配该action的BroadcastReceiver
            ArrayList<ReceiverRecord> entries = mActions.get(intent.getAction());
            if (entries != null) {
                ArrayList<ReceiverRecord> receivers = null;
                for (int i=0; i<entries.size(); i++) {//遍历匹配到的BroadcastReceiver
                    ReceiverRecord receiver = entries.get(i);
                    if (receiver.broadcasting) {//正匹配，不重复处理
                        continue;
                    }
                    //这里利用IntentFilter的匹配规则根据action，
                    //type，scheme，data来查看遍历的recevier是否完全匹配
                    int match = receiver.filter.match(action, type, scheme, data,
                            categories, "LocalBroadcastManager");
                    if (match >= 0) {
                        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;
                    }
                    //将四项都匹配的Receiver放到一个list中待处理，并且
                    //利用主线程的handler发送一个消息，该handler就是构造函数中创建的handler
                    mPendingBroadcasts.add(new BroadcastRecord(intent, receivers));
                    if (!mHandler.hasMessages(MSG_EXEC_PENDING_BROADCASTS)) {
                        mHandler.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);
                    }
                    return true;
                }
            }
        }
        return false;
    }

handler处理消息调用该方法
private void executePendingBroadcasts() {
        while (true) {
            final BroadcastRecord[] brs;
            synchronized (mReceivers) {
                final int N = mPendingBroadcasts.size();
                if (N <= 0) {
                    return;//回调完匹配到的receiver后退出while循环
                }
                brs = new BroadcastRecord[N];
                mPendingBroadcasts.toArray(brs);
                mPendingBroadcasts.clear();
            }
            for (int i=0; i<brs.length; i++) {
                final BroadcastRecord br = brs[i];
                final int nbr = br.receivers.size();
                for (int j=0; j<nbr; j++) {
                    final ReceiverRecord rec = br.receivers.get(j);
                    if (!rec.dead) {
                    //回调receiver的onReceiver方法，注意这是在主线程中回调，onReceive的参数context是生成LocalBroadcastManager时获取的ApplicationContext intent是发送广播时的intent
                        rec.receiver.onReceive(mAppContext, br.intent);
                    }
                }
            }
        }
    }

结论：LocalBroadcastManager本质上是使用handler来进行通信，它只是利用了Broadcast这一套匹配规则。handler通信仅限于同一进程，所以LocalBroadcastManager也限于同一进程间通信