iOS 擼一個簡單路由 Router

iOS開發 · 發表 2018-09-16 07:57:14

摘要：平常開發中使用者點選頭像，進入個人主頁，這看似平常的操作，背後極有可能會牽扯到多個模組。再如：視訊模組的播放頁，有與視訊相關的音樂，點選這些音樂，需要跳轉到音樂模組的播放頁，這樣視訊與音樂模組之間，不可避免的會產生依賴或耦合。這個問題讓人腦殼疼，相信很多朋友都這樣做過，寫一些...

平常開發中使用者點選頭像，進入個人主頁，這看似平常的操作，背後極有可能會牽扯到多個模組。再如：視訊模組的播放頁，有與視訊相關的音樂，點選這些音樂，需要跳轉到音樂模組的播放頁，這樣視訊與音樂模組之間，不可避免的會產生依賴或耦合。這個問題讓人腦殼疼，相信很多朋友都這樣做過，寫一些代理或通知，不停的傳遞事件；有時乾脆直接匯入另一個模組。

因為我在公司獨立開發，顧及少一點，可以拿公司專案做實踐，在嘗試元件化的過程中，瞭解到了路由，對於解決上述問題，有極大的幫助。因此我想總結並與大家分享一下。

介面預覽

Router

NS_ASSUME_NONNULL_BEGIN
@interface SJRouter : NSObject
+ (instancetype)shared;

- (void)handleRequest:(SJRouteRequest *)request completionHandler:(SJCompletionHandler)completionHandler;
@end
NS_ASSUME_NONNULL_END

RouteRequest

NS_ASSUME_NONNULL_BEGIN
@interface SJRouteRequest : NSObject
- (instancetype)initWithURL:(NSURL *)URL;
- (instancetype)initWithPath:(NSString *)requestPath parameters:(nullable SJParameters)parameters;
@property (nonatomic, strong, readonly) NSString *requestPath;
@property (nonatomic, strong, readonly, nullable) SJParameters prts;
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)newNS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END

RouteHandlerProtocol

NS_ASSUME_NONNULL_BEGIN
typedef id SJParameters;

@protocol SJRouteHandler
+ (NSString *)routePath;
+ (void)handleRequestWithParameters:(nullable SJParameters)parameters topViewController:(UIViewController *)topViewController completionHandler:(nullable SJCompletionHandler)completionHandler;
@end
NS_ASSUME_NONNULL_END

流程

簡單的講，app應用中，路由識別一個請求，將它分派給對應的handler進行處理。這個流程非常像傳送一個網路請求（拼接引數=>發起請求=>回撥）。

同樣的，當Router收到下面的請求時(請求視訊播放頁)：

- (void)push:(id)sender {
SJRouteRequest *request = [[SJRouteRequest alloc] initWithPath:@"video/playbackInfo" parameters:@{@"video_id":@(111)}];
[SJRouter.shared handleRequest:request completionHandler:^(id_Nullable result, NSError * _Nullable error) {
#ifdef DEBUG
NSLog(@"%d - %s", (int)__LINE__, __func__);
#endif
}];
}

會嘗試識別路由，找到匹配的handler，傳遞必要引數：

@implementation SJRouter
- (void)handleRequest:(SJRouteRequest *)request completionHandler:(SJCompletionHandler)completionHandler {
NSParameterAssert(request); if ( !request ) return;
Class<SJRouteHandler> handler = _handlersM[request.requestPath];
if ( handler ) {
[handler handleRequestWithParameters:request.requestPath topViewController:_sj_get_top_view_controller() completionHandler:completionHandler];
}
else {
printf("\n (-_-) Unhandled request: %s", request.description.UTF8String);
}
}
@end

最後handler進行處理。

@implementation TestViewController
+ (NSString *)routePath {
return @"video/playbackInfo";
}

+ (void)handleRequestWithParameters:(nullable SJParameters)parameters topViewController:(UIViewController *)topViewController completionHandler:(nullableSJCompletionHandler)completionHandler {
TestViewController *vc = [TestViewController new];
vc.completionHandler = completionHandler;
[topViewController.navigationController pushViewController:vc animated:YES];
}
@end

至此，我們再回過頭看剛開始舉的那個例子：

視訊模組的播放頁，有與視訊相關的音樂，點選這些音樂，需要跳轉到音樂模組的播放頁。

