3단계. 모듈 설치

모듈 설치는 앱에서 사용할 제품 모듈을 Unity 프로젝트 의존성에 추가하는 작업입니다. Hive Axyl SDK는 필요한 기능만 선택해 설치하는 구조입니다.

1. 공통 모듈 선택

Hive Axyl 사용에 필요한 최소 공통 모듈을 선택합니다.

• com.com2usplatform.hiveaxyl.core: SDK를 시작할 때 호출하는 초기화와 다른 모듈이 공통으로 사용하는 기본 기능을 제공하는 모듈

2. 인증 기능을 위한 모듈 선택

게스트 로그인과 유저네임 로그인, 로그아웃, 계정 삭제에는 아래 모듈이 필요합니다.

• com.com2usplatform.hiveaxyl.auth: 계정 생성과 로그인에 필요한 모듈
• com.com2usplatform.hiveaxyl.storage: 저장한 토큰을 지우는 로그아웃과 계정 삭제에 필요한 모듈

com.com2usplatform.hiveaxyl.storage는 앱에서 지정한 값을 사용자 기기에 저장하고 필요할 때 다시 불러오는 기능을 제공합니다. 자동 로그인처럼 로그인 세션 정보를 기기에 유지할 때 사용하며, 로그아웃과 계정 삭제에서 저장해 둔 토큰을 지울 때도 필요합니다.

Note

com.com2usplatform.hiveaxyl.storage는 Android, iOS, macOS, Windows 플레이어 빌드에서 동작합니다. 플레이어 빌드는 Unity 에디터가 아니라 빌드해서 실행하는 실제 앱입니다. Unity 에디터에서는 기기 보안 저장소가 없으므로 저장소 기능이 등록되지 않습니다. 자세한 내용은 보안 저장소 모듈 등록을 참조하세요.

3. 모듈 설치

SDK 설치에서 Hive Axyl 레지스트리를 등록한 Unity 프로젝트에 앞에서 고른 모듈을 추가합니다. 시작하기에서는 로그인, 로그아웃, 계정 삭제만 안내하므로 com.com2usplatform.hiveaxyl.core, com.com2usplatform.hiveaxyl.auth, com.com2usplatform.hiveaxyl.storage 세 개를 설치합니다.

모듈을 추가하는 방법은 두 가지입니다. 둘 중 하나만 사용하세요.

• 방법 1: Unity 에디터에서 모듈 설치: Unity 에디터의 Package Manager에서 작업
• 방법 2: Packages/manifest.json에 모듈 추가: 텍스트 편집기로 여는 Packages/manifest.json에서 작업

모든 Hive Axyl 패키지는 같은 버전을 사용합니다. 버전 규칙을 참조하세요.

방법 1: Unity 에디터에서 모듈 설치

Package Manager 목록에서 인증 모듈과 저장소 모듈을 찾아 설치합니다.

1. Unity 에디터에서 Window > Package Manager를 여세요.
2. 왼쪽 목록에서 My Registries > Hive Axyl을 선택하세요.
3. com.com2usplatform.hiveaxyl.auth를 선택하고 Install을 선택하세요.
4. 같은 방법으로 com.com2usplatform.hiveaxyl.storage를 설치하세요.

com.com2usplatform.hiveaxyl.core는 두 모듈이 의존성으로 요구하므로 목록에서 따로 선택하지 않아도 함께 설치됩니다.

방법 2: Packages/manifest.json에 모듈 추가

Unity 프로젝트의 Packages/manifest.json을 텍스트 편집기로 열고 dependencies에 com.com2usplatform.hiveaxyl.core, com.com2usplatform.hiveaxyl.auth, com.com2usplatform.hiveaxyl.storage를 추가합니다.

manifest.json

{
"scopedRegistries": [
    {
    "name": "Hive Axyl",
    "url": "https://package.openupm.com",
    "scopes": [
        "com.com2usplatform.hiveaxyl"
    ]
    }
],
"dependencies": {
    "com.com2usplatform.hiveaxyl.core": "1.0.0",
    "com.com2usplatform.hiveaxyl.auth": "1.0.0",
    "com.com2usplatform.hiveaxyl.storage": "1.0.0"
}
}

Note

com.com2usplatform.hiveaxyl.auth와 com.com2usplatform.hiveaxyl.storage는 com.com2usplatform.hiveaxyl.core를 의존성으로 요구하므로, dependencies에 com.com2usplatform.hiveaxyl.core를 적지 않아도 UPM이 레지스트리에서 함께 내려받습니다. 위 예시는 어떤 패키지가 설치되는지 명시하기 위해 com.com2usplatform.hiveaxyl.core를 함께 적었습니다.

실제 서비스에서 설치할 모듈

실제 서비스에서는 앱에서 사용할 기능 모듈을 모두 설치해야 합니다. 인증, 결제, 우편함, 서비스 접근 제어, 애널리틱스 기능을 함께 사용하는 앱은 Packages/manifest.json에 아래 의존성을 추가합니다.

