A iOS router that help app navigate to controllers.
pod 'KLMRouter', '1.0.2.3'
- 支持iOS5及以上。
- 页面路由支持push和present两种常用打开方式。并兼容本路由方式和原生路由方式的相互跳转。
- 支持路由拦截器。
- 支持参数依赖注入。
- 支持路径参数，并支持跳转重复页面，如商品A跳转商品B。
- 实现KLMRouter delegate，让KLMRouter获取UIWindow。
@protocol KLMRouterDelegate <NSObject>
@required
- (UIWindow *)rootWindowFromApp;
@end
//一般在APPDelegate里面实现
- (UIWindow *)rootWindowFromApp {
self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
self.window.backgroundColor = [UIColor whiteColor];
return self.window;
}
- 注册ViewController
[KLMRouterRegister.routerRegister registerWithPath:@"main" toClass:[KLMMainViewController class]];
[KLMRouterRegister.routerRegister registerWithPath:@"detail/:goodsId/" toClass:[KLMDetailViewController class]];
- 路由的ViewController需要实现协议
@protocol KLMProvider <NSObject>
- (id)initWithParameter:(NSDictionary *)parameter callback:(KLMCallbackBlock)callback; //必须实现
@optional
- (void)updateWithParameter:(NSDictionary *)parameter;//可选实现
@end
- 初始路由到rootViewController
KLMRouter.router.delegate = self;
//初始home是TabBarController，里面有两个Controller，“main”和“my”，包了一层UINavigationController。
KLMRouter.router.buildRoot(@"home").withControllersUrls(@[@"main", @"my"]).withNavigation([UINavigationController class]).navigate();
- 路由方式
KLMRouter.router.build(@"detail").withString(@"say", @"hello").withAnimated(YES).navigate();
KLMRouter.router.build([NSString stringWithFormat:@"detail/%ld/", 10000]).withAnimated(YES).backIfExist(NO).navigate();
KLMRouter.router.build(@"login").withAnimated(YES).withCallback(^(id data) {
//callbackblock
}).present(); //present方式
[[KLMRouter router] popTopViewControllerAnimated:YES completion:nil];//把顶部的ViewController 弹走，包括以push和present方式呈现的。
//如果由路由push进去，然后用原生的pop出来的话，pop后需要调用以下方法去除路由记录。
- (void)removeMapControllersWithViewController:(UIViewController *)vc;
- 依赖注入
//需要注意的是：注入的属性名必须和传进的参数的key的名字一致。
- (id)initWithParameter:(NSDictionary *)parameter callback:(KLMCallbackBlock)callback {
if (self = [super initWithParameter:parameter callback:callback]) {
[KLMRouter.router inject:self withParameter:parameter];
}
return self;
}
-
拦截器
拦截器需要实现协议：KLMInterceptor
@interface KLMLoginInterceptor : NSObject<KLMInterceptor> @end @implementation KLMLoginInterceptor - (void)processWithPostcard:(KLMPostcard *)postcard callback:(KLMInterceptorBlock)callback { if ([postcard.url isEqualToString:@"my"]) { KLMRouter.router.build(@"login").withAnimated(YES).withCallback(^(id data) { callback([data boolValue]); }).present(); } else { callback(YES); } } @end注册拦截器
[KLMRouterRegister.routerRegister addInterceptor:[KLMLoginInterceptor new]];
| 方法 | 参数 | 说明 |
|---|---|---|
| build() | NSString | 普通路由方式，但是在之前必须先有buildRoot(),传注册过的path |
| buildRoot() | NSString | 跟build()类似，不同的这是设置rootViewController |
| navigate() | 无 | 以push方式进行路由，如果某页面已存在，则会路由到那个页面，如果那页面实现updateWithParameter: 协议，则调用这个updateWithParameter方法。如果页面不存在，则新建一个页面。 |
| present() | 无 | 以present方式路由，无论页面之前是否存在，都会新建页面 |
| withDictionary() | NSDictionary | 传参，跟withNumber(key,value)等类似 |
| withCallback() | KLMCallbackBlock | 传参（callback），可以把参数callback回来 |
| withNavigation() | Class | 是否需要包UINavigationController(可以是子类) |
| withControllersUrls() | NSArray，数组内是NSString | build(),buildRoot()是UITabBarController才可以 |
| backIfExist() | BOOL | 指定当跳转的path已存在时，是回到之前，还是重新打开并删除之前的。默认是YES（回到之前）。 |