iOS VIPER架构实践(三)：面向接口的路由设计

Router的作用

路由缺失时的情况

[sourceViewController.navigationController pushViewController:destinationViewController animated:YES];

[sourceViewController presentViewController:destinationViewController animated:YES completion:nil];

寻找模块

声明依赖和接口

@protocol ZIKLoginServiceInput <NSObject>
- (void)loginWithAccount:(NSString *)account
password:(NSString *)password
success:(void(^_Nullable)(void))successHandler
error:(void(^_Nullable)(void))errorHandler;
@end

@interface ZIKNoteListViewController ()
//笔记界面需要登录后才能查看，因此在头文件中声明，让外部在使用的时候设置此属性
@property (nonatomic, strong) id<ZIKLoginServiceInput> loginService;
@end

Builder和依赖注入

现有的Router

URL Router

//注册某个URL，和路由处理进行匹配保存
[URLRouter registerURL:@"settings" handler:^(NSDictionary *userInfo) {
UIViewController *sourceViewController = userInfo[@"sourceViewController"];
//获取其他参数
id param = userInfo[@"param"];
//获取需要的界面
UIViewController *settingViewController = [[SettingViewController alloc] init];
[sourceViewController.navigationController pushViewController: settingViewController animated:YES];
}];

//调用路由
[URLRouter openURL:@"myapp://noteList/settings?debug=true" userInfo:params completion:^(NSDictionary *info) {

}];

优点

缺点

Protocol Router

id<ZIKLoginServiceInput> loginService = [[BeeHive shareInstance] createService:@protocol(ZIKLoginServiceInput)];

优点

@property (nonatomic, string) id<ZIKLoginServiceInput> *loginService;

@interface ModuleA ()
- (instancetype)initWithLoginService:(id<ZIKLoginServiceInput>)loginService;
@end

缺点

Protocol是否会导致耦合？

Target-Action

[URLRouter openURL:@"login" userInfo:@{@"message":@"请登录查看笔记详情"}];

@protocol LoginViewInput <NSObject>
@property (nonatomic, copy) NSString *message;
@end

//获取登录界面进行设置
UIViewController<LoginViewInput> *loginViewController = [ProtocolRouter destinationForProtocol:@protocol(LoginViewInput)];
loginViewController.message = @"请登录查看笔记详情";

@"message"

LoginViewInput

NSString *message

NSString
*notifyString

@"notifyString"

notifyString

Required
Interface

Provided Interface

Required Interface

Provided
Interface

Required Interface

Provided
Interface

Required Interface

Provided
Interface

Required
Interface

Provided Interface

Required Interface

Provided
Interface

Required
Interface

Required Interface

Provided
Interface

@protocol ModuleARequiredLoginViewInput <NSObject>
@property (nonatomic, copy) NSString *message;
@end

//Module A中的调用代码
UIViewController<ModuleARequiredLoginViewInput> *loginViewController = [ZIKViewRouterToView(LoginViewInput) makeDestination];
loginViewController.message = @"请登录查看笔记详情";

//Login Module Provided Interface
@protocol ProvidedLoginViewInput <NSObject>
@property (nonatomic, copy) NSString *notifyString;
@end

//App Context 中的 Adapter，用Objective-C的category或者Swift的extension进行接口适配
@interface LoginViewController (ModuleAAdapte) <ModuleARequiredLoginViewInput>
@property (nonatomic, copy) NSString *message;
@end
@implementation LoginViewController (ModuleAAdapte)
- (void)setMessage:(NSString *)message {
self.notifyString = message;
}
- (NSString *)message {
return self.notifyString;
}
@end

App Context

LoginViewController

message

Required Interface

Provided
Interface

Target-Action

@implementation CTMediator (CTMediatorModuleAActions)
- (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];
}
}
@end

-performTarget:action:params:shouldCacheTarget:

NSClassFromString

