Activity、Service、子线程之间的消息传递轻松实现

1. 引子
   以前工作中实现界面之间消息传递、service与activity之间的消息传递需要broadcastReceiver来实现不经设计麻烦，而且代码冗余。后来通过查看代码时发现了一个挺不错的方法来实现这个功能。本篇博客主要介绍本人所总结的如何解决上面提到的问题。效果图（第二个界面的按钮点击修改了第一个界面的textView内容）
   

---

• 上面的这种简单情况代码如下

/**
 * 事件分发的单例类
 */
public class EventManager {
    private static EventManager manager;//单例模式
    private EventManager(){}
    public static EventManager getInstance(){//这儿用的懒汉式单利，暂未考虑多线程问题
        if(manager == null){
            manager = new EventManager();
        }
        return manager;
    }

    private List<EventListener> listeners = new ArrayList<>();//存放所以的监听器
    public void registListener(EventListener eventListener){
        if(!listeners.contains(eventListener))
            listeners.add(eventListener);
    }

    public void eventRunEnd(String content){//某一个事件运行完毕后启动监听器
        for(EventListener listener : listeners){
            listener.runEnd(content);
        }
    }

    public static interface EventListener{//监听器接口
        void runEnd(String content);
    }
}

/**
 * 第一个界面
 */
public class MainActivity extends AppCompatActivity implements EventManager.EventListener, View.OnClickListener {

    private TextView tv;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        tv = (TextView) findViewById(R.id.tv);
        findViewById(R.id.bu).setOnClickListener(this);
        EventManager.getInstance().registListener(this);
    }

    @Override
    public void runEnd(String content) {
        tv.setText(content);
    }

    @Override
    public void onClick(View v) {
        Intent i = new Intent(this, NextActivity.class);
        startActivity(i);
    }
}

/**
 * 第二个界面
 */
public class NextActivity extends AppCompatActivity implements View.OnClickListener {

    private EditText editText;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_next);
        editText = (EditText) findViewById(R.id.et);
        findViewById(R.id.bu).setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
        EventManager.getInstance().eventRunEnd(editText.getText().toString());
    }
}

• 除了以上功能外，下面代码可以实现的功能有
  
  • 在子线程中进行耗时操作，运行完毕后通过handler回到主线程的方法。实现子线程与主线程通讯
  • 可以自定义传递的内容，替换掉传递的string。
  • 一个事件可以出发多个监听器

---

下面附上我自己设计的一个比较通用的eventmanager。这只是一个简化版，适用于大部分的普通项目，如果有特殊需求可以修改相关代码来实现。

/**
 * Created by Sober_philer on 2017/3/8 13:51
 * 自定义的一个通用EventManager
 * 参数支持各种类型，返回值支持各种内训
 * 事件运行结束后统一在主线程中
 * 可以多个地方同时监听一个runner
 */
public class EventManager {
    private static EventManager eventManager;
    //一个key可以对应多个value的自定义工具类
    private OToMoreMap<Integer, EventListener> code2listeners = new OToMoreMap<>();
    //注册的事件runner，一个int类型的key对应一个EventRunner
    private SparseArray<EventRunner> code2EventRunner = new SparseArray<>();
    private int CODE_RUNEND = 1;//EventRunner事件正常结束
    private int CODE_ERROR = 2;//EventRunner事件运行过程中出现了异常
    private ExecutorService mExecutorService;//子线程

    //从子线程中跳转到主线程
    private Handler hand = new Handler() {
        @Override
        public void handleMessage(Message msg) {
            super.handleMessage(msg);
            if (msg.what == CODE_RUNEND) {
                Event event = (Event) msg.obj;
                eventRunend(event);
            }else if(msg.what == CODE_ERROR){
                Event event = (Event) msg.obj;
                eventRunendError(event);
            }
        }
    };

    private EventManager() {
        mExecutorService = Executors.newCachedThreadPool();
    }

    public static EventManager getInstance() {
        if (eventManager == null) {
            eventManager = new EventManager();
        }
        return eventManager;
    }

    //注册eventRunner(注册与运行时分开的，可以在application中注册，在其他activity中直接运行)
    public void registEventRunner(int code, EventRunner runner) {
        code2EventRunner.append(code, runner);
    }

    //取消注册eventrunner
    public void unregistEventRunner(int code) {
        code2EventRunner.remove(code);
    }

    public void registEventListener(int code, EventListener listener) {
        code2listeners.put(code, listener);
    }

    public void unregistEventListener(int code, EventListener listener) {
        code2listeners.remove(code, listener);
    }

    public void pushEvent(int code){
        pushEvent(new Event(code));
    }

    //运行事件,event是一个自定义类，用于保存code、传递的内容与需要返回的内容等等
    public void pushEvent(final Event event) {
        if (code2EventRunner.get(event.getEventCode()) != null) {
            mExecutorService.execute(new Runnable() {
                @Override
                public void run() {
                    try {
                        code2EventRunner.get(event.getEventCode()).runEvent(event);
                        Message message = hand.obtainMessage();
                        message.what = CODE_RUNEND;
                        message.obj = event;
                        hand.sendMessage(message);
                    } catch (Throwable e) {
                        Message message = hand.obtainMessage();
                        message.what = CODE_ERROR;
                        message.obj = event;
                        event.setIsSuccess(false);
                        if (e instanceof Exception)
                            event.setException((Exception) e);
                        hand.sendMessage(message);
                    }
                }
            });
        }
    }

