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:FFRouterhtml

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 installgit

手動安裝

添加其中的 FFRouter 文件夾到本身項目github

使用方法

首先objective-c

#import "FFRouter.h"
複製代碼
一、基本使用
/**
 註冊 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<NSString *, id> *)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<NSString *, id> *)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<NSString *, id> *)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:ruby

[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,例如:ide

//註冊並返回必要的值
[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&parameters......"];
複製代碼

以後從routerParameters中獲取這些參數。例如:routerParameters[@"nickname"]

二、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<NSDictionary *> *)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<NSDictionary *> *)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=原子彈
複製代碼
二、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實現方案參考瞭如下文章,在此表示感謝!

相關文章
相關標籤/搜索