基本用法
Gradle集成
compile 'com.mcxiaoke.xbus:bus:1.0.+'
接收事件
public class SimpleActivity extends Activity {
@Override
protected void onCreate(final Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 注册
Bus.getDefault().register(this);
}
@Override
protected void onDestroy() {
super.onDestroy();
// 取消注册
Bus.getDefault().unregister(this);
}
@BusReceiver
public void onStringEvent(String event) {
// handle your event
// 这里处理事件
}
@BusReceiver
public void onSomeEvent(SomeEventClass event) {
// SomeEventClass表示任意的自定义类
// handle your event
// 这里处理事件
}
@BusReceiver
public void onObjectEvent(Object event) {
// 不建议使用Object,会收到所有类型的事件
// handle your event
// 这里处理事件
}
}
发送事件
然后在需要的地方调用 post(event) 发送事件通知,如 Service 或某个线程里,可以在任何地方发送事件:
// 比如在IntentService里
public class SimpleService extends IntentService {
public SimpleService() {
super("SimpleService");
}
@Override
protected void onHandleIntent(final Intent intent) {
// 这里是举例,可以在任何地方发送事件
Bus.getDefault().post("String Event");
Bus.getDefault().post(new SomeEventClass());
Bus.getDefault().post(new Object());
}
}
高级用法
任何地方注册
你还可以选择在 onStart() 里注册,在 onStop() 里取消注册。你完全可以在任何地方注册和取消注册,没有任何限制。但是建议你在生命周期事件方法里注册和取消注册,如 Activity/Fragment/Service 的 onCreate/onDestroy 方法里, register()和 unregister() 建议配对使用,避免内存泄露。
@Override
protected void onStart() {
super.onStart();
// you can also register here
Bus.getDefault().register(this);
}
@Override
protected void onStop() {
super.onStop();
// you can also unregister here
Bus.getDefault().unregister(this);
}
自定义 Bus
你也可以不使用默认的 Bus.getDefault(),改用自己创建的 Bus 对象:
public class MainApp extends Application {
private Bus mBus = new Bus();
@Override
public void onCreate() {
super.onCreate();
}
public Bus getBus() {
return mBus;
}
}
Debug
默认不输出任何LOG信息,可以这样启用调试模式:
public Bus setDebug(final boolean debug)
MethodFinder
默认使用注解(@BusReceiver)识别事件接 收 器方法,可以这样修改 :
public Bus setMethodFinder(final MethodFinder finder)
默认使用的是 AnnotationMethodFinder,只有使用了 @BusReceiver 的方法才可以接受事件。
可选使用 NamedMethodFinder ,NamedMethodFinder 使用方法名识别,默认方法名是 onEvent ,你可以指定其它的方法名。
使用 NamedMethodFinder 会比使用 AnnotationMethodFinder 效率高一点,因为它忽略注解,直接使用方法名字符串匹配。一般使用,两者差别不大。
你还可以实现 MethodFinder 接口,自定义其它的事件接 收 器方法匹配模式:i
interface MethodFinder {
Set<MethodInfo> find(final Bus bus, final Class<?> targetClass);
}
StrictMode
宽泛匹配模式
默认情况下, Bus 使用宽泛的事件类型匹配模式,事件参数会匹配它的父类和接口,如果你调用 post(String),那么这几个方法都会收到举例:
// 如果你调用这个方法,发送一个StringBuilder类型的事件
Bus.getDefault().post(new StringBuilder("Event"));
// 这几个方法会收到事件
public void onEvent1(StringBuilder event) // 匹配,类型相符
public void onEvent2(Object event) // 匹配,StringBuilder是Object的子类
public void onEvent3(CharSequence event) // 匹配,StringBuilder是CharSequence的实现类
public void onEvent4(Serializable event) // 匹配,StringBuilder实现了Serializable接口
// 这几个方法不会收到事件
public void onEvent5(Exception event) 不匹配,Exception与String完全无关
public void onEvent6(String event) // 不匹配,StringBuilder不能转换成String类型
对于 post(event) 和 onEvent(EventType) ,匹配规则是:如果 event.getClass() 可以强制转换成 EventType,那么匹配成功,能收到事件。
严格匹配模式
可以使用下面的方法更改默认行为,使用严格的事件类型匹配模式:
public Bus setStrictMode(final boolean strictMode)
启用严格匹配模式后,发送和接受方法的参数类型必须严格匹配才能收到事件,举例:
// setStrictMode(true) 启用严格模式后:
Bus.getDefault().post(new StringBuilder("Event"));
// 只有 onEvent1 能收到事件
public void onEvent1(StringBuilder event)
public void onEvent2(Object event)public void onEvent3(CharSequence event)
public void onEvent4(Serializable event)
public void onEvent5(Exception event)
public void onEvent6(String event)
对于 post(event) 和 onEvent(EventType) ,严格模式的匹配规则是当且仅当 event.getClass().equals(EventType) 时才能收到事件。
说明:启用严格模式效率会稍微高一点,因为不会递归查找 event 的父类和实现的接口,但是由于 Bus 内部使用了缓存,对于同一个事件类型,并不会重复查找,所以实际使用几乎没有差别。
StickyEvent
可以使用下面的方法发送 Sticky 事件,这种事件会保留在内存中,当下一个注册者注册时,会立即收到上一次发送的该类型事件,每种类型的事件只会保留一个, Sticky 事件使用严格匹配模式。
public <E> void postSticky(E event)
一般不需要使用 Sticky 事件,但在某些场景下可以用到,比如一个网络状态监听服务,会不断的发送网络状态信息,接受者一旦注册就可以立即收到一个事件,可以知道当前的网络状态。
@BusEvent
还有一个注解 @BusEvent 可用于标注某个类是事件类,这个像 @Override 注解一样,纯标注用,没有其它用途,没有运行时消耗。
来自:
https://github.com/mcxiaoke/xBus/blob/master/docs/xbus-user-guide.md
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。