iOS实现一个简单的Router [组件化、中间件、动态内容]

背景

在项目中经常会遇到一些通过URL链接来动态调用一些功能，或者是一个Safari中通过URL打开我们的App中的某一个功能，或者是做组件化管理，那就需要用到一个URLRouter这种类似中间件。
在之前使用过 MGJRouter 和 CTMediator，MGJRouter 使用超级简单，但它的一些弊端让我不得不放弃使用(弊端请自行搜索)，最后发现了 CTMediator 这个中间件，它使用 Target-Action 的这种方式来连接相应的功能模块，不同模块可以设置不同的 Target-Action (分布式)，在使用的时候由 runtime 主动找到相应的 Target-Action 获取对应的功能，CTMediator 也支持url的方式调用一个模块，但是扩展性不是很好，不能自定义路由规则，别人写的第三方库建议别修改他的源码。最后在工作之余借鉴了 CTMediator 的设计思想自己写了一个类似的东西，实现了可自定义路由规则、支持多种scheme的URL调用（http https 自定义scheme ... ）等功能的简单Router。

源码地址

https://github.com/LiliCode/Router-objc

使用方法请看 REDEME.md

设计思路

router_architecture.png

源码解析

这里提供了三个类和一个协议：

Router
URLConnector
HTTPConnector
NativeConnector

Router

管理遵守 URLConnector 协议的对象
根据 URL 中的 Scheme 分配 Connector 对象

APIs

+ (instancetype)sharedRouter;
// 打开URL指定链接
- (id)openURL:(NSURL *)URL error:(NSError **)error;
// 注册Connector连接器
- (void)registerConnector:(id<URLConnector>)connector forScheme:(NSString *)scheme;

URLConnector

让 Connector 遵循这个标准协议，便于类型判断
让 Connector 实现方法，自定义路由逻辑

APIs

// 将要执行URL
- (BOOL)willPerformURL:(NSURL *)URLObject;
// 开始执行URL链接
- (id)performURL:(NSURL *)URLObject error:(NSError **)error;

HTTPConnector

调用 Web 模块（WebViewController）

NativeConnector

调用本地模块

API

// 本地组件和接口调用
- (id)performTarget:(NSString *)target withAction:(NSString *)action withParameter:(NSDictionary *)parameter error:(NSError **)error;

URL 调用逻辑

在使用前会通过 Scheme 注册 HTTPConnector 和 NativeConnector 这两个类，并为 HTTPConnector 指定一个 Web 控制器的类，如下所示：

// 创建连接器
HTTPConnector *httpConnector = [[HTTPConnector alloc] init];
httpConnector.webControllerClass = [WebController class];
NativeConnector *nativeConnector = [[NativeConnector alloc] init];
// 注册连接器
[[Router sharedRouter] registerConnector:httpConnector forScheme:@"http"];
[[Router sharedRouter] registerConnector:httpConnector forScheme:@"https"];
[[Router sharedRouter] registerConnector:nativeConnector forScheme:@"app"];

Scheme：http https 为网页链接； app 为本地模块，当然你可以自己指定；在注册的时候 Connector 对象会存放在一个可变字典中，Scheme 作为键，Connector 作为值；注册代码如下所示：

- (void)registerConnector:(id<URLConnector>)connector forScheme:(nonnull NSString *)scheme {
    if (!connector || !scheme.length) {
        NSLog(@"%s 注册失败, connector 或 scheme 为空!", __FUNCTION__);
        return;
    }
    
    if (![connector conformsToProtocol:@protocol(URLConnector)]) {
        NSLog(@"%s 注册失败, connector 没有遵循URLConnector协议!", __FUNCTION__);
        return;
    }
    
    [self.schemes setObject:connector forKey:scheme];
}

在需要打开一个URL的时候，会通过 openURL: error: 此方法调用

// 示例链接
[[Router sharedRouter] openURL:[NSURL URLWithString:@"app://user/userCenter"] error:NULL];

在发起 URL 调用的时候，Router 会根据 URL 的 Scheme 来决定选择哪个 Connector 对象发起调用，也就是根据 Scheme 选择不同的调用逻辑，然后会调用 Scheme 对应的 Connector 对象的 URLConnector 协议方法。

- (id)openURL:(NSURL *)URL error:(NSError **)error {
    if (!URL) {
        if (error) {
            *error = [NSError errorWithDomain:@"router" code:0 userInfo:@{NSLocalizedDescriptionKey:@"URL为空"}];
        }
        
        return nil;
    }
    
    // 获取连接器
    id <URLConnector> connector = [self.schemes objectForKey:URL.scheme];
    if (!connector) {
        if (error) {
            NSString *errorMsg = [NSString stringWithFormat:@"Router不支持这个URL的Scheme，你可以通过 registerConnector:forScheme: 方法注册%@这个Scheme", URL.scheme];
            *error = [NSError errorWithDomain:@"router" code:0 userInfo:@{NSLocalizedDescriptionKey:errorMsg}];
        }
        
        return nil;
    }
    
    if ([connector willPerformURL:URL]) {   // 判断当前URL是否可以被执行
        return [connector performURL:URL error:error];  // 执行URL，返回对象
    }
    
    return nil;
}

