浅谈强大易用支持URL Rewrite的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"

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，并带上额外参数

 @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"]}];

2、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=原子弹

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

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