URL Scheme笔记

我们都知道苹果手机中的APP都有一个沙盒，APP就是一个信息孤岛，相互是不可以进行通信的。但是iOS的APP可以注册自己的URL Scheme，URL Scheme是为方便app之间互相调用而设计的。这也是scheme最常用到的地方，但是平时项目中还有另外两个地方一样需要用到：服务器通知客户端如何跳转和H5与Native跳转。所以制定一个统一的scheme协议来完成APP间跳转和App内页面跳转，然后定义一个专门的类来处理相关跳转，可以使代码更加整洁优雅。

scheme三方面的作用：

服务器下发跳转路径，客户端根据服务器下发跳转路径跳转相应的页面；
H5页面点击锚点，根据锚点具体跳转路径APP端跳转具体的页面；
APP端收到服务器端下发的PUSH通知栏消息，根据消息的点击跳转路径跳转相关页面

URL scheme 概述

客户端应用可以向操作系统注册一个 URL scheme，该 scheme 用于从浏览器或其他应用中启动本应用。通过指定的 URL 字段，可以让应用在被调起后直接打开某些特定页面，比如车辆详情页、订单详情页、消息通知页、促销广告页等等。也可以执行某些指定动作，如订单支付等。也可以在应用内通过 html 页来直接调用显示 app 内的某个页面。

URL scheme 的格式

客户端自定义的 URL 作为从一个应用调用另一个的基础，遵循 RFC 1808 (Relative Uniform Resource Locators) 标准。这跟我们常见的网页内容 URL 格式一样。

一个普通的 URL 分为几个部分，scheme、host、relativePath、query。
我们用到的NSURL

NSURL *url = [NSURL URLWithString:@"http://www.testurl.com:8080/subpath/subsubpath?uid=123&gid=456"];  
[url scheme]为http,  [url host]为www.testurl.com，[url port]为8080，[url path]为/subpath/subsubpath，[url lastPathComponent]为subsubpath，[url query]为uid=123&gid=456

一个应用中使用的 URL 例子（该 URL 会调起车辆详情页）：

zqprojectmobile://project/carDetail?car_id=123456
scheme为zqprojectmobile,host为project,relativePath为/carDetail,query为car_id=123456

项目中定义了专门的类命名为JumpURLHandle，通过类方法parseURL:来处理参数中的url。本文以此为例讲解scheme的定义与解析。

1 首先客户端应用向操作系统注册一个或者多个 URL scheme，例如项目中就定义了多个分别scheme，分别为：

zqprojectmobile: 对应普通APP间跳转scheme
zqprojectwxpay: 对应微信支付完成之后跳转回来的scheme
zqprojectalipay：对应支付宝支付完成之后跳转回来的scheme

对应的parseURL:方法里解析为：

+ (BOOL)parseURL:(NSURL *)url
{
    // 支付宝客户端支付后的回调
    if ([[url scheme] isEqualToString:@"zqprojectalipay"]
        || ([[[url scheme] lowercaseString] isEqualToString:kUuyongcheAlipayScheme]))
    {
        return 支付宝支付完成后的回调处理方法;
    }
    // 微信客户端支付后的回调
    else if ([url.scheme isEqualToString:@"zqprojectwxpay"] && [url.host isEqualToString:@"pay"])
    {
        return 微信支付完成后的回调处理方法;
    }
    // 本应用 scheme 调用
    else if (([[url scheme] isEqualToString:@"zqprojectmobile"])
             || ([[[url scheme] lowercaseString] isEqualToString:@"zqprojectmobile"]))
    {
        return [[JumpURLHandle getInstance] parseAppUrl:url];
    }
    return NO;
}

2 定义relativePath，并通过relativePath来判断是执行动作还是跳转页面，当执行动作时把relativePath定义为"/action"，在解析时如果url的relativePath是"/action"则跳转到执行动作的处理方法里，否则执行跳转页面的逻辑。
例如：

zqprojectmobile://project/action?name=back，
relativePath为/action，执行动作（返回前页）

zqprojectmobile://project/order?order_id=42347645&type=2
relativePath为/order，执行跳转页面的逻辑

代码：

- (BOOL)parseAppUrl:(NSURL *)url
{
    NSString *relativePath = [url relativePath];
    
    // scheme 调起执行动作
    if ([relativePath isEqualToString:@"/action"])
    {
        [self jumpActions:url];
    }
    // scheme 调起跳转页面
    else
    {
        [self jumpNativeViewControllers:url];
    }
    return YES;
}

