iOS/tvOS/macOS アプリケーションの統合¶

Xcode UI を使用する場合

1. Xcode で File -> Add Package Dependency... を選択します。

2. 表示されたページの検索ボックスに https://github.com/GuanceCloud/datakit-ios.git を入力します。

3. Xcode がパッケージを解析したら、依存バージョンルールを選択します。Up to Next Major Version を推奨します。

   追加先のプロジェクトを選択し、Add Package をクリックして、読み込みが完了するまで待ちます。

4. パッケージの解析が完了したら、Package Products リストで各ターゲットに追加する製品を選択し、Add Package をクリックします。

   GuanceSDK：メインプロジェクトのターゲットに追加します。iOS、tvOS、macOS をサポートします。macOS は Alpha バージョンです。

   GuanceWidgetExtension：iOS Widget Extension ターゲットにのみ追加します。

Package.swift を使用する場合

プロジェクト自体が Swift Package である場合、SDK を依存関係として追加するには、Package.swift の dependencies に追加します。

// メインプロジェクト
dependencies: [
.package(url: "https://github.com/GuanceCloud/datakit-ios.git",
.upToNextMajor(from: "[latest_version]"))
]

ターゲットに依存関係を追加します。

targets: [
    .target(
        name: "YourTarget",
        dependencies: [
            .product(name: "GuanceSDK", package: "GuanceSDK"),
        ]),
    .target(
        name: "YourWidgetExtensionTarget",
        dependencies: [
            .product(name: "GuanceWidgetExtension", package: "GuanceSDK"),
        ]),
    ]

注意：1.4.0-beta.1 以降で Swift Package Manager をサポートしています。SDK 1.6.6 以降では、SPM の製品名が GuanceSDK、GuanceWidgetExtension、GuanceSessionReplay に変更されています。旧製品名からの移行については、移行ガイド を参照してください。

1. Cartfile ファイルを設定します。

   github "GuanceCloud/datakit-ios" == [latest_version]
   

2. 依存関係を更新します。

   ターゲットプラットフォーム（iOS、tvOS、macOS）に応じて、対応する carthage update コマンドを実行し、--use-xcframeworks パラメータを追加して XCFrameworks を生成します。

   • iOS プラットフォームの場合：

     carthage update --platform iOS --use-xcframeworks
     

   • tvOS プラットフォームの場合：

     carthage update --platform tvOS --use-xcframeworks
     

   • macOS プラットフォームの場合：

     carthage update --platform macOS --use-xcframeworks
     

   生成された xcframework は、通常の Framework と同じ方法で使用します。コンパイルされたライブラリをプロジェクトに追加します。

   GuanceSDK：メインプロジェクトのターゲットに追加します。iOS、tvOS、macOS をサポートします。macOS は Alpha バージョンです。

   GuanceWidgetExtension：iOS ウィジェット Widget Extension ターゲットにのみ追加します。

3. TARGETS -> Build Setting -> Other Linker Flags に -ObjC を追加します。

4. Carthage を使用した統合における SDK バージョンサポート：

   GuanceSDK：>=1.6.6

   GuanceWidgetExtension：>=1.6.6

1. Podfile ファイルを設定します。

   • Dynamic Library を使用する場合

     use_frameworks!
     def shared_pods
       pod 'GuanceSDK', '[latest_version]'
       # Widget Extension データを収集する場合
       pod 'GuanceSDK/WidgetExtension', '[latest_version]'
     end
     
     # メインプロジェクト
     target 'yourProjectName' do
       shared_pods
     end
     
     # Widget Extension
     target 'yourWidgetExtensionName' do
       shared_pods
     end
     

   • Static Library を使用する場合

     use_modular_headers!
     # メインプロジェクト
     target 'yourProjectName' do
       pod 'GuanceSDK', '[latest_version]'
     end
     # Widget Extension
     target 'yourWidgetExtensionName' do
       pod 'GuanceSDK/WidgetExtension', '[latest_version]'
     end
     

   • コードベースをローカルにダウンロードして使用する

     Podfile ファイル：

     use_modular_headers!
     # メインプロジェクト
     target 'yourProjectName' do
       pod 'GuanceSDK', :path => '[folder_path]'
     end
     # Widget Extension
     target 'yourWidgetExtensionName' do
       pod 'GuanceSDK/WidgetExtension', :path => '[folder_path]'
     end
     

     folder_path：GuanceSDK.podspec が配置されているフォルダのパスです。

     GuanceSDK.podspec ファイル：

     GuanceSDK.podspec ファイル内の s.version と s.source を変更します。

     Pod::Spec.new do |s|
       s.name         = "GuanceSDK"
       s.version      = "[latest_version]"
     s.source       = { :git => "https://github.com/GuanceCloud/datakit-ios.git", :tag => s.version }
     end
     

     s.version：指定されたバージョンに変更します。Sources/Agent/Core/FTSDKVersion.h の SDK_VERSION と一致させることを推奨します。

     s.source：tag => s.version

Widget Extension の互換性のある記述方法：

SDK 1.6.6 以降では、GuanceSDK/WidgetExtension の使用を推奨します。以前のプロジェクトで pod 'FTMobileSDK', :subspecs => ['Extension'] を使用していた場合、GuanceSDK にアップグレード後も、互換性のある subspec を引き続き使用できます。

target 'yourWidgetExtensionName' do
  pod 'GuanceSDK', :subspecs => ['Extension']
end

1. Podfile ディレクトリで pod install を実行して SDK をインストールします。

互換性に関する注意：SDK 1.6.6 以降では、メイン Pod 名が GuanceSDK に変更されています。古い FTMobileSDK を使用した統合方法は、1.6.6 以前のバージョンに対応しています。1.6.6 以降にアップグレードする場合は、移行ガイド を参照して依存関係名を変更してください。