Swiftでトラッキングコードをどこからでも呼び出せるようにする方法

markdown

はじめに (対象読者・この記事でわかること)

この記事は、iOSアプリ開発でアナリティクスツール（Firebase Analyticsや独自のトラッキング）を導入したい開発者を対象にしています。特に、複数の画面やクラスからトラッキングコードを呼び出したいけど、どこに実装すればいいか迷っている方に向けています。

この記事を読むことで、Swiftでトラッキングコードを一元管理し、どこからでも簡単に呼び出せるようにする方法がわかります。シングルトンパターンを使った実装方法と、実際のコード例を通して、保守性の高いトラッキングシステムの作り方をマスターできます。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 - Swiftの基本的な文法 - iOSアプリ開発の基礎知識 - プロトコルと委譲の概念

なぜトラッキングコードを一元管理する必要があるのか

iOSアプリ開発において、ユーザー行動の分析は非常に重要です。しかし、トラッキングコードを各画面に散在させてしまうと、以下のような問題が発生します。

まず、コードの重複が増え、同じトラッキング処理を複数箇所で書くことになります。これはDRY（Don't Repeat Yourself）原則に反します。また、トラッキングロジックに変更があった場合、複数のファイルを修正する必要があり、メンテナンスが困難になります。

さらに、テストが困難になります。トラッキングコードが各画面に散在していると、単体テストを書く際にモック化するのが大変です。これらの問題を解決するため、トラッキングコードを一元管理する仕組みが必要です。

シングルトンパターンでトラッキングマネージャーを実装する

ここでは、シングルトンパターンを使ってトラッキングコードを一元管理する方法を詳しく解説します。シングルトンパターンは、クラスのインスタンスがアプリケーション内に1つしか存在しないことを保証するデザインパターンです。

ステップ1: トラッキングマネージャーの基本構造を作成

まず、トラッキングマネージャーの基本構造から始めましょう。

Swift

import Foundation

final class TrackingManager {
    // シングルトンインスタンス
    static let shared = TrackingManager()

    // プライベートイニシャライザで外部からのインスタンス化を防ぐ
    private init() {}

    // トラッキングイベントを送信するメソッド
    func track(event: String, parameters: [String: Any]? = nil) {
        // 実際のトラッキング処理をここに実装
        print("Tracking event: \(event)")
        if let parameters = parameters {
            print("Parameters: \(parameters)")
        }

        // Firebase Analyticsを使っている場合
        // Analytics.logEvent(event, parameters: parameters)
    }
}

この基本構造では、シングルトンとして実装し、アプリ内のどこからでも TrackingManager.shared.track() で呼び出せるようにしています。

ステップ2: イベントタイプを列挙型で管理

ハードコーディングされた文字列はバグの元です。列挙型を使ってイベントタイプを管理しましょう。

Swift

enum TrackingEvent: String {
    case appLaunched = "app_launched"
    case buttonTapped = "button_tapped"
    case screenViewed = "screen_viewed"
    case purchaseCompleted = "purchase_completed"

    var name: String {
        return rawValue
    }
}

extension TrackingManager {
    func track(event: TrackingEvent, parameters: [String: Any]? = nil) {
        track(event: event.name, parameters: parameters)
    }
}

これにより、イベント名のタイプミスを防げます。

ステップ3: ユーザープロパティの管理

トラッキングには、ユーザーの属性情報も重要です。ユーザープロパティを管理する機能を追加しましょう。

Swift

final class TrackingManager {
    static let shared = TrackingManager()

    private var userProperties: [String: Any] = [:]

    private init() {}

    func setUserProperty(_ value: String, forKey key: String) {
        userProperties[key] = value

        // Firebase Analyticsの場合
        // Analytics.setUserProperty(value, forName: key)
    }

    func track(event: TrackingEvent, parameters: [String: Any]? = nil) {
        var mergedParameters = userProperties
        if let parameters = parameters {
            mergedParameters.merge(parameters) { _, new in new }
        }

        print("Tracking event: \(event.name)")
        print("Parameters: \(mergedParameters)")
    }
}

ステップ4: 非同期処理とエラーハンドリング

実際のトラッキング処理は非同期で行われることが多いです。エラーハンドリングも実装しましょう。

Swift

final class TrackingManager {
    static let shared = TrackingManager()

