1. 程式人生 > >Arouter核心思路和原始碼詳解

Arouter核心思路和原始碼詳解

前言

閱讀本文之前,建議讀者:

  • 對Arouter的使用有一定的瞭解。
  • 對Apt技術有所瞭解。

Arouter是一款Alibaba出品的優秀的路由框架,本文不對其進行全面的分析,只對其最重要的功能進行原始碼以及思路分析,至於其攔截器,降級,ioc等功能感興趣的同學請自行閱讀原始碼,強烈推薦閱讀雲棲社群的官方介紹。

對於一個框架的學習和講解,我個人喜歡先將其最核心的思路用簡單一兩句話總結出來:ARouter通過Apt技術,生成儲存路徑(路由path)和被註解(@Router)的元件類的對映關係的類,利用這些儲存了對映關係的類,Arouter根據使用者的請求postcard(明信片)尋找到要跳轉的目標地址(class),使用Intent跳轉。

原理很簡單,可以看出來,該框架的核心是利用apt生成的對映關係,這裡要用到Apt技術,讀者可以自行搜尋瞭解一下。

分析

我們先看最簡單的程式碼的使用:

首先需要在需要跳轉的元件添加註解

@Route(path = "/main/homepage")
public class HomeActivity extends BaseActivity {
        onCreate()
        ....
}

然後在需要跳轉的時候呼叫

Arouter.getInstance().build("main/hello").navigation;

這裡的路徑“main/hello”是使用者唯一配置的東西,我們需要通過這個path找到對應的Activity。最簡單的思路就是通過APT技術,尋找到所有帶有註解@Router的元件,將其註解值path和對應的Activity儲存到一個map裡,比如像下面這樣:

class RouterMap {
     public Map getAllRoutes {
            Map map = new HashMap<String,Class<?>>;
            map.put("/main/homepage",HomeActivity.class);
            map.put("/main/setting",SettingActivity.class);
            map.put("/login/register",LoginRegisterActivity.class);
            ....
      
      return map;
     }
}

然後在工程程式碼中將這個map載入到記憶體中,需要的時候直接get(path)就可以了,這種方案似乎能解決我們的問題。

發現問題

上面的思路確實能夠實現路由功能,但是這麼做會存在一個較大的問題:對於一個大型專案,元件數量會很多,可能會有一兩百或者更多,把這麼多元件都放到這個Map裡,顯然會對記憶體造成很大的壓力,因此,Arouter作為一款阿里出品的優秀框架,顯然是要解決這個問題的。

這裡建議讀者自行思考一下,如何解決一次性載入所有對映關係帶來的記憶體損耗問題,我在思考這個問題的時候首先想到的是“懶載入”,但是僅僅懶載入是不夠的,因為懶載入後如果還是一次性把所有對映關係載入進來,記憶體損耗還是一樣大的。因此,再深入思考一下,可能還能想出解決一個思路:分段懶載入,思路有了,如何實現呢?這裡還是建議大家在閱讀下面的內容之前思考一下,或許你能想到一套不同於Arouter的方案來哦。

Arouter採用的方法就是“分組+按需載入”,分組還帶來的另一個好處是便於管理,下面我們來看一下實現原理。

解決步驟一:分組

首先看如何分組的,Arouter在一層map之外,增加了一層map,我們看WareHouse這個類,裡面有兩個靜態Map:

    static Map<String, Class<? extends IRouteGroup>> groupsIndex = new HashMap<>();
    static Map<String, RouteMeta> routes = new HashMap<>();
  • groupsIndex 儲存了group名字到IRouteGroup類的對映,這一層對映就是Arouter新增的一層對映關係。

  • routes 儲存了路徑path到RouteMeta的對映,其中,RouteMeta是目標地址的包裝。這一層對映關係跟我門自己方案裡的map是一致的,我們路徑跳轉也是要用這一層來對映。

這裡出現了兩個我們不認識的類,IRouteGroup和RouteMeta,後者很簡單,就是對跳轉目標的封裝,我們後續稱其為“目標”,其內包含了目標元件的資訊,比如Activity的Class。那IRouteGroup是個什麼東西?

public interface IRouteGroup {
    /**
     * Fill the atlas with routes in group.
     */
    void loadInto(Map<String, RouteMeta> atlas);
}

一個介面,只有一個方法loadInto,都有誰實現了這個介面呢?我拿我手上的一個專案為例,Arouter通過apt生成了下面幾個類:

這幾個類都以Arouter$$Group開頭,我們隨便拿一個看看:

public class ARouter$$Group$$main implements IRouteGroup {
  @Override
  public void loadInto(Map<String, RouteMeta> atlas) {
    atlas.put("/main/fa/leakscan", RouteMeta.build(RouteType.ACTIVITY, MainFaLeakScanActivity.class, "/main/fa/leakscan", "main", }}, -1, 1));
    atlas.put("/main/login", RouteMeta.build(RouteType.ACTIVITY, LoginActivity.class, "/main/login", "main", null, -1, -2147483648));
    atlas.put("/main/register", RouteMeta.build(RouteType.ACTIVITY, RegPhoneActivity.class, "/main/register", "main", null, -1, -2147483648));
  }
}

我們看到,他實現了loadInto方法,在這個方法中,它往這個HashMap中填充了好多資料,填充的是什麼呢?填充的是路徑path和它對應的目標RouteMeta,也就是我們最終需要的那層對映關係。而且,我們還能觀察到:這個類下面所有的路由path都有一個共同點,即全是“/main”開頭的,也就是說,這個類載入的對映關係,都是在一個組內的。因此我們總結出:

Arouter通過apt技術,為每個組生成了一個以Arouter$$Group開頭的類,這個類負責向atlas這個Hashmap中填充組內路由資料。

IRouteGroup正如其名字,它就是一個能裝載該組路由對映資料的類,其實有點像個工具類,為了方便後續講解,我們姑且稱上面這樣一個實現了IRouteGroup的類叫做“組載入器”,本質是一個類。上圖中的類是一個組載入器,其他所有以Arouter$$Group開頭的類都是一個“組載入器”。回到之前的主線,Warehoust中的兩個Hashmap,其中groupsIndex這個map中儲存的是什麼呢?我們通過它的呼叫找到這一行程式碼(已簡化):

for (String className : routerMap) {
     if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR +SUFFIX_ROOT)) {
        ((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);
            }
}

其中 ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR +SUFFIX_ROOT 這行程式碼是幾個靜態字串拼起來的,它等於 com.alibaba.android.arouter.routes.Arouter$$Root 。另外routerMap是什麼呢?它是一個HashSet<String>:

routerMap = ClassUtils.getFileNameByPackageName(mContext, ROUTE_ROOT_PAKCAGE);

這一行程式碼對它進行了初始化,目的是找到 com.alibaba.android.arouter.routes 這個包名下所有的類,將其類名儲存到routerMap中。因此,上面的程式碼意思就是將com.alibaba.android.arouter.routes 包下所有名字以 com.alibaba.android.arouter.routes.Arouter$$Root 開頭的類找出來,通過反射例項化並強轉成IRouteRoot,然後呼叫loadInto方法。這裡又出來一個新的介面:IRouteRoot,我們看程式碼:

public interface IRouteRoot {

    /**
     * Load routes to input
     * @param routes input
     */
    void loadInto(Map<String, Class<? extends IRouteGroup>> routes);
}

跟IRouteGroup長得還挺像,也是loadInto,我們看它的實現。還是以我的專案為例,在apt生成的資料夾下查詢:

最底下一行,有個Arouter$$Root$$app,它符合前面名字規則,我們進去看看:

public class ARouter$$Root$$app implements IRouteRoot {
  @Override
  public void loadInto(Map<String, Class<? extends IRouteGroup>> routes) {
    routes.put("YDY", ARouter$$Group$$YDY.class);
    routes.put("app", ARouter$$Group$$app.class);
    routes.put("main", ARouter$$Group$$main.class);
    routes.put("payment", ARouter$$Group$$payment.class);
    routes.put("wallet", ARouter$$Group$$wallet.class);
  }
}

這個類實現了IRouteRoot,在loadInto方法中,他將組名和組對應的“組載入器”儲存到了routes這個map中。也就是說,這個類將所有的“組載入器”給索引了下來,通過任意一個組名,可以找到對應的“組載入器”,我們再回到前面講的初始化Arouter時候的方法中:

