iOS 解耦、组件化最佳实践

iOS 解藕、组件化最常用的是使用统跳路由的方式，目前比较常用的 iOS 开源路由框架主要是JLRoutes、MGJRouter、HHRouter等，这些路由框架各有优点和缺点，基本可以满足大部分需求。目前最常用来作路由跳转，以实现基本的组件化开发，实现各模块之间的解藕。但是，在实际中开发中会发现，无法彻底使用它们完成所有模块间通信，比如模块间的同步、异步通信等。再比如，我们在配置了相关路由跳转的 URL 后，如何在上线之后动态修改相关跳转逻辑？在模块间通信时，如何在上线后动态修改相关参数？APP 能否实现类似 Web 的302跳转？于是 FFRouter 诞生了！

而 FFRouter 则在参考了其他开源框架后诞生的一个路由框架，FFRouter 不仅支持路由跳转，还支持模块间同步、异步通信。增加了 Rewrite 引擎，可以在 APP 上线后动态修改相应路由逻辑，以及动态修改相应参数，支持使用正则语法创建 Rewrite 规则，更加灵活。

对于 URL Rewrite，天猫就用来在解决 App 中 URL 平台展现一致性的问题，并且在双11期间，在全链路界面降级方案和会场上下线中发挥了重要作用。FFRouter 的 URL Rewrite 也是参考了天猫的方案。

FFRouter 的主要使用方法如下：（来自github:FFRouter）

Github链接：FFRouter

功能

具备基本的 URL 注册、Route、取消注册、打印 Log 等
支持使用通配符(*)注册 URL
支持 URL Rewrite
支持 Rewrite 时获取原 URL 参数或 URLComponents，并可对其进行URL Encode或 Decode
支持通过 URL 获取 Object
支持 Route URL 时通过异步回调的方式获取 Object
支持 Route URL 时传递非常规对象
支持 Route 一个未注册的 URL 时统一回调

安装

CocoaPods

target 'MyApp' do
  pod 'FFRouter'
end

运行 pod install

手动安装

添加其中的 FFRouter 文件夹到自己项目

使用方法

首先

#import "FFRouter.h"

1、基本使用

/**
 注册 url,与 ‘routeURL:’ 和 ‘routeURL: withParameters:’ 配合使用

 @param routeURL 要注册的 URL
 @param handlerBlock URL 被 Route 后的回调
 */
+ (void)registerRouteURL:(NSString *)routeURL handler:(FFRouterHandler)handlerBlock;

/**
 注册 URL,与 'routeObjectURL:' 和 ‘routeObjectURL: withParameters:’ 配合使用,可返回一个 Object

 @param routeURL 要注册的 URL
 @param handlerBlock URL 被 Route 后的回调,可在回调中返回一个 Object
 */
+ (void)registerObjectRouteURL:(NSString *)routeURL handler:(FFObjectRouterHandler)handlerBlock;

/**
 注册 URL,与 ‘routeCallbackURL: targetCallBack:’ 和 ‘routeCallbackURL: withParameters: targetCallBack:’ 配合使用，可异步回调返回一个 Object

 @param routeURL 要注册的 URL
 @param handlerBlock URL 被 Route 后的回调,handlerBlock 中有一个 targetCallBack ,对应 ‘routeCallbackURL: targetCallBack:’ 和 ‘routeCallbackURL: withParameters: targetCallBack:’ 中的 targetCallBack，可用于异步回调返回一个 Object
 */
+ (void)registerCallbackRouteURL:(NSString *)routeURL handler:(FFCallbackRouterHandler)handlerBlock;




/**
 判断 URL 是否可被 Route（是否已经注册）

 @param URL 要判断的 URL
 @return 是否可被 Route
 */
+ (BOOL)canRouteURL:(NSString *)URL;




/**
 Route 一个 URL

 @param URL 要 Route 的 URL
 */
+ (void)routeURL:(NSString *)URL;

/**
 Route 一个 URL，并带上额外参数

 @param URL 要 Route 的 URL
 @param parameters 额外参数
 */
+ (void)routeURL:(NSString *)URL withParameters:(NSDictionary *)parameters;

/**
 Route 一个 URL，可获得返回的 Object

 @param URL 要 Route 的 URL
 @return 返回的 Object
 */
+ (id)routeObjectURL:(NSString *)URL;

/**
 Route 一个 URL，并带上额外参数，可获得返回的 Object

 @param URL 要 Route 的 URL
 @param parameters 额外参数
 @return 返回的 Object
 */
+ (id)routeObjectURL:(NSString *)URL withParameters:(NSDictionary *)parameters;

/**
 Route 一个 URL,targetCallBack 可异步回调以返回一个 Object

 @param URL 要 Route 的 URL
 @param targetCallback 异步回调
 */
