LocalBroadcastManager源碼分析

LocalBroadcastManager優(yōu)勢:

Helper to register for and send broadcasts of Intents to local objects within your process. This has a number of advantages over sending global broadcasts with {@link android.content.Context#sendBroadcast}:

  • You know that the data you are broadcasting won't leave your app, so don't need to worry about leaking private data.
  • It is not possible for other applications to send these broadcasts to your app, so you don't need to worry about having security holes they can exploit.
  • It is more efficient than sending a global broadcast through the system.

相對于BroadcastReceiver來說,LocalBroadcastManager有如下優(yōu)勢:

  • 發(fā)送的廣播只會在當(dāng)前APP中傳播,不會泄露給其他APP,確保數(shù)據(jù)傳輸?shù)陌踩?
  • 其他APP的廣播無法發(fā)送到本地APP中,不用擔(dān)心安全漏洞被其他APP利用.
  • 比系統(tǒng)全局廣播更加高效.

LocalBraodcastManager源碼如下:


    /**
     * Helper to register for and send broadcasts of Intents to local objects
     * within your process.  This has a number of advantages over sending
     * global broadcasts with {@link android.content.Context#sendBroadcast}:
     * <ul>
     * <li> You know that the data you are broadcasting won't leave your app, so
     * don't need to worry about leaking private data.
     * <li> It is not possible for other applications to send these broadcasts to
     * your app, so you don't need to worry about having security holes they can
     * exploit.
     * <li> It is more efficient than sending a global broadcast through the
     * system.
     * </ul>
     */
    public final class LocalBroadcastManager {
        private static class ReceiverRecord {
            final IntentFilter filter;
            final BroadcastReceiver receiver;
            boolean broadcasting;
    
            ReceiverRecord(IntentFilter _filter, BroadcastReceiver _receiver) {
                filter = _filter;
                receiver = _receiver;
            }
    
            @Override
            public String toString() {
                StringBuilder builder = new StringBuilder(128);
                builder.append("Receiver{");
                builder.append(receiver);
                builder.append(" filter=");
                builder.append(filter);
                builder.append("}");
                return builder.toString();
            }
        }
    
        private static class BroadcastRecord {
            final Intent intent;
            final ArrayList<ReceiverRecord> receivers;
    
            BroadcastRecord(Intent _intent, ArrayList<ReceiverRecord> _receivers) {
                intent = _intent;
                receivers = _receivers;
            }
        }
    
        private static final String TAG = "LocalBroadcastManager";
        private static final boolean DEBUG = false;
    
        private final Context mAppContext;
    
        private final HashMap<BroadcastReceiver, ArrayList<IntentFilter>> mReceivers
                = new HashMap<BroadcastReceiver, ArrayList<IntentFilter>>();
        private final HashMap<String, ArrayList<ReceiverRecord>> mActions
                = new HashMap<String, ArrayList<ReceiverRecord>>();
    
        private final ArrayList<BroadcastRecord> mPendingBroadcasts
                = new ArrayList<BroadcastRecord>();
    
        static final int MSG_EXEC_PENDING_BROADCASTS = 1;
    
        private final Handler mHandler;
    
        private static final Object mLock = new Object();
        private static LocalBroadcastManager mInstance;
    
        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);
                    }
                }
            };
        }
    
        /**
         * Register a receive for any local broadcasts that match the given IntentFilter.
         *
         * @param receiver The BroadcastReceiver to handle the broadcast.
         * @param filter Selects the Intent broadcasts to be received.
         *
         * @see #unregisterReceiver
         */
        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);
                }
            }
        }
    
        /**
         * Unregister a previously registered BroadcastReceiver.  <em>All</em>
         * filters that have been registered for this BroadcastReceiver will be
         * removed.
         *
         * @param receiver The BroadcastReceiver to unregister.
         *
         * @see #registerReceiver
         */
        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);
                            }
                        }
                    }
                }
            }
        }
    
        /**
         * Broadcast the given intent to all interested BroadcastReceivers.  This
         * call is asynchronous; it returns immediately, and you will continue
         * executing while the receivers are run.
         *
         * @param intent The Intent to broadcast; all receivers matching this
         *     Intent will receive the broadcast.
         *
         * @see #registerReceiver
         */
        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();
    
                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);
    
                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;
                        }
    
                        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.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);
                        }
                        return true;
                    }
                }
            }
            return false;
        }
    
        /**
         * Like {@link #sendBroadcast(Intent)}, but if there are any receivers for
         * the Intent this function will block and immediately dispatch them before
         * returning.
         */
        public void sendBroadcastSync(Intent intent) {
            if (sendBroadcast(intent)) {
                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);
                    }
                }
            }
        }
    }
    
    
  • LocalBroadcastManager中有三個關(guān)鍵字段分別為:

    
         private final HashMap<BroadcastReceiver, ArrayList<IntentFilter>> mReceivers = new HashMap();  
         private final HashMap<String, ArrayList<ReceiverRecord>> mActions = new HashMap();
         private final ArrayList<BroadcastRecord> mPendingBroadcasts = new ArrayList();
    
    

    HashMap對象的mReceivers存儲廣播和過濾信息集合,通過以BroadcastReceiver為Key,ArrayList<IntentFilter>為Value,這樣做是為了方便注銷.

    HashMap對象的mActions存儲ActionReceiverRecord,以Action為key,ArrayList<ReceiverRecord>為value,mActions的主要作用是方便在廣播發(fā)送后快速得到可以接收他的BroadcastReceiver.

    mPendingBroadcasts就是發(fā)送廣播的集合.

  • LocalBroadcastManager的構(gòu)造函數(shù):

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

    LocalBroadcastManager的構(gòu)造函數(shù)很簡單,就做了一件事,創(chuàng)建一個基于主線程Looper的Handler,并接收msg.whatMSG_EXEC_PENDING_BROADCASTS的消息,并調(diào)用 executePendingBroadcasts()發(fā)送廣播.

  • LocalBroadcastManager注冊

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

    基于要注冊的BroadReceiver和IntentFilter,在mReceivers中查找,如果為null,便把傳過來的receiver和filter參數(shù)存儲到mReceivers中,同時將IntentFilter中的Action存儲到mActions中.方便后面注銷廣播,對元素的移除.

  • LocalBroadcastManager的注銷

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

    LocalBroadcastManager注銷就是從mReceivers和mActions中移除相應(yīng)的元素,比如BroadcastReceiver和IntentFilter以及Action.

  • LocalBroadcastManager發(fā)送廣播:

    
        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();
    
                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);
    
                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;
                        }
    
                        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.sendEmptyMessage(MSG_EXEC_PENDING_BROADCASTS);
                        }
                        return true;
                    }
                }
            }
            return false;
        }
    
    

    先根據(jù)Action從mActions中取出ReceiverRecord列表,遍歷ReceiverRecord判斷filter和intent中的action,type,scheme,data,category是否匹配,是的話保存到receivers列表中,發(fā)送msg.what為MSG_EXEC_PENDING_BROADCASTS的消息,通過主線程的Handler去處理.

  • LocalBroadcastManager處理消息

    
        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轉(zhuǎn)換為數(shù)組BroadcastRecord,循環(huán)遍歷每個receiver,調(diào)用其onReceive函數(shù),完成消息的傳遞.

LocalBroadcastManager分析總結(jié):

  • LocalBroadcastManager的核心思想還是Handler,只是利用了IntentFilter的match功能,至于BroadcastReceiver換成其他接口也無所謂,只是順便利用了現(xiàn)成的類和概念而已.
  • 因為是Handler通訊,所以才有實現(xiàn)了應(yīng)用內(nèi)通訊,自然安全性高,效率高.
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容