@implementation CTMediator
- (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]) {
return [self safePerformAction:action target:target params:params];
} else {
// 有可能target是Swift对象
actionString = [NSString stringWithFormat:@"Action_%@WithParams:", actionName];
action = NSSelectorFromString(actionString);
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里是处理无响应请求的地方，如果无响应，则尝试调用对应target的notFound方法统一处理
SEL action = NSSelectorFromString(@"notFound:");
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里也是处理无响应请求的地方，在notFound都没有的时候，这个demo是直接return了。实际开发过程中，可以用前面提到的固定的target顶上的。
[self.cachedTarget removeObjectForKey:targetClassString];
return nil;
}
}
}
}
@end

优点

缺点

Required Interface

Provided
Interface

UIStoryboardSegue

@implementation SourceViewController

- (void)showLoginViewController {
//调用在storyboard中定义好的segue identifier
[self performSegueWithIdentifier:@"presentLoginViewController" sender:nil];
}

//perform segue时的回调
- (BOOL)shouldPerformSegueWithIdentifier:(NSString *)identifier sender:(nullable id)sender {
return YES;
}

//配置目的界面
- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender {
//用[segue destinationViewController]获取目的界面，再对目的界面进行传参
}
@end

-prepareForSegue:sender:

总结

ZIKRouter的特性

离散式管理

@interface ZIKLoginViewRouter : ZIKViewRouter
@end

@implementation ZIKLoginViewRouter
//app启动时，注册对应的模块和Router
//不使用+load和+initialize方法，因为在Swift中已经不适用
+ (void)registerRoutableDestination {
[self registerView:[ZIKLoginViewController class]];
[self registerViewProtocol:ZIKRoutableProtocol(ZIKLoginViewProtocol)];
}
//执行路由时，返回对应的viewController或者UIView
- (id)destinationWithConfiguration:(ZIKViewRouteConfiguration *)configuration {
UIStoryboard *sb = [UIStoryboard storyboardWithName:@"Main" bundle:nil];
ZIKLoginViewController *destination = [sb instantiateViewControllerWithIdentifier:@"ZIKLoginViewController"];
return destination;
}
//检查来自storyboard的界面是否需要让外界进行
+ (BOOL)destinationPrepared:(UIViewController<ZIKLoginViewProtocol> *)destination {
if (destination.loginService != nil) {
return YES;
}
return NO;
}
//初始化工作
- (void)prepareDestination:(UIViewController<ZIKLoginViewProtocol> *)destination configuration:(__kindof ZIKViewRouteConfiguration *)configuration {
if (destination.loginService == nil) {
//ZIKLoginService也可以用ZIKServiceRouter动态获取
destination.loginService = [ZIKLoginService new];
}
}
//路由时的AOP回调
+ (void)router:(nullable ZIKViewRouter *)router willPerformRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router didPerformRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router willRemoveRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router didRemoveRouteOnDestination:(id)destination fromSource:(id)source {
}
@end

自由定义路由参数

//跳转到Login界面
[ZIKLoginViewRouter
performFromSource:self //界面跳转时的源界面
configuring:^(ZIKViewRouteConfiguration *config) {
//跳转类型，支持push、presentModally、presentAsPopover、performSegue、show、showDetail、addChild、addSubview、custom、getDestination
config.routeType = ZIKViewRouteTypePush;
config.animated = NO;
config.prepareDestination = ^(id<ZIKLoginViewProtocol> destination) {
//跳转前配置界面
};
config.routeCompletion = ^(id<NoteEditorProtocol> destination) {
//跳转成功并结束处理
};
config.performerErrorHandler = ^(ZIKRouteAction routeAction, NSError * error) {
//跳转失败处理，有失败的详细信息
};
}];

[ZIKLoginViewRouter performFromSource:self routeType:ZIKViewRouteTypePush];

移除已执行的路由