((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);

理解了吧,這個方法的意義就在於將所有的組路由載入類索引到了groupsIndex這個map中。因此我們就明白了:

WareHouse中的groupsIndex儲存的是組名到“組載入器”的對映關係

說句題外話:回過頭想想前面用到的兩個介面:IRouteGroup和IRouteRoot,它們其實是apt生成的類和我們專案中程式碼之間溝通的橋樑,熟悉AIDL的同學可能會覺得很熟悉,二者其實是異曲同工的,兩個系統進行互動的時候都是通過介面來溝通的。當然,在使用apt生成的類時,我們需要用到反射技術。

總結一下Arouter的分組設計:Arouter在原來path到目標的map外,加了一個新的map,該map儲存了組名到“組載入器”的對映關係。其中“組載入器”是一個類,可以載入其組內的path到目標的對映關係。

到此為止,Arouter只是完成了分組工作,但這麼做的目的是什麼呢?彆著急,前面的都只是鋪墊,接下來才是這個分組設計發揮作用的地方,我們進入“按需載入”的程式碼分析:

解決步驟二:按需載入

之前說過,Arouter使用的是分組按需載入,分組是為了按需做準備的。我們看Arouter是怎麼按需載入的,我們還是從程式碼的使用入手:

Arouter.getInstance().build("main/hello").navigation;

在navigation這個方法中,最終會跳轉到這裡:

protected Object navigation(final Context context, final Postcard postcard, final int requestCode, final NavigationCallback callback) {
        try {
          //請關注這一行
            LogisticsCenter.completion(postcard);
        } catch (NoRouteFoundException ex) {
            logger.warning(Consts.TAG, ex.getMessage());
                ....//簡化程式碼
        }
            //呼叫Intent跳轉
        return _navigation(context, postcard, requestCode, callback)

最後一行的return語句很簡單,就是去呼叫Intent喚起元件了,我們看前面try中的第一行 LogisticsCenter.completion(postcard),我們進到這個函式裡:

//從快取裡取路由資訊
RouteMeta routeMeta = Warehouse.routes.get(postcard.getPath());
//如果為空,需要載入該組的路由
if (null == routeMeta) {
  Class<? extends IRouteGroup> groupMeta = Warehouse.groupsIndex.get(postcard.getGroup());
  IRouteGroup iGroupInstance = groupMeta.getConstructor().newInstance();
  iGroupInstance.loadInto(Warehouse.routes);
  Warehouse.groupsIndex.remove(postcard.getGroup());
} 
//如果不為空,走後續流程
else {
     postcard.setDestination(routeMeta.getDestination());
     ...
}

這段程式碼就是“按需載入”的核心邏輯所在了,我對其進行了簡化,分析其邏輯是這樣的:

  • 首先從Warehouse.routes(前面說了,這裡存放的是path到目標的對映)裡拿到目標資訊,如果找不到,說明這個資訊還沒載入,需要載入,實際上,剛開始這個routes裡面什麼都沒有。
  • 載入流程:首先從Warehouse.groupsIndex裡獲取“組載入器”,組載入器是一個類,需要通過反射將其例項化,例項化為iGroupInstance,接著呼叫組載入器的載入方法loadInto,將該組的路由對映關係載入到Warehouse.routes中,載入完成後,routes中就快取下來當前組的所有路由映射了,因此這個組載入器其實就沒用了,為了節省記憶體,將其從Warehouse.groupsIndex移除。
  • 如果之前載入過,則在Warehouse.routes裡面是可以找到路有對映關係的,因此直接將目標資訊routeMeta傳遞給postcard,儲存在postcard中,這樣postcard就知道了最終要去哪個元件了。

到此為止分組按需載入的邏輯就都分析完了,通過這兩個步驟,解決了路由對映一次性載入到記憶體佔用記憶體過大的缺點,這是Arouter這個框架優秀的重要原因之一。當然Arouter還有一些優秀的功能,比如攔截器,依賴注入等,總之,功能全,效能好,使用方便,這些都是Arouter受歡迎的原因,這點值得我們所有開發者去學習。

總結

最後結合一張圖總結一下Arouter的分組按需載入的邏輯:

圖中左側groupsIndex是“組對映”,右側routes是“路由對映”。Arouter在初始化的時候,通過反射技術,將所有的“組載入器”索引到groupsIndex這個map中,而此時,右側的routes還是空的。在使用者呼叫navigation()進行跳轉的時候,會根據路徑提取組名,由組名根據groupsIndex獲取到相應組的“組載入器”,由組載入器載入對應組內的路由資訊,此時儲存全域性“路由目標對映的”routes這個map中就儲存了剛才組的所有路由對映關係了。同樣,當其他組請求時,其他組也會載入組對應的路由對映,這樣就實現了整個App執行時,只有用到的組才會加到記憶體中,沒有去過的組就不會載入到記憶體中,達到了節省記憶體的目的