ARouter路由框架原始碼解析

SharryChoo發表於2018-08-14

前言

隨著專案業務邏輯和功能點日益遞增, 邏輯的耦合程度也逐漸升高, 元件化技術可以很好的解決這個問題, 公司大佬最近也在搞元件化工程, 我想是時候分析一下元件化的實現方案了, Alibaba 的 ARouter 是非常出名的一個庫, 筆者抱著學習的態度去了解其實現原理, 以便於對元件化有更深刻的瞭解.

GitHub

github.com/alibaba/ARo…

一. ARouter 的模組區分

arouter-annotation

  • @Router
    • 作用在 Activity 上會在對應的 Module 上生成 ARouter$$Group$$group_name1 類
    • 作用在 IProvider 介面的實現類上會在對應的 Module 上生成 ARouter$$Provider$$module_name 類
/**
 * Mark a page can be route by router.
 *
 * @author Alex <a href="mailto:zhilong.liu@aliyun.com">Contact me.</a>
 * @version 1.0
 * @since 16/8/15 下午9:29
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.CLASS)
public @interface Route {

    /**
     * 跳轉地址
     */
    String path();

    /**
     * 跳轉地址所屬的組, 必須是通用的組名(一般不填/或者填寫當前 module 名)
     */
    String group() default "";

    /**
     * 用於生成 java 文件名(可忽略) 
     */
    String name() default "";

    /**
     * Extra data, can be set by user.
     * Ps. U should use the integer num sign the switch, by bits. 10001010101010
     */
    int extras() default Integer.MIN_VALUE;

    /**
     * 路由的優先順序, 用於攔截路由的分發
     */
    int priority() default -1;
}
複製程式碼
  • @Interceptor
    • 作用在 IInterceptor 的實現類上會在對應的 Module 上生成 ARouter$$Provider$$module_name 類
/**
 * Mark a interceptor to interception the route.
 * BE ATTENTION : This annotation can be mark the implements of #{IInterceptor} ONLY!!!
 *
 * @author Alex <a href="mailto:zhilong.liu@aliyun.com">Contact me.</a>
 * @version 1.0
 * @since 16/8/23 14:03
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.CLASS)
public @interface Interceptor {
    /**
     * The priority of interceptor, ARouter will be excute them follow the priority.
     */
    int priority();

    /**
     * The name of interceptor, may be used to generate javadoc.
     */
    String name() default "Default";
}
複製程式碼

arouter-compiler

編譯時註解的掃描與相關類的生成

arouter-api

提供路由的基本服務

  • ARouter
    • 門面
  • _ARouter
    • 實現
  • LogisticsCenter
    • 邏輯中心
  • Postcard
    • 導航的明信片
  • Warehouse
    • 陣列倉庫

整體模組之間的依賴關係

graph TB
arouter-api-->arouter-annotation
arouter-compiler-->arouter-annotation
複製程式碼

接下來開始分析 ARouter 的工作流程

二. 路由的初始化

  • 呼叫方式在 Application 中呼叫 ARouter.init(this);
  • 接下來分析一下路由初始化的原始碼
    /**
     * ARouter.init
     */
    public static void init(Application application) {
        if (!hasInit) {
            // 用於 ARouter 的 logger 列印, 之後會忽略這部分的原始碼
            logger = _ARouter.logger;
            _ARouter.logger.info(Consts.TAG, "ARouter init start.");
            // 1. 呼叫了 _ARouter 中的 init 
            hasInit = _ARouter.init(application);
            if (hasInit) {
                // 2. 呼叫 _ARouter 中的 afterInit 處理初始化之後的相關操作
                _ARouter.afterInit();
            }
        }
    }
複製程式碼

可以看到 ARouter 其實就是個外殼, 具體的實現均由 _ARouter 提供, 可見路由的初始化分為兩步進行

  • 呼叫 _ARouter 的 init 執行初始化操作
  • 呼叫了 _ARouter 的 afterInit() 執行善後操作