    //事件运行结束后分发到指定的监听地方，因为可能有多个地方监听通一个事件运行，所以这儿自定义帮助类OToMoreMap（作用是一个key可以对应多个value）
    private void eventRunend(Event event) {
        List<EventListener> value = code2listeners.getValue(event.getEventCode());
        Log.i("hx", event.getEventCode() + " listenner count : " + value.size());
        for (EventListener listener : value) {
            listener.runEnd(event);
        }
    }

    private void eventRunendError(Event event) {
        List<EventListener> value = code2listeners.getValue(event.getEventCode());
        Log.i("hx", event.getEventCode() + " listenner count : " + value.size());
        for (EventListener listener : value) {
            listener.runEndError(event);
        }
    }

    //Runner接口，可以根据需要改为抽象类
    public static abstract interface EventRunner {

        public abstract void runEvent(Event event) throws Throwable;
    }

    //事件运行结束监听接口，可以根据需要改为抽象类
    public static abstract  interface EventListener {
        void runEnd(Event event);
        void runEndError(Event event);
    }
}

通过一个常用的请求数据然后显示在界面demo来介绍使用方法

/**
 * eventmanager使用demo,实现请求数据与处理出去的分层
 */
public class TestManager extends Activity implements EventManager.EventListener, SwipeRefreshLayout.OnRefreshListener {

    //使用b站的一个json
    private String BILIBILI_BANNER_URL = "http://app.bilibili.com/x/region/show/old?" +
            "tid=13&plat=0&platform=android&device=&build=408002&channel=";
    private final int BIBLI_URL_CODE = 233;//事件的标记
    private EventManager manager;
    private SwipeRefreshLayout sf;
    private ListView lv;
    private InnerAdapter innerAdapter;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test_manager);
        manager = EventManager.getInstance();
        sf = (SwipeRefreshLayout) findViewById(R.id.sw);
        sf.setOnRefreshListener(this);
        lv = (ListView) findViewById(R.id.lv);
        lv.setAdapter(innerAdapter = new InnerAdapter());
        manager.registEventRunner(BIBLI_URL_CODE, new InnerRunner());//注册一个启动器
        //注册需要监听那些事件,可以通过code来见他任何地方发送的消息来实现交互
        manager.registEventListener(BIBLI_URL_CODE, this);
        manager.pushEvent(BIBLI_URL_CODE);//启动一个事件
    }

    //运行正常结束后执行这儿
    @Override
    public void runEnd(Event event) {
        sf.setRefreshing(false);
        int code = event.getEventCode();
        if(code == BIBLI_URL_CODE){
            BBean bBean = event.findReturnParam(BBean.class);
            if(bBean != null && bBean.getResult() != null){
                innerAdapter.replaceAll(bBean.getResult().getRecommends());
            }
        }
    }

    @Override
    public void runEndError(Event event) {
        sf.setRefreshing(false);
        Toast.makeText(this, "请求或解析失败~" + event.getException().getMessage(), Toast.LENGTH_LONG).show();
    }

    @Override
    public void onRefresh() {
        manager.pushEvent(BIBLI_URL_CODE);
    }

    //具体的运行
    private class InnerRunner implements EventManager.EventRunner{
        @Override
        public void runEvent(Event event) throws Throwable {
            RequestParams params = new RequestParams(BILIBILI_BANNER_URL);
            String s = x.http().getSync(params, String.class);
            Gson g = new Gson();
            BBean bBean = g.fromJson(s, BBean.class);
            event.addReturnParam(bBean);
            event.addReturnParam(s);
            event.setIsSuccess(true);
        }
    }

    private class InnerAdapter extends BaseAdapter {//适配器
        private List<BBean.ResultBean.RecommendsBean> dates = new ArrayList<>();
        private void replaceAll(List<BBean.ResultBean.RecommendsBean> dates){
            this.dates.clear();
            this.dates.addAll(dates);
            notifyDataSetChanged();
        }
        @Override
        public int getCount() {
            return dates.size();
        }

        @Override
        public Object getItem(int position) {
            return dates.get(position);
        }

        @Override
        public long getItemId(int position) {
            return position;
        }

        @Override
        public View getView(int position, View convertView, ViewGroup parent) {
            InnerHolder holder = null;
            if(convertView == null){
                convertView = View.inflate(TestManager.this, R.layout.test_manager_item, null);
                holder = new InnerHolder(convertView);
                convertView.setTag(holder);
            }else {
                holder = (InnerHolder) convertView.getTag();
            }
            BBean.ResultBean.RecommendsBean bean = (BBean.ResultBean.RecommendsBean) getItem(position);
            x.image().bind(holder.iv, bean.getPic());
            holder.tvTitle.setText(bean.getTitle());
            holder.tvContent.setText(bean.getDescription());
            return convertView;
        }

        private class InnerHolder{
            private ImageView iv;
            private TextView tvTitle, tvContent;
            private InnerHolder(View v){
                iv = (ImageView) v.findViewById(R.id.iv);
                tvTitle = (TextView) v.findViewById(R.id.tvTitle);
                tvContent = (TextView) v.findViewById(R.id.tvContent);
            }
        }
    }
}