##XFLegoVIPER使用文档

###一、模块入口类XFRouting

Routing<或称为WireFrame>是一个模块开始的入口，也是管理模块与模块之间的跳转（相当于界面之跳转），它初化始当前模块的的所有层级关系链，也保存着上一个和下一个模块的引用关系链，是整个架构的关键层。

####1、初始化一个模块，建立一个XFSearchRouting并继承自XFRouting,在.m文件中（使用Activity而不使用UIViewController是为了和旧项目MVC等架构区别开来）：

@implementation XFSomeRouting

/* 有UINavigationController的情况*/
XF_InjectMoudleWith_Nav([UINavigationController class],
                        [XFSearchActivity class],
                        [XFSearchPresenter class],
                        [XFSearchInteractor class],
                        [XFPictureDataManager class])

/* 无UINavigationController的情况*/
XF_InjectMoudleWith_Act(XF_Class_(XFPictureResultsActivity),
                        XF_Class_(XFPictureResultsPresenter),
                        XF_Class_(XFPictureResultsInteractor),
                        XF_Class_(XFPictureDataManager))

/* xib方式加载*/
XF_InjectMoudleWith_IB(@"x-XFDetailsActivity", [XFDetailsPresenter class], nil, nil)

/* storyboard方式*/
XF_InjectMoudleWith_IB(@"s-XFDetails-XFDetailsID", [XFDetailsPresenter class], nil, nil)

@end

####2、在UIWindow上显示：

XF_ShowRootRouting2Window_(XFSearchRouting, {

    // 配置导航栏
    UINavigationController *navigation = routing.realNavigator;

    navigation.navigationBar.barTintColor = [UIColor colorWithRed:217/255.0 green:108/255.0 blue:0/255.0 alpha:1];

    [navigation.navigationBar setTitleTextAttributes:@{NSForegroundColorAttributeName : [UIColor whiteColor]}];

})

####3、模块之间的跳转,这个方法是XFSearchPresenter发起对XFSearchRouting的请求：

- (void)transitionToShowResultsMoudle {

    XF_PUSH_Routing_(XFPictureResultsRouting, {
        // 自定义切换动画
        CATransition *animation = [CATransition animation];

        animation.duration = 0.5;

        animation.timingFunction = [CAMediaTimingFunction functionWithName:@"easeOut"];

        //animation.type = kCATransitionPush;

        //animation.subtype = kCATransitionFromBottom;

        /*

        animation.type = @"cube";//立方体效果

        animation.type = @"suckEffect";//收缩效果

        animation.type = @"oglFlip";//上下翻转效果

        animation.type = @"rippleEffect";//滴水效果

        animation.type = @"pageCurl";//向上翻一页效果

        animation.type = @"pageUnCurl";//向下翻一页效果

        */

        animation.type = @"rippleEffect";

        [[self.realInterface navigationController].view.layer addAnimation:animation forKey:@"animation"];
    })

}

####4、配置路由管理器(注意：使一个模块自动加入到路由管理时，一定要有事件层Presenter)：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // 允许跟踪打印模块导航信息

    [XFRoutingLinkManager enableLog];

    // 设置通用模块前辍,用于MVx架构里的控制器加载VIPER视图作为子控制器，并能提高模块通信时匹配精准度

    [XFRoutingLinkManager setMoudlePrefix:@"XF"];

}

###二、显示视图层XFActivity

在MVP、MVVM、VIPER架构中UIViewController和UIView一样是View，所以不能再当控制器来使用，而只能做UI的渲染、布局、动画的工作，这也是用Activity来替换ViewController命名的原因之一。

####1、把一个UIViewController转为VIPER里的视图层：

#import <UIKit/UIKit.h>

#import "UIViewController+XFLego.h" // 导入头文件

@interface XFSearchActivity : UIViewController

@end

####2、请求事件处理

上面的操作会自动绑定在XFSearchRouting设置的事件处理者XFSearchPresenter,请求事件处理者可以使用：

// 转换为事件处理实现的接口

id<XFSearchEventHandlerPort> presenter = XFConvertPresenterToType(id<XFSearchEventHandlerPort>);

[presenter loginButtonClickWithName:name pwd:pwd];

如果采用MVVM的双向绑定思想，则可以结合ReactiveCocoa的信号传递：

id<XFSearchEventHandlerPort> presenter = XFConvertPresenterToType(id<XFSearchEventHandlerPort>);

RAC(self,title) = RACObserve(presenter, navigationTitle);

RAC(presenter, mainCategory) = self.mainCategoryTextField.rac_textSignal;

RAC(presenter, secondCategory) = self.secondCategoryTextFiled.rac_textSignal;

// 绑定命令

self.searchButton.rac_command = presenter.executeSearch;

// 其它绑定...

###三、事件处理层XFPresenter

事件处理层负责界面上的按钮点击事件、页面数据推送填充，而不能对View的渲染、布局直接操作，只针对View行为做出响应。Presenter持有对内容提供者Provider转换过来的界面显示数据***ExpressData类的强引用，这个类与模型不同，它拥有界面所需显示的所有对象数据。另外View和Presenter是不能直接引用到模型数据的。

