2. 程式人生 > >Android 框架煉成 教你如何寫元件間通訊框架EventBus

Android 框架煉成 教你如何寫元件間通訊框架EventBus

阿新 • • 發佈：2019-02-08
轉載請標明出處：

1、概述

首先我們回顧一下，這玩意就是在register時，掃描類中複合命名規範的方法，存到一個map，然後post的時候，查詢到匹配的方法，反射呼叫；好，那麼根據這一句話，我們就開始編寫框架之旅~~~

2、依然是原來的配方

1、ItemListFragment

package com.angeldevil.eventbusdemo;

import android.os.Bundle;
import android.support.v4.app.ListFragment;
import android.view.View;
import android.widget.ArrayAdapter;
import android.widget.ListView;

import com.angeldevil.eventbusdemo.Event.ItemListEvent;
import com.zhy.eventbus.EventBus;

public class ItemListFragment extends ListFragment
{

	@Override
	public void onCreate(Bundle savedInstanceState)
	{
		super.onCreate(savedInstanceState);
		// Register
		EventBus.getInstatnce().register(this);
	}

	@Override
	public void onDestroy()
	{
		super.onDestroy();
		// Unregister
		EventBus.getInstatnce().unregister(this);
	}

	@Override
	public void onViewCreated(View view, Bundle savedInstanceState)
	{
		super.onViewCreated(view, savedInstanceState);
		// 開啟執行緒載入列表
		new Thread()
		{
			public void run()
			{
				try
				{
					Thread.sleep(2000); // 模擬延時
					// 釋出事件，在後臺執行緒發的事件
					EventBus.getInstatnce().post(new ItemListEvent(Item.ITEMS));
				} catch (InterruptedException e)
				{
					e.printStackTrace();
				}
			};
		}.start();
	}

	public void onEventUI(ItemListEvent event)
	{
		setListAdapter(new ArrayAdapter<Item>(getActivity(),
				android.R.layout.simple_list_item_activated_1,
				android.R.id.text1, event.getItems()));
	}

	@Override
	public void onListItemClick(ListView listView, View view, int position,
			long id)
	{
		super.onListItemClick(listView, view, position, id);
		EventBus.getInstatnce().post(getListView().getItemAtPosition(position));
	}

}

2、ItemDetailFragment

package com.angeldevil.eventbusdemo;

import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;

import com.zhy.eventbus.EventBus;

public class ItemDetailFragment extends Fragment
{

	private TextView tvDetail;

	@Override
	public void onCreate(Bundle savedInstanceState)
	{
		super.onCreate(savedInstanceState);
		// register
		EventBus.getInstatnce().register(this);
	}

	@Override
	public void onDestroy()
	{
		super.onDestroy();
		// Unregister
		EventBus.getInstatnce().unregister(this);
	}

	/** List點選時會發送些事件，接收到事件後更新詳情 */
	public void onEventUI(Item item)
	{
		if (item != null)
			tvDetail.setText(item.content);
	}

	@Override
	public View onCreateView(LayoutInflater inflater, ViewGroup container,
			Bundle savedInstanceState)
	{
		View rootView = inflater.inflate(R.layout.fragment_item_detail,
				container, false);
		tvDetail = (TextView) rootView.findViewById(R.id.item_detail);
		return rootView;
	}
}

可以看到，我們在ItemListFragment裡面使用了：

EventBus.getInstatnce().post(new ItemListEvent(Item.ITEMS));去釋出了一個事件，然後更新了我們的列表；

點選Item的時候，使用EventBus.getInstatnce().post(getListView().getItemAtPosition(position));釋出了一個事件，更新了我們的ItemDetailFragment的列表；

效果：


效果圖和之前的一摸一樣~~~

但是請注意，現在我們用的是EventBus.getInstatnce()；併發是EventBus.getDefault()；並且看下包名import com.zhy.eventbus.EventBus;

我想你應該明白了，這是我們自己寫的類來實現的~~~~

