LocalBroadcastManager 源码解析

LocalBroadcastManager是干嘛用的

平时我们想到在不同的场景中传递一些消息时，大家会用什么办法。

举个栗子：

比如在 A B C 三个界面都有用户信息。现在在A界面登录，登录成功后同时刷新B，C界面。你说这种情况咋整。

你会说：Handle，EventBus，otto，还有广播。
对了。我们这次讲到就是广播。平时大家用的都是系统级的广播，啥意思。就是你发出的广播：我要吃饭！然后手机内的所有APP都可以收听到你说你要吃饭。至于他们想不想管，就是他们的事了。那你说我只想自己关心自己广播，我不会告诉他们Action，不告诉他们IntentFilter，不就行了。这样是可以，但是不安全。万一人家知道了呢 。

所以要推荐大家使用更加轻量级，更加安全的LocalBroadcastManager。应用内广播。

使用方法很简单，想用的时候注册，不想用的时候注销。该发送的时候发送。这里就不介绍。

转载请注明：http://blog.csdn.net/zezeviyao/article/details/49584811

源码解析正式开始

先看看源码

    // 单例模式 在整个应用中只从在一个 Manager。
    public static LocalBroadcastManager getInstance(Context context) {
        //同步锁
        synchronized (mLock) {
            if (mInstance == null) {
                // 构造方法
                mInstance = new LocalBroadcastManager(context.getApplicationContext());
            }
            return mInstance;
        }
    }
    // 构造方法 参数是Context。
    private LocalBroadcastManager(Context context) {
        mAppContext = context;
        创建了一个主线程上的Handler
        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);
                }
            }
        };
    }

行了 代码太多，我知道你们也不看。

从上面的代码中，可以看出两个重点。一个是LocalBroadcastManager在全局是一个单例。另一个是起构造方法中，创建了一个主线程的Handle，用来执行广播。

注册广播接收者

    // 需要一个 receiver 和 一个 filter
    public void registerReceiver(BroadcastReceiver receiver, IntentFilter filter) {
        synchronized (mReceivers) {
            // 接收者记录器
            ReceiverRecord entry = new ReceiverRecord(filter, receiver);
            ArrayList<IntentFilter> filters = mReceivers.get(receiver);
            if (filters == null) {
                // Google的工程师多么严谨啊
                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) {
                    // Google的工程师多么严谨啊
                    entries = new ArrayList<ReceiverRecord>(1);
                    mActions.put(action, entries);
                }
                entries.add(entry);
            }
        }
    }

mReceivers是一个key为receiver，value为ArrayList < filter >的HashMap.
mReceivers 是接收器和IntentFilter的对应表，主要作用是方便在unregisterReceiver(…)取消注册，同时作为对象锁限制注册接收器、发送广播、取消接收器注册等几个过程的并发访问。
由于一个receiver可能是同时拥有多个filter。这个我们看到，Google的工程师为了减少内存占用，在创建的时候特意创建了容量为 1 的ArrayList。

mActions是一个key为action，value为ArrayList < ReceiverRecord >的HashMap.
就是action 和 接收者记录器 的对应表。表示该action将会被那几个 接收者 关心。

注销广播接收者

继续 继续
注册完，当然要记得注销哦

    // 注销接收者
    public void unregisterReceiver(BroadcastReceiver receiver) {
        synchronized (mReceivers) {
            // 根据receiver，取出它对应的所有 filters，并且remove
            ArrayList<IntentFilter> filters = mReceivers.remove(receiver);
            if (filters == null) {
                return;
            }
            for (int i=0; i<filters.size(); i++) {
                // for 循环查找每一个 filter
                IntentFilter filter = filters.get(i);
                for (int j=0; j<filter.countActions(); j++) {
                     // 根据filter 取出它对应的 Actions。
                    String action = filter.getAction(j);
                    ArrayList<ReceiverRecord> receivers = mActions.get(action);
                     // 根据 action 得到 ReceiverRecord 记录器
                    if (receivers != null) {
                        for (int k=0; k<receivers.size(); k++) {
                            if (receivers.get(k).receiver == receiver) {
                                // 根据action 删除记录器
                                receivers.remove(k);
                                k--;
                            }
                        }
                        if (receivers.size() <= 0) {
                            mActions.remove(action);
                        }
                    }
                }
            }
        }
    }

在注册时，每一个记录器保存一对 receiver 和 filter。

ReceiverRecord entry = new ReceiverRecord(filter, receiver);

注销时，找到这个receiver对应的所有filter，再根据每一个filter的actions，找到ReceiverRecord（记录器），然后remove他们。

发送广播

// 发生一个广播 intent
 public boolean sendBroadcast(Intent intent) {
        synchronized (mReceivers) {
            // 最重要的就是action
            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();
            // 反正就是一堆和 intent相关的参数 包括：action type data scheme categories

            final boolean debug = DEBUG ||
                    ((intent.getFlags() & Intent.FLAG_DEBUG_LOG_RESOLUTION) != 0);
            if (debug) Log.v(
                    TAG, "Resolving type " + type + " scheme " + scheme
                    + " of intent " + intent);

            // 根据action 得到 一堆 记录器 ReceiverRecords
            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 (debug) Log.v(TAG, "Matching against filter " + receiver.filter);

                    if (receiver.broadcasting) {
                        if (debug) {
                            Log.v(TAG, "  Filter's target already added");
                        }
                        continue;
                    }
                    // 查看 发生的intent 和 注册的intent 是否匹配
                    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 (debug) {
                            String reason;
                            switch (match) {
                                case IntentFilter.NO_MATCH_ACTION: reason = "action"; break;
                                case IntentFilter.NO_MATCH_CATEGORY: reason = "category"; break;
                                case IntentFilter.NO_MATCH_DATA: reason = "data"; break;
                                case IntentFilter.NO_MATCH_TYPE: reason = "type"; break;
                                default: reason = "unknown reason"; break;
                            }
                            Log.v(TAG, "  Filter did not match: " + reason);
                        }
                    }
                }

                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是正在的执行者
                        mHandler.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);
                    }
                    return true;
                }
            }
        }
        return false;
    }

这真的没啥说的，核心就两个，用action找到所有关心它的Receiver。然后一一匹配，如果相同，就调用Handler 执行 回调。

执行Receiver的回调

说白了，就是一个 观察者模式。观察者在manager中注册自己。然后被观察（action）被发出时，点用观察者的回调方法。

    // 执行回掉方法
    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循环，把所有的receiver 的 回调方法 onReceive（）都执行一遍。
            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);
                }
            }
        }
    }

是不是很简单。

知其然，知其所以然。

转载请注明：http://blog.csdn.net/zezeviyao/article/details/49584811

如果您有好的工作机会，请联系我：
王建磊
zezeviyao@163.com