iOS组件化过程中的几种路由方式 - shenchunxing/better-ios-developer GitHub Wiki

// 打开邮箱
mailto://
// 给110拨打电话
tel://110

com.ios.Qhomer://

// 手机QQ
mqq://
// 微信
weixin://
// 新浪微博
sinaweibo://
// 饿了么
eleme://

- (BOOL)application:(UIApplication *)application
 openURL:(NSURL *)url
 sourceApplication:(NSString *)sourceApplication
 annotation:(id)annotation {
     NSLog(@"sourceApplication: %@", sourceApplication);
     NSLog(@"URL scheme:%@", [url scheme]);
     NSLog(@"URL query: %@", [url query]);

     if ([sourceApplication isEqualToString:@"com.tencent.weixin"]){
         // 允许打开
         return YES;
     }else{
         return NO;
     }
}

@weakify(self);
 [[[_viewModel.someCommand executionSignals] flatten] subscribeNext:^(id x) {
 @strongify(self);
 // 跳转逻辑
 [self.navigationController pushViewController:targetViewController animated:YES];
 }];

- (void)_registerRoute:(NSString *)routePattern priority:(NSUInteger)priority handler:(BOOL (^)(NSDictionary *parameters))handlerBlock
{
 JLRRouteDefinition *route = [[JLRRouteDefinition alloc] initWithScheme:self.scheme pattern:routePattern priority:priority handlerBlock:handlerBlock];
  
 if (priority == 0 || self.routes.count == 0) {
 [self.routes addObject:route];
 } else {
 NSUInteger index = 0;
 BOOL addedRoute = NO;
  
 // 找到当前已经存在的一条优先级比当前待插入的路由低的路由
 for (JLRRouteDefinition *existingRoute in [self.routes copy]) {
 if (existingRoute.priority < priority) {
 // 如果找到，就插入数组
 [self.routes insertObject:route atIndex:index];
 addedRoute = YES;
 break;
 }
 index++;
 }
  
 // 如果没有找到任何一条路由比当前待插入的路由低的路由，或者最后一条路由优先级和当前路由一样，那么就只能插入到最后。
 if (!addedRoute) {
 [self.routes addObject:route];
 }
 }
}

- (BOOL)_routeURL:(NSURL *)URL withParameters:(NSDictionary *)parameters executeRouteBlock:(BOOL)executeRouteBlock
{
 if (!URL) {
 return NO;
 }
  
 [self _verboseLog:@"Trying to route URL %@", URL];
  
 BOOL didRoute = NO;
 JLRRouteRequest *request = [[JLRRouteRequest alloc] initWithURL:URL];
  
 for (JLRRouteDefinition *route in [self.routes copy]) {
 // 检查每一个route，生成对应的response
 JLRRouteResponse *response = [route routeResponseForRequest:request decodePlusSymbols:shouldDecodePlusSymbols];
 if (!response.isMatch) {
 continue;
 }
  
 [self _verboseLog:@"Successfully matched %@", route];
  
 if (!executeRouteBlock) {
 // 如果我们被要求不允许执行，但是又找了匹配的路由response。
 return YES;
 }
  
 // 装配最后的参数
 NSMutableDictionary *finalParameters = [NSMutableDictionary dictionary];
 [finalParameters addEntriesFromDictionary:response.parameters];
 [finalParameters addEntriesFromDictionary:parameters];
 [self _verboseLog:@"Final parameters are %@", finalParameters];
  
 didRoute = [route callHandlerBlockWithParameters:finalParameters];
  
 if (didRoute) {
 // 调用Handler成功
 break;
 }
 }
  
 if (!didRoute) {
 [self _verboseLog:@"Could not find a matching route"];
 }
  
 // 如果在当前路由规则里面没有找到匹配的路由，当前路由不是global 的，并且允许降级到global里面去查找，那么我们继续在global的路由规则里面去查找。
 if (!didRoute && self.shouldFallbackToGlobalRoutes && ![self _isGlobalRoutesController]) {
 [self _verboseLog:@"Falling back to global routes..."];
 didRoute = [[JLRoutes globalRoutes] _routeURL:URL withParameters:parameters executeRouteBlock:executeRouteBlock];
 }
  
 // 最后，依旧没有找到任何能匹配的，如果有unmatched URL handler，调用这个闭包进行最后的处理。
if, after everything, we did not route anything and we have an unmatched URL handler, then call it
 if (!didRoute && executeRouteBlock && self.unmatchedURLHandler) {
 [self _verboseLog:@"Falling back to the unmatched URL handler"];
 self.unmatchedURLHandler(self, URL, parameters);
 }
  
 return didRoute;
}

