Skip to content

Latest commit

 

History

History
175 lines (133 loc) · 6.04 KB

README.md

File metadata and controls

175 lines (133 loc) · 6.04 KB
Raw

Deprecated

该项目于17.0815停止维护，主要原因是个人不太推荐使用事件总线来实现功能，具体原因点这里

Android RxBus

该项目基于RxJava2 & RxAndroid，并且从AndroidKnife/RxBus中学习而实现的。

使用annotation processing（注释处理）自动生成模板代码，避免了反射带来的性能影响。通过@Subscribe标记订阅方法，@Rxthread可设置订阅方法的运行线程，线程支持RxJava中提供的6种线程：MainThread、IO、Computation、Single、NewThread、Trampoline。

引用

在gradle中加入：

dependencies {
  compile 'com.github.vitess:rxbus:2.0.3'
  annotationProcessor 'com.github.vitess:rxbus-compiler:2.0.3'
}

开发版本的快照可从Sonatype's snapshots repository中找到。

使用

在类的初始化处使用RxBus.register注册，并在类销毁的地方使用RxBus.unregister注销。注册后的类中的方法即可使用@Subscribe注释标记，此后在类以外的地方即可通过RxBus.post发射数据到指定方法中。

当使用@Subscribe标记方法时，若不指定特定的tag，该方法将被默认的tag所标记。这一类被默认tag标记的方法可接收RxBus.post(Object value)发射数据，或者使用RxBus.post(Subscribe.DEFAULT , ${value})来显式发射。

For example:

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        RxBus.register(this);
        //TODO something
        ...
        
        findViewById(R.id.button).setOnClickListenernew(View.OnClickListener() {
            @Override
            public void onClick(View v) {
                RxBus.post("receiver1", 123);//post to receiver1
                RxBus.post("This is post to receiver2");//post to receiver2
                RxBus.post(new Object());//post to receiver3
                RxBus.post("receiver4", null);//post to receiver4
                RxBus.post(null);//post to receiver5
            }
        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        RxBus.unregister(this);
    }

    @Subscribe("receiver1")
    @RxThread(ThreadType.IO)
    public void receiver1(int random) {
        Log.i("RxBus", "receiver1:" + Thread.currentThread().getName());
    }

    @Subscribe
    @RxThread(ThreadType.Single)
    public void receiver2(String str) {
        Log.i("RxBus", "receiver2:" + Thread.currentThread().getName());
    }
    
    @Subscribe
    public void receiver3(Object obj) {
    	Log.i("RxBus", "receiver3:" + Thread.currentThread().getName());
    }
    
    @Subscribe("receiver4")
    public void receiver4(){
       Log.i("RxBus", "receiver4:" + Thread.currentThread().getName());
    }
    
    @Subscribe
    public void receiver5(){
       Log.i("RxBus", "receiver5:" + Thread.currentThread().getName());
    }
}

粘性功能

从2.0.3版本开始，增加了发送粘性事件(Sticky)的功能，但目前该功能尚处于试验阶段。

  • 粘性事件使用RxBus.postSticky(String tag ,Object value)发布，同时返回该粘性事件的标记码(int类型)
  • 使用RxBus.removeSticky(int key)来回收标记码对应的粘性事件
  • 使用RxBus.removeAllSticky()回收所有粘性事件

由于粘性事件使用静态容器存储，所以请务必在应用关闭时回收所有粘性事件，或在不需要用到粘性事件后将其回收。

For example:

public class MainActivity extends AppCompatActivity {

    int mStickyKey;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        RxBus.register(this);
        //TODO something
        ...
        
        findViewById(R.id.button).setOnClickListenernew(View.OnClickListener() {
            @Override
            public void onClick(View v) {
                mStickyKey = RxBus.postSticky("sticky", 123);//post sticky event to receiver
            }
        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //RxBus.removeAllSticky();
        RxBus.removeSticky(mStickyKey);
        RxBus.unregister(this);
    }

    @Subscribe("sticky")
    @RxThread(ThreadType.IO)
    public void receiver(int random) {
        Log.i("RxBus", "receiver1:" + Thread.currentThread().getName());
    }
}

限制

  1. 不支持发送实现了Map、Collection接口的参数类型（如ArrayList、HashMap等），如果必须发送这种集合容器参数，请自实现实体类，集合容器作为成员变量，然后发送实体类参数

TODO

目前思路稍微有些瓶颈，如果有好点子或者有可改进的地方，欢迎pull request，thanks！

  • 增加单元测试
  • 优化Processor性能
  • 优化模板代码
  • 优化Processor的缓存方式和生成模式
  • 增加sticky事件支持
  • 根据使用方式分别生成不同的Observable，使用频率较少的用post方法发射，每次独立生成Single完成操作；使用频率较高且生命周期较长的使用continuePost方法发射，仅生成Processor完成操作
  • etc.

License

Copyright 2017 Vincent Tam

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.