先從 _ARouter.init 開始

1. _ARouter.init

    /**
     * _ARouter.init
     */
    protected static synchronized boolean init(Application application) {
        mContext = application;
        // 1. 呼叫了 LogisticsCenter 的 init 方法
        LogisticsCenter.init(mContext, executor);
        // 2. 更新標記位
        hasInit = true;
        // 3. 繫結主執行緒的 Handler
        mHandler = new Handler(Looper.getMainLooper());
        return true;
    }
複製程式碼

主要做了三件事情

  • 呼叫了 LogisticsCenter 的 init 方法
  • 標記為已經初始化完畢
  • 建立主執行緒的 Handler

接下來分析一下 LogisticsCenter 初始化做了哪些事情

1.1 LogisticsCenter 邏輯處理中心的初始化

    /**
     * LogisticsCenter.init, load all metas in memory. Demand initialization
     */
    public synchronized static void init(Context context, ThreadPoolExecutor tpe) throws HandlerException {
        mContext = context;
        // 給執行緒池賦值
        executor = tpe;
        try {
            // 嘗試使用外掛註冊 ARouter 
            loadRouterMap();
            
            if (registerByPlugin) {
                // ...
            } else {
                // 這裡我們著重分析非外掛註冊的初始化實現
                Set<String> routerMap;
                // 1. 判斷是否是除錯(除錯會生成類), 若是除錯, 則從生成資料夾下找尋生成類
                if (ARouter.debuggable() || PackageUtils.isNewVersion(context)) {
                    // 1.1 每次除錯, 會通過編譯時註解, 生成相關檔案儲存到本地 com.alibaba.android.arouter.routes 資料夾下
                    // 當程式執行時, 通過 getFileNameByPackageName 找到對應的全限定名
                    routerMap = ClassUtils.getFileNameByPackageName(mContext, ROUTE_ROOT_PAKCAGE);
                    if (!routerMap.isEmpty()) {
                        // 1.2 更新生成檔案的集合
                        context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE).edit()
                                .putStringSet(AROUTER_SP_KEY_MAP, routerMap)
                                .apply();
                    }
                    PackageUtils.updateVersion(context);    // Save new version name when router map update finishes.
                } else {
                    // 2. 若不是除錯, 則直接從本地的快取中獲取, 非除錯環境, 不會生成新的程式碼
                    routerMap = new HashSet<>(
                         context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE)
                                .getStringSet(AROUTER_SP_KEY_MAP, new HashSet<String>())
                    );
                }
                // 3. 遍歷集合, 將快取的集合載入進相應的集合中
                for (String className : routerMap) {
                    if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_ROOT)) {
                        // 3.1 載入根元素(com.alibaba.android.arouter.routes.ARouter$$Root$$XXX)
                        ((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);
                    } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_INTERCEPTORS)) {
                        // 3.2 載入攔截器標籤元素(com.alibaba.android.arouter.routes.ARouter$$Interceptors$$XXX)
                        ((IInterceptorGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.interceptorsIndex);
                    } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_PROVIDERS)) {
                        // 3.3 載入提供器元素(com.alibaba.android.arouter.routes.ARouter$$Providers$$XXX)
                        ((IProviderGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.providersIndex);
                    }
                }
            }
            // ...忽略日誌程式碼
        } catch (Exception e) {
            // ...忽略異常程式碼
        }
    }
    
    /**
     * LogisticsCenter.loadRouterMap 若啟用了外掛註冊 ARouter , 將會在這個方法中自動生成程式碼
     */
    private static void loadRouterMap() {
        registerByPlugin = false;
        //auto generate register code by gradle plugin: arouter-auto-register
        // looks like below:
        // registerRouteRoot(new ARouter..Root..modulejava());
        // registerRouteRoot(new ARouter..Root..modulekotlin());
    }
    
    /**
     * Warehouse : ARouter 的資料倉儲
     */
    class Warehouse {
        // Cache route and metas
        static Map<String, Class<? extends IRouteGroup>> groupsIndex = new HashMap<>();
        static Map<String, RouteMeta> routes = new HashMap<>();

        // Cache provider
        static Map<Class, IProvider> providers = new HashMap<>();
        static Map<String, RouteMeta> providersIndex = new HashMap<>();

        // Cache interceptor
        static Map<Integer, Class<? extends IInterceptor>> interceptorsIndex = new UniqueKeyTreeMap<>("More than one interceptors use same priority [%s]");
        static List<IInterceptor> interceptors = new ArrayList<>();

        static void clear() {
            routes.clear();
            groupsIndex.clear();
            providers.clear();
            providersIndex.clear();
            interceptors.clear();
            interceptorsIndex.clear();
        }
   }
