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 목록에서 각 Target에 추가할 제품을 선택하고 Add Package를 클릭합니다.

   GuanceSDK: 메인 프로젝트 Target에 추가하며, iOS, tvOS, macOS를 지원합니다. macOS는 Alpha 버전입니다.

   GuanceWidgetExtension: iOS Widget Extension Target에만 추가합니다.

Package.swift 사용

프로젝트 자체가 Swift Package인 경우, SDK를 종속성으로 추가하려면 Package.swift에 dependencies를 추가합니다.

// 메인 프로젝트
dependencies: [
.package(url: "https://github.com/GuanceCloud/datakit-ios.git",
.upToNextMajor(from: "[latest_version]"))
]

Targets에 종속성을 추가합니다:

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 명령을 실행하고, XCFrameworks를 생성하기 위해 --use-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: 메인 프로젝트 Target에 추가하며, iOS, tvOS, macOS를 지원합니다. macOS는 Alpha 버전입니다.

   GuanceWidgetExtension: iOS Widget Extension Target에만 추가합니다.

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 이상 버전으로 업그레이드할 때는 마이그레이션 가이드를 참조하여 종속성 이름을 조정하세요.