好了，接下來就帶大家一起實現這個類~~

ps :以上程式碼和效果圖，完全是為了部落格的完整性，勿見怪~~

3、無中生有

1、getInstance

我們這裡為了方便，直接簡單粗暴的使用惡漢模式建立單例：

	private static EventBus eventBus = new EventBus();
	
	public static EventBus getInstatnce()
	{
		return eventBus;
	}
	
	private EventBus()
	{
		mHandler = new Handler(Looper.getMainLooper());
	}

然後在構造方法中初始化了一個mHandler，沒錯，它就是用來在處理在UI執行緒呼叫方法的。

接下來看register

2、register

/*
	 * 我們的強大的map，儲存我們的方法
	 */
	private static Map<Class, CopyOnWriteArrayList<SubscribeMethod>> mSubscribeMethodsByEventType = new HashMap<Class, CopyOnWriteArrayList<SubscribeMethod>>();

	public void register(Object subscriber)
	{

		Class clazz = subscriber.getClass();
		Method[] methods = clazz.getDeclaredMethods();

		CopyOnWriteArrayList<SubscribeMethod> subscribeMethods = null;
		/**
		 * 遍歷所有方法
		 */
		for (Method method : methods)
		{
			String methodName = method.getName();
			/**
			 * 判斷方法是否以onEvent的開頭
			 */
			if (methodName.startsWith("onEvent"))
			{
				SubscribeMethod subscribeMethod = null;
				// 方法命中提前在什麼執行緒執行。預設在UI執行緒
				String threadMode = methodName.substring("onEvent".length());
				ThreadMode mode = ThreadMode.UI;

				Class<?>[] parameterTypes = method.getParameterTypes();

				// 引數的個數為1
				if (parameterTypes.length == 1)
				{
					Class<?> eventType = parameterTypes[0];

					synchronized (this)
					{

						if (mSubscribeMethodsByEventType.containsKey(eventType))
						{
							subscribeMethods = mSubscribeMethodsByEventType
									.get(eventType);
						} else
						{
							subscribeMethods = new CopyOnWriteArrayList<SubscribeMethod>();
							mSubscribeMethodsByEventType.put(eventType,
									subscribeMethods);
						}
					}

					if (threadMode.equals("Async"))
					{
						mode = ThreadMode.Async;
					}
					// 提取出method，mode，方法所在類物件，存數的型別封裝為SubscribeMethod
					subscribeMethod = new SubscribeMethod(method, mode,
							subscriber);
					subscribeMethods.add(subscribeMethod);
				}
			}

		}
	}

	enum ThreadMode
	{
		UI, Async
	}

	class SubscribeMethod
	{
		Method method;
		ThreadMode threadMode;
		Object subscriber;

		public SubscribeMethod(Method method, ThreadMode threadMode,
				Object subscriber)
		{
			this.method = method;
			this.threadMode = threadMode;
			this.subscriber = subscriber;
		}

	}


可以看到我們使用了一個Map儲存所有的方法，key為引數的型別class；value為CopyOnWriteArrayList<SubscribeMethod>

這裡我們封裝了一個SubscribeMethod，這個裡面儲存了我們需要執行方法的所有引數，畢竟我們執行時，需要該方法，該方法所在的物件，以及在什麼執行緒執行；三個物件足以，當然也缺一不可了~~

register裡面，我們遍歷該類的所有方法，找到onEvent開頭的，封裝成SubscribeMethod，存在Map裡面，當然了，一個引數型別對應很多方法，所以value是個CopyOnWriteArrayList。

掃描完成，我們就完成了將方法的儲存。

還有一點，我們這裡預設在UI執行緒執行，如果方法是onEventAsync則認為在子執行緒執行，我們也只支援這兩種模式，簡化一點~

3、post