複製程式碼

通過 LogisticsCenter.init 的分析, 可知該方法起到了非常重要的作用, 主要做了以下工作

  • 嘗試通過外掛去註冊 ARouter, 這裡忽略
  • 獲取 Set routerMap 的資料
    • Debug: 若是開發環境, 則會讀取編譯時註解在 com.alibaba.android.arouter.routes 資料夾下的生成檔案, 新增到 routerMap 中
      • 不為空, 則通過 SharedPreferences 快取到本地
    • Release: 若線上環境, 則直接從快取中讀取
  • 遍歷 routerMap 集合
    • 反射例項化 com.alibaba.android.arouter.routes.ARouter$$Root$$XXX 物件, 呼叫 loadInto 新增到 Warehouse.groupsIndex 中
    • 反射例項化 com.alibaba.android.arouter.routes.ARouter$$Interceptors$$XXX 物件, 呼叫 loadInto 新增到 Warehouse.interceptorsIndex 中
    • 反射例項化 com.alibaba.android.arouter.routes.ARouter$$Providers$$XXX 物件, 呼叫 loadInto 新增到 Warehouse.providersIndex 中

1.2 生成類展示

/**
 * CreateTime: @Router 註解作用在類上時, 被生成
 * Description: 
 * 將所有被 @Router(path="", group="m2") 註解標記並且 group = m2 的類, 新增到 Warehouse.routes 中
 * Warehouse.routes(key = @Router中的path, value = @Router標記類的資訊生成的RouteMeta物件)
 */
public class ARouter$$Group$$m2 implements IRouteGroup {
    @Override
    public void loadInto(Map<String, RouteMeta> atlas) {
        atlas.put("/module/2", RouteMeta.build(RouteType.ACTIVITY, TestModule2Activity.class, "/module/2", "m2", null, -1, -2147483648));
    }
}

/**
 * CreateTime: 一個 Module 中若有 ARouter$$Group$$XXX 存在時, 被生成
 * Description: 
 * 收集一個 Module 下所有的 ARouter$$Group$$XXX 新增到 Warehouse.groupsIndex 中
 * Warehouse.groupsIndex (key = Group名, value = ARouter$$Group$$XXX.class)
 */
public class ARouter$$Root$$modulejava implements IRouteRoot {
    @Override
    public void loadInto(Map<String, Class<? extends IRouteGroup>> routes) {
        routes.put("m2", ARouter$$Group$$m2.class);
    }
}


/**
 * CreateTime: @Router 註解作用在實現了 IProvider 的類上時, 被生成
 * Description: 
 * 收集一個 Module 下所有的 IProvider 實現類資訊新增到 Warehouse.providersIndex 中
 * Warehouse.providersIndex(key = 實現的介面類的全限定名, value = @Router標記類的資訊生成的RouteMeta物件);
 */
public class ARouter$$Providers$$app implements IProviderGroup {
    @Override
    public void loadInto(Map<String, RouteMeta> providers) {
        providers.put("com.alibaba.android.arouter.demo.testservice.HelloService",
                RouteMeta.build(RouteType.PROVIDER, HelloServiceImpl.class, "/service/hello", "service", null, -1, -2147483648)
        );
    }
}


