服务器之家

服务器之家 > 正文

浅谈强大易用支持URL Rewrite的iOS路由库FFRouter

时间：2021-05-13 17:21     来源/作者：imlifengfeng

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 时统一回调

安装

?
1
2
3
4
CocoaPods
target 'MyApp' do
 pod 'FFRouter'
end

运行 pod install

手动安装

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

使用方法

首先

?
1
#import "FFRouter.h"

1、基本使用

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
 注册 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:

?
1
2
3
4
5
6
7
8
9
10
11
[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)当需要通过以下方法：

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

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

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

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

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

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

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

2、URL Rewrite

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/**
 根据设置的 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 规则：

?
1
[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=原子弹。

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

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

?
1
+ (void)addRewriteRules:(NSArray<NSDictionary *> *)rules;

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

?
1
2
3
@[@{@"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
2
$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
2
$1=%e5%8e%9f%e5%ad%90%e5%bc%b9
$#1=原子弹

3、FFRouterNavigation

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/**
 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;

 以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。

原文链接：https://www.jianshu.com/p/be33b7b07bb0

标签：
iOS FFRouter 

相关文章

热门资讯

2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全
2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全 2019-12-26
yue是什么意思 网络流行语yue了是什么梗
yue是什么意思 网络流行语yue了是什么梗 2020-10-11
背刺什么意思 网络词语背刺是什么梗
背刺什么意思 网络词语背刺是什么梗 2020-05-22
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总 2020-11-13
2021德云社封箱演出完整版 2021年德云社封箱演出在线看
2021德云社封箱演出完整版 2021年德云社封箱演出在线看 2021-03-15
返回顶部