private static ThreadLocal<PostingThread> mPostingThread = new ThreadLocal<PostingThread>()
	{
		@Override
		public PostingThread get()
		{
			return new PostingThread();
		}
	};
	
	

	public void post(Object eventTypeInstance)
	{
		//拿到該執行緒中的PostingThread物件
		PostingThread postingThread = mPostingThread.get();
		postingThread.isMainThread = Looper.getMainLooper() == Looper
				.myLooper();
		//將事件加入事件佇列
		List<Object> eventQueue = postingThread.mEventQueue;
		eventQueue.add(eventTypeInstance);
		//防止多次呼叫
		if (postingThread.isPosting)
		{
			return;
		}
		postingThread.isPosting = true;
		//取出所有事件進行呼叫
		while (!eventQueue.isEmpty())
		{
			Object eventType = eventQueue.remove(0);
			postEvent(eventType, postingThread);
		}
		postingThread.isPosting = false;

	}

我們這裡學習了原始碼，也搞了個當前執行緒中的變數，儲存了一個事件佇列以及事件的狀態；

class PostingThread
{
	List<Object> mEventQueue = new ArrayList<Object>();
	boolean isMainThread;
	boolean isPosting;
}

最終釋出的事件先加入到事件佇列，然後再取出來呼叫postEvent

private void postEvent(final Object eventType, PostingThread postingThread)
	{
		CopyOnWriteArrayList<SubscribeMethod> subscribeMethods = null;
		synchronized (this)
		{
			subscribeMethods = mSubscribeMethodsByEventType.get(eventType
					.getClass());
		}

		for (final SubscribeMethod subscribeMethod : subscribeMethods)
		{

			if (subscribeMethod.threadMode == ThreadMode.UI)
			{
				if (postingThread.isMainThread)
				{
					invokeMethod(eventType, subscribeMethod);
				} else
				{
					mHandler.post(new Runnable()
					{
						@Override
						public void run()
						{
							invokeMethod(eventType, subscribeMethod);
						}
					});
				}
			} else
			{
				new AsyncTask<Void, Void, Void>()
				{

					@Override
					protected Void doInBackground(Void... params)
					{
						invokeMethod(eventType, subscribeMethod);
						return null;
					}
				};
				
			}

		}

	}

postEvent也很簡單，直接根據引數型別，去map改到該方法，根據其threadMode，如果在UI執行緒，則判斷當前執行緒，如果是UI執行緒，直接呼叫，否則通過handler執行；

如果非UI執行緒，這裡我們直接開啟了一個Thread去執行；

invokeMethod很簡單，就是反射呼叫方法了~

private void invokeMethod(Object eventType, SubscribeMethod subscribeMethod)
	{
		try
		{
			subscribeMethod.method
					.invoke(subscribeMethod.subscriber, eventType);
		} catch (Exception e)
		{
			e.printStackTrace();
		}
	}

4、unregister

public void unregister(Object subscriber)
	{
		Class clazz = subscriber.getClass();
		Method[] methods = clazz.getDeclaredMethods();

		List<SubscribeMethod> subscribeMethods = null;

		for (Method method : methods)
		{
			String methodName = method.getName();

			if (methodName.startsWith("onEvent"))
			{
				Class<?>[] parameterTypes = method.getParameterTypes();
				if (parameterTypes.length == 1)
				{
					synchronized (this)
					{
						mSubscribeMethodsByEventType.remove(parameterTypes[0]);
					}
				}
			}
		}

	}

unregister時，由於我們沒有存任何的輔助狀態，我們只能再去遍歷了方法了~~不過通過這個，也能反應出EventBus內部好幾個Map的作用了~~

並且，我們也不支援一些狀態的查詢，還是因為我們沒有存一些輔助狀態，例如isRegister等等。

到此，我們的EventBus就寫好了，100多行程式碼，肯定沒有EventBus健壯，主要目的還是學習人家的思想，經過自己寫了這麼個類，我相信對於EventBus的理解就更深刻了~面試的時候，恨不得拿只筆寫給面試官看，哈哈~~

5、EventBus最佳實踐