/**
 * CreateTime: @Interceptor 註解作用在實現了 IInterceptor 的類上時, 被生成
 * Description: 
 * 收集一個 Module 下所有的 IInterceptorGroup 實現類資訊新增到 Warehouse.interceptorsIndex 中
 * Warehouse.interceptorsIndex (key = @Interceptor中的優先順序資訊, value = 實現類的型別)
 */
public class ARouter$$Interceptors$$app implements IInterceptorGroup {
    @Override
    public void loadInto(Map<Integer, Class<? extends IInterceptor>> interceptors) {
        interceptors.put(7, Test1Interceptor.class);
    }
}
複製程式碼

1.3 生成類之間的依賴關係

  • IRouteRoot 與 IRootGroup 之間的依賴關係

    • 一個 module 會生成一個 ARouter$$Root$$module_name 類

    • 一個 module 會根據 group 的不同, 生成多個 ARouter$$Root$$group_name 類

    • ARouter$$Root$$module_name.loadInto() 方法被呼叫時, 會將儲存的 ARouter$$Root$$group_name.class 資訊注入 Warehouse.groupsIndex 中

    • 通過 Warehouse.groupsIndex 可以找到 ARouter$$Root$$group_name 類

      • 例項化後呼叫其 ARouter$$Root$$group_name.loadInto() , 會將 @Route 標記類的資訊注入 Warehouse.routes 中, 這是非常重要的一步, 在後面會展開分析
    • IRouteRoot 與 IRootGroup 之間的依賴關係.png

  • IProvider 生成類

    • IProvider 生成類.png
  • IInterceptor 生成類

    • IInterceptor 生成類.png

2. _ARouter.afterInit

    static void afterInit() {
        // 初始化攔截服務
        interceptorService = (InterceptorService) ARouter.getInstance()
            .build("/arouter/service/interceptor")
            .navigation();
    }
複製程式碼

2.1 從 ARouter.build 方法開始分析

    /**
     * ARouter.build 
     */
    public Postcard build(String path) {
        return _ARouter.getInstance().build(path);
    }

    /**
     * ARouter.build 
     */
    @Deprecated
    public Postcard build(String path, String group) {
        return _ARouter.getInstance().build(path, group);
    }

    /**
     * ARouter.build 
     */
    public Postcard build(Uri url) {
        return _ARouter.getInstance().build(url);
    }
複製程式碼

可以看到三個過載方法都呼叫了 _ARouter 的方法, 這裡與 WindowManager 中的方法使用 WindowManagerGlobal 橋接的手法很類似

    /**
     * _ARouter.build
     * 使用預設的 Group 組, 構建 Postcard 明信片
     */
    protected Postcard build(String path) {
        if (TextUtils.isEmpty(path)) {
            throw new HandlerException(Consts.TAG + "Parameter is invalid!");
        } else {
            // 1. 獲取 PathReplaceService 服務
            PathReplaceService pService = ARouter.getInstance().navigation(PathReplaceService.class);
            if (null != pService) {
                path = pService.forString(path);
            }
            // 呼叫 extractGroup 方法從 path 獲取路由的 group, 呼叫了過載方法
            return build(path, extractGroup(path));
        }
    }

    /**
     * _ARouter.build
     * 通過 Uri 來構建 Postcard 明信片
     */
    protected Postcard build(Uri uri) {
        if (null == uri || TextUtils.isEmpty(uri.toString())) {
            throw new HandlerException(Consts.TAG + "Parameter invalid!");
        } else {
            // 1. 獲取 PathReplaceService 服務
            PathReplaceService pService = ARouter.getInstance().navigation(PathReplaceService.class);
            if (null != pService) {
                uri = pService.forUri(uri);
            }
            // 2. 通過 path/group/uri 來構建明信片
            return new Postcard(uri.getPath(), extractGroup(uri.getPath()), uri, null);
        }
    }

    /**
     * _ARouter.build
     * 通過路徑和指定的 group(用於合併路由) 構建明信片
     */
    protected Postcard build(String path, String group) {
        if (TextUtils.isEmpty(path) || TextUtils.isEmpty(group)) {
            throw new HandlerException(Consts.TAG + "Parameter is invalid!");
        } else {
            // 1. 獲取 PathReplaceService 服務
            PathReplaceService pService = ARouter.getInstance().navigation(PathReplaceService.class);
            if (null != pService) {
                path = pService.forString(path);
            }
            // 2. 通過 path / group 來構建明信片
            return new Postcard(path, group);
        }
    }
