iOS 解藕鼠证、組件化最常用的是使用統(tǒng)跳路由的方式峡竣,目前比較常用的 iOS 開源路由框架主要是JLRoutes、MGJRouter量九、HHRouter等适掰,這些路由框架各有優(yōu)點(diǎn)和缺點(diǎn),基本可以滿足大部分需求荠列。目前最常用來作路由跳轉(zhuǎn)类浪,以實(shí)現(xiàn)基本的組件化開發(fā),實(shí)現(xiàn)各模塊之間的解藕肌似。但是戚宦,在實(shí)際中開發(fā)中會(huì)發(fā)現(xiàn),無法徹底使用它們完成所有模塊間通信锈嫩,比如模塊間的同步受楼、異步通信等垦搬。再比如,我們在配置了相關(guān)路由跳轉(zhuǎn)的 URL 后艳汽,如何在上線之后動(dòng)態(tài)修改相關(guān)跳轉(zhuǎn)邏輯猴贰?在模塊間通信時(shí),如何在上線后動(dòng)態(tài)修改相關(guān)參數(shù)河狐?APP 能否實(shí)現(xiàn)類似 Web 的302跳轉(zhuǎn)米绕?于是 FFRouter 誕生了!
而 FFRouter 則在參考了其他開源框架后誕生的一個(gè)路由框架馋艺,F(xiàn)FRouter 不僅支持路由跳轉(zhuǎn)栅干,還支持模塊間同步、異步通信捐祠。增加了 Rewrite 引擎碱鳞,可以在 APP 上線后動(dòng)態(tài)修改相應(yīng)路由邏輯,以及動(dòng)態(tài)修改相應(yīng)參數(shù)踱蛀,支持使用正則語法創(chuàng)建 Rewrite 規(guī)則窿给,更加靈活。
對于 URL Rewrite率拒,天貓就用來在解決 App 中 URL 平臺(tái)展現(xiàn)一致性的問題崩泡,并且在雙11期間,在全鏈路界面降級(jí)方案和會(huì)場上下線中發(fā)揮了重要作用猬膨。FFRouter 的 URL Rewrite 也是參考了天貓的方案角撞。
FFRouter 的主要使用方法如下:(來自github:FFRouter)
Github鏈接:FFRouter
功能
- 具備基本的 URL 注冊、Route勃痴、取消注冊靴寂、打印 Log 等
- 支持使用通配符(*)注冊 URL
- 支持 URL Rewrite
- 支持 Rewrite 時(shí)獲取原 URL 參數(shù)或 URLComponents,并可對其進(jìn)行URL Encode或 Decode
- 支持通過 URL 獲取 Object
- 支持 Route URL 時(shí)通過異步回調(diào)的方式獲取 Object
- 支持 Route URL 時(shí)傳遞非常規(guī)對象
- 支持 Route 一個(gè)未注冊的 URL 時(shí)統(tǒng)一回調(diào)
安裝
CocoaPods
target 'MyApp' do
pod 'FFRouter'
end
運(yùn)行 pod install
手動(dòng)安裝
添加其中的 FFRouter
文件夾到自己項(xiàng)目
使用方法
首先
#import "FFRouter.h"
1召耘、基本使用
/**
注冊 url,與 ‘routeURL:’ 和 ‘routeURL: withParameters:’ 配合使用
@param routeURL 要注冊的 URL
@param handlerBlock URL 被 Route 后的回調(diào)
*/
+ (void)registerRouteURL:(NSString *)routeURL handler:(FFRouterHandler)handlerBlock;
/**
注冊 URL,與 'routeObjectURL:' 和 ‘routeObjectURL: withParameters:’ 配合使用,可返回一個(gè) Object
@param routeURL 要注冊的 URL
@param handlerBlock URL 被 Route 后的回調(diào),可在回調(diào)中返回一個(gè) Object
*/
+ (void)registerObjectRouteURL:(NSString *)routeURL handler:(FFObjectRouterHandler)handlerBlock;
/**
注冊 URL,與 ‘routeCallbackURL: targetCallBack:’ 和 ‘routeCallbackURL: withParameters: targetCallBack:’ 配合使用百炬,可異步回調(diào)返回一個(gè) Object
@param routeURL 要注冊的 URL
@param handlerBlock URL 被 Route 后的回調(diào),handlerBlock 中有一個(gè) targetCallBack ,對應(yīng) ‘routeCallbackURL: targetCallBack:’ 和 ‘routeCallbackURL: withParameters: targetCallBack:’ 中的 targetCallBack,可用于異步回調(diào)返回一個(gè) Object
*/
+ (void)registerCallbackRouteURL:(NSString *)routeURL handler:(FFCallbackRouterHandler)handlerBlock;
/**
判斷 URL 是否可被 Route(是否已經(jīng)注冊)
@param URL 要判斷的 URL
@return 是否可被 Route
*/
+ (BOOL)canRouteURL:(NSString *)URL;
/**
Route 一個(gè) URL
@param URL 要 Route 的 URL
*/
+ (void)routeURL:(NSString *)URL;
/**
Route 一個(gè) URL污它,并帶上額外參數(shù)
@param URL 要 Route 的 URL
@param parameters 額外參數(shù)
*/
+ (void)routeURL:(NSString *)URL withParameters:(NSDictionary<NSString *, id> *)parameters;
/**
Route 一個(gè) URL剖踊,可獲得返回的 Object
@param URL 要 Route 的 URL
@return 返回的 Object
*/
+ (id)routeObjectURL:(NSString *)URL;
/**
Route 一個(gè) URL,并帶上額外參數(shù)衫贬,可獲得返回的 Object
@param URL 要 Route 的 URL
@param parameters 額外參數(shù)
@return 返回的 Object
*/
+ (id)routeObjectURL:(NSString *)URL withParameters:(NSDictionary<NSString *, id> *)parameters;
/**
Route 一個(gè) URL,targetCallBack 可異步回調(diào)以返回一個(gè) Object
@param URL 要 Route 的 URL
@param targetCallback 異步回調(diào)
*/
+ (void)routeCallbackURL:(NSString *)URL targetCallback:(FFRouterCallback)targetCallback;
/**
Route 一個(gè) URL,并帶上額外參數(shù),targetCallBack 可異步回調(diào)以返回一個(gè) Object
@param URL 要 Route 的 URL
@param parameters 額外參數(shù)
@param targetCallback 異步回調(diào)
*/
+ (void)routeCallbackURL:(NSString *)URL withParameters:(NSDictionary<NSString *, id> *)parameters targetCallback:(FFRouterCallback)targetCallback;
/**
Route 一個(gè)未注冊 URL 時(shí)回調(diào)
@param handler 回調(diào)
*/
+ (void)routeUnregisterURLHandler:(FFRouterUnregisterURLHandler)handler;
/**
取消注冊某個(gè) URL
@param URL 要被取消注冊的 URL
*/
+ (void)unregisterRouteURL:(NSString *)URL;
/**
取消注冊所有 URL
*/
+ (void)unregisterAllRoutes;
/**
是否顯示 Log德澈,用于調(diào)試
@param enable YES or NO,默認(rèn)為 NO
*/
+ (void)setLogEnabled:(BOOL)enable;
【備注】
(1)注冊 URL:
[FFRouter registerRouteURL:@"protocol://page/routerDetails/:id" handler:^(NSDictionary *routerParameters) {
//Route的URL與本次注冊URL匹配時(shí)的回調(diào)
//routerParameters中包含了傳遞過來的所有參數(shù)
}];
[FFRouter registerRouteURL:@"wildcard://*" handler:^(NSDictionary *routerParameters) {
//Route的URL與本次注冊URL匹配時(shí)的回調(diào)
//routerParameters中包含了傳遞過來的所有參數(shù)
}];
[FFRouter registerRouteURL:@"protocol://page/routerObjectDetails" handler:^(NSDictionary *routerParameters) {
//Route的URL與本次注冊URL匹配時(shí)的回調(diào)
//routerParameters中包含了傳遞過來的所有參數(shù)
}];
可通過routerParameters
獲取 URL 中的參數(shù)固惯,routerParameters[FFRouterParameterURLKey]
為完整的URL.
(2)當(dāng)需要通過以下方法:
+ (id)routeObjectURL:(NSString *)URL;
Route 一個(gè) URL 并獲取返回值時(shí)梆造,需要使用如下方法注冊 URL:
+ (void)registerObjectRouteURL:(NSString *)routeURL handler:(FFObjectRouterHandler)handlerBlock;
并在 handlerBlock 中返回需要返回的 Object,例如:
//注冊并返回必要的值
[FFRouter registerObjectRouteURL:@"protocol://page/routerObjectDetails" handler:^id(NSDictionary *routerParameters) {
NSString *str = @“根據(jù)需要返回必要的Object”;
return str;
}];
//獲取返回的值
NSString *ret = [FFRouter routeObjectURL:@"protocol://page/routerObjectDetails"];
(3)如果想要 routeURL 后通過異步回調(diào)獲取返回的 Object,可使用下面方法注冊和 Route URL:
//注冊并在必要時(shí)間通過回調(diào)返回對應(yīng) Object
[FFRouter registerCallbackRouteURL:@"protocol://page/RouterCallbackDetails" handler:^(NSDictionary *routerParameters, FFRouterCallback targetCallBack) {
//在必要時(shí)候通過 targetCallBack 回調(diào)去返回對應(yīng) Object
targetCallBack(@"任意Object");
}];
//Route 時(shí)通過 ‘targetCallback’ 回調(diào)獲取返回的對應(yīng) Object
[FFRouter routeCallbackURL:@"protocol://page/RouterCallbackDetails?nickname=imlifengfeng" targetCallback:^(id callbackObjc) {
self.testLabel.text = [NSString stringWithFormat:@"%@",callbackObjc];
}];
(4)如果需要傳遞非常規(guī)對象作為參數(shù)镇辉,如UIImage
等屡穗,可使用如下方式:
[FFRouter routeURL:@"protocol://page/routerDetails?nickname=imlifengfeng" withParameters:@{@"img":[UIImage imageNamed:@"router_test_img"]}];
如果只需要傳遞普通參數(shù),直接在URL后拼接參數(shù)即可:
[FFRouter routeURL:@"protocol://page/routerDetails?nickname=imlifengfeng&id=666¶meters......"];
之后從routerParameters
中獲取這些參數(shù)忽肛。例如:routerParameters[@"nickname"]
2村砂、URL Rewrite
/**
根據(jù)設(shè)置的 Rules 去 rewrite 一個(gè) URL
@param url 將被 rewrite 的 URL
@return rewrite 后的 URL
*/
+ (NSString *)rewriteURL:(NSString *)url;
/**
添加一個(gè) RewriteRule
@param matchRule 正則匹配規(guī)則
@param targetRule 轉(zhuǎn)換規(guī)則
*/
+ (void)addRewriteMatchRule:(NSString *)matchRule targetRule:(NSString *)targetRule;
/**
同時(shí)添加多個(gè) RewriteRule,格式必須為:@[@{@"matchRule":@"YourMatchRule",@"targetRule":@"YourTargetRule"},...]
@param rules RewriteRules
*/
+ (void)addRewriteRules:(NSArray<NSDictionary *> *)rules;
/**
移除一個(gè) RewriteRule
@param matchRule 將被移除的 matchRule
*/
+ (void)removeRewriteMatchRule:(NSString *)matchRule;
/**
移除所有 RewriteRule
*/
+ (void)removeAllRewriteRules;
【備注】
(1)可以使用正則
添加一條 Rewrite 規(guī)則屹逛,例如:
要實(shí)現(xiàn)打開 URL:https://www.taobao.com/search/原子彈
時(shí)础废,將其攔截,改用本地已注冊的 URL:protocol://page/routerDetails?product=原子彈
打開罕模。
首先添加一條 Rewrite 規(guī)則:
[FFRouterRewrite addRewriteMatchRule:@"(?:https://)?www.taobao.com/search/(.*)" targetRule:@"protocol://page/routerDetails?product=$1"];
之后在打開URL:https://www.taobao.com/search/原子彈
時(shí)评腺,將會(huì) Rewrite 到URL:protocol://page/routerDetails?product=原子彈
。
[FFRouter routeURL:@"https://www.taobao.com/search/原子彈"];
(2)可以通過以下方法同時(shí)增加多個(gè)規(guī)則:
+ (void)addRewriteRules:(NSArray<NSDictionary *> *)rules;
其中 rules 格式必須為以下格式:
@[@{@"matchRule":@"YourMatchRule1",@"targetRule":@"YourTargetRule1"},
@{@"matchRule":@"YourMatchRule2",@"targetRule":@"YourTargetRule2"},
@{@"matchRule":@"YourMatchRule3",@"targetRule":@"YourTargetRule3"},]
(3)Rewrite 規(guī)則中的保留字:
- 通過
$scheme
淑掌、$host
蒿讥、$port
、$path
锋拖、$query
、$fragment
獲取標(biāo)準(zhǔn) URL 中的相應(yīng)部分祸轮。通過$url
獲取完整 URL - 通過
$1
兽埃、$2
、$3
...獲取matchRule
的正則中使用圓括號(hào)取出的參數(shù) -
$
:原變量的值适袜、$$
:原變量URL Encode后的值柄错、$#
:原變量URL Decode后的值
例如:
https://www.taobao.com/search/原子彈
對于Rewrite 規(guī)則(?: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 規(guī)則(?:https://)?www.taobao.com/search/(.*)
$1=%e5%8e%9f%e5%ad%90%e5%bc%b9
$#1=原子彈
2苦酱、FFRouterNavigation
考慮到經(jīng)常用路由配置UIViewController
之間的跳轉(zhuǎn)售貌,所以增加了額外的工具FFRouterNavigation
來更方便地控制UIViewController
之間的跳轉(zhuǎn)。具體使用方法如下:
/**
push 時(shí)是否自動(dòng)隱藏底部TabBar
@param hide 是否自動(dòng)隱藏疫萤,默認(rèn)為 NO
*/
+ (void)autoHidesBottomBarWhenPushed:(BOOL)hide;
/**
獲取當(dāng)前 ViewController
@return 當(dāng)前 ViewController
*/
+ (UIViewController *)currentViewController;
/**
獲取當(dāng)前 NavigationViewController
@return return 當(dāng)前 NavigationViewController
*/
+ (nullable UINavigationController *)currentNavigationViewController;
/**
Push ViewController
@param viewController 被 Push 的 ViewController
@param animated 是否使用動(dòng)畫
*/
+ (void)pushViewController:(UIViewController *)viewController animated:(BOOL)animated;
/**
Push ViewController颂跨,可設(shè)置當(dāng)前 ViewController 是否還保留
@param viewController 被 Push 的 ViewController
@param replace 當(dāng)前 ViewController 是否還保留
@param animated 是否使用動(dòng)畫
*/
+ (void)pushViewController:(UIViewController *)viewController replace:(BOOL)replace animated:(BOOL)animated;
/**
Push 多個(gè) ViewController
@param viewControllers ViewController Array
@param animated 是否使用動(dòng)畫
*/
+ (void)pushViewControllerArray:(NSArray *)viewControllers animated:(BOOL)animated;
/**
present ViewController
@param viewController 被 present 的 ViewController
@param animated 是否使用動(dòng)畫
@param completion 回調(diào)
*/
+ (void)presentViewController:(UIViewController *)viewController animated:(BOOL)animated completion:(void (^ __nullable)(void))completion;
/**
關(guān)閉當(dāng)前 ViewController,push扯饶、present 方式通用
@param animated 是否使用動(dòng)畫
*/
+ (void)closeViewControllerAnimated:(BOOL)animated;
感謝
FFRouter
實(shí)現(xiàn)方案參考了以下文章恒削,在此表示感謝!