####1、界面显示移除回调方法

/**

* 初始化命令（绑定视图层的事件动作<Action>）

*/

- (void)initCommand;

/**

* 注册MVx架构通知 (不用手动移除通知，内部会进行管理)

*/

- (void)registerMVxNotifactions;

/**

* 初始化渲染视图数据,在viewDidLoad之后，viewWillAppear之前调用

*/

- (void)initRenderView;

// 同步视图生命周期(框架方法，用于子类覆盖，不要直接调用！）

- (void)viewDidLoad;

- (void)viewWillAppear;

- (void)viewDidAppear;

- (void)viewWillDisappear;

- (void)viewDidDisappear;

####2、界面切换回调方法

// 当前界面将获得焦点时

- (void)viewWillBecomeFocusWithIntentData:(id)intentData{}

// 当前界面将失去焦点时

- (void)viewWillResignFocus{}

####3、常用属性与方法

/**

* 视图填充数据

*

*/

@property (nonatomic, strong) id expressData;

/**

* 错误消息

*/

@property (nonatomic, copy) NSString *errorMessage;

/**

* 返回按钮被点击的处理方法（子类可以覆盖这个方法实现自己的逻辑）

*/

- (void)xfLego_onBackItemTouch;

####4、请求业务数据和界面切换

// 按钮响应信号方法

- (RACSignal *)executeSearchSignal {

    // 预加载数据

    return [[[XFConvertInteractorToType(id<XFSearchInteractorPort>) fetchPictureDataWithMainCategory:self.mainCategory secondCategory:self.secondCategory] doNext:^(id x) {

    // 设置意图数据

    self.intentData = x;

    // 请求Routing切换界面

    [XFConvertRoutingToType(id<XFSearchWireFramePort>) transitionToShowResultsMoudle];

    }] doError:^(NSError *error) {

        NSLog(@"error %@",error);

    }];

}

###四、业务层XFInteractor

业务层负责当前模块的核心业务处理与数据转换工作，它完全不关心界面UI与响应事件如果处理，它对原始模型类***Model有强引用，管理最基层的数据交换。

####1、响应事件处理层的业务数据请求

- (RACSignal *)fetchPictureDataWithMainCategory:(NSString *)mainCategory secondCategory:(NSString *)secondCategory

{

    return [XFConvertDataManagerToType(XFPictureDataManager *) grabPictureDataWithMainCategory:mainCategory secondCategory:secondCategory];

}

####2、模型数据与界面显示数据的转换

- (RACSignal *)deconstructPreLoadData:(id)preLoadData {

    self.pictureListModel = preLoadData;

    return [RACSignal createSignal:^RACDisposable *(id<RACSubscriber> subscriber) {

        XFPictureProvider *provider = [XFPictureProvider provider];

        [subscriber sendNext:[provider collectedPictureExpressDataFrom:preLoadData]];

        [subscriber sendCompleted];

        return [RACDisposable disposableWithBlock:^{

        }];

    }];

}

###五、数据层***DataManager和服务层***Service

这两层是VIPER架构的补充，它们分别充当数据搬运管理者和本地/远程数据访问服务，这两层的特殊地方是可以在任意模块中使用，所以是无关于模块的，数据层和服务层也是可以分散使用。数据层会对所需的用服务对象***Service有强引用，它会调用相关服务对象获得所需的数据，服务层负责本地/远程数据获取。

####1、数据层整理返回给业务层数据

- (RACSignal *)grabPictureDataWithMainCategory:(NSString *)mainCategory secondCategory:(NSString *)secondCategory

{

    return [self.pictureService pullPictureDataWithMainCategory:mainCategory secondCategory:secondCategory];

}

####2、服务层获得远程数据

- (RACSignal *)pullPictureDataWithMainCategory:(NSString *)mainCategory secondCategory:(NSString *)secondCategory
{

    // 从服务器获取数据

    return [[XFRACHttpTool getWithURL:@"http://image.baidu.com/search/acjson"
                                params:@{
                                          @"tn": @"resultjson_com",

                                          @"ipn": @"rj",

                                          @"word":mainCategory,

                                          @"step_word":secondCategory,

                                          @"pn": @1, // 第几条开始

                                          @"rn": @5, // 返回多少条

                                          }]
                                map:^id(RACTuple *tuple) {

                                    // 模型转换

                                    return [XFPictureListModel mj_objectWithKeyValues:tuple.first];

                                }];

}

###六、扩展功能

####1、当前模块Activity子View获得Presenter事件层

#import "UIView+XFLego.h" // 导入头文件

@interface SomeView : UIView

@end

@implementation SomeView

- (void)buttonAction:(id)target

{

    // 调用事件处理层

    // 注意：只有在当前视图添加到父视图后才能获取

    [self.eventHandler xfLego_onBackItemTouch];

}

@end

####2、VIPER模块视图层Activity添加子路由视图

@implementation XFPageControlActivity