3 如果是执行动作的逻辑，获取query，字符串处理，获取键值对，获取名称为"name"的key对应的字符串，字符串对比判断执行相应的动作
例如：

zqprojectmobile://project/action?name=back，
relativePath为/action，query为name=back，字符串处理后得到字典@{name:back},

代码：

- (void)jumpActions:(NSURL *)url
{
    //dictionaryFromQueryComponents为字符串处理方法，处理query得到字典
    NSDictionary *dictionaryQuery = [[url query] dictionaryFromQueryComponents];
    NSString *actionName = [dictionaryQuery objectForKey:@"name"];

    // 返回前面的页面
    if ([actionName isEqualToString:@"back"])
    {
        //返回上一个页面的动作
    }

4 如果是执行跳转页面的逻辑，可以直接将要跳转的页面设置为relativePath的值，然后获取relativePath字符串进行对比跳转相应的页面。如果页面跳转需要传值可以放到query里，获取url的query，字符串处理，获取键值对，一一赋值，例如：

zqprojectmobile://project/order?order_id=42347645&type=2
relativePath为/order，跳转到订单详情页面
query为order_id=42347645&type=2，字符串处理获取字典@{order_id:42347645,type:2},订单详情页面的订单id为order_id对应的值42347645，订单类型为2

代码：

- (void)jumpNativeViewControllers:(NSURL *)url
{
    NSString *relativePath = [url relativePath];

    if ([relativePath isEqualToString:@"/order"])
    {
        [self jumpOrder:url];
    }
}

- (void)jumpOrder:(NSURL *)url
{
    //dictionaryFromQueryComponents为字符串处理方法，处理query得到字典
    NSDictionary *dictionaryQuery = [[url query] dictionaryFromQueryComponents];
    NSString *orderId = [dictionaryQuery objectForKey:@"orderId"];
    NSString *type = [dictionaryQuery objectForKey:@"type"];
    // 创建新的订单页面并且传值
}

通过以上几步就可以定义出一个完整的scheme协议并且在JumpURLHandle类里完成解析

需要用到JumpURLHandle解析scheme的地方

1 APP端收到服务器端下发的PUSH通知栏消息和APP相互跳转时需要在AppDelegate里处理

// 废弃
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(id)annotation
{
    return [JumpURLHandle parseURL:url];
}
或者
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString*, id> *)options
{
    return [JumpURLHandle parseURL:url];
}

2 服务器下发跳转路径，客户端根据服务器下发跳转路径跳转相应的页面,在一个网络请求成功的回调方法或者block里拿到url，调用[JumpURLHandle parseURL:url];

3 H5页面点击锚点，根据锚点具体跳转路径APP端跳转具体的页面，在UIWebView的代理方法

- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType

中调用，
该回调方法返回YES时webView才继续加载页面，当我们通过scheme解析处理事件时就不需要再继续加载页面返回NO.
UIWebViewNavigationType的类型有：

UIWebViewNavigationTypeLinkClicked，用户触击了一个链接。
UIWebViewNavigationTypeFormSubmitted，用户提交了一个表单。
UIWebViewNavigationTypeBackForward，用户触击前进或返回按钮。
UIWebViewNavigationTypeReload，用户触击重新加载的按钮。
UIWebViewNavigationTypeFormResubmitted，用户重复提交表单
UIWebViewNavigationTypeOther，发生其它行为。
并且不能所有在webView上发生的动作都靠scheme协议解析解决，只有在webView发生用户点击事件或者其他行为时我们才根据request.url进一步判断是否需要scheme解析，代码如下：

-(BOOL)webView:(UIWebView *)webView
    shouldStartLoadWithRequest:(NSURLRequest *)request
                navigationType:(UIWebViewNavigationType)navigationType
{
    if (navigationType == UIWebViewNavigationTypeLinkClicked
        || navigationType == UIWebViewNavigationTypeOther)
    {
        if (([[request.URL scheme] isEqualToString:@"zqprojectmobile"])
            || ([[[request.URL scheme] lowercaseString] isEqualToString:@"zqprojectmobile"]))
        {
            [JumpURLHandle parseURL:request.URL];
            return NO;
        }
    }
    return YES;
}

URL Scheme笔记