iOS使用核心的50行代碼實現一個路由組件 頂 原 薦

使用組件化是爲了解耦處理，多個模塊之間通過協議進行交互。而負責解析協議，找到目的控制器，或者是返回對象給調用者的這個組件就是路由組件。本文講解如何使用核心的50行代碼實現一個路由組件。

本文包含以下內容：

• 組件化和路由
• 路由的實現
  • 路由註冊實現
  • 路由使用實現
• 客戶端的使用
• 一些小想法

提供一個Demo可以在YTRouterDemo這裏找到這裏找到

組件化和路由

之前看過挺多的關於路由管理、路由處理的文章，常常會和組件化出現在一起，一開始不知道爲何路由和組件化出現在一起，後來公司的項目中使用了路由組件（他本身也是一個組件，確切的說是一箇中間人或者中介者），才突然想明白了，原來如此。
使用組件化是爲了解耦處理，多個模塊之間通過協議進行交互。而負責解析協議，找到目的控制器，或者是返回對象給調用者的這個組件就是路由組件。

路由組件的職責主要是：

• 給註冊者提供註冊接口
  • 註冊者傳遞path和path對應的block，block的具體實現又註冊者自己處理
• 給調用者提供使用接口
  • 調用者最簡單可以傳遞一個path給路由組件發起調用，路由組件會把具體的處理轉發給註冊者，理論上是可以任意的操作，包括頁面跳轉、彈窗提示、返回一個值給調用者等

下面會會在以上分析的基礎上實現一個簡單的路由組件，對應的代碼可以在YTRouterDemo這裏找到

路由的實現

路由的實現包括兩部分：路由註冊實現以及路由使用實現

路由註冊實現

路由註冊實現時序圖：


如上圖所示，步驟很簡單：

• 初始化一個YTRouterActionObject對象，用於保存path和對應的blok
• 獲取到路徑對應的節點，path會使用"/"符拆分爲多個pathItem，每個pathItem都會保存在一個Dictionary對應的位置上，subRouterMapWithPath負責深度遍歷Dictionary，然後找到對應的位置
• 把YTRouterActionObject對象保存在上一步找到的位置中

以上步驟對應的代碼如下：

- (void)registerPath:(NSString *)path actionBlock:(RouterActionBlock)actionBlock {
    YTRouterActionObject *actionObject = [YTRouterActionObject new];
    actionObject.path = path;
    actionObject.actionBlock = actionBlock;
    NSMutableDictionary *subRouter = [self subRouterMapWithPath:path];
    subRouter[YTRouterActionObjectKey] = actionObject;
}

- (NSMutableDictionary *)subRouterMapWithPath:(NSString *)path {
    NSArray *components = [path componentsSeparatedByString:@"/"];
    NSMutableDictionary *subRouter = self.routerMap;
    for (NSString *component in components) {
        if (component.length == 0) {
            continue;
        }
        if (!subRouter[component]) {
            subRouter[component] = [NSMutableDictionary new];
        }
        subRouter = subRouter[component];
    }
    return subRouter;
}

在Demo中註冊的幾個路由最終的配置如下，比如home/messagelist對應的路由配置保存在<YTRouterActionObject: 0x6040000365e0>對象中

Printing description of self->_routerMap:
{
    home =     {
        "_" = "<YTRouterActionObject: 0x60c00003b040>";
        messagelist =         {
            "_" = "<YTRouterActionObject: 0x6040000365e0>";
            detail =             {
                "_" = "<YTRouterActionObject: 0x600000038ec0>";
            };
            getmessage =             {
                "_" = "<YTRouterActionObject: 0x600000038e80>";
            };
        };
    };
}

路由使用實現

路由使用實現時序圖：


如上圖所示，步驟很簡單：

• 從註冊的配置中找到匹配的YTRouterActionObject對象
• 執行YTRouterActionObject對象的actionBlock，會傳遞一個YTRouterActionCallbackObject對象，如果調用者需要的是返回值，可以使用YTRouterActionCallbackObject對象的actionCallbackBlock傳遞一個返回值，這個actionBlock是又業務方的註冊者實現的

以上步驟對應的代碼如下：

- (BOOL)runWithActionCallbackObject:(YTRouterActionCallbackObject *)actionCallbackObject {
    // 判斷是否支持scheme
    if (![self canAcceptScheme:actionCallbackObject.uri.scheme]) {
        return NO;
    }
    // 獲取path對應的ActionObject
    YTRouterActionObject *actionObject = [self actionObjectWithPath:actionCallbackObject.uri.path];
    // 執行Path註冊的對應Block
    !actionObject.actionBlock ?: actionObject.actionBlock(actionCallbackObject);
    return YES;
}

- (YTRouterActionObject *)actionObjectWithPath:(NSString *)path {
    NSMutableDictionary *subRouter = [self subRouterMapWithPath:path];
    return subRouter[YTRouterActionObjectKey];
}

客戶端的使用

以上講到了核心的路由註冊實現和路由使用實現，總共代碼還沒有50行，所以還是很簡單的，接下來會講下客戶端的使用步驟，包括

• 客戶端註冊者註冊
• 客戶端調用者使用

客戶端註冊者註冊

