深扒 EventBus：解鎖新姿勢

本文章已授權玉剛說微信公眾號轉載

封裝優(yōu)化

今天將 EventBus 封裝到基類中報錯了

先翻譯一下這段報錯的提示，這個報錯說的是這個 Activity 自己以及它的父類沒有任何訂閱的方法

于是乎我回去看了一下公司項目對 EventBus 的封裝（PS：這個不是我封裝的），我的同事采用的是在基類占位的方式

但是我有更好的寫法，那種無意義的訂閱方法占位寫法不優(yōu)雅，我們可以捕捉這個異常，讓我們的 App 不會崩掉

我們要思考的一個問題，EventBus.register 的時候如果這個類里面沒有訂閱的方法會報錯，那么問題來了，如果取消訂閱的時候會不會報錯呢？接下來讓我們簡單看一下源碼

然而并不會拋異常，只是簡單地打印了一個 log 日志，所以在 EventBus.unregister 方法中無需捕捉異常

但是我們可以再做一下優(yōu)化，先判斷當前對象有沒有注冊過 EventBus，有的話再取消注冊

相關代碼

public abstract class BaseActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        try {
            EventBus.getDefault().register(this);
        } catch (EventBusException ignored) {
            // Subscriber class Activity and its super classes have no public methods with the @Subscribe annotation
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();

        if (EventBus.getDefault().isRegistered(this)) {
            EventBus.getDefault().unregister(this);
        }
    }
}

APT 插件

在項目中集成 Apt 插件

android {

    defaultConfig {

        javaCompileOptions {
            annotationProcessorOptions {
                // EventBus Apt 索引類生成位置
                arguments = [ eventBusIndex : applicationId + '.MyEventBusIndex' ]
            }
        }
    }
}

dependencies {
    implementation 'org.greenrobot:eventbus:3.1.1'
    annotationProcessor 'org.greenrobot:eventbus-annotation-processor:3.1.1'
}

在 Application 中初始化 EventBus 的默認配置

// 初始化 EventBus
EventBus.builder()
        .ignoreGeneratedIndex(false) // 使用 Apt 插件
        .addIndex(new MyEventBusIndex()) // 添加索引類
        .installDefaultEventBus(); // 作為默認配置

然后選擇 Build -> Rebuild Project，前提是項目已經使用了 EventBus（項目中有 @Subscribe 注解的方法），否則沒辦法生成這個類

看過這段由 APT 自動生成的代碼你是否煥然大悟了

/** This class is generated by EventBus, do not edit. */
public class MyEventBusIndex implements SubscriberInfoIndex {
    private static final Map<Class<?>, SubscriberInfo> SUBSCRIBER_INDEX;

    static {
        SUBSCRIBER_INDEX = new HashMap<Class<?>, SubscriberInfo>();

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.PersonFragment.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
            new SubscriberMethodInfo("onLoginOutEvent", com.gatewang.ksl.event.LoginOutEvent.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.MainActivity.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("goBackHomeEvent", com.gatewang.ksl.event.GoBackHomeEvent.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.SJMBaseFragment.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onEvent", String.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.LoginActivity.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onLoginEventEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.KSLBaseActivity.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onEvent", String.class, ThreadMode.MAIN),
            new SubscriberMethodInfo("onLoginOutEvent", com.gatewang.ksl.event.LoginOutEvent.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.activity.SignInActivity.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
        }));

        putIndex(new SimpleSubscriberInfo(com.gatewang.ksl.ui.fragment.ShopCartFragment.class, true,
                new SubscriberMethodInfo[] {
            new SubscriberMethodInfo("onRefreshShopCartEvent", com.gatewang.ksl.event.RefreshShopCartEvent.class,
                    ThreadMode.MAIN),
            new SubscriberMethodInfo("onLoginEvent", com.gatewang.ksl.event.LoginEvent.class, ThreadMode.MAIN),
        }));

    }

    private static void putIndex(SubscriberInfo info) {
        SUBSCRIBER_INDEX.put(info.getSubscriberClass(), info);
    }

    @Override
    public SubscriberInfo getSubscriberInfo(Class<?> subscriberClass) {
        SubscriberInfo info = SUBSCRIBER_INDEX.get(subscriberClass);
        if (info != null) {
            return info;
        } else {
            return null;
        }
    }
}

接下來讓我們看一下這段代碼是個什么東西

