iOS路由组件使用说明
该路由基于第三方框架JLRoutes,其中运行机制为:保存一个全局的map,key是url,value是对应存放的block数组,url和block都会常驻在内存中,当打开一个URL时,JLRoutes就可以遍历 , 这个全局的map,通过url来执行对应的block。
原理理解:
- routeControllersMap 是全局的单例字典,可以想象成一个大的盒子。
- 这个盒子里装了很多的字典,而字典的key值对应 一个标识,源码中称之为scheme,为了不混淆,咱们就叫其为JLRoutes对象标识。这个标识对应的value值为JLRoutes类的对象。
- JLRoutes对象有很多属性,常用的有两个,一个是 scheme 也就是是上述所说的JLRoutes对象标识,也就是说,此value值记录了自己的key值。另外一个属性为routes数组,此数组中存放了JLRRouteDefinition 对象。
- JLRRouteDefinition对象为最终的具体模型 , 也就是说,我们注册的跳转逻辑的所有信息,都存在于这个模型中,包括要实施操作的block代码块,JLRoutes对象标识,取url内容值的标识。
类名 | 作用 |
---|---|
JLRoutes | 作为 JLRoutes 框架的入口,负责注册 URL,管理路由以及分配路由。 |
JLRRouteDefinition | 用来封装注册 URL 的路由信息,包括 URL scheme, route pattern, and priority,并且可以根据 request 提供相应的 response。可以通过继承该类来实现自定义的匹配方式。 |
JLRRouteRequest | 用来封装一个 URL 的路由请求信息,包括 URL、解析后的 path components 和 query parameters。 |
JLRRouteResponse | 根据 URL 匹配路由信息时的 response,包含 isMatch、parameters 等信息。如果 JLRRouteDefinition 匹配 URL 成功时,就会设置属性 isMatch 为 YES,同时将解析 URL 后的参数和 默认参数、附加参数组合返回。 |
JLRParsingUtilities | 解析 URL 参数的工具类。 |
JLRRouteHandler | 自定义路由 handler,也就是将回调参数处理的逻辑交给自定义类去处理。 |
注册路由相关类关系图如下:
流程图如下:
查找路由的过程:
首先根据外部传进来的URL初始化一个JLRRouteRequest,然后用这个JLRRouteRequest在当前的路由数组里面依次request,每个规则都会生成一个response,但是只有符合条件的response才会match,最后取出匹配的JLRRouteResponse拿出其字典parameters里面对应的参数就可以了。
使用步骤
-
首先,配置info.plist —>添加URL types字段,这是一个数组 –>然后咱们在item0 处在加一个URL Schemes,又是一个数组。这里说明了一个问题,一个app可以对应多个scheme —>配置scheme,URL identifier 最好设置复杂些,保证其唯一性,如图
- 在didFinishLaunchingWithOptions方法中注册跳转路由
//OCFTRescueRouteID=/router/:type/:controller
+ (void)registRouterWithScheme:(NSString *)scheme
{
[[OCFTRouter routesForScheme:scheme] addRoute:OCFTRescueRouteID handler:^BOOL(NSDictionary<NSString *,id> * _Nonnull parameters) {
if ([parameters objectForKey:@"controller"] && [parameters objectForKey:@"type"]) {
Class class = NSClassFromString(parameters[@"controller"]);
NSString *type = parameters[@"type"];
UIViewController *nextVC = [[class alloc] init];
[self paramToVc:nextVC param:parameters];
UIViewController *currentVc = [self currentViewController];
if ([type isEqualToString:@"push"]) {
[currentVc.navigationController pushViewController:nextVC animated:YES];
} else {
[currentVc presentViewController:nextVC animated:YES completion:nil];
}
return YES;
}
return NO;
}];
}
[OCFTRouterAction registRouterWithScheme:OCFTRescueFromHome3ToTestScheme];
- 在页面跳转的地方调用开始跳转方法
跳转url的格式如下:
"[scheme]://router/[跳转方式(push|present)]/[控制器名称]?参数1key=参数1value&参数2key=参数2value"
/**
* 开始跳转(默认scheme)
*
* @param controller 将要跳转到的控制器名称
* @param parameters 参数字典(key/value均为字符串)
* @param isJson 是否传递json字符串
* @param type 页面跳转方式
*/
+ (void)startOpenUrlWithScheme:(NSString *)scheme controller:(NSString *)controller andParameters:(NSDictionary<NSString*,NSString*> *)parameters isJson:(BOOL)isJson routerType:(OCFTRouterType)type
{
NSString *cstring = controller;
NSString *urlstring;
NSString *routerType = @"";
if (type == OCFTRouterTypePush) {
routerType = @"push";
} else {
routerType = @"present";
}
if (isJson) {
NSString *parameterString = [OCFTJSON stringFromObject:parameters];
urlstring = [NSString stringWithFormat:@"%@://rescue/%@/%@?json=%@",scheme,routerType,cstring,parameterString];
} else {
NSString *parameterString = [OCFTNetworkUtils sortDic:parameters];
urlstring = [NSString stringWithFormat:@"%@://rescue/%@/%@?%@",scheme,routerType,cstring,parameterString];
}
NSURL *url = [NSURL URLWithQueryAllowedString:urlstring];
[[UIApplication sharedApplication] openURL:url];
}
- (void)didClickToSkip:(UIButton *)button
{
NSDictionary *dict = @{
@"titleText":@"fromHome",
@"name":@"中国"
};
[OCFTRouterAction startOpenUrlWithScheme:OCFTRescueFromHome3ToTestScheme controller:@"OCFTTestViewController" andParameters:dict isJson:NO routerType:OCFTRouterTypePush];
}
- (void)didClickToSkip:(UIButton *)button
{
[OCFTRouterAction startOpenUrlWithScheme:OCFTRescueFromHome3ToTestScheme controller:@"OCFTTestViewController1" andParameters:@{@"abc":@"123"} isJson:YES routerType:OCFTRouterTypePush];
}
- (void)didClickToSkip:(UIButton *)button
{
[OCFTRouterAction startOpenUrlWithController:@"OCFTTestViewController2" andParameters:@{} isJson:NO routerType:OCFTRouterTypeModal];
}
- 在AppDelegate中截取系统跳转回调并判断是否允许跳转
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
return [OCFTRouterAction shouldOpenUrl:url];
}
//是否跳转页面
+ (BOOL)shouldOpenUrl:(NSURL *)url
{
NSString *str = url.absoluteString;
NSArray *arr = [str componentsSeparatedByString:@"://"];
NSString *classStr = @"";
if (arr.firstObject && arr.firstObject != NULL) {
classStr = [NSString stringWithFormat:@"%@",arr.firstObject];
}
if ([classStr.lowercaseString isEqualToString:OCFTRescueFromHome3ToTestScheme.lowercaseString]) {
return [[OCFTRouter routesForScheme:OCFTRescueFromHome3ToTestScheme] routeURL:url];
} else if ([classStr.lowercaseString isEqualToString:OCFTRescueFromTestToTest1Scheme.lowercaseString]) {
return [[OCFTRouter routesForScheme:OCFTRescueFromTestToTest1Scheme] routeURL:url];
}
NSLog(@"跳转链接错误");
return NO;
}
- 参数正向传递的方案(基于运行时)
+ (void)paramToVc:(UIViewController *)v param:(NSDictionary<NSString *,NSString *> *)parameters
{
unsigned int outCount = 0;
objc_property_t * properties = class_copyPropertyList(v.class , &outCount);
for (int i = 0; i < outCount; i++) {
objc_property_t property = properties[i];
NSString *key = [NSString stringWithUTF8String:property_getName(property)];
id param = parameters[key];
if (param != nil) {
[v setValue:param forKey:key];
}
}
outCount = 0;
if ([v.superclass isEqual:[OCFTBaseViewController class]]) {
objc_property_t * properties = class_copyPropertyList(v.superclass , &outCount);
for (int i = 0; i < outCount; i++) {
objc_property_t property = properties[i];
NSString *key = [NSString stringWithUTF8String:property_getName(property)];
id param = parameters[key];
if (param != nil) {
[v setValue:param forKey:key];
}
}
}
}
- 参数反向传递解决方案
在基类控制器中写一个block
//退出VC的block 专门用来传返回值的block
@property(nonatomic,copy)void(^backBlock)(id obj);
A控制器 ---> B控制器
利用UINAVigationController的ViewController 获取B控制器的前一个控制器
BaseViewController *backVC = (BaseViewController*)[[self.navigationController viewControllers] objectAtIndex:[self.navigationController viewControllers].count - 2];
这样在B里面就可以获取A控制器了,那么就可以利用A.backBlock()回传值。