//初始化router
self.loginRouter = [[ZIKLoginViewRouter alloc] initWithConfiguring:^(ZIKViewRouteConfiguration * _Nonnull config) {
config.source = self;
config.routeType = ZIKViewRouteTypePush;
}];

//执行路由
if ([self.loginRouter canPerform] == NO) {
NSLog(@"此时无法执行路由:%@",self.loginRouter);
return;
}
[self.loginRouter performRouteWithSuccessHandler:^{
NSLog(@"performer: push success");
} performerErrorHandler:^(ZIKRouteAction routeAction, NSError * _Nonnull error) {
NSLog(@"performer: push failed: %@",error);
}];

if ([self.loginRouter canRemove] == NO) {
NSLog(@"此时无法移除路由:%@", self.loginRouter);
return;
}
[self.loginRouter removeRouteWithSuccessHandler:^{
NSLog(@"performer: pop success");
} performerErrorHandler:^(ZIKRouteAction routeAction, NSError * _Nonnull error) {
NSLog(@"performer: pop failed,error:%@",error);
}];

通过protocol获取对应模块

Protocol作为匹配标识

ZIKLoginViewRouter

ZIKLoginViewProtocol

ZIKLoginViewProtocol

ZIKViewRouter

ZIKViewRouterToView

ZIKLoginViewProtocol

[ZIKViewRouterToView(ZIKLoginViewProtocol)
performFromSource:self
configuring:^(ZIKViewRouteConfiguration *config) {
config.routeType = ZIKViewRouteTypePush;
config.prepareDestination = ^(id<ZIKLoginViewProtocol> destination) {
//跳转前配置界面
};
config.routeCompletion = ^(id<ZIKLoginViewProtocol> destination) {
//跳转成功并结束处理
};
}];

ZIKLoginViewProtocol

requiredProtocol

providedProtocol

多对一匹配

[ZIKViewRouterToModule(ZIKCompatibleAlertConfigProtocol)
performFromSource:self
configuring:^(ZIKViewRouteConfiguration<ZIKCompatibleAlertConfigProtocol> * _Nonnull config) {
config.routeType = ZIKViewRouteTypeCustom;
config.title = @"Compatible Alert";
config.message = @"Test custom route for alert with UIAlertView and UIAlertController";
[config addCancelButtonTitle:@"Cancel" handler:^{
NSLog(@"Tap cancel alert");
}];
[config addOtherButtonTitle:@"Hello" handler:^{
NSLog(@"Tap hello button");
}];
config.routeCompletion = ^(id _Nonnull destination) {
NSLog(@"show custom alert complete");
};
}];

依赖注入和依赖声明

固定依赖和运行时依赖

-prepareDestination:configuration:

-prepareDestination:configuration:

ZIKLoginViewProtocol

prepareDestination

直接在头文件中声明

ZIKViewConfigRoutable

ZIKViewRoutable

使用泛型指明特定router

ZIKViewRouterToModule

ZIKViewRouterToView

