LocalBradcastManager源码分析

基本使用

LocalBroadcastManager是Android Support包提供了一个工具,用于在同一个应用内的不同组件间发送BroadcastReceiver。
android.support.v4.content.LocalBroadcastManager工具类,可以实现在自己的进程内进行局部广播发送与注册,使用它比直接通过sendBroadcast(Intent)发送系统全局广播有以下几个好处:

  • 因广播数据在本应用范围内传播,不用担心隐私数据泄露的问题
  • 不用担心别的应用伪造广播,造成安全隐患
  • 相比在系统内发送全局广播,它更高效

广播的注册

var mLocalBroadcastManager: LocalBroadcastManager? = null
var mReceiver: BroadcastReceiver? = null

val filter = IntentFilter()
filter.addAction("action")
mReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context?, intent: Intent?) {

    }
}
mLocalBroadcastManager = LocalBroadcastManager.getInstance(this)
mLocalBroadcastManager?.registerReceiver(mReceiver!!, filter)

反注册

mLocalBroadcastManager.unregisterReceiver(mReceiver!!)

广播的发送

LocalBroadcastManager.getInstance(context).sendBroadcast(new Intent("action"));

源码解析

注册广播时,会将BroadcastReceiver和IntentFilter保存到HashMap中。发送广播时,则根据IntentFilter的Action值从已保存的HashMap找到对应接受者,并发送Handler消息去执行receiver的onReceive方法。同步方法则直接调用receiver的onReceive方法。

成员变量

private final HashMap<BroadcastReceiver, ArrayList<IntentFilter>> mReceivers
        = new HashMap<BroadcastReceiver, ArrayList<IntentFilter>>();//用于保存注册的BroadcastReceiver和IntentFilter
private final HashMap<String, ArrayList<ReceiverRecord>> mActions
        = new HashMap<String, ArrayList<ReceiverRecord>>();//用于保存action和ReceiverRecord集合

private final ArrayList<BroadcastRecord> mPendingBroadcasts
        = new ArrayList<BroadcastRecord>();//用于保存待分发的广播

BroadcastRecord

主要是对Intent和ReceiverRecord的封装

private static class BroadcastRecord {
    final Intent intent;
    final ArrayList<ReceiverRecord> receivers;

    BroadcastRecord(Intent _intent, ArrayList<ReceiverRecord> _receivers) {
        intent = _intent;
        receivers = _receivers;
    }
}

ReceiverRecord

主要是对IntentFilter和BroadcastReceiver的封装

private static class ReceiverRecord {
    final IntentFilter filter;
    final BroadcastReceiver receiver;
    boolean broadcasting;

    ReceiverRecord(IntentFilter _filter, BroadcastReceiver _receiver) {
        filter = _filter;
        receiver = _receiver;
    }
}

registerReceiver

注册广播

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);//添加receiver和IntentFilter
        }
        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);//添加action和ReceiverRecord
            }
            entries.add(entry);
        }
    }
}
  • 首先通过查找mReceivers中找到已经注册的IntentFilter,并添加进ArrayList<IntentFilter>中
  • 遍历IntentFilter的action,将action对应的ReceiverRecord添加进ArrayList<ReceiverRecord>中

其实注册动作就是向HashMap中添加元素,进行保存

unregisterReceiver

反注册广播

    public void unregisterReceiver(BroadcastReceiver receiver) {
        synchronized (mReceivers) {
            ArrayList<IntentFilter> filters = mReceivers.remove(receiver);//根据receiver得到ArrayList<IntentFilter>并从mReceivers中移除
            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);//获取ReceiverRecord的集合
                    if (receivers != null) {
                        for (int k=0; k<receivers.size(); k++) {
                            if (receivers.get(k).receiver == receiver) {
                                receivers.remove(k);//移除ReceiverRecord
                                k--;
                            }
                        }
                        if (receivers.size() <= 0) {
                            mActions.remove(action);//如果action对应的ArrayList<ReceiverRecord>为空代表这个action没有注册的广播了,进行移除
                        }
                    }
                }
            }
        }
    }

反注册的过程与注册的过程相反,主要是从两个HashMap移除数据

sendBroadcast

广播的发送,代码比较长,我把无关紧要的debug代码和log删除了

    public boolean sendBroadcast(Intent intent) {
        synchronized (mReceivers) {
            //得到Intent中的action、type、data、scheme和categories
            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());//从mActions得到ReceiverRecord的集合,也就是我们需要广播的对象
            if (entries != null) {
                ArrayList<ReceiverRecord> receivers = null;
                for (int i=0; i<entries.size(); i++) {
                    ReceiverRecord receiver = entries.get(i);
                    if (receiver.broadcasting) {
                        continue;//正在广播则不处理
                    }
                    int match = receiver.filter.match(action, type, scheme, data,
                            categories, "LocalBroadcastManager");//根据action、type、scheme、data和categories判断是否 匹配
                    if (match >= 0) {
                        if (receivers == null) {
                            receivers = new ArrayList<ReceiverRecord>();
                        }
                        receivers.add(receiver);//添加进待广播ReceiverRecord的集合中
                        receiver.broadcasting = true;//广播标志位设置为true
                    } else {
                        //省略部分代码
                    }
                }
                if (receivers != null) {
                    for (int i=0; i<receivers.size(); i++) {
                        receivers.get(i).broadcasting = false;//广播标志位设置为false
                    }
                    mPendingBroadcasts.add(new BroadcastRecord(intent, receivers));//封装intent和receivers并添加到待处理的广播集合中
                    if (!mHandler.hasMessages(MSG_EXEC_PENDING_BROADCASTS)) {
                        mHandler.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);//发送消息进行广播分发
                    }
                    return true;
                }
            }
        }
        return false;
    }

LocalBroadcastManager#Handler

收到消息之后进行消息分发,Handler创建的之后传入的Looper是主线程的,那么我们的回调也就切换到主线程中了

    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);
                }
            }
        };
    }

executePendingBroadcasts

广播的分发,遍历待处理的集合,并调用onReceive进行分发

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);//调用BroadcastReceiver的onReceive
            }
        }
    }
}

这里面将mPendingBroadcasts可能发生改变看,所以需要同步代码块,集合转换数组,为了提高效率,同步代码块中只对原集合操作保证其安全,并不需要包括广播分发。

sendBroadcastSync

同步分发广播,并不会切换线程,回调的线程是在调用者的线程

public void sendBroadcastSync(Intent intent) {
    if (sendBroadcast(intent)) {
        executePendingBroadcasts();
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容