複製程式碼

通過 _ARouter.build 過載方法可知有一個非常重要的點 通過呼叫 ARouter.navigation(PathReplaceService.class) 獲取了一個 PathReplaceService 服務, 接下來看看這個服務獲取的流程

    /**
     * ARouter.navigation
     */
    public <T> T navigation(Class<? extends T> service) {
        return _ARouter.getInstance().navigation(service);
    }
    
    /**
     * _ARouter.navigation
     */
    protected <T> T navigation(Class<? extends T> service) {
        try {
            // 1 通過全限定類名嘗試獲取 service 的 Postcard
            Postcard postcard = LogisticsCenter.buildProvider(service.getName());
            if (null == postcard) {
                // 嘗試通過簡單類名獲取 Postcard
                postcard = LogisticsCenter.buildProvider(service.getSimpleName());
            }
            // 2. 沒找到則返回 null
            if (null == postcard) {
                return null;
            }
            // 3. 找到了則呼叫 LogisticsCenter.completion 對這個 postcard 進行資料填充
            LogisticsCenter.completion(postcard);
            // 4. 通過 postcard.getProvider() 返回資料
            return (T) postcard.getProvider();
        } catch (NoRouteFoundException ex) {
            // ...
        }
    }
    
    /**
     * LogisticsCenter.buildProvider
     */
    public static Postcard buildProvider(String serviceName) {
        // Warehouse.providersIndex 在 LogisticsCenter.init 中進行資料注入, 在上面已經分析過
        // 通過 serviceName 獲取對應類的資訊封裝物件 RouteMeta
        RouteMeta meta = Warehouse.providersIndex.get(serviceName);
        if (null == meta) {
            return null;
        } else {
            // 構建明信片
            return new Postcard(meta.getPath(), meta.getGroup());
        }
    }
複製程式碼

可以看到 _ARouter.navigation 中主要處理了以下事務

  • 呼叫 LogisticsCenter.buildProvider 獲取要獲取服務的 Postcar
    • 通過 Warehouse.providersIndex 找到對應的 RouteMeta 物件 meta
    • 使用 meta 來構建 Postcard 物件
  • 沒找到則返回 null
  • 找到相應的 Postcard 則呼叫 LogisticsCenter.completion 對這個 Postcard 進行資料填充
    • LogisticsCenter.completion 這個方法非常重要, 放在後面分析
  • 經過 LogisticsCenter.completion 對 Postcard 進行資料填充之後, Postcard 中的 provider 就有了資料, 呼叫 Postcard.getProvider() 將所需服務物件返回

PathReplaceService 不為空的話, 會呼叫其 forString(path)/forUri(uri) 進行自定義解析(一般為空, ARouter 預設沒有實現這個介面)

小結

至此 ARouter.build 完成之後獲取到了一個 Postcard 物件, 然後會呼叫 Postcard.navigation() 獲取所需物件例項, 接下來分析一下 Postcard.navigation() 的流程

2.2 分析 Postcard.navigation() 方法流程

    /**
     * Postcard.navigation
     */
    public Object navigation() {
        return navigation(null);
    }

    /**
     * Postcard.navigation
     */
    public Object navigation(Context context) {
        return navigation(context, null);
    }

    /**
     * Postcard.navigation
     */
    public Object navigation(Context context, NavigationCallback callback) {
        // 最終還是回到了 ARouter.navigation 方法中
        return ARouter.getInstance().navigation(context, this, -1, callback);
    }
