淺談強大易用支持URL Rewrite的iOS路由庫FFRouter

FFRouter 是 iOS 中一個強大且易用的 URL 路由框架,支持 URL Rewrite,使 APP 在發(fā)布之后也可以動態(tài)修改相關路由邏輯?;谄ヅ洳檎?URL,效率高。集成和使用都非常簡單!

功能

  • 具備基本的 URL 注冊、Route、取消注冊、打印 Log 等
  • 支持使用通配符(*)注冊 URL
  • 支持 URL Rewrite
  • 支持 Rewrite 時獲取原 URL 參數(shù)或 URLComponents,并可對其進行URL Encode或 Decode
  • 支持通過 URL 獲取 Object
  • 支持 Route URL 時傳遞非常規(guī)對象
  • 支持 Route 一個未注冊的 URL 時統(tǒng)一回調

安裝

CocoaPods

target 'MyApp' do
  pod 'FFRouter'
end

運行 pod install

手動安裝

添加其中的 FFRouter 文件夾到自己項目

使用方法

首先

#import "FFRouter.h"

1、基本使用
/**
 注冊 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,并帶上額外參數(shù)

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

/**
 Route 一個 URL,可獲得返回的 Object

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

/**
 Route 一個 URL,并帶上額外參數(shù),可獲得返回的 Object

 @param URL 要 Router 的 URL
 @param parameters 額外參數(shù)
 @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 中的參數(shù),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)如果需要傳遞非常規(guī)對象作為參數(shù),如UIImage等,可使用如下方式:

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

2、URL Rewrite
/**
 根據設置的 Rules 去 rewrite 一個 URL

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

/**
 添加一個 RewriteRule

 @param matchRule 正則匹配規(guī)則
 @param targetRule 轉換規(guī)則
 */
+ (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 規(guī)則,例如:
要實現(xiàn)打開 URL:https://www.taobao.com/search/原子彈時,將其攔截,改用本地已注冊的 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/原子彈時,將會 Rewrite 到URL:protocol://page/routerDetails?product=原子彈。

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

(2)可以通過以下方法同時增加多個規(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 獲取標準 URL 中的相應部分。通過$url獲取完整 URL
  • 通過 $1$2$3...獲取matchRule的正則中使用圓括號取出的參數(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

考慮到經常用路由配置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;

總結
以上就是這篇文章的全部內容了,希望本文的內容對大家具有一定的參考學習價值,謝謝大家的支持

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,694評論 19 139
  • 今天又超了半盒水果,兩盒花生,真是受不了自己,一點自制力都沒有,完不成目標了啦!碰上經期,又要停運動三天!收獲了做...
    aseeya閱讀 244評論 0 0
  • 一個人去了 所有的怨懟都可以淡忘 一個人去了 一切的過往都可以原諒 - 春節(jié)、清明、七月半 應時的節(jié)氣,后人輪番上...
    錦茱萸閱讀 308評論 4 14
  • 今天這組照片純粹是隨性而攝,最開始沒有設定一個主題,剛入手一套手機設備。廣角鏡頭+微距鏡頭+偏光鏡,對于第一次使用...
    多少有理閱讀 987評論 0 1
  • 蓑笠翁_5750閱讀 439評論 0 2

友情鏈接更多精彩內容