此時，可以讓視訊模組依賴Router，進行跳轉請求。這看起來都是依賴，實則兩者差別很大了。

路由不止能處理跳轉音樂模組的請求，依賴也從多個變成只依賴Router即可。。。
在刪除某個依賴模組時，需要刪除依賴的程式碼，很煩的，對吧。
吧啦吧啦吧啦吧啦吧啦。。。

所以點選跳轉音樂模組，可以替換成如下操作, 發起請求：

SJRouteRequest *request = [[SJRouteRequest alloc] initWithPath:@"audio/playbackInfo" parameters:@{@"audio_id":@(232)}];
[SJRouter.shared handleRequest:request completionHandler:^(id_Nullable result, NSError * _Nullable error) {
#ifdef DEBUG
NSLog(@"%d - %s", (int)__LINE__, __func__);
#endif
}];

router找到對應的handler，讓其進行處理。

Handler

從開始到現在，可以看出Handler就是最終執行請求的那個傢伙。相信大家都有疑問，如何成為一個Handler？

很簡單，它是自動的(參見Router)，只要某個類遵守了SJRouteHandlerProtocol，它便成為了一個Handler。再來看一遍協議吧。

NS_ASSUME_NONNULL_BEGIN
typedef id SJParameters;

@protocol SJRouteHandler
+ (NSString *)routePath;
+ (void)handleRequestWithParameters:(nullable SJParameters)parameters topViewController:(UIViewController *)topViewController completionHandler:(nullable SJCompletionHandler)completionHandler;
@end
NS_ASSUME_NONNULL_END

routePath：即路徑，表示handler能夠處理的路徑。當發起請求時， Router會通過路徑獲取到對應的handler，交給其進行處理。
handleRequestWithParameters。。。： handler進行的處理。

Router

在整個請求過程中，Router做的事情實質上就是在眾多Handler中尋找命中註定的那一個。如何尋找呢？為什麼遵守了SJRouteHandlerProtocol便自動成為了Handler呢？

這自然要歸功於Runtime的強大力量，我們先看如何實現吧。

@implementation SJRouter 
- (instancetype)init {
self = [super init];
if ( !self ) return nil;
_handlersM = [NSMutableDictionary new];
int count = objc_getClassList(NULL, 0);
Class *classes = (Class *)malloc(sizeof(Class) * count); objc_getClassList(classes, count);
Protocol *p_handler = @protocol(SJRouteHandler);
for ( int i = 0 ; i < count ; ++ i ) {
Class cls = classes[i];
for ( Class thisCls = cls ; nil != thisCls ; thisCls = class_getSuperclass(thisCls) ) {
if ( !class_conformsToProtocol(thisCls, p_handler) ) continue;
if ( ![(id)thisCls respondsToSelector:@selector(routePath)] ) continue;
if ( ![(id)thisCls respondsToSelector:@selector(handleRequestWithParameters:topViewController:completionHandler:)] ) continue;
_handlersM[[(id<SJRouteHandler>)thisCls routePath]] = thisCls;
break;
}
}
if ( classes ) free(classes);
return self;
}
@end

objc_getClassList：很明顯了，獲取App所有類。
class_conformsToProtocol：該類是否遵守某個協議。

得益於Runtime的這兩個函式，即可獲取到眾多的Handler。當發起請求時，在眾多Handler中尋找註定的那一個，豈不是易如反掌。

Request

App發起的跳轉請求，更多到是內部頁面之間的跳轉，我們最需要關注的就是它的路徑，所以整個路由都是圍繞著路徑去跳轉的，而像URL中的scheme 和host ，體現出來的作用倒是不大。至少在我的專案中跳轉第三方App(例如分享)都是使用的友盟這類的SDK去處理的。

因此， Request持有每個請求的路徑，以及必要的引數，之後再無多餘操作。

好了，就到這裡了。

下面是專案地址，有興趣到話可以與我一起交流哦。。。

ofollow,noindex">https://github.com/changsanjiang/SJRouter

Email:[email protected]

QQGroup: 719616775

最後，文章難免會有疏漏與考慮不周之處，望請大家指正。

iOS 擼一個簡單路由 Router

介面預覽

流程

Handler

Router

Request

您可能也會喜歡…