    private var userProperties: [String: Any] = [:]
    private let queue = DispatchQueue(label: "tracking.queue", qos: .background)

    private init() {}

    func setUserProperty(_ value: String, forKey key: String) {
        queue.async { [weak self] in
            self?.userProperties[key] = value
            // 実際のトラッキングサービスに送信
        }
    }

    func track(event: TrackingEvent, parameters: [String: Any]? = nil) {
        queue.async { [weak self] in
            guard let self = self else { return }

            var mergedParameters = self.userProperties
            if let parameters = parameters {
                mergedParameters.merge(parameters) { _, new in new }
            }

            do {
                try self.sendTrackingEvent(event: event, parameters: mergedParameters)
            } catch {
                print("Tracking error: \(error)")
                // エラーログを送信したり、リトライ処理を実装
            }
        }
    }

    private func sendTrackingEvent(event: TrackingEvent, parameters: [String: Any]) throws {
        // 実際のトラッキング送信処理
        // エラーが発生した場合はthrowする
    }
}

ステップ5: 実際の使用例

実際にアプリで使う場合の例を見てみましょう。

Swift

// AppDelegateで初期化
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, 
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        // ユーザープロパティを設定
        TrackingManager.shared.setUserProperty("premium", forKey: "user_type")
        TrackingManager.shared.setUserProperty("1.0.0", forKey: "app_version")

        // アプリ起動イベント
        TrackingManager.shared.track(event: .appLaunched)

        return true
    }
}

// 各画面でトラッキング
class HomeViewController: UIViewController {
    override func viewDidAppear(_ animated: Bool) {
        super.viewDidAppear(animated)

        TrackingManager.shared.track(event: .screenViewed, 
                                   parameters: ["screen_name": "home"])
    }

    @IBAction func purchaseButtonTapped(_ sender: UIButton) {
        TrackingManager.shared.track(event: .buttonTapped, 
                                   parameters: ["button_name": "purchase"])
    }
}

ハマった点やエラー解決

実装中に遭遇する代表的な問題をいくつか紹介します。

問題1: メモリリーク シングルトンでクロージャを使う際に、循環参照が発生することがあります。

Swift

// ❌ 良くない例
queue.async {
    self.userProperties[key] = value // selfの強参照
}

// ✅ 正しい例
queue.async { [weak self] in
    self?.userProperties[key] = value
}

問題2: テストが困難 シングルトンはテストが難しいと言われますが、プロトコルを使うことで解決できます。

Swift

protocol TrackingManagerProtocol {
    func track(event: TrackingEvent, parameters: [String: Any]?)
    func setUserProperty(_ value: String, forKey key: String)
}

final class TrackingManager: TrackingManagerProtocol {
    static let shared: TrackingManagerProtocol = TrackingManager()
    // ... 実装
}

// テスト用のモック
class MockTrackingManager: TrackingManagerProtocol {
    var trackedEvents: [(event: TrackingEvent, parameters: [String: Any]?)] = []

    func track(event: TrackingEvent, parameters: [String: Any]?) {
        trackedEvents.append((event, parameters))
    }

    func setUserProperty(_ value: String, forKey key: String) {
        // モック実装
    }
}

解決策

上記の問題に対する解決策として、以下の実装パターンを推奨します：

プロトコルベースの設計: シングルトンもプロトコルに準拠させることで、テスト時にモックに置き換え可能にする
Dependency Injection: 本番コードではシングルトンを、テスト時はモックを注入する
エラーハンドリングの充実: ネットワークエラーなど、トラッキング失敗時の適切な処理
バッチ処理: 大量のトラッキングイベントを効率的に処理するため、バッチで送信する仕組み

まとめ

本記事では、Swiftでトラッキングコードを一元管理し、どこからでも呼び出せるようにする方法を解説しました。

シングルトンパターンを使ったトラッキングマネージャーの実装方法
列挙型によるイベントタイプの安全管理
非同期処理とエラーハンドリングの実装
テスタビリティを考慮したプロトコルベースの設計

この記事を通して、保守性の高く、テスト可能なトラッキングシステムの作り方が身についたことでしょう。今後は、SwiftUIでの実装や、複数のアナリティクスサービスを切り替える仕組みについても記事にする予定です。

Swiftでトラッキングコードをどこからでも呼び出せるようにする方法📊