FFRouter 强大易用的 iOS 路由库开源项目

我要开发同款
匿名用户2018年10月12日
44阅读
开发技术Object-c
所属分类Objective-C、手机/移动开发
授权协议MIT

作品详情

FFRouter是iOS中一个强大且易用的URL路由库,支持URLRewrite,使APP在发布之后也可以动态修改相关路由逻辑。基于匹配查找URL,效率高。集成和使用都非常简单!

功能

具备基本的URL注册、Route、取消注册、打印Log等

支持使用通配符(*)注册URL

支持URLRewrite

支持Rewrite时获取原URL参数或URLComponents,并可对其进行URLEncode或Decode

支持通过URL获取Object

支持RouteURL时传递非常规对象

支持Route一个未注册的URL时统一回调

安装CocoaPodstarget 'MyApp' do  pod 'FFRouter'end

运行 podinstall

手动安装

添加其中的 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、URLRewrite

/** 根据设置的 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的正则中使用圆括号取出的参数

$:原变量的值、$$:原变量URLEncode后的值、$#:原变量URLDecode后的值

例如: 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=原子弹

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;感谢

FFRouter实现方案参考了以下文章,在此表示感谢!

天猫解耦神器——统跳协议和Rewrite引擎

蘑菇街App的组件化之路

声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论