註冊的時機需要比較找，考慮到集成的方便，選擇在load方法中處理路由註冊，如下代碼所示，添加了幾個測試的路由，分兩種情況來說明下使用

1、不需要返回值
如下注冊"home/messagelist"的是一個頁面跳轉的路由，actionBlock的參數是一個YTRouterActionCallbackObject對象，可以從YTRouterActionCallbackObject對象或者到參數，關於如何傳遞值，會在下面的客戶端調用者使用這裏講到。然後在actionBlock處理目的頁面的初始化、參數設置等步驟，然後執行頁面跳轉。

2、需要返回值
如下注冊"home/messagelist/getmessage"的是一個提供返回值的路由，同樣也可以從YTRouterActionCallbackObject對象獲取參數，另外YTRouterActionCallbackObject對象還有一個actionCallbackBlock屬性是專門處理返回參數給調用者的，如下的代碼只是簡單返回一個字符串，在更加具體的業務場景中，這裏會設置接口調用、數據庫查詢等任務，最後把結果返回。

@implementation ModuleAUriRegister

+ (void)load {
    [[YTRouterManager sharedRouterManager] registerPath:@"home/messagelist" actionBlock:^(YTRouterActionCallbackObject *callbackObject) {
        MessageListViewController *messageListVC = [MessageListViewController new];
        NSString *title = callbackObject.uri.params[@"title"];
        messageListVC.title = title;
        [[UIViewController yt_currentViewControlloer].navigationController pushViewController:messageListVC animated:YES];;
    }];
    [[YTRouterManager sharedRouterManager] registerPath:@"home/" actionBlock:^(YTRouterActionCallbackObject *callbackObject) {
        
    }];
    [[YTRouterManager sharedRouterManager] registerPath:@"home/messagelist/detail" actionBlock:^(YTRouterActionCallbackObject *callbackObject) {
        
    }];
    [[YTRouterManager sharedRouterManager] registerPath:@"home/messagelist/getmessage" actionBlock:^(YTRouterActionCallbackObject *callbackObject) {
        // 內容回調
        !callbackObject.actionCallbackBlock ?: callbackObject.actionCallbackBlock(@"message content text demo");
    }];
}

@end

客戶端調用者使用

1、簡單的path跳轉調用
使用YTRouterManager單例對象的runWithPath方法，傳遞一個註冊的path參數完成跳轉。

[self addActionWithTitle:@"Router頁面跳轉" detailText:@"home/messagelist" callback:^{
    [[YTRouterManager sharedRouterManager] runWithPath:@"home/messagelist"];
}];

2、使用URL調用和有URL參數的調用
使用YTRouterManager單例對象的runWithURLString方法，傳遞一個完整的包含了scheme/path，或者有參數的會纔有參數的URL，比如"YTRouter://home/messagelist" 和 "YTRouter://home/messagelist?title=Hello Message" ，路由組件會解析出裏面的scheme、path、params，進行scheme過濾處理、path查詢YTRouterActionObject對象處理、參數傳遞處理。

[self addActionWithTitle:@"Router使用URL調用" detailText:@"YTRouter://home/messagelist" callback:^{
    [[YTRouterManager sharedRouterManager] runWithURLString:@"YTRouter://home/messagelist"];
}];

[self addActionWithTitle:@"Router使用帶參數的URL調用" detailText:@"YTRouter://home/messagelist?title=Hello Message" callback:^{
    [[YTRouterManager sharedRouterManager] runWithURLString:@"YTRouter://home/messagelist?title=Hello Message"];
}];

效果如下圖所示：

3、簡單的path跳轉調用
使用YTRouterManager單例對象的runWithActionCallbackObject方法，傳遞一個YTRouterActionCallbackObject類型的參數，設置YTRouterActionCallbackObject對象的uri和結果回調actionCallbackBlock參數，在actionCallbackBlock中處理返回值。

[self addActionWithTitle:@"Router獲取返回值" detailText:@"home/messagelist/getmessage" callback:^{
    __block id message = nil;
    YTRouterActionCallbackObject *actionCallbackObject = [YTRouterActionCallbackObject new];
    actionCallbackObject.uri = [[YTUri alloc] initWithPath:@"home/messagelist/getmessage"];
    actionCallbackObject.actionCallbackBlock = ^(id result) {
        message = result;
    };
    [[YTRouterManager sharedRouterManager] runWithActionCallbackObject:actionCallbackObject];
    
    NSLog(@"message = %@", message);
}];

一些小想法

• load方法中註冊path對性能有一定的影響，如果這裏會成爲性能瓶頸，考慮把這部分分代碼放在對象方法中初始化，比如主模塊發送消息給各個模塊，然後在各個模塊中處理註冊
• YTRouterActionObject 如果需要更高的細嫩，可以考慮把path參數解析爲components進行緩存，這是一種以空間換時間的策略
• 爲了提高查找的效率，使用Dictionary而不是數組保存RouterActionObject

參考資料

iOS應用架構談 組件化方案
iOS組件化實踐方案－LDBusMediator煉就
iOS組件化思路－大神博客研讀和思考
iOS 組件化方案探索
蘑菇街 App 的組件化之路
NSRecursiveLock遞歸鎖的使用