[[JLRoutes globalRoutes] addRoute:@"/:object/:primaryKey" handler:^BOOL(NSDictionary *parameters) {
 NSString *object = parameters[@"object"];
 NSString *primaryKey = parameters[@"primaryKey"];
 // stuff
 return YES;
}];

NSURL *editPost = [NSURL URLWithString:@"ele://post/halfrost?debug=true&foo=bar"];
[[UIApplication sharedApplication] openURL:editPost];

{
 "object": "post",
 "action": "halfrost",
 "debug": "true",
 "foo": "bar",
 "JLRouteURL": "ele://post/halfrost?debug=true&foo=bar",
 "JLRoutePattern": "/:object/:action",
 "JLRouteScheme": "JLRoutesGlobalRoutesScheme"
}

/the/foo/:a/bar/:b
/the/foo/:a
/the/bar/:b
/the

- (RouterParams *)routerParamsForUrl:(NSString *)url extraParams: (NSDictionary *)extraParams {
 if (!url) {
 //if we wait, caching this as key would throw an exception
 if (_ignoresExceptions) {
 return nil;
 }
 @throw [NSException exceptionWithName:@"RouteNotFoundException"
 reason:[NSString stringWithFormat:ROUTE_NOT_FOUND_FORMAT, url]
 userInfo:nil];
 }
  
 if ([self.cachedRoutes objectForKey:url] && !extraParams) {
 return [self.cachedRoutes objectForKey:url];
 }
  
 // 比对url通过/分割之后的参数个数和pathComponents的个数是否一样
 NSArray *givenParts = url.pathComponents;
 NSArray *legacyParts = [url componentsSeparatedByString:@"/"];
 if ([legacyParts count] != [givenParts count]) {
 NSLog(@"Routable Warning - your URL %@ has empty path components - this will throw an error in an upcoming release", url);
 givenParts = legacyParts;
 }
  
 __block RouterParams *openParams = nil;
 [self.routes enumerateKeysAndObjectsUsingBlock:
 ^(NSString *routerUrl, UPRouterOptions *routerOptions, BOOL *stop) {
  
 NSArray *routerParts = [routerUrl pathComponents];
 if ([routerParts count] == [givenParts count]) {
  
 NSDictionary *givenParams = [self paramsForUrlComponents:givenParts routerUrlComponents:routerParts];
 if (givenParams) {
 openParams = [[RouterParams alloc] initWithRouterOptions:routerOptions openParams:givenParams extraParams: extraParams];
 *stop = YES;
 }
 }
 }];
  
 if (!openParams) {
 if (_ignoresExceptions) {
 return nil;
 }
 @throw [NSException exceptionWithName:@"RouteNotFoundException"
 reason:[NSString stringWithFormat:ROUTE_NOT_FOUND_FORMAT, url]
 userInfo:nil];
 }
 [self.cachedRoutes setObject:openParams forKey:url];
 return openParams;
}

- (NSDictionary *)paramsForUrlComponents:(NSArray *)givenUrlComponents routerUrlComponents:(NSArray *)routerUrlComponents {
  
 __block NSMutableDictionary *params = [NSMutableDictionary dictionary];
 [routerUrlComponents enumerateObjectsUsingBlock:
 ^(NSString *routerComponent, NSUInteger idx, BOOL *stop) {
  
 NSString *givenComponent = givenUrlComponents[idx];
 if ([routerComponent hasPrefix:@":"]) {
 NSString *key = [routerComponent substringFromIndex:1];
 [params setObject:givenComponent forKey:key];
 }
 else if (![routerComponent isEqualToString:givenComponent]) {
 params = nil;
 *stop = YES;
 }
 }];
 return params;
}

NSDictionary *givenParams = [self paramsForUrlComponents:givenParts routerUrlComponents:routerParts];
if (givenParams) {
 openParams = [[RouterParams alloc] initWithRouterOptions:routerOptions openParams:givenParams extraParams: extraParams];
 *stop = YES;
}

[self.cachedRoutes setObject:openParams forKey:url];