如果链接是一个网页链接（http/https），就会使用 HTTPConnector 来调用，并且返回一个 WebViewController，返回的这个控制器你可以模态打开或者导航控制器打开，由你决定

- (id)performURL:(NSURL *)URLObject error:(NSError * _Nullable __autoreleasing *)error {
    if (!self.webControllerClass) {
        if (error) {
            *error = [NSError errorWithDomain:@"HTTPConnector" code:0 userInfo:@{NSLocalizedDescriptionKey:@"webControllerClass为空，请设置webControllerClass"}];
        }
        NSLog(@"%s webControllerClass 不能为空!", __FUNCTION__);
        return nil;
    }
    
    // 在注册的时候设置的 WebViewController 
    // 通过设置 WebViewController class 创建一个控制器
    id webViewController = [[self.webControllerClass alloc] init];
    @try {
        // WebViewController 需要一个 url 属性
        [webViewController setValue:URLObject.absoluteString forKey:@"url"];
    } @catch (NSException *exception) {
        NSLog(@"%s -> %@", __FUNCTION__, exception);
    }
    
    return webViewController;
}

如果链接是一个本地调用的链接（app 或者自定义的 Scheme）,会使用 NativeConnector 进行调用，在调用逻辑中借鉴 CTMediator 思想，使用 runtime 动态调用 Target/Action。

本地调用会分成下面几步进行执行：

URL 解析，解析出链接中的 Target、Action、parameter （类名，方法，需要的参数）三部分
通过解析出来的三部分进行本地调用，这一步通过 runtime 实现

- (id)performURL:(NSURL *)URLObject error:(NSError * _Nullable __autoreleasing *)error {
    // 解析URL
    NSURLComponents *components = [NSURLComponents componentsWithString:URLObject.absoluteString];
    // 获取path（action）
    NSString *path = [[components.path componentsSeparatedByString:@"/"] lastObject];
    // 转换成Action
    NSString *action = [path copy];
    if (components.query.length) {
        action = [action stringByAppendingString:@":"];
    }
    // 解析query（参数）
    NSMutableDictionary *params = [NSMutableDictionary new];
    for (NSURLQueryItem *item in components.queryItems) {
        [params setObject:item.value forKey:item.name];
    }
    
    // 接口类 Target_ 后面名称首字母大写
    NSMutableString *mTargetName = [components.host mutableCopy];
    NSString *targetName = nil;
    if (mTargetName.length) {
        NSUInteger index = 1;
        NSString *firstChar = [mTargetName substringToIndex:index];
        NSString *suffixString = [mTargetName substringFromIndex:index];
        targetName = [[firstChar uppercaseString] stringByAppendingString:suffixString];
    }
    
    // 开始调用
    return [self performTarget:[NSString stringWithFormat:@"Target_%@", targetName] withAction:action withParameter:[params copy] error:error];
}

// 模块调用
- (id)performTarget:(NSString *)target withAction:(NSString *)action withParameter:(NSDictionary *)parameter error:(NSError * _Nullable __autoreleasing *)error {
    if (!target.length || !action.length) {
        if (error) {
            *error = [NSError errorWithDomain:@"NativeConnector" code:0 userInfo:@{NSLocalizedDescriptionKey:@"链接不符合NativeConnector规范"}];
        }
        
        return nil;
    }
    
    Class class = NSClassFromString(target);
    SEL selector = NSSelectorFromString(action);
    // 判断class是否可以响应selector
    if (![class respondsToSelector:selector]) {
        if (error) {
            NSString *errorMsg = [NSString stringWithFormat:@"%@ 接口类中找不到 %@ 方法", target, action];
            *error = [NSError errorWithDomain:@"NativeConnector" code:0 userInfo:@{NSLocalizedDescriptionKey:errorMsg}];
        }
        
        return nil;
    }
    
    NSMethodSignature *signature = [class methodSignatureForSelector:selector];
    if (!strcmp(signature.methodReturnType, @encode(void))) {   // 方法无返回值
        // 使用 runtime 动态调用 class 中的方法: 参考: //www.greatytc.com/p/6517ab655be7
        // 也可以使用 performSelector 的方法动态调用，只不过在ARC下面编译器会出现警告(爆栈)
        ((void (*)(id, SEL, id))[class methodForSelector:selector])(class, selector, parameter);
        return nil;
    }
    
    return ((id (*)(id, SEL, id))[class methodForSelector:selector])(class, selector, parameter);
}

本地调用逻辑就是将解析出来 Target、Action、Parameter 使用 runtime 生成对象、方法，然后传入参数进行调用。

使用 NSClassFromString(target) 生成 Target 对应的类
使用 NSSelectorFromString(action) 生成 Target 类中的方法选择器
通过 performSelector: 或者 performSelector:withObject: 进行调用并返回控制器

参考

CTMediator
MGJRouter

写在最后

文章有的地方不够详情，是因为代码中有注释
如果有不好的地方请各路大佬多多指教，欢迎在下方评论区留言