複製程式碼

可以看到 Postcard.navigation 的一系列過載方法, 最終都會呼叫到 ARouter.navigation 中, 這裡才是重頭戲的開始
接下來分析 ARouter.navigation(context, this, -1, callback) 這個方法的處理了哪些事務

    /**
     * ARouter.navigation
     */
    public Object navigation(Context mContext, Postcard postcard, int requestCode, NavigationCallback callback) {
        return _ARouter.getInstance().navigation(mContext, postcard, requestCode, callback);
    }
    
    /**
     * _ARouter.navigation
     */
    protected Object navigation(final Context context, final Postcard postcard, final int requestCode, final NavigationCallback callback) {
        try {
            // 1. 通過 postcard 明信片, 進行導航查詢
            LogisticsCenter.completion(postcard);
        } catch (NoRouteFoundException ex) {
            // ...回撥一些沒有找到目標的操作
            return null;
        }
        // 2. 回撥通過 postcard 明信片定位到了目標
        if (null != callback) {
            callback.onFound(postcard);
        }
        // 3. 判斷 postcard 是否為綠色通道, 若不是則啟動攔截器服務進行攔截
        if (!postcard.isGreenChannel()) {   // 必須執行在非同步執行緒, 否則可能 ANR
            interceptorService.doInterceptions(postcard, new InterceptorCallback() {
                @Override
                public void onContinue(Postcard postcard) {
                    _navigation(context, postcard, requestCode, callback);
                }

                @Override
                public void onInterrupt(Throwable exception) {
                    if (null != callback) {
                        callback.onInterrupt(postcard);
                    }
                }
            });
            
        } else {
            // 4. 回撥 _navigation 方法
            return _navigation(context, postcard, requestCode, callback);
        }
        return null;
    }

    /**
     * _ARouter._navigation
     */
    private Object _navigation(final Context context, final Postcard postcard, final int requestCode, final NavigationCallback callback) {
        final Context currentContext = null == context ? mContext : context;
        switch (postcard.getType()) {
            // 4.1 處理 Activity 的導航
            case ACTIVITY:
                // 4.1.1 構建 Intent 意圖
                final Intent intent = new Intent(currentContext, postcard.getDestination());
                intent.putExtras(postcard.getExtras());
                // 4.1.2 獲取並設定 Flags
                int flags = postcard.getFlags();
                if (-1 != flags) {
                    intent.setFlags(flags);
                } else if (!(currentContext instanceof Activity)) {    // Non activity, need less one flag.
                    intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
                }
                // 4.1.3 設定 Intent 的 Action
                String action = postcard.getAction();
                if (!TextUtils.isEmpty(action)) {
                    intent.setAction(action);
                }
                // 4.1.4 在主執行緒中處理 Activity 的啟動
                if (Looper.getMainLooper().getThread() != Thread.currentThread()) {
                    mHandler.post(new Runnable() {
                        @Override
                        public void run() {
                            startActivity(requestCode, currentContext, intent, postcard, callback);
                        }
                    });
                } else {
                    startActivity(requestCode, currentContext, intent, postcard, callback);
                }
                break;
            // 4.2 處理 PROVIDER("com.alibaba.android.arouter.facade.template.IProvider") 的導航
            case PROVIDER:
                return postcard.getProvider();
            // 4.3 處理 BOARDCAST/CONTENT_PROVIDER/FRAGMENT 的導航
            case BOARDCAST:
            case CONTENT_PROVIDER:
            case FRAGMENT:
                Class fragmentMeta = postcard.getDestination();
                try {
                    // 4.3.1 反射建立 Fragment 物件
                    Object instance = fragmentMeta.getConstructor().newInstance();
                    // 4.3.2 給 Fragment 設定引數
                    if (instance instanceof Fragment) {
                        ((Fragment) instance).setArguments(postcard.getExtras());
                    } else if (instance instanceof android.support.v4.app.Fragment) {
                        ((android.support.v4.app.Fragment) instance).setArguments(postcard.getExtras());
                    }
                    return instance;
                } catch (Exception ex) {
                    // ...
                }
            // 4.4 處理 METHOD/SERVICE 的導航
            case METHOD:
            case SERVICE:
            default:
                return null;
        }

        return null;
    }