- (UIViewController *)controllerForRouterParams:(RouterParams *)params {
 SEL CONTROLLER_CLASS_SELECTOR = sel_registerName("allocWithRouterParams:");
 SEL CONTROLLER_SELECTOR = sel_registerName("initWithRouterParams:");
 UIViewController *controller = nil;
 Class controllerClass = params.routerOptions.openClass;
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
 if ([controllerClass respondsToSelector:CONTROLLER_CLASS_SELECTOR]) {
 controller = [controllerClass performSelector:CONTROLLER_CLASS_SELECTOR withObject:[params controllerParams]];
 }
 else if ([params.routerOptions.openClass instancesRespondToSelector:CONTROLLER_SELECTOR]) {
 controller = [[params.routerOptions.openClass alloc] performSelector:CONTROLLER_SELECTOR withObject:[params controllerParams]];
 }
#pragma clang diagnostic pop
 if (!controller) {
 if (_ignoresExceptions) {
 return controller;
 }
 @throw [NSException exceptionWithName:@"RoutableInitializerNotFound"
 reason:[NSString stringWithFormat:INVALID_CONTROLLER_FORMAT, NSStringFromClass(controllerClass), NSStringFromSelector(CONTROLLER_CLASS_SELECTOR),  NSStringFromSelector(CONTROLLER_SELECTOR)]
 userInfo:nil];
 }
  
 controller.modalTransitionStyle = params.routerOptions.transitionStyle;
 controller.modalPresentationStyle = params.routerOptions.presentationStyle;
 return controller;
}

- (void)map:(NSString *)route toControllerClass:(Class)controllerClass;
- (UIViewController *)matchController:(NSString *)route;

- (void)map:(NSString *)route toBlock:(HHRouterBlock)block;
- (HHRouterBlock)matchBlock:(NSString *)route;
- (id)callBlock:(NSString *)route;

- (HHRouteType)canRoute:(NSString *)route;

typedef NS_ENUM (NSInteger, HHRouteType) {
 HHRouteTypeNone = 0,
 HHRouteTypeViewController = 1,
 HHRouteTypeBlock = 2
};

@interface HHRouter ()
@property (strong, nonatomic) NSMutableDictionary *routes;
@end

- (void)map:(NSString *)route toBlock:(HHRouterBlock)block
{
 NSMutableDictionary *subRoutes = [self subRoutesToRoute:route];
 subRoutes[@"_"] = [block copy];
}
- (void)map:(NSString *)route toControllerClass:(Class)controllerClass
{
 NSMutableDictionary *subRoutes = [self subRoutesToRoute:route];
 subRoutes[@"_"] = controllerClass;
}

- (NSMutableDictionary *)subRoutesToRoute:(NSString *)route
{
 NSArray *pathComponents = [self pathComponentsFromRoute:route];
 NSInteger index = 0;
 NSMutableDictionary *subRoutes = self.routes;
 while (index < pathComponents.count) {
 NSString *pathComponent = pathComponents[index];
 if (![subRoutes objectForKey:pathComponent]) {
 subRoutes[pathComponent] = [[NSMutableDictionary alloc] init];
 }
 subRoutes = subRoutes[pathComponent];
 index++;
 }
  
 return subRoutes;
}

[[HHRouter shared] map:@"/user/:userId/"
 toControllerClass:[UserViewController class]];
[[HHRouter shared] map:@"/story/:storyId/"
 toControllerClass:[StoryViewController class]];
[[HHRouter shared] map:@"/user/:userId/story/?a=0"
 toControllerClass:[StoryListViewController class]];

{
 story =     {
 ":storyId" =         {
 "_" = StoryViewController;
 };
 };
 user =     {
 ":userId" =         {
 "_" = UserViewController;
 story =             {
 "_" = StoryListViewController;
 };
 };
 };
}

[[[HHRouter shared] matchController:@"hhrouter20://user/1/"] class],

{
 "controller_class" = UserViewController;
 route = "/user/1/";
 userId = 1;
}

- (NSDictionary *)paramsInRoute:(NSString *)route

"controller_class" = 
route =

[[HHRouter shared] matchController:@"/user/1/?a=b&c=d"]

{
 a = b;
 c = d;
 "controller_class" = UserViewController;
 route = "/user/1/?a=b&c=d";
 userId = 1;
}

[[HHRouter shared] map:@"/user/add/"
 toBlock:^id(NSDictionary* params) {
 }];

{
 story =     {
 ":storyId" =         {
 "_" = StoryViewController;
 };
 };
 user =     {
 ":userId" =         {
 "_" = UserViewController;
 story =             {
 "_" = StoryListViewController;
 };
 };
 add =         {
 "_" = "<__NSMallocBlock__: 0x600000240480>";
 };
 };
}

// 1.第一种方式匹配到对应的block之后，还需要手动调用一次闭包。
 HHRouterBlock block = [[HHRouter shared] matchBlock:@"/user/add/?a=1&b=2"];
 block(nil);
