iOSアプリ間連携の実装に x-callback-url を使う - クックパッド開発者ブログ

はじめに

モバイルファースト室の @slightair です。クックパッドが提供しているiOSアプリには、連携して機能するものがあります。

買い物リストアプリを例に挙げると、クックパッドアプリのレシピ画面からレシピに使われている材料を買い物リストアプリに登録することができます。

f:id:Slightair:20141113101333p:plain

この機能は、x-callback-url という仕様に沿って実装しています。 x-callback-url は別のアプリの呼び出しや情報の受け渡しに使うカスタムURLスキームの形式を定義するものです。この仕様に沿って実装することで、他のアプリから呼び出せる処理や必要なパラメータをきれいにまとめることができます。

この記事では x-callback-url を用いたアプリ間連携の実装について説明します。

カスタムURLスキーム

iOSアプリで他のアプリに遷移しつつなにかしらの情報を渡すにはカスタムURLスキームを使う事になると思います。遷移先のアプリでは叩かれたURLを受け取れるので、URLをパースして渡ってきた値を解釈したり、次にどのような処理をするか決めることができます。

どのような形式のURLを受け付けるかはアプリそれぞれで定義することになります。 URLで表現できるものであればなんでもよいのですが、ここで好き勝手に形式を決めてしまうと、よほどうまくやらない限りいつか破綻してしまうでしょう。

x-callback-url

クックパッドでは、アプリ間連携を x-callback-url という仕様に沿って実装しています。この仕様では、パラメータをURLに含める形式を定めています。 x-callback-url では、他のアプリに渡す値だけではなく、他のアプリに委譲した処理の結果を受け取るためのパラメータも決められています。

具体的には以下の様な形式です。

[scheme]://[host]/[action]?[x-callback parameters]&[action parameters]

action に遷移先のアプリに委譲したい処理名を、action parameters には action に必要なパラメータを指定します。 x-callback parameters には、遷移先のアプリで表示するために使う遷移元のアプリ名(x-source)、成功時に遷移元のアプリに戻るためのURL(x-success) などを指定します。詳しくは x-callback-url の仕様を読んでみてください。

x-callback-url は Google Chrome でも使われているようです。 https://developer.chrome.com/multidevice/ios/links#using-the-x-callback-url-registration-scheme

このページに書かれている仕様に沿ってアプリを実装すると、Webページを開く際にChromeを使い、ユーザがページの閲覧を終えたら元のアプリに戻ってくるような動きをさせることができます。

実装

x-callback-url の仕様に沿ったアプリ間連携を簡単に実装するためのライブラリ InterAppCommunication があります。クックパッドではこのライブラリをラップし、他のクックパッドのアプリの機能を簡単に呼び出せるようにして社内共通ライブラリに組み込んでいます。

呼び出し側の実装例

InterAppCommunication を使うと、他のアプリの機能を呼び出すときには以下のように書けます。

    IACClient *client = [IACClient clientWithURLScheme:@"url-scheme"];

    [client performAction:@"action"
               parameters:@{
                             ...
                            }
                onSuccess:^(NSDictionary *params) {
                    ...
                }
                onFailure:^(NSError *error){
                    ...
                }
     ];

受け側の実装例

application:didFinishLaunchingWithOptions: でcallbackURLSchemeとアクションに対応する処理を書くデリゲートをセットします。

    [IACManager sharedManager].callbackURLScheme = @"url-scheme";
    [IACManager sharedManager].delegate = <IACDelegateに準拠したクラスのインスタンス>;

application:openURL:sourceApplication:annotation: で IACManager のインスタンスメソッド handleOpenURL: を使い、呼び出された url をわたします。

    if ([[url scheme] isEqualToString:@"url-scheme"]) {
        return [[IACManager sharedManager] handleOpenURL:url];
    }

上記2つのコードは、呼び出し側で処理が終わった後に元のアプリに戻ってくる場合にも必要です。

IACManager の delegate に設定するインスタンスのクラスで supportsIACAction: と performIACAction:parameters:onSuccess:onFailure: を定義します。

- (BOOL)supportsIACAction:(NSString *)action
{
    NSArray *supportedActions = @[@"action1", @"action2", ...];
    return [supportedActions containsObject:action];
}

- (void)performIACAction:(NSString *)action
              parameters:(NSDictionary *)parameters
               onSuccess:(IACSuccessBlock)success
               onFailure:(IACFailureBlock)failure
{
    if ([action isEqualToString:@"action1"]){
        // action1 の処理
        // 結果に応じて success/failure block を呼ぶ
    }
    ...
}

ライブラリが x-callback-url の仕様に沿ったURLを解析して、パラメータやsuccess/failureブロックに展開してくれます。

おわりに

クックパッドで公開しているアプリのアプリ間連携の実装の話をしました。別のアプリに遷移して、再びアプリに戻るような動きがなかったとしても、x-callback-url のような仕様に合わせたほうがきれいに実装できます。自前でURLクエリをパースする処理を書いたり、独自の形式を考えるより楽だと思います。

スムーズなアプリ間連携を実装して、ユーザーに気持ちのよい体験を届けられるとうれしいですね。