複製程式碼

通過上面的原始碼分析可以非常清晰的看到 _ARouter.navigation 主要做了以下的事情

  • 呼叫 LogisticsCenter.completion 方法, 對 postcard 明信片資料填充
  • 回撥通過 postcard 明信片定位到了目標
  • 判斷 postcard 是否為綠色通道, 若不是則啟動攔截器服務進行攔截
  • 回撥 _navigation 方法真正的執行導航
    • 處理 Activity 的跳轉
    • 處理 ARouter IProvider 的服務獲取
    • 處理 BOARDCAST/CONTENT_PROVIDER/FRAGMENT 的導航
    • 處理 METHOD/SERVICE 的導航

小結

可以看到 ARouter.navigation(context, this, -1, callback) 中最終會呼叫 LogisticsCenter.completion 進行資料注入, 前面 2.1 中提到 ARouter.navigation(Class<? extends T> service) 同樣也呼叫了這個方法, 其重要程度可見一斑

接下來我們看一下, 最後的操作, LogisticsCenter.completion 中到底對 Postcard 做了哪些操作

2.4 LogisticsCenter.completion

    /**
     * LogisticsCenter.completion
     */
    public synchronized static void completion(Postcard postcard) {
        if (null == postcard) {
            throw new NoRouteFoundException(TAG + "No postcard!");
        }
        // 1. 從快取池中 Warehouse.routes 獲取對應的 ARouter$$Group$$xxx.class 類的資訊封裝物件 routeMeta
        // 初始化的時候, 一定為 null, 在 LogisticsCenter.init 中, 只對 Warehouse.groupsIndex 進行了資料填充
        RouteMeta routeMeta = Warehouse.routes.get(postcard.getPath());
        if (null == routeMeta) {
            // 2. 從索引池 Warehouse.groupsIndex 中獲取 IRouteGroup 對應的實體型別(ARouter$$Group$$xxx.class)
            Class<? extends IRouteGroup> groupMeta = Warehouse.groupsIndex.get(postcard.getGroup());
            if (null == groupMeta) {
                // ...異常日誌
            } else {
                try {
                    // 2.1 例項化 IRouteGroup(ARouter$$Group$$xxx.class)
                    IRouteGroup iGroupInstance = groupMeta.getConstructor().newInstance();
                    // 2.2 呼叫其 loadInto 方法, 將該 Group 下所有類的資訊 RouteMeta 填充到 Warehouse.routes 中
                    iGroupInstance.loadInto(Warehouse.routes);
                    // 2.3 說明當前 group 下的 RouteMeta 已經解析到 Warehouse.routes 中了, 從集合中移除
                    Warehouse.groupsIndex.remove(postcard.getGroup());
                } catch (Exception e) {
                    // ... 異常日誌
                }
                // 2.4 重新呼叫 LogisticsCenter.completion, 下次將會走到 3 中
                completion(postcard);   // Reload
            }
        } else {
            // 3. 給 postcard 注入資料
            postcard.setDestination(routeMeta.getDestination());
            postcard.setType(routeMeta.getType());
            postcard.setPriority(routeMeta.getPriority());
            postcard.setExtra(routeMeta.getExtra());
            // 3.1 獲取 URI
            Uri rawUri = postcard.getUri();
            if (null != rawUri) {   // Try to set params into bundle.
                // 3.2 分割 uri 引數
                Map<String, String> resultMap = TextUtils.splitQueryParameters(rawUri);
                // 3.3 獲取引數型別並且注入 postcard 中
                Map<String, Integer> paramsType = routeMeta.getParamsType();
                if (MapUtils.isNotEmpty(paramsType)) {
                    // Set value by its type, just for params which annotation by @Param
                    for (Map.Entry<String, Integer> params : paramsType.entrySet()) {
                        setValue(postcard, params.getValue(),  params.getKey(), resultMap.get(params.getKey()));
                    }
                    postcard.getExtras().putStringArray(ARouter.AUTO_INJECT, paramsType.keySet().toArray(new String[]{}));
                }
                // 3.5 mBundle 向 Bundle 中儲存 URI鍵值對
                postcard.withString(ARouter.RAW_URI, rawUri.toString());
            }
            // 4. 根據 routeMeta 的型別資訊處理相應的操作
            switch (routeMeta.getType()) {
                case PROVIDER:  // 4.1 為 ARouter 的 IProvider
                    // 4.1.1 構建例項物件
                    Class<? extends IProvider> providerMeta = (Class<? extends IProvider>) routeMeta.getDestination();
                    // 根據 IProvider 的資訊從 providers 中獲取快取的例項物件
                    IProvider instance = Warehouse.providers.get(providerMeta);
                    if (null == instance) {
                        IProvider provider;
                        try {
                            // 反射建立例項物件
                            provider = providerMeta.getConstructor().newInstance();
                            provider.init(mContext);
                            // 新增到快取池
                            Warehouse.providers.put(providerMeta, provider);
                            instance = provider;
                        } catch (Exception e) {
                            // ...
                        }
                    }
                    // 4.1.2 給 postcard 注入例項物件
                    postcard.setProvider(instance);
                    // 4.1.3 IProvider 型別的目標不允許設定為不可攔截(綠色通道)
                    postcard.greenChannel();
                    break;
                case FRAGMENT :// 4.2 Fragment 的型別
                    // 4.2.1 FRAGMENT 型別的目標不允許設定為不可攔截(綠色通道)
                    postcard.greenChannel();
                default:
                    break;
            }
        }
    }
