iOS使用核心的50行程式碼實現一個路由元件

aron1992發表於2019-04-04
iOS行程路由元件

使用元件化是為了解耦處理，多個模組之間通過協議進行互動。而負責解析協議，找到目的控制器，或者是返回物件給呼叫者的這個元件就是路由元件。本文講解如何使用核心的50行程式碼實現一個路由元件。

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

元件化和路由

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

路由元件的職責主要是：

  • 給註冊者提供註冊介面
    • 註冊者傳遞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遞迴鎖的使用

相關文章