【Swift】カスタムURLスキームの設定方法と特定のアプリ内画面に遷移させる方法について徹底解説！

2024年3月8日2024年4月2日

ふくしま

こんにちは！株式会社メモリアインクのふくしまです！

この記事では、Swift 5.9とXcode 15を使用して、アプリ内の特定の画面にディープリンクを通じて遷移する方法について、サンプルコードを示しながら解説します。

この記事を読んで分かること…
・カスタムURLスキームとは？
・カスタムURLスキームの基本設定方法
・カスタムURLスキームを利用して特定のアプリ内画面に遷移させる具体的な実装方法

カスタムURLスキームとは

カスタムURLスキームは、アプリケーションが独自に定義するURLスキームで、ユーザーをアプリの特定のコンテンツや画面へ直接案内するために使用されます。これにより、アプリ外部からのリンクを通じてアプリ内の特定の画面を開くことが可能になります。

カスタムURLスキームの実装

ステップ１：info.plistの設定

XcodeプロジェクトのInfoタブを開き、「URL Types」セクションに新しいURLスキームを追加します。例えば、myappというスキームを追加する場合、URL Schemesにmyappを入力します。

ステップ２：遷移先の画面を用意

今回は例としてViewControllerとSecondViewControllerの２画面用意をします。
各々の画面とViewController、SecondViewControllerが紐づいていること確認してください。
また、各画面のStoryboard IDが設定されているかも確認してください。

ステップ３：SceneDelegateの編集

プロジェクト作成時にすでにあるSceneDelegate.swiftファイルを編集して、ディープリンクからの情報を処理するコードを追加します。

サンプルコード

import UIKit

class SceneDelegate: UIResponder, UIWindowSceneDelegate {

    var window: UIWindow?

　　・・・
    
    func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
            guard let url = URLContexts.first?.url else {
                return
            }
            handleDeepLinkURL(url)
        }
    private func handleDeepLinkURL(_ url: URL) {
        let urlString = url.absoluteString
        
        if urlString == "myapp://top" {
            navigateToTopViewController()
        }
        
        if urlString == "myapp://second" {
            navigateToSecondViewController()
        }
        
    }
    private func navigateToTopViewController() {
        // UIWindowSceneとそのrootViewControllerを取得します
        guard let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene,
              let rootViewController = windowScene.windows.first?.rootViewController else {
            return
        }
    }
        
    private func navigateToSecondViewController() {
        // StoryboardからSecondViewControllerをインスタンス化
        let storyboard = UIStoryboard(name: "Main", bundle: nil)
        guard let secondViewController = storyboard.instantiateViewController(withIdentifier: "SecondViewControllerID") as? SecondViewController else {
            return
        }
        
        // UINavigationControllerを取得して遷移
        if let navigationController = window?.rootViewController as? UINavigationController {
            navigationController.pushViewController(secondViewController, animated: true)
        } else {
            // UINavigationControllerがrootViewControllerではない場合の対応
            // 例: rootViewControllerをUINavigationControllerに置き換える
            let navigationController = UINavigationController(rootViewController: secondViewController)
            window?.rootViewController = navigationController
            window?.makeKeyAndVisible()
        }
    }

    ・・・
}

サンプルコードの説明

・９行目：
scene(_:openURLContexts:)メソッドは、アプリが外部からのURLを介して開かれた際に呼び出されます。
・１０−１２行目：
guard文を使って、受け取ったURLの集合URLContextsから最初のURLを安全に取り出します。URLが存在しない場合は、メソッドから直ちに抜けます。
・１３行目：
取得したURLをhandleDeepLinkURLメソッドに渡して処理します。
・１５行目：
handleDeepLinkURLメソッドは、受け取ったURLに基づいて適切な画面遷移を行います
・１６行目：
URLを文字列形式に変換します。
・１８−２４行目：
文字列形式のURLを確認し、それがmyapp://topまたはmyapp://secondと一致する場合、それぞれnavigateToTopViewControllerまたはnavigateToSecondViewControllerメソッドを呼び出します。
・２７−３３行目：
navigateToTopViewControllerメソッドは、myapp://top からアプリが立ち上がった場合にアプリのトップ画面に遷移させるためのメソッドです。
UIApplication.shared.connectedScenesから最初のシーンを取得しようと試みます。
取得したシーンがUIWindowSceneのインスタンスであるかどうかをチェックし、そうであればそのシーンをwindowSceneに代入します。
取得したwindowSceneのwindowsコレクションの最初のウィンドウから、rootViewControllerを取得します。これはアプリケーションの最初の画面（ルートビューコントローラー）を指します。
guard文の条件のいずれかが満たされない場合（つまり、適切なUIWindowSceneが見つからない、またはルートビューコントローラーが存在しない場合）、この時点で処理を中断し、return文によってメソッドから抜け出します。
・３５−５２行目：
navigateToSecondViewControllerメソッドは、myapp://second からアプリが立ち上がった場合にSecondViewControllerへの遷移を担います。
・３７行目：
UIStoryboardクラスのインスタンスを作成します。このインスタンスは、アプリのメインStoryboardを表します（”Main”はStoryboardのファイル名）。
・３８−４０行目：
Storyboard上で指定した識別子（”SecondViewControllerID”）を使用してSecondViewControllerのインスタンスを生成し、その型をSecondViewControllerにキャストします。この処理が失敗した場合（つまり、インスタンス化できないか、キャストに失敗した場合）、メソッドはここで終了します。
・４３−４５行目：
アプリのwindowのrootViewControllerがUINavigationControllerのインスタンスであるか確認します。もし条件がtrue（つまり、ルートビューコントローラーがナビゲーションコントローラーである）ならば、SecondViewControllerをナビゲーションスタックにプッシュします。
・４５−５２行目：
もしアプリのルートビューコントローラーがUINavigationControllerのインスタンスではない場合（例えば、最初からナビゲーションコントローラーが組み込まれていない場合）、新しくUINavigationControllerのインスタンスを作成し、そのルートビューコントローラーとしてSecondViewControllerを設定します。そして、アプリのwindowのrootViewControllerをこの新しいナビゲーションコントローラーに置き換え、makeKeyAndVisibleメソッドを呼び出してウィンドウを表示状態にします。