那么它究竟是怎么提升 EventBus 效率的，可以看出來，這個 Apt 插件將那些訂閱的方法生成到 MyEventBusIndex 中，那么這樣做的好處是什么？試想一下，EventBus 的原理大概是什么樣子的，EventBus.register 到底是怎么獲取到這個類中被 @Subscribe 修飾的方法信息，相信用過注解的人都知道，注解只能通過反射獲取得到。但是 EventBus 使用 Apt 自動生成的 MyEventBusIndex 類中，包含了這個類所有被注解的方法信息（方法名、事件對象、執(zhí)行的線程等等），因為這樣的話就不需要通過反射獲取注解上面的信息了，因為這些信息已經被 Apt 自動生成到一個類里面了，在 EventBus.register 的時候會優(yōu)先判斷，有沒有這個 MyEventBusIndex 類，有的話就從這個類獲取，沒有的話再通過反射獲取，這樣就能有效避免使用反射帶來的性能問題

終極優(yōu)化

學過 Apt 插件后，可以換一種更優(yōu)雅更好的寫法，這樣就不需要捕捉代碼塊中的異常了

/**
 *    author : Android 輪子哥
 *    github : https://github.com/getActivity/AndroidProject
 *    time   : 2019/04/02
 *    desc   : EventBus 輔助類
 */
public final class EventBusHelper {

    // EventBus 索引類
    private static final SubscriberInfoIndex SUBSCRIBE_INDEX = new MyEventBusIndex();

    // 這個類是否需要注冊 EventBus
    private static final ArrayMap<String, Boolean> SUBSCRIBE_EVENT = new ArrayMap<>();

    // 不允許被外部實例化
    private EventBusHelper() {}

    /**
     * 初始化 EventBus
     */
    public static void init() {
        EventBus.builder()
                .ignoreGeneratedIndex(false) // 使用 Apt 插件
                .addIndex(SUBSCRIBE_INDEX) // 添加索引類
                .installDefaultEventBus(); // 作為默認配置
    }

    /**
     * 注冊 EventBus
     */
    public static void register(Object subscriber) {
        if (canSubscribeEvent(subscriber)) {
            EventBus.getDefault().register(subscriber);
        }
    }

    /**
     * 反注冊 EventBus
     */
    public static void unregister(Object subscriber) {
        if (canSubscribeEvent(subscriber) && EventBus.getDefault().isRegistered(subscriber)) {
            EventBus.getDefault().unregister(subscriber);
        }
    }

    /**
     * 判斷是否使用了 EventBus 注解
     *
     * @param subscriber                 被訂閱的類
     */
    private static boolean canSubscribeEvent(Object subscriber) {
        Class<?> clazz = subscriber.getClass();
        // 這個 Class 類型有沒有遍歷過
        Boolean result = SUBSCRIBE_EVENT.get(clazz.getName());
        if (result != null) {
            // 有的話直接返回結果
            return result;
        }

        // 沒有的話進行遍歷
        while (clazz != null) {
            // 如果索引集合中有這個 Class 類型的訂閱信息，則這個類型的對象都需要注冊 EventBus
            if (SUBSCRIBE_INDEX.getSubscriberInfo(clazz) != null) {
                // 這個類需要注冊 EventBus
                result = true;
                clazz = null;
            } else {
                String clazzName = clazz.getName();
                // 跳過系統(tǒng)類（忽略 java. javax. android. androidx. 等開頭包名的類）
                if (clazzName.startsWith("java") || clazzName.startsWith("android")) {
                    clazz = null;
                } else {
                    // 往上查找
                    clazz = clazz.getSuperclass();
                }
            }
        }
        // 這個類不需要注冊 EventBus
        if (result == null) {
            result = false;
        }
        SUBSCRIBE_EVENT.put(subscriber.getClass().getName(), result);
        return result;
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onEventBus(EventBusHelper helper) {
        // 占位，只為了能生成 MyEventBusIndex 索引類
        // 如果項目中已經有用到 @Subscribe 去注解方法，這個方法可以直接刪除
    }
}

public class BaseApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // 初始化 EventBus
        EventBusHelper.init();
    }
}

public abstract class BaseActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        // 注冊 EventBus
        EventBusHelper.register(this);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 反注冊 EventBus
        EventBusHelper.unregister(this);
    }
}

為什么要那么寫呢？下篇文章我們將對 EventBus 的源碼進行詳細的解析

Android 技術討論 Q 群：10047167

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發(fā)布，文章內容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

友情鏈接更多精彩內容