+ (void)routeCallbackURL:(NSString *)URL targetCallback:(FFRouterCallback)targetCallback;

/**
 Route 一个 URL,并带上额外参数,targetCallBack 可异步回调以返回一个 Object

 @param URL 要 Route 的 URL
 @param parameters 额外参数
 @param targetCallback 异步回调
 */
+ (void)routeCallbackURL:(NSString *)URL withParameters:(NSDictionary *)parameters targetCallback:(FFRouterCallback)targetCallback;




/**
 Route 一个未注册 URL 时回调

 @param handler 回调
 */
+ (void)routeUnregisterURLHandler:(FFRouterUnregisterURLHandler)handler;




/**
 取消注册某个 URL

 @param URL 要被取消注册的 URL
 */
+ (void)unregisterRouteURL:(NSString *)URL;

/**
 取消注册所有 URL
 */
+ (void)unregisterAllRoutes;



/**
 是否显示 Log，用于调试

 @param enable YES or NO，默认为 NO
 */
+ (void)setLogEnabled:(BOOL)enable;

【备注】

(1)注册 URL:

[FFRouter registerRouteURL:@"protocol://page/routerDetails/:id" handler:^(NSDictionary *routerParameters) {
   //Route的URL与本次注册URL匹配时的回调 
   //routerParameters中包含了传递过来的所有参数 
}];

[FFRouter registerRouteURL:@"wildcard://*" handler:^(NSDictionary *routerParameters) {
   //Route的URL与本次注册URL匹配时的回调 
   //routerParameters中包含了传递过来的所有参数 
}];

[FFRouter registerRouteURL:@"protocol://page/routerObjectDetails" handler:^(NSDictionary *routerParameters) {
   //Route的URL与本次注册URL匹配时的回调  
   //routerParameters中包含了传递过来的所有参数
}];

可通过routerParameters获取 URL 中的参数，routerParameters[FFRouterParameterURLKey]为完整的URL.

(2)当需要通过以下方法：

+ (id)routeObjectURL:(NSString *)URL;

Route 一个 URL 并获取返回值时，需要使用如下方法注册 URL：

+ (void)registerObjectRouteURL:(NSString *)routeURL handler:(FFObjectRouterHandler)handlerBlock;

并在 handlerBlock 中返回需要返回的 Object，例如：

//注册并返回必要的值
[FFRouter registerObjectRouteURL:@"protocol://page/routerObjectDetails" handler:^id(NSDictionary *routerParameters) {
        NSString *str = @“根据需要返回必要的Object”;
        return str;
    }];
    
//获取返回的值
NSString *ret = [FFRouter routeObjectURL:@"protocol://page/routerObjectDetails"];

(3)如果想要 routeURL 后通过异步回调获取返回的 Object，可使用下面方法注册和 Route URL：

//注册并在必要时间通过回调返回对应 Object
[FFRouter registerCallbackRouteURL:@"protocol://page/RouterCallbackDetails" handler:^(NSDictionary *routerParameters, FFRouterCallback targetCallBack) {
       //在必要时候通过 targetCallBack 回调去返回对应 Object
       targetCallBack(@"任意Object");
}];

//Route 时通过 ‘targetCallback’ 回调获取返回的对应 Object
[FFRouter routeCallbackURL:@"protocol://page/RouterCallbackDetails?nickname=imlifengfeng" targetCallback:^(id callbackObjc) {
        self.testLabel.text = [NSString stringWithFormat:@"%@",callbackObjc];
    }];

(4)如果需要传递非常规对象作为参数，如UIImage等，可使用如下方式：

[FFRouter routeURL:@"protocol://page/routerDetails?nickname=imlifengfeng" withParameters:@{@"img":[UIImage imageNamed:@"router_test_img"]}];

如果只需要传递普通参数，直接在URL后拼接参数即可：

[FFRouter routeURL:@"protocol://page/routerDetails?nickname=imlifengfeng&id=666¶meters......"];

之后从routerParameters中获取这些参数。例如：routerParameters[@"nickname"]

2、URL Rewrite

/**
 根据设置的 Rules 去 rewrite 一个 URL

 @param url 将被 rewrite 的 URL
 @return rewrite 后的 URL
 */
+ (NSString *)rewriteURL:(NSString *)url;

/**
 添加一个 RewriteRule

 @param matchRule 正则匹配规则
 @param targetRule 转换规则
 */
+ (void)addRewriteMatchRule:(NSString *)matchRule targetRule:(NSString *)targetRule;

/**
 同时添加多个 RewriteRule，格式必须为：@[@{@"matchRule":@"YourMatchRule",@"targetRule":@"YourTargetRule"},...]

 @param rules RewriteRules
 */
