iOS撸一个简单路由Router的实现代码

时间：2022-09-19 17:14:43

平常开发中用户点击头像， 进入个人主页，这看似平常的操作， 背后极有可能会牵扯到多个模块。 再如： 视频模块的播放页， 有与视频相关的音乐，点击这些音乐，需要跳转到音乐模块的播放页， 这样视频与音乐模块之间，不可避免的会产生依赖或耦合。 这个问题让人脑壳疼，相信很多朋友都这样做过，写一些代理或通知， 不停的传递事件； 有时干脆直接导入另一个模块。

因为我在公司独立开发， 顾及少一点，可以拿公司项目做实践，在尝试组件化的过程中， 了解到了路由， 对于解决上述问题， 有极大的帮助。因此我想总结并与大家分享一下。

什么是移动端路由层：

路由层的概念在服务端是指url请求的分层解析，将一个请求分发到对应的应用处理程序。移动端的路由层指的是将诸如App内页面访问、H5与App访问的访问请求和App间的访问请求，进行分发处理的逻辑层。

移动端路由层需要解决的问题：

1.对外部提供远程访问的功能，实现跨应用调用响应，包括H5应用调用、其他App应用调用、系统访问调用等
2.原生页面、模块、组件等定义，统称为资源(Resource)，在跨应用调用和路由层在不同端实现的业务表现需要一致的前提下，需要对资源进行定义，在路由提供内部请求分发的时候则可以提供不依赖对外进行资源定义的功能
3.外部调用如何使用统一标示(Uniform)进行表示资源
4.如何在移动端统一定义访问请求的过程，从而达成移动端与web端的统一性
5.如何更好的兼容iOS、Android的系统访问机制、App链接协议、web端路由机制与前端开发规范等
6.如何兼容各平台(Android、iOS)App页面导航机制
7.如何解决安全访问问题
8.移动端在客户端进行动态配置

移动端路由所应用的场景：

0.H5页面与App原生页面、模块与组件的交互
1.App与App之间的相互访问
2.App内部页面跳转、模块调度与组件加载等
3.推送与通知系统解除硬编码的逻辑，动态访问原生资源，更好的支持通过通知和推送完成动态页面访问和逻辑执行
4.Extension等动态调用主App的资源
5.App实现更复杂的架构MVVM或者是VIPER架构，提供解除业务相互依赖的能力
6.以组件化为目的的工程改造，隔离各个业务，以制作单独的组件

接口预览

Router

?
1
2
3
4
5
6
7
NS_ASSUME_NONNULL_BEGIN
@interface SJRouter : NSObject
+ (instancetype)shared;
 
- (void)handleRequest:(SJRouteRequest *)request completionHandler:(SJCompletionHandler)completionHandler;
@end
NS_ASSUME_NONNULL_END

RouteRequest

?
1
2
3
4
5
6
7
8
9
10
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)new NS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END

RouteHandlerProtocol

?
1
2
3
4
5
6
7
8
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收到下面的请求时(请求视频播放页)：

?
1
2
3
4
5
6
7
8
- (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，传递必要参数：

?
1
2
3
4
5
6
7
8
9
10
11
12
@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进行处理。

?
1
2
3
4
5
6
7
8
9
10
11
@implementation TestViewController
+ (NSString *)routePath {
  return @"video/playbackInfo";
}
 
+ (void)handleRequestWithParameters:(nullable SJParameters)parameters topViewController:(UIViewController *)topViewController completionHandler:(nullable SJCompletionHandler)completionHandler {
  TestViewController *vc = [TestViewController new];
  vc.completionHandler = completionHandler;
  [topViewController.navigationController pushViewController:vc animated:YES];
}
@end

至此， 我们再回过头看刚开始举的那个例子：

视频模块的播放页， 有与视频相关的音乐，点击这些音乐，需要跳转到音乐模块的播放页。

此时，可以让视频模块依赖Router， 进行跳转请求。这看起来都是依赖，实则两者差别很大了。

  1. 路由不止能处理跳转音乐模块的请求， 依赖也从多个变成只依赖Router即可。。。
  2. 在删除某个依赖模块时， 需要删除依赖的代码， 很烦的， 对吧。
  3. 吧啦吧啦吧啦吧啦吧啦。。。

所以点击跳转音乐模块，可以替换成如下操作, 发起请求：

?
1
2
3
4
5
6
  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。再来看一遍协议吧。

?
1
2
3
4
5
6
7
8
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
  1. routePath： 即路径， 表示handler能够处理的路径。当发起请求时， Router会通过路径获取到对应的handler， 交给其进行处理。
  2. handleRequestWithParameters。。。： handler进行的处理。

Router

在整个请求过程中，Router做的事情实质上就是在众多Handler中寻找命中注定的那一个。如何寻找呢？为什么遵守了SJRouteHandlerProtocol便自动成为了Handler呢？

这自然要归功于Runtime的强大力量，我们先看如何实现吧。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@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
  1. objc_getClassList： 很明显了， 获取App所有类。
  2. class_conformsToProtocol： 该类是否遵守某个协议。

得益于Runtime的这两个函数，即可获取到众多的Handler。 当发起请求时， 在众多Handler中寻找注定的那一个， 岂不是易如反掌。

Request

App发起的跳转请求，更多到是内部页面之间的跳转， 我们最需要关注的就是它的路径，所以整个路由都是围绕着路径去跳转的， 而像URL中的scheme和host，体现出来的作用倒是不大。至少在我的项目中跳转第三方App(例如分享)都是使用的友盟这类的SDK去处理的。

因此， Request持有每个请求的路径， 以及必要的参数， 之后再无多余操作。

好了， 就到这里了。

下面是项目地址， 有兴趣到话可以与我一起交流哦。。。

https://github.com/changsanjiang/SJRouter

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持服务器之家。

原文链接：https://segmentfault.com/a/1190000016407541

标签：

相关文章