- (void)initSubView {

    self.pageViewController.dataSource = self;

    self.pageViewController.delegate = self;

    // 添加模块子视图，当前Activity就为父模块视图

    XFActivity *movieActivity = XF_SubUInterface_(@"Movie");

    XFActivity *musicActivity = XF_SubUInterface_(@"Music");

    XFActivity *bookActivity = XF_SubUInterface_(@"Book");

    self.subActivitys = @[movieActivity,musicActivity,bookActivity];

    self.movieActivity = movieActivity;

    self.musicActivity = musicActivity;

    self.bookActivity = bookActivity;

    // 设置每一个显示视图

    [self.pageViewController setViewControllers:@[self.movieActivity] direction:UIPageViewControllerNavigationDirectionForward animated:NO completion:nil];

}

@end

####3、MVx控制器添加VIPER子路由视图作为子控制器

#import "XFInterfaceFactory.h" // 导入头文件

@implementation XFSourceViewController

- (void)initSubView {

    // Idea为模块名（注意：使用XF_SubUInterfaceForMVx_AddChild_Fast前使用[XFRoutingLinkManager setMoudlePrefix:@"XX"]配置路由管理器的通用模块名）

    XFActivity *ideaActivity = XF_SubUInterfaceForMVx_AddChild_Fast(@"Idea");

    [self addChildViewController:ideaActivity];

    [self.view addSubview:ideaActivity.view];

}

@end

####4、不同构架模块间事件通信

本框架实现了不同构架间的模块通信机制：

在VIPER架构中，模块与模块之间事件通信。
从VIPER架构往MVx（MVC、MVP、MVVM）构架发通知。
从MVx构架往VIPER架构发事件。
在VIPER架构中接收MVx里发出的通知。

// 一个模块的Presenter发起事件

@implementation XFPictureResultsPresenter

- (void)viewDidLoad
{

    // 发送单模块消息事件

    XF_SendEventForMoudle_(@"Search", @"loadData", @"SomeData")

    // 发送多模块消息事件

    XF_SendEventForMoudles_(@[@"Search"], @"loadData", @"SomeData")

    // 在MVx架构中使用下面方法对VIPER架构中模块发事件数据（须导入XFRoutingLinkManager.h头文件）

    XF_SendEventFormMVxForVIPERMoudles_(@[@"Search"], @"loadData", @"SomeData");

    // 在VIPER架构中对MVx架构模块发通知

    XF_SendMVxNoti_(@"XFReloadDataNotification", nil);

}

- (void)registerMVxNotifactions
{

    // 模拟在MVx架构里发通知

    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(1 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{

    [[NSNotificationCenter defaultCenter] postNotificationName:@"StartSearchNotification" object:nil userInfo:@{@"key":@"value"}];

    });

    // 在VIPER架构中注册MVx架构里的原生通知并转为本框架支持的事件，使用`-receiveOtherMoudleEventName:intentData:`接收

    XF_RegisterMVxNotis_(@[@"StartSearchNotification"])

}

@end

// 另一个模块的Presenter接收事件

@implementation XFSearchPresenter

- (void)receiveOtherMoudleEventName:(NSString *)eventName intentData:(id)intentData

{

    XF_EventIs_(@"StartSearchNotification", {

        NSLog(@"接收到Mvx架构的通知: %@",eventName);

    })

}

@end

####5、不同架构间的融合

#####5.1、从MVx架构的界面跳转到VIPER架构的界面

#import "XFInterfaceFactory.h" // 导入头文件

@implementation XFUserViewController

- (void)pushToNext

{

    // Notice为模块名（注意：使用XF_UInterfaceForMVx_Show_Fast前使用[XFRoutingLinkManager setMoudlePrefix:@"XX"]配置路由管理器的通用模块名）

    XFActivity *noticeActivity = XF_UInterfaceForMVx_Show_Fast(@"Notice");

    noticeActivity.hidesBottomBarWhenPushed = YES;

    [self.navigationController pushViewController:noticeActivity animated:YES];

}

@end

#####5.2、从VIPER架构的界面跳转到MVx架构的界面

@implementation XFUserRouting

// 使用当前模块的Presenter层调用这个切换界面的方法

- (void)transition2Agreement

{

    XF_PUSH_VCForMVx_(ProvisionViewController,{

        viewController.title = @"用户使用协议";

    })

}

@end

#####5.3、把MVx架构代码转为VIPER架构

@implementation XFIndexRouting

XF_InjectMoudleWith_Act([XFIndexViewController class],[XFIndexPresenter class],nil,nil)

@end

⚠注意事项

在UIViewController/Activity中，任何生命周期方法要先调用父类实现（如：覆盖-viewDidLoad生命周期方法，要先调用[super viewDidLoad]）。
在UIView中，覆盖-didMoveToSuperview生命周期方法，要先调用[super didMoveToSuperview]。
一个模块就是一个路由，模块名由路由业务名决定（如：路由XFIndexRouting的模块名是Index），注意模块名不要重复，否由会影响路由管理器对事件的分发。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README1_5_x.md

README1_5_x.md

⚠注意事项

Files

README1_5_x.md

Latest commit

History

README1_5_x.md

File metadata and controls

⚠注意事项