+ (void)addRewriteRules:(NSArray *)rules;

/**
 移除一个 RewriteRule

 @param matchRule 将被移除的 matchRule
 */
+ (void)removeRewriteMatchRule:(NSString *)matchRule;

/**
 移除所有 RewriteRule
 */
+ (void)removeAllRewriteRules;

【备注】

(1)可以使用正则添加一条 Rewrite 规则，例如：
要实现打开 URL:https://www.taobao.com/search/原子弹时，将其拦截，改用本地已注册的 URL:protocol://page/routerDetails?product=原子弹打开。
首先添加一条 Rewrite 规则：

[FFRouterRewrite addRewriteMatchRule:@"(?:https://)?www.taobao.com/search/(.*)" targetRule:@"protocol://page/routerDetails?product=$1"];

之后在打开URL:https://www.taobao.com/search/原子弹时，将会 Rewrite 到URL:protocol://page/routerDetails?product=原子弹。

[FFRouter routeURL:@"https://www.taobao.com/search/原子弹"];

(2)可以通过以下方法同时增加多个规则：

+ (void)addRewriteRules:(NSArray *)rules;

其中 rules 格式必须为以下格式：

@[@{@"matchRule":@"YourMatchRule1",@"targetRule":@"YourTargetRule1"},
  @{@"matchRule":@"YourMatchRule2",@"targetRule":@"YourTargetRule2"},
  @{@"matchRule":@"YourMatchRule3",@"targetRule":@"YourTargetRule3"},]

(3)Rewrite 规则中的保留字：

通过 $scheme、$host、$port、$path、$query、$fragment 获取标准 URL 中的相应部分。通过$url获取完整 URL
通过 $1、$2、$3...获取matchRule的正则中使用圆括号取出的参数
$：原变量的值、$$：原变量URL Encode后的值、$#：原变量URL Decode后的值

例如：
https://www.taobao.com/search/原子弹对于Rewrite 规则(?:https://)?www.taobao.com/search/(.*)

$1=原子弹
$$1=%e5%8e%9f%e5%ad%90%e5%bc%b9

同样，https://www.taobao.com/search/%e5%8e%9f%e5%ad%90%e5%bc%b9对于Rewrite 规则(?:https://)?www.taobao.com/search/(.*)

$1=%e5%8e%9f%e5%ad%90%e5%bc%b9
$#1=原子弹

2、FFRouterNavigation

考虑到经常用路由配置UIViewController之间的跳转，所以增加了额外的工具FFRouterNavigation来更方便地控制UIViewController之间的跳转。具体使用方法如下：

/**
 push 时是否自动隐藏底部TabBar

 @param hide 是否自动隐藏，默认为 NO
 */
+ (void)autoHidesBottomBarWhenPushed:(BOOL)hide;



/**
 获取当前 ViewController

 @return 当前 ViewController
 */
+ (UIViewController *)currentViewController;

/**
 获取当前 NavigationViewController

 @return return 当前 NavigationViewController
 */
+ (nullable UINavigationController *)currentNavigationViewController;



/**
 Push ViewController

 @param viewController 被 Push 的 ViewController
 @param animated 是否使用动画
 */
+ (void)pushViewController:(UIViewController *)viewController animated:(BOOL)animated;

/**
 Push ViewController，可设置当前 ViewController 是否还保留

 @param viewController 被 Push 的 ViewController
 @param replace 当前 ViewController 是否还保留
 @param animated 是否使用动画
 */
+ (void)pushViewController:(UIViewController *)viewController replace:(BOOL)replace animated:(BOOL)animated;

/**
 Push 多个 ViewController

 @param viewControllers ViewController Array
 @param animated 是否使用动画
 */
+ (void)pushViewControllerArray:(NSArray *)viewControllers animated:(BOOL)animated;

/**
 present ViewController

 @param viewController 被 present 的 ViewController
 @param animated 是否使用动画
 @param completion 回调
 */
+ (void)presentViewController:(UIViewController *)viewController animated:(BOOL)animated completion:(void (^ __nullable)(void))completion;



/**
 关闭当前 ViewController，push、present 方式通用

 @param animated 是否使用动画
 */
+ (void)closeViewControllerAnimated:(BOOL)animated;

感谢

FFRouter实现方案参考了以下文章，在此表示感谢！

天猫解耦神器 —— 统跳协议和Rewrite引擎
蘑菇街 App 的组件化之路

iOS 解耦、组件化最佳实践

Github链接：FFRouter

功能

安装

CocoaPods

手动安装

使用方法

1、基本使用

【备注】

2、URL Rewrite

【备注】

2、FFRouterNavigation

感谢

你可能感兴趣的:(iOS 解耦、组件化最佳实践)