manifest.json

{
"scopedRegistries": [
    {
    "name": "Hive Axyl",
    "url": "https://package.openupm.com",
    "scopes": [
        "com.com2usplatform.hiveaxyl"
    ]
    }
],
"dependencies": {
    "com.com2usplatform.hiveaxyl.core": "1.0.0",
    "com.com2usplatform.hiveaxyl.auth": "1.0.0",
    "com.com2usplatform.hiveaxyl.storage": "1.0.0",
    "com.com2usplatform.hiveaxyl.payments": "1.0.0",
    "com.com2usplatform.hiveaxyl.mailbox": "1.0.0",
    "com.com2usplatform.hiveaxyl.serviceaccess": "1.0.0",
    "com.com2usplatform.hiveaxyl.analytics": "1.0.0"
}
}

Add-on을 사용할 때 함께 설치할 모듈

Hive Axyl 패키지는 기능 모듈과 Add-on으로 나뉘며, Add-on만 설치하면 오류 없이 설치가 끝나고도 기능이 동작하지 않습니다.

패키지 종류	역할	예시
기능 모듈	인증, 결제처럼 기능 전체를 담당합니다.	인증 모듈 com.com2usplatform.hiveaxyl.auth
Add-on	기능 모듈이 제공하는 기능을 특정 플랫폼이나 외부 서비스에 연결합니다.	Apple 로그인 Add-on com.com2usplatform.hiveaxyl.auth.addon.apple

예를 들어 Apple 로그인 Add-on인 com.com2usplatform.hiveaxyl.auth.addon.apple은 인증 모듈 com.com2usplatform.hiveaxyl.auth가 제공하는 로그인에 Apple 계정을 연결합니다. 이처럼 Add-on 이름은 그 Add-on이 확장하는 기능 모듈 이름으로 시작합니다.

Add-on은 SDK 공통 모듈인 com.com2usplatform.hiveaxyl.core를 의존성으로 요구하지만, 그 Add-on이 확장하는 기능 모듈은 의존성에 들어 있지 않습니다. 따라서 Add-on만 설치하면 기능 모듈이 빠진 채로 설치가 끝나고, 컴파일과 빌드도 오류 없이 끝납니다. 앱을 실행해 해당 기능이 동작하지 않을 때에야 모듈이 빠진 것을 확인합니다. Add-on을 사용할 때는 그 Add-on이 확장하는 기능 모듈을 함께 설치하세요.

manifest.json

{
"dependencies": {
    "com.com2usplatform.hiveaxyl.auth": "1.0.0",
    "com.com2usplatform.hiveaxyl.auth.addon.apple": "1.0.0"
}
}

Add-on을 제외하면 앱에서 직접 사용하는 패키지만 설치하면 됩니다. 나머지는 의존성으로 함께 설치됩니다.

시작하기에서 안내하는 게스트 로그인과 유저네임 로그인에는 Add-on이 필요하지 않습니다. 기능별로 어떤 Add-on이 필요한지는 아래에서 확인하세요.

• 로그인: 로그인 수단별로 필요하며, 수단별 Add-on은 모듈 설치 및 초기화를 참조하세요.
• 결제: 스토어별로 필요하며, 스토어별 Add-on은 결제를 참조하세요.
• 푸시 알림: 알림 수신 방식별로 필요하며, 방식별 Add-on은 푸시 알림을 참조하세요.
• 저장소, 우편함, 서비스 접근 제어, 애널리틱스: Add-on 없이 기능 모듈만 설치

4. 설치 확인

설치한 SDK와 인증 모듈의 네임스페이스를 using 구문에서 정상적으로 인식하는지 확인합니다.

Unity

using Hive.Axyl.Core;
using Hive.Axyl.Auth;
using Hive.Axyl.Storage;

Unity 에디터를 열지 않고 확인하려면 Packages/packages-lock.json을 여세요. 설치한 각 Hive Axyl 패키지의 version이 모두 같은 값인지, source가 registry인지 확인합니다. source가 registry가 아니면 Git URL이나 로컬 경로처럼 레지스트리 밖에서 가져온 패키지입니다.

아래 항목을 모두 만족하면 설치 단계가 완료됩니다.

• Unity Package Manager에서 설치한 모듈이 Installed 상태로 표시
• Packages/packages-lock.json에서 설치한 모듈의 source가 registry로 표시
• 위 using 구문에서 컴파일 오류가 발생하지 않음
• 이후 단계의 초기화 코드(HiveBootstrap.Initialize)를 추가할 준비가 완료

Note

실제 서비스 환경에서 인증 외에 결제, 푸시 등 여러 기능을 사용하려면, 사용하려는 모듈을 모두 설치한 후에 설치 확인을 합니다.

다음 단계

Hive Axyl SDK 초기화를 실행해 SDK를 초기화합니다.