比JLRoutes更強大更好用的iOS開源路由框架—FFRouter

目前iOS經常使用路由框架是JLRouter、HHRouter、MGJRouter。
可是這些路由庫都各有不足，首先是JLRouter，用不到的功能繁多，並且基於遍歷查找URL，效率低下。HHRouter耦合程度過高，過分依賴ViewController。MGJRouter功能太過簡單。

今天介紹一個新發現的iOS路由框架，FFRouter：

FFRouter 是 iOS 中一個強大且易用的 URL 路由框架，支持 URL Rewrite，使 APP 在發佈以後也能夠動態修改相關路由邏輯。基於匹配查找 URL，效率高。集成和使用都很是簡單！

Github連接：FFRouter

功能

• 具有基本的 URL 註冊、Route、取消註冊、打印 Log 等
• 支持使用通配符(*)註冊 URL
• 支持 URL Rewrite
• 支持 Rewrite 時獲取原 URL 參數或 URLComponents，並可對其進行URL Encode或 Decode
• 支持經過 URL 獲取 Object
• 支持 Route URL 時傳遞很是規對象
• 支持 Route 一個未註冊的 URL 時統一回調

安裝

CocoaPods

target 'MyApp' do
  pod 'FFRouter'
end

運行 pod install

手動安裝

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

使用方法

首先

#import "FFRouter.h"

一、基本使用

/**
 註冊 url

 @param routeURL 要註冊的 URL
 @param handlerBlock URL 被 Route 後的回調
 */
+ (void)registerRouteURL:(NSString *)routeURL handler:(FFRouterHandler)handlerBlock;

/**
 註冊 URL,經過該方式註冊的 URL 被 Route 後可返回一個 Object

 @param routeURL 要註冊的 URL
 @param handlerBlock URL 被 Route 後的回調,可在回調中返回一個 Object
 */
+ (void)registerObjectRouteURL:(NSString *)routeURL handler:(FFObjectRouterHandler)handlerBlock;



/**
 判斷 URL 是否可被 Route（是否已經註冊）

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



/**
 Route 一個 URL

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

/**
 Route 一個 URL，並帶上額外參數

 @param URL 要 Router 的 URL
 @param parameters 額外參數
 */
+ (void)routeURL:(NSString *)URL withParameters:(NSDictionary<NSString *, id> *)parameters;

/**
 Route 一個 URL，可得到返回的 Object

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

/**
 Route 一個 URL，並帶上額外參數，可得到返回的 Object

 @param URL 要 Router 的 URL
 @param parameters 額外參數
 @return 返回的 Object
 */
+ (id)routeObjectURL:(NSString *)URL withParameters:(NSDictionary<NSString *, id> *)parameters;



/**
 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匹配時的回調  
}];

[FFRouter registerRouteURL:@"wildcard://*" handler:^(NSDictionary *routerParameters) {
   //Route的URL與本次註冊URL匹配時的回調  
}];

[FFRouter registerRouteURL:@"protocol://page/routerObjectDetails" handler:^(NSDictionary *routerParameters) {
   //Route的URL與本次註冊URL匹配時的回調  
}];

可經過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)若是須要傳遞很是規對象做爲參數，如UIImage等，可以使用以下方式：

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

二、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;