// 2.第二种方式匹配block之后自动会调用改闭包。
 [[HHRouter shared] callBlock:@"/user/add/?a=1&b=2"];

{
 a = 1;
 b = 2;
 block = "<__NSMallocBlock__: 0x600000056b90>";
 route = "/user/add/?a=1&b=2";
}

block = 
route =

- (void)setParams:(NSDictionary *)paramsDictionary
{
 objc_setAssociatedObject(self, &kAssociatedParamsObjectKey, paramsDictionary, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (NSDictionary *)params
{
 return objc_getAssociatedObject(self, &kAssociatedParamsObjectKey);
}

- (UIViewController *)matchController:(NSString *)route
{
 NSDictionary *params = [self paramsInRoute:route];
 Class controllerClass = params[@"controller_class"];
 UIViewController *viewController = [[controllerClass alloc] init];
 if ([viewController respondsToSelector:@selector(setParams:)]) {
 [viewController performSelector:@selector(setParams:)
 withObject:[params copy]];
 }
 return viewController;
}

@interface MGJRouter ()
@property (nonatomic) NSMutableDictionary *routes;
@end

[MGJRouter openURL:@"mgj://category/travel" withUserInfo:@{@"user_id": @1900} completion:nil];

if (parameters) {
 MGJRouterHandler handler = parameters[@"block"];
 if (completion) {
 parameters[MGJRouterParameterCompletion] = completion;
 }
 if (userInfo) {
 parameters[MGJRouterParameterUserInfo] = userInfo;
 }
 if (handler) {
 [parameters removeObjectForKey:@"block"];
 handler(parameters);
 }
 }

[parameters enumerateKeysAndObjectsUsingBlock:^(id key, NSString *obj, BOOL *stop) {
 if ([obj isKindOfClass:[NSString class]]) {
 parameters[key] = [obj stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
 }
 }];

if (parameters) {
 MGJRouterHandler handler = parameters[@"block"];
 if (handler) {
 [parameters removeObjectForKey:@"block"];
 handler(parameters);
 }
 }

NSString *const MGJRouterParameterURL = @"MGJRouterParameterURL";
NSString *const MGJRouterParameterCompletion = @"MGJRouterParameterCompletion";
NSString *const MGJRouterParameterUserInfo = @"MGJRouterParameterUserInfo";

[MGJRouter registerURLPattern:@"ele://name/:name" toHandler:^(NSDictionary *routerParameters) {
 void (^completion)(NSString *) = routerParameters[MGJRouterParameterCompletion];
 if (completion) {
 completion(@"完成了");
 }
 }];
  
 [MGJRouter openURL:@"ele://name/halfrost/?age=20" withUserInfo:@{@"user_id": @1900} completion:^(id result) {
 NSLog(@"result = %@",result);
 }];

{
 MGJRouterParameterCompletion = "<__NSGlobalBlock__: 0x107ffe680>";
 MGJRouterParameterURL = "ele://name/halfrost/?age=20";
 MGJRouterParameterUserInfo =     {
 "user_id" = 1900;
 };
 age = 20;
 block = "<__NSMallocBlock__: 0x608000252120>";
 name = halfrost;
}

#define TEMPLATE_URL @"qq://name/:name"
[MGJRouter registerURLPattern:TEMPLATE_URL  toHandler:^(NSDictionary *routerParameters) {
 NSLog(@"routerParameters[name]:%@", routerParameters[@"name"]); // halfrost
}];
[MGJRouter openURL:[MGJRouter generateURLWithPattern:TEMPLATE_URL parameters:@[@"halfrost"]]];
}

@interface ModuleProtocolManager : NSObject
+ (void)registServiceProvide:(id)provide forProtocol:(Protocol*)protocol;
+ (id)serviceProvideForProtocol:(Protocol *)protocol;
@end

@interface ModuleProtocolManager ()
@property (nonatomic, strong) NSMutableDictionary *serviceProvideSource;
@end
@implementation ModuleProtocolManager
+ (ModuleProtocolManager *)sharedInstance
{
 static ModuleProtocolManager * instance;
 static dispatch_once_t onceToken;
 dispatch_once(&onceToken, ^{
 instance = [[self alloc] init];
 });
 return instance;
}
- (instancetype)init
{
 self = [super init];
 if (self) {
 _serviceProvideSource = [[NSMutableDictionary alloc] init];
 }
 return self;
}
+ (void)registServiceProvide:(id)provide forProtocol:(Protocol*)protocol
{
 if (provide == nil || protocol == nil)
 return;
 [[self sharedInstance].serviceProvideSource setObject:provide forKey:NSStringFromProtocol(protocol)];
}
+ (id)serviceProvideForProtocol:(Protocol *)protocol
{
 return [[self sharedInstance].serviceProvideSource objectForKey:NSStringFromProtocol(protocol)];
}

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
@protocol DetailModuleEntryProtocol <NSObject>
@required;
- (UIViewController *)detailViewControllerWithId:(NSString*)Id Name:(NSString *)name;
@end

#import <Foundation/Foundation.h>
@interface DetailModuleEntry : NSObject
@end

#import "DetailModuleEntry.h"
#import <DetailModuleEntryProtocol/DetailModuleEntryProtocol.h>
#import <ModuleProtocolManager/ModuleProtocolManager.h>
#import "DetailViewController.h"
@interface DetailModuleEntry()<DetailModuleEntryProtocol>
@end
@implementation DetailModuleEntry
+ (void)load
{
 [ModuleProtocolManager registServiceProvide:[[self alloc] init] forProtocol:@protocol(DetailModuleEntryProtocol)];
}
- (UIViewController *)detailViewControllerWithId:(NSString*)Id Name:(NSString *)name
{
 DetailViewController *detailVC = [[DetailViewController alloc] initWithId:id Name:name];
 return detailVC;
}
@end

- (void)didClickDetailButton:(UIButton *)button
{
 id< DetailModuleEntryProtocol > DetailModuleEntry = [ModuleProtocolManager serviceProvideForProtocol:@protocol(DetailModuleEntryProtocol)];
 UIViewController *detailVC = [DetailModuleEntry detailViewControllerWithId:@“详情界面” Name:@“我的购物车”];
 [self.navigationController pushViewController:detailVC animated:YES];
  
}

- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget
{
  
 NSString *targetClassString = [NSString stringWithFormat:@"Target_%@", targetName];
 NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
 Class targetClass;
  
 NSObject *target = self.cachedTarget[targetClassString];
 if (target == nil) {
 targetClass = NSClassFromString(targetClassString);
 target = [[targetClass alloc] init];
 }
  
 SEL action = NSSelectorFromString(actionString);
  
 if (target == nil) {
 // 这里是处理无响应请求的地方之一，这个demo做得比较简单，如果没有可以响应的target，就直接return了。实际开发过程中是可以事先给一个固定的target专门用于在这个时候顶上，然后处理这种请求的
 return nil;
 }
  
 if (shouldCacheTarget) {
 self.cachedTarget[targetClassString] = target;
 }
 if ([target respondsToSelector:action]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
 return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
 } else {
 // 有可能target是Swift对象
 actionString = [NSString stringWithFormat:@"Action_%@WithParams:", actionName];
 action = NSSelectorFromString(actionString);
 if ([target respondsToSelector:action]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
 return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
 } else {
 // 这里是处理无响应请求的地方，如果无响应，则尝试调用对应target的notFound方法统一处理
 SEL action = NSSelectorFromString(@"notFound:");
 if ([target respondsToSelector:action]) {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
 return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
 } else {
 // 这里也是处理无响应请求的地方，在notFound都没有的时候，这个demo是直接return了。实际开发过程中，可以用前面提到的固定的target顶上的。
 [self.cachedTarget removeObjectForKey:targetClassString];
 return nil;
 }
 }
 }
}

 - (UIViewController *)CTMediator_viewControllerForDetail
{
 UIViewController *viewController = [self performTarget:kCTMediatorTargetA
 action:kCTMediatorActionNativFetchDetailViewController
 params:@{@"key":@"value"}
 shouldCacheTarget:NO
 ];
 if ([viewController isKindOfClass:[UIViewController class]]) {
 // view controller 交付出去之后，可以由外界选择是push还是present
 return viewController;
 } else {
 // 这里处理异常场景，具体如何处理取决于产品
 return [[UIViewController alloc] init];
 }
}
- (void)CTMediator_presentImage:(UIImage *)image
{
 if (image) {
 [self performTarget:kCTMediatorTargetA
 action:kCTMediatorActionNativePresentImage
 params:@{@"image":image}
 shouldCacheTarget:NO];
 } else {
 // 这里处理image为nil的场景，如何处理取决于产品
 [self performTarget:kCTMediatorTargetA
 action:kCTMediatorActionNativeNoImage
 params:@{@"image":[UIImage imageNamed:@"noImage"]}
 shouldCacheTarget:NO];
 }
}