前面的文章，很多朋友問，如果我多個方法引數都一樣，豈不是post一個此引數，會多個方法呼叫；而此時我想呼叫指定的方法怎麼辦？

還有，專案中會有很多地方去接收List引數，而List<T>中的泛型是不一致的，所以也可能post(List）時，會呼叫很多方法，造成出錯。

的確，上述，不加處理肯定會出現；

但是，推薦大家在使用EventBus的時候，建立一個事件類，把你的每一個引數（或者可能發生衝突的引數），封裝成一個類：

例如：

public class Event
{
	public static class UserListEvent
	{
		public List<User> users ;
	}
	public static class ItemListEvent
	{
		public List<Item> items;
	}

}

這樣的話，就不會發生什麼呼叫衝突了~~

我建了一個QQ群，方便大家交流。群號：55032675

----------------------------------------------------------------------------------------------------------

博主部分視訊已經上線，如果你不喜歡枯燥的文字，請猛戳（初錄，期待您的支援）：



相關推薦

Android 框架煉成 教你如何寫元件間通訊框架EventBus

轉載請標明出處：1、概述首先我們回顧一下，這玩意就是在register時，掃描類中複合命名規範的方法，存到一個map，然後post的時候，查詢到匹配的方法，反射呼叫；好，那麼根據這一句話，我們就開始編寫框架之旅~~~2、依然是原來的配方1、ItemListFragmentpa

Android 框架練成 教你打造高效的圖片載入框架

                轉載請標明出處：http://blog.csdn.net/lmj623565791/article/details/41874561，本文出自：【張鴻洋的部落格】1、概述優秀的圖片載入框架不要太多，什麼UIL , Volley ,Picasso,Imageloader等等。但是

Android開發之手把手教你寫ButterKnife框架（一）

系列文章目錄導讀： 一、概述 JakeWharton我想在Android界無人不知，無人不曉的吧， ButterKnife這個框架就是出自他隻手。這個框架我相信很多人都用過，本系列部落格就是帶大家更加深入的認識這個框架，ButterKnife截至目前

Android開發之手把手教你寫ButterKnife框架（三）

系列文章目錄導讀： 一、概述 然後在Processor裡生成自己的程式碼，把要輸出的類，通過StringBuilder拼接字串，然後輸出。 try { // write the file JavaFileObject

Android Service、IntentService，Service和元件間通訊

Service元件 Service 和Activity 一樣同為Android 的四大元件之一，並且他們都有各自的生命週期，要想掌握Service 的用法，那就要了解Service 的生命週期有哪些方法，並且生命週期中各個方法回撥的時機和作用 什麼是service？service的基本概念 Servic

教你寫Android網路框架之基本架構

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

教你寫Android網路框架之Request Response類與請求佇列

                我正在參加部落格之星，點選這裡投我一票吧，謝謝~   前言在教你寫Android網路框架之基本架構一文中我們已經介紹了SimpleNet網路框架的基本結構，今天我們就開始從程式碼的角度來開始切入該網路框架的實現，在剖析的同時我們會分析設計思路，以及為什麼要這樣做，這樣做的好處是

教你寫Android ImageLoader框架之圖片快取 （完結篇）

在教你寫Android ImageLoader框架系列博文中，我們從基本架構到具體實現已經更新了大部分的內容。今天，我們來講最後一個關鍵點，即圖片的快取。為了使用者體驗，通常情況下我們都會將已經下載的圖片快取起來，一般來說記憶體和本地都會有圖片快取。那既然是框架

android 手把手教你寫資料庫框架(第一篇)

前言:當你想成為什麼樣的人,努力朝目標努力,終究有一天會實現,人生最大的快樂就是不斷追尋夢想的過程 準備寫一個數據庫框架,現在的專案中資料庫框架是用三方orm,不知道是不是叫這個名字,不重要了,準備這段時間把這資料庫框架寫出來,也許寫的不夠好,沒關係,只要堅持住總會比之前

教你寫Http框架（二）——三個樣例帶你深入理解AsyncTask

func implement oncreate 其它 層疊 worker dcl 例如 人員 這個標題大家不要奇怪，扯Http框架怎麽扯到AsyncTask去了，有兩個原因：首先是Http框架除了核心http理論外。其技術實現核心也是線程池 + 模板 +

手把手教你寫DI_1_DI框架有什麼？

DI框架有什麼？ 在上一節：手把手教你寫DI_0_DI是什麼？ 我們已經理解DI是什麼 接下來我們就徒手擼一擼，玩個支援建構函式注入的DI出來 首先我們回顧一下 建構函式注入 的程式碼形式， 大概長這模樣： class MovieLister { private IMovieFinder f

手把手教你寫DI_1_DI框架有什麽？

這樣的 desc inject var .net 框架 抽象 幹什麽 depend DI框架有什麽？ 在上一節：手把手教你寫DI_0_DI是什麽？ 我們已經理解DI是什麽 接下來我們就徒手擼一擼，玩個支持構造函數註入的DI出來 首先我們回顧一下 構造函數註入 的代碼形式，

手把手教你寫一個基於RxJava的擴充套件框架

今日科技快訊近日訊息，由於央行不再新設第三方支付機構，網際網路企業們只能買買買。最近有通知稱，中

400行python 教你寫個高效能 http伺服器+web框架，效能秒勝tornado django webpy uwsgi

tornado 4kqps 多程序 1wnginx+tornado 9kqpsnginx+uwsgi 8kqps （注意：沒說比nginx快，只是這幾個web框架不行） 本server 3.2w qps 沒用任何python加速不相信的可以自己壓測下哦已經真實使用到自己的多

教你寫響應式框架（二）

還要做什麼? 在教你寫響應式框架（一）中我們介紹了觀察者模式，現在我們將基於上一篇中的程式碼進行改造。當然，我們是有目的的改造： 在響應式框架中，觀察者是可能隨時產生，種類多,生命週期卻短暫. 我們希望操作是非同步的,並且只有在觀察者被註冊到

教你寫響應式框架（一）

在真正開始編寫自己的響應式框架之前，我們先來從觀察者模式說起。已經對觀察者模式很熟悉的可以直接掠過。 基本概念 觀察者模式屬於物件行為模式之一，也可叫做釋出——訂閱模式。它定義了一種以對多的依賴關係，讓多個觀察者（訂閱者）同時觀察（監聽）一個被觀察者（主

教你寫Http框架（一）

大家都知道，從本質上來說app實際只是整個大系統當中的View層，因為設計優秀的系統中，app基本都不會承擔任何實際的業務邏輯處理，只是負責向用戶展示資料以及從使用者端蒐集使用者資料。而這個資料的一來一去，自然離不開網路通訊協議，而我們用得最多的，自然是這個ht

Android Proguard安全加固教你如何讓自己的應用程式或SDK更難被反編譯--library打包成jar並且混淆

在android 應用層開發的時候咱們技術人員都或多或少都會接觸一些SDK比如so、jar等，這些都是資料類公司提供給網際網路開發公司的關於技術核心類方便的東西，因為是核心所以加密加固是必不可少的工作，本博今天就向大家介紹jar的封裝打包以及混淆，完成自己的SDK！在此之前需

小程序初體驗：手把手教你寫出第一個小程序（一）

輸入框 個人 創建 公測 快速 nsh 成功 too 調用 本文筆者將根據quick start中的範例代碼，帶大家簡單地剖析一下小程序的運行方式，並介紹小程序開發中一些通用的特性，帶著大家一步步寫出自己的小程序。 適用對象：前端初學者，對小程序開發感興趣者 tip

【Python】三個例子教你寫代碼

位數 mage int 1-1000 image end src orm origin 這篇文章包括用Python編寫的斐波那契數列，三位數的水仙花數和百錢買百雞的基礎代碼： （一）斐波那契數列： ‘‘‘ def hanshu(n): n_1 = 1 n_2 =