//注意这个示例代码只是用于演示泛型的意思，实际运行时必须要用一个ZIKViewRouter子类才可以
[ZIKViewRouter<UIViewController> *>
performFromSource:self
configuring:^(ZIKViewRouteConfiguration<ZIKLoginConfigProtocol> *config) {
config.routeType = ZIKViewRouteTypePerformSegue;
config.configureSegue(^(ZIKViewRouteSegueConfiguration *segueConfig) {
segueConfig.identifier = @"showLoginViewController";
);
}];

ZIKViewRouter<UIViewController> *>

ZIKViewRouteConfiguration<ZIKLoginConfigProtocol>
*

Class

@property (nonatomic, strong) ZIKViewRouter<UIViewController> *> *loginViewRouter;

//在Builder中注入alertRouter
swiftSampleViewController.alertRouter = Router.to(RoutableViewModule<ZIKCompatibleAlertConfigProtocol>())

class SwiftSampleViewController: UIViewController {
//在Builder里注入alertRouterClass后，就可以直接用这个routerClass执行路由
var alertRouter: ViewRouter<Any, ZIKCompatibleAlertConfigProtocol>!

@IBAction func testInjectedRouter(_ sender: Any) {
self.alertRouter.perform(
from: self,
configuring: { (config, prepareDestination, prepareModule) in
prepareModule({ moduleConfig in
//moduleConfig在类型推断时就是ZIKCompatibleAlertConfigProtocol，无需在判断后再强制转换
moduleConfig.title = "Compatible Alert"
moduleConfig.message = "Test custom route for alert with UIAlertView and UIAlertController"
moduleConfig.addCancelButtonTitle("Cancel", handler: {
print("Tap cancel alert")
})
moduleConfig.addOtherButtonTitle("Hello", handler: {
print("Tap Hello alert")
})
})
}
}
}

ViewRouter<Any,
ZIKCompatibleAlertConfigProtocol>

@interface ZIKCompatibleAlertViewRouter : ZIKViewRouter<UIViewController> *>

@end

class ZIKCompatibleAlertViewRouter: ZIKViewRouter<UIViewController> {

}

调用安全和类型安全

编译检查

ZIKViewRouterToModule

ZIKViewRouterToView

泛型的协变和逆变

let alertRouterClass: ZIKViewRouter<UIViewController>.Type

//编译错误
//ZIKCompatibleAlertViewRouter.Type is ZIKViewRouter<UIViewController>.Type
alertRouterClass = ZIKCompatibleAlertViewRouter.self

ZIKViewRouter<UIViewController>.Type

ZIKViewRouter<UIViewController>.Type

用Adapter兼容接口

requiredProtocol

providedProtocol

requiredProtocol

providedProtocol

为

Provided

模块添加

Required
Interface

requiredProtocol

@protocol ModuleARequiredLoginViewInput <ZIKViewRoutable>
@property (nonatomic, copy) NSString *message;
@end

//Module A中的调用代码
UIViewController<ModuleARequiredLoginViewInput> *loginViewController = [ProtocolRouter destinationForProtocol:@protocol(LoginViewInput)];
loginViewController.message = @"请登录查看笔记详情";

//Login Module Provided Interface
@protocol ProvidedLoginViewInput <NSObject>
@property (nonatomic, copy) NSString *notifyString;
@end

//ZIKEditorAdapter.h，ZIKViewAdapter子类
@interface ZIKEditorAdapter : ZIKViewRouteAdapter
@end

//ZIKEditorAdapter.m
//用Objective-C的category、Swift的extension进行接口适配
@interface LoginViewController (ModuleAAdapte) <ModuleARequiredLoginViewInput>
@property (nonatomic, copy) NSString *message;
@end
@implementation LoginViewController (ModuleAAdapte)
- (void)setMessage:(NSString *)message {
self.notifyString = message;
}
- (NSString *)message {
return self.notifyString;
}
@end

@implementation ZIKEditorAdapter

+ (void)registerRoutableDestination {
//注册NoteListRequiredNoteEditorProtocol和ZIKEditorViewRouter匹配
[ZIKEditorViewRouter registerViewProtocol:ZIKRoutableProtocol(NoteListRequiredNoteEditorProtocol)];
}

@end

用中介者转发接口

@protocol ModuleARequiredLoginViewDelegate <NSObject>
- (void)didFinishLogin;
@end

@protocol ModuleARequiredLoginViewInput <ZIKViewRoutable>
@property (nonatomic, copy) NSString *message;
@property (nonatomic, weak) id<ModuleARequiredLoginViewDelegate> delegate;
@end

@protocol LoginViewDelegate <NSObject>
- (void)didLogin;
@end

@protocol ProvidedLoginViewInput <NSObject>
@property (nonatomic, copy) NSString *notifyString;
@property (nonatomic, weak) id<LoginViewDelegate> delegate;
@end

-setDelegate:

NSProxy

LoginViewDelegate

ModuleARequiredLoginViewDelegate

@implementation ZIKEditorMediatorViewRouter
+ (void)registerRoutableDestination {
//注册NoteListRequiredNoteEditorProtocol，和新的ZIKEditorMediatorViewRouter配对，而不是目的模块中的ZIKEditorViewRouter
//新的ZIKEditorMediatorViewRouter负责调用ZIKEditorViewRouter，插入一个中介者
[self registerView:/* mediator的类*/];
[self registerViewProtocol:ZIKRoutableProtocol(NoteListRequiredNoteEditorProtocol)];
}
- (id)destinationWithConfiguration:(ZIKViewRouteConfiguration *)configuration {
//用ZIKEditorViewRouter获取真正的destination
id<ProvidedLoginViewInput> realDestination = [ZIKEditorViewRouter makeDestination];
//获取一个负责转发ProvidedLoginViewInput和ModuleARequiredLoginViewInput的mediator
id<ModuleARequiredLoginViewInput> mediator = MediatorForDestination(realDestination);
return mediator;
}
@end

requiredProtocol

providedProtocol

封装UIKit跳转和移除方法

封装iOS的路由方法

ZIKViewRouter

-pushViewController:animated:

-presentViewController:animated:completion:

UIPopoverController

-presentPopoverFromRect:inView:permittedArrowDirections:animated:

UIPopoverPresentationController

-performSegueWithIdentifier:sender:

-showViewController:sender:

-showDetailViewController:sender:

-addChildViewController:

-addSubview:

[ZIKViewRouterToView(ZIKLoginViewProtocol)
performFromSource:self routeType::ZIKViewRouteTypePush];

ZIKViewRouteTypePush

ZIKViewRouteTypePresentModally

ZIKViewRouteTypePresentAsPopover

ZIKViewRouteTypePerformSegue

ZIKViewRouteTypeShow

ZIKViewRouteTypeShowDetail

ZIKViewRouteTypeAddAsChildViewController

ZIKViewRouteTypeAddAsSubview

ZIKViewRouteTypeCustom

ZIKViewRouteTypeGetDestination

-popViewControllerAnimated:

-dismissViewControllerAnimated:completion:

-dismissPopoverAnimated:

-removeFromParentViewController

-removeFromSuperview

ZIKViewRouter

识别

adaptative

类型的路由

-performSegueWithIdentifier:sender:

-showViewController:sender:

-showDetailViewController:sender:

adaptative

UINavigationController

UISplitViewController

push

present

ZIKViewRouter

支持自定义路由

ZIKViewRouter

关于extension里的跳转方法

Watch

WKInterfaceController

-pushControllerWithName:context:

-popController

Share

SLComposeServiceViewController

-pushConfigurationViewController:

-popConfigurationViewController

ZIKViewRouteTypeCustom

支持storyboard

ZIKViewRouter

-prepareForSegue:sender:

ZIKRoutableView

-prepareDestinationFromExternal:configuration:

-prepareForSegue:sender:

AOP

ZIKViewRouter

+ (void)router:(nullable ZIKViewRouter *)router willPerformRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router didPerformRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router willRemoveRouteOnDestination:(id)destination fromSource:(id)source {
}
+ (void)router:(nullable ZIKViewRouter *)router didRemoveRouteOnDestination:(id)destination fromSource:(id)source {
}

UIViewController

UIViewController

路由错误检查

ZIKRouter

ZIKViewRouter

unbalanced transition

-viewWillAppear:

-viewDidAppear:

-viewWillDisAppear:

-viewDidDisappear:

支持任意模块

ZIKRouter

ZIKViewRouter

ZIKServiceRouter

ZIKViewRouter

ZIKServiceRouter

ZIKServiceRouter

ZIKServiceRouter

ZIKViewRouter

性能

ZIKViewRouter

ZIKServiceRouter

项目地址和Demo

参考