複製程式碼

可見這個方法真的做了很多重要的事情

  • 從快取池中 Warehouse.routes 獲取對應的 ARouter$$Group$$xxx.class 類的資訊封裝物件 routeMeta

  • routeMeta 在快取中不存在

    • 從索引池 Warehouse.groupsIndex 中獲取 IRouteGroup 對應的實體型別 IRouteGroup(ARouter$$Group$$xxx.class)
    • 例項化 IRouteGroup(ARouter$$Group$$xxx.class)
    • 呼叫其 loadInto 方法, 將該 Group 下所有類的資訊 RouteMeta 填充到 Warehouse.routes 中
    • 說明當前 group 下的 RouteMeta 已經解析到 Warehouse.routes 中了, 從集合中移除
    • 重新回撥 LogisticsCenter.completion 方法, 下次不會走此分支
  • routeMeta 在快取中存在

    • 給 postcard 注入 routeMeta 中儲存的資料
  • routeMeta 的型別資訊處理相應的操作

    • PROVIDER:

      • 構建 IProvider 物件
      • 給 postcard 注入例項物件
      • 設定為綠色通道(不可攔截)
    • FRAGMENT:

      • 設定 為綠色通道, 其 例項 在上面分析過的 LogisticsCenter._navigation 中構建

之後便可以通過 postcard.getProvider(); 返回 ARouter.navigation 的例項物件了

三. 結語

通過本次對 ARouter 進行分析, 藉此釐清 ARouter 初始化的工作原理, 雖然說是初始化, 但可以發現很多核心程式碼都一併被分析了, 裡面的快取思想和程式碼設計是極好的, 非常值得學習, 筆者有很多分析不到位的地方, 希望大家能夠批評指出, 接下來準備手寫一份自己的 Router 庫, 以加深對 Router 的理解, 到時候還希望大家的支援

相關文章