시작하기

이 문서는 카카오디벨로퍼스에서 제공하는 iOS SDK(Kakao SDK for iOS) 사용 방법을 안내합니다.

준비

요구 사양

• Xcode 14.3 이상
• iOS 13.0 이상
• iOS Deployment Target 13.0 이상
• Swift 5.0 이상

참고: 외부 라이브러리 의존성

iOS SDK는 아래와 같은 외부 라이브러리를 사용합니다. iOS SDK 설치 시, 해당 외부 라이브러리가 자동으로 설치됩니다.

• iOS SDK: Alamofire
• ReactiveX iOS SDK: RxSwift, RxCocoa

플랫폼

앱 관리 페이지의 [앱] > [플랫폼 키] > [네이티브 앱 키]에서 iOS 앱 정보를 입력합니다. 이 설정은 iOS SDK로 카카오 API를 사용하려면 필수입니다. 자세한 안내는 네이티브 앱 키를 참고합니다.

샘플 앱

카카오디벨로퍼스는 iOS SDK의 주요 기능을 빠르게 확인할 수 있는 샘플 앱을 제공합니다. 샘플 앱으로 카카오 로그인, 카카오톡 공유 등 SDK 기능을 직접 테스트하고, 구현 예제 코드를 확인할 수 있습니다.

사용 방법

iOS SDK 샘플 앱을 실행하는 방법에 대해 안내합니다.

1. 다운로드에서 iOS SDK 샘플 앱을 다운로드 받습니다.
2. iOS SDK 샘플 앱은 tuist 기반 프로젝트입니다. 프로젝트 루트 경로에서 tuist install과 tuist generate 명령어를 차례로 실행해 의존성을 추가하고 Xcode 프로젝트를 생성합니다.
3. 샘플 앱을 실행해 iOS SDK의 주요 기능을 테스트하고, 구현 예제 코드를 확인할 수 있습니다.

프로젝트 설정

앱 실행 허용 목록

iOS 9.0 이상에서 iOS SDK로 카카오톡을 실행하려면 Info.plist 파일에 앱 실행 허용 목록(Allowlist)을 설정해야 합니다. 이 설정은 사용자 정보 보호를 위한 OS 정책에 따라 필요한 것으로, 자세한 내용은 Privacy and Your App을 참고합니다.

1. [Info] > [Custom iOS Target Properties]에 Array 타입 키(Key)인 Queried URL Schemes을 추가
2. 해당 키의 [Item]에 값으로 아래 문구 추가
   • kakaokompassauth: 카카오 로그인
   • kakaolink: 카카오톡 공유
   • kakaoplus: 카카오톡 채널

위 설정은 Info.plist 파일을 직접 수정해 적용할 수도 있습니다. 상세한 설정 값은 아래 예제를 참고합니다.

<key>LSApplicationQueriesSchemes</key>
  <array>
      <!-- 카카오톡으로 로그인 -->
      <string>kakaokompassauth</string>
      <!-- 카카오톡 공유 -->
      <string>kakaolink</string>
      <!-- 카카오톡 채널 -->
      <string>kakaoplus</string>
  </array>

커스텀 URL 스킴

서비스 앱 실행을 위해 커스텀 URL 스킴 설정을 합니다. [Info] > [URL Types] > [URL Schemes] 항목에 네이티브 앱 키(Native App Key)를 kakao${NATIVE_APP_KEY} 형식으로 등록합니다. 예를 들어 네이티브 앱 키가 "123456789"라면 [URL Schemes]에 "kakao123456789"를 입력합니다.

이 설정은 커스텀 URL 스킴 생성 시 사용됩니다. 커스텀 URL 스킴은 카카오톡으로 로그인 후 서비스 앱으로 돌아오거나, 카카오톡 공유 메시지로 서비스 앱을 실행할 때 사용하며 각각 아래와 같은 형식입니다.

• 카카오 로그인: kakao${NATIVE_APP_KEY}://oauth
• 카카오톡 공유: kakao${NATIVE_APP_KEY}://kakaolink

설치

SPM으로 설치

SPM(Swift Package Manager)로 iOS SDK를 설치할 수 있습니다.

1. 패키지 추가 화면 띄우기

➊ [Project Target] > ➋ [Package Dependencies] > ➌ [Packages]의 [+]를 눌러 패키지 추가 화면을 엽니다.

2. 레포지토리 검색

패키지 추가 화면 우측 상단의 ➍ 검색창에 설치할 iOS SDK의 레포지토리(Repository) URL를 입력해 검색합니다.

검색된 레포지토리 이름이 올바른지 확인한 후, ➎ [Dependency Rule]을 브랜치(Branch)로 선택합니다. 브랜치 이름을 master로 입력하고 ➏ [Add Packages]를 누릅니다.

참고: 특정 버전을 지정하여 설치하는 방법

