Skip to content

iOS DeepLink.通过URL跳转到APP对应控制器并传值,适用于网页打开APP,或者点击推送打开特定界面。支持远程配置。 Jump to the appropriate interface according to the URL address, apply to a web page, open a link, or click push to open a specific interface

Notifications You must be signed in to change notification settings

xueyongwei/XYWdispatcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 

Repository files navigation

XYWdispatcher

iOS deeplink,通用跨平台解决方案。 通过注册scheme,可直接给出URL,通过url地址跳转到相应界面,同时支持传值。 特色:支持远程配置,支持版本兼容与扩展。

不适用于url注册制的组件化方案

建议格式

在使用过程中,建议遵守URLComponents规则。

这里粗略的举个例子来说明url的组成:

https://johnny:[email protected]:443/script.ext;param=value?query=value#ref

这个url拆解后:

组件名称
scheme https
user johnny
password p4ssw0rd
host www.example.com
port 443
path /script.ext
pathExtension ext
pathComponents ["/", "script.ext"]
parameterString param=value
query query=value
fragment ref

使用XYWdispatcher格式建议:

  • scheme:bundleID或app名(如:weixin://或者com.115://)
  • host:控制器类名 (如:pkdetail)
  • path:操作方法(如:like)
  • query:控制器属性(如:id=123)

格式举例:
 urlStr = "XYWAPP://pkdetail/like?id=123"
 
说明:
scheme: XYWAPP        
host: pkdetail  
path: like
query:  id=123

操作解析:打开XYWAPP,跳转到pkdetail控制器,给id=123的pk点个赞。

使用场景

  • 在网页里点击链接打开app,或者跳转到app里的某个详情页界面。
  • 收到推送,或者Socket等消息,点击后跳转到消息列表或者内容详情。
  • APP内无需导入头文件,直接跳转到某个VC中去。

使用示例

需求:在APP里分享一组对战,别人通过网页打开,点击“对战详情”时打开app,并且到达此场pk的详情界面。

做法:只需要在网页里的按钮 添加点击URL: zuoyoupk://pkdetail/open?pkID=10010

当在网页里点击时会发生:

  1. 打开左右app
  2. 跳转pkderailViewController详情页
  3. 传入参数pkID为10010,加载id为10010的比赛数据
  4. 显示正确的内容

使用方法

  1. 拖入XYWdispatcher文件夹
  2. 在XYWdispatcherRouter.plist路由表里添加host和viewController的对应关系,以及参数的对应关系(为了:跨平台统一,保证URL的path参数对应到控制器的className,也可消除URL参数里包含OC的关键字)。
  3. 在appdelegate里的-(Bool)application openURL方法捕获scheme
-(BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
  
    {
      if ([XYWdispatcher HandleOpenURL:url withScheme:@"XYWdispatcher"]) {
         return YES;
     }else{//其他sdk代码
         return NO;
      }
   //    return [XYWdispatcher HandleOpenURL:url withScheme:@"roter"];
   }

远程配置

一般情况下,我们无法预料后续版本会要跳转哪些界面,甚至APP里会创建哪些控制器,这样的话此功能就会有版本限制。 所以我们需要一个可以远程配置的功能,让旧版本的app也能打开已有的控制器。(已做 容错 处理)

在XYWdispatcher文件夹下,附带一个plist文件以供配置。当需要远程配置的时候,您需要一个远程文件的下载地址,在XYWdispatcher实现文件里的downloadRouterFile方法下,修改即可。

当您需要更新配置的时候(建议每次启动时跟新),只需要调用:

[XYWdispatcher updateDispatcher];

如果您没有服务器(个人或公司)来存放配置文件,我建议您把配置文件放在GitHub上,然后从GitHub下载即可。

注意:您应该通过这种方式获得GitHub上文件的下载地址:

  1. 点击项目地址 (比如https://github.com/xueyongwei/XYWdispatcher)
  2. 点击文件名 (比如:README.md)
  3. 在文件详情的右上角点击“Raw”,打开的网页地址就是下载地址

也可以在raw上右键下载文件以得到文件的下载地址,而不是通过https://github.com/xueyongwei/XYWdispatcher/blob/master/README.md来下载。(您会下载到一个网页)

测试效果

在appdelegate里的-(Bool)application openURL方法捕获XYWdispatcher

  1. 网页打开APP:使用safari输入XYWdispatcher://test1ViewController?str=hahahha
  2. 应用内跳转控制器:某个ViewController或者View或者NSObject里写下代码:[[UIApplication sharedApplication]openURL:[NSURL URLWithString:@"XYWdispatcher://test1ViewController?str=hahahha"]];
  3. 推送或SOCKET:接收到消息后,获取info里的url="XYWdispatcher://test1ViewController?str=hahahha",直接调用[[UIApplication sharedApplication]openURL:url];

发生了:打开应用,并跳转到test1界面,且传入str为“hahahha”

容错

我们可能无法记得要同步这个配置文件,导致在某些情况下配置出现了无效的情况。或者在使用了远程配置之后,一些旧的APP里也获取到了新的配置,但是却没有相应的处理方法或类。

当出现通过URL等,是有可能分发无效的路由,或者旧版本不存在的类,那我们就要做一些容错,防止新版本的url在较早版本的APP里无法识别,而造成不可预知的错误。

代码已经对不识别的类,或参数做了判断,当出现无法被创建的类或被赋值的参数时,会弹窗提示需要升级才能完成操作,并直return。

About

iOS DeepLink.通过URL跳转到APP对应控制器并传值,适用于网页打开APP,或者点击推送打开特定界面。支持远程配置。 Jump to the appropriate interface according to the URL address, apply to a web page, open a link, or click push to open a specific interface

Resources

Stars

Watchers

Forks

Packages

No packages published