[Dependency Rule] 설정으로 iOS SDK의 특정 버전을 지정하여 설치할 수 있습니다. 단, SPM으로 설치는 2.8.5 이상 버전에서만 제공하므로, 그 이하 버전은 지정 설치가 불가능합니다.

3. 모듈 선택 및 설치

설치할 수 있는 패키지 목록 화면이 나타납니다. ➐[Package Product] 목록에서 필요한 모듈에 체크하고 ➑[Add Packages] 버튼을 눌러 설치합니다. 한 번에 모든 모듈을 설치하려면 [KakaoSDK] 또는 [RxKakaoSDK]를 선택합니다.

설치된 iOS SDK는 아래와 같이 [Packages] 메뉴에서 확인할 수 있습니다.

참고: 타겟 선택

iOS SDK는 타겟별로 각각 설치해야 합니다. 테스트 앱에도 iOS SDK를 설치하려면 Step 3의 모듈 선택 시 [Add to Target]을 테스트 앱으로 설정합니다.

4. 리소스 번들 설정하기

SPM으로 KakaoSDKFriend, RxKakaoSDKFriend 모듈 설치 시, 피커에 사용되는 UI 요소 등 리소스 번들을 별도 설치해야 합니다. KakaoSDKFriendResources.bundle 파일을 [Build Phase] > [Copy Bundle Resources]에 [+] 버튼 클릭 또는 드래그앤드롭하여 추가합니다.

모듈 임포트

iOS 앱의 각 파일에서 iOS SDK를 사용하려면 필요한 모듈의 파일을 임포트(import)해야 합니다. 제품별로 임포트해야 하는 모듈은 아래와 같습니다.

// iOS SDK
import KakaoSDKCommon

// ReactiveX iOS SDK
import KakaoSDKCommon
import RxKakaoSDKCommon

// iOS SDK
import KakaoSDKCommon
import KakaoSDKAuth
import KakaoSDKUser

// ReactiveX iOS SDK
import KakaoSDKCommon
import KakaoSDKAuth
import KakaoSDKUser
import RxKakaoSDKCommon
import RxKakaoSDKAuth
import RxKakaoSDKUser

// iOS SDK
import KakaoSDKShare
import KakaoSDKTemplate    // 기본 템플릿 사용 시

// ReactiveX iOS SDK
import KakaoSDKShare
import KakaoSDKTemplate    // 기본 템플릿 사용 시
import RxKakaoSDKShare

// iOS SDK
import KakaoSDKAuth
import KakaoSDKUser
import KakaoSDKTalk
import KakaoSDKFriend    // 피커 사용 시

// ReactiveX iOS SDK
import KakaoSDKAuth
import KakaoSDKUser
import KakaoSDKTalk
import KakaoSDKFriend      // 피커 사용 시
import RxKakaoSDKAuth
import RxKakaoSDKUser
import RxKakaoSDKTalk
import RxKakaoSDKFriend    // 피커 사용 시

// iOS SDK
import KakaoSDKTalk
import KakaoSDKUser    // 카카오톡 채널 관계 조회 API 사용 시

// ReactiveX iOS SDK
import KakaoSDKTalk
import KakaoSDKUser    // 카카오톡 채널 관계 조회 API 사용 시
import RxKakaoSDKTalk
import RxKakaoSDKUser    // 카카오톡 채널 관계 조회 API 사용 시

import KakaoSDKNavi

초기화

iOS 앱에서 iOS SDK를 사용하려면, 아래와 같이 iOS SDK를 임포트(import) 후 네이티브 앱 키를 사용해 initSDK() 메서드로 iOS SDK를 초기화해야 합니다. AppDelegate.swift에 Kakao SDK를 초기화하는 코드를 추가합니다.

SwiftUI App Life Cycle 사용 시에는 프로젝트와 함께 생성되는 ${PROJECT_NAME}App 클래스가 AppDelegate.swift를 대신하므로, 해당 클래스 내부에 Kakao SDK 초기화 코드를 추가합니다.

import KakaoSDKCommon

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

  ...
  KakaoSDK.initSDK(appKey: "${NATIVE_APP_KEY}")
  ...

}

import RxKakaoSDKCommon

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

  ...
  RxKakaoSDK.initSDK(appKey: "${NATIVE_APP_KEY}")
  ...

}

import SwiftUI
import KakaoSDKCommon
import KakaoSDKAuth
...

@main
struct SwiftUI_testApp: App {

    ...
    init() {
        // Kakao SDK 초기화
        KakaoSDK.initSDK(appKey: "NATIVE_APP_KEY")
    }
    ...

}

모듈 정보

제공 모듈과 주요 기능

iOS SDK가 제공하는 모듈과 주요 기능은 아래와 같습니다.

모듈간 의존성

Kakao SDK의 일부 모듈은 다른 모듈에 의존성이 있으며, 각 모듈은 설치 시 의존하는 모듈을 자동으로 함께 설치합니다. 모듈간 의존성 구조는 아래 이미지를 참고합니다.