콘텐츠로 이동

모듈 설치 및 초기화

Hive Axyl SDK에 TCB 모듈을 설치하고 초기화하는 방법을 안내합니다. 아직 Hive Axyl SDK를 설치하지 않았다면 먼저 Hive Axyl SDK를 설치하세요.

1. TCB 모듈 설치

아래 순서로 TCB 모듈을 Hive Axyl SDK에 설치합니다.

1.1. 공통 모듈 선택

Hive Axyl을 사용하기 위한 최소 기능인 공통 모듈을 선택합니다.

모듈 설명
com.hive.axyl.core SDK를 시작할 때 호출하는 초기화와 다른 모듈이 공통으로 사용하는 기본 기능을 제공합니다.

1.2. TCB Connector 사용을 위한 모듈 선택

Tencent CloudBase 콘솔에 등록한 Cloud Function을 호출하려면 다음 모듈을 선택합니다.

모듈 설명
com.hive.axyl.tcb Tencent CloudBase 콘솔에 등록한 Cloud Function을 실행하는 기능을 제공합니다.

1.3. 모듈 설치

모듈 설치 방법은 SDK 설치 방법과 기본적으로 동일합니다.

권장: Packages/manifest.json (Scoped Registry)

Packages/manifest.json을 사용한다면 dependencies에 com.hive.axyl.core와 com.hive.axyl.tcb를 함께 추가합니다.

{
  "scopedRegistries": [
    {
      "name": "Hive Axyl",
      "url": "PLACEHOLDER_AXYL_REGISTRY_URL",
      "scopes": [
        "com.hive.axyl"
      ]
    }
  ],
  "dependencies": {
    "com.hive.axyl.core": "PLACEHOLDER_AXYL_CORE_VERSION",
    "com.hive.axyl.tcb": "PLACEHOLDER_AXYL_TCB_VERSION"
  }
}

Git URL 직접 설치 방식

Git URL 방식이라면 ?path= 경로를 com.hive.axyl.tcb로 지정해 추가로 설치합니다.

PLACEHOLDER_AXYL_GIT_URL?path=PLACEHOLDER_PACKAGE_PATH/com.hive.axyl.tcb

1.4. 설치 확인

다음 코드는 설치한 SDK와 TCB 모듈의 네임스페이스가 정상적으로 인식되는지 확인하는 예시입니다.

using Hive.Axyl.Core;
using Hive.Axyl.Tcb;

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

  • Unity Package Manager에서 설치한 모듈이 Installed 상태로 표시됩니다.

2. SDK 초기화

Method

Initialize


Hive Axyl SDK 초기화는 앱이 Tencent CloudBase 기능을 사용하기 전에 한 번 거치는 준비 단계입니다. 앱을 시작할 때 초기화를 호출해 Tencent CloudBase 콘솔에 등록한 Cloud Function을 호출할 준비를 합니다.

앱을 시작할 때 한 번만 호출하며 다음 순서로 진행합니다.

  1. 앱 정보 생성에서 만든 App ID를 확인합니다.
  2. App ID를 가지고 CoreConfig.CreateBuilder를 실행해 CoreConfig 객체를 생성합니다.
    • SetZone을 실행해 개발 중에는 Zone.Sandbox, 실제 서비스에서는 Zone.Real을 지정합니다.
  3. HiveBootstrap.Initialize로 초기화를 실행합니다. builder에 AddTcb()를 등록합니다.
  4. 초기화 후 HiveCore.Resolve<ITcbService>()로 Tencent CloudBase 기능을 가져와 사용합니다.


호출 파라미터

필드명 타입 필수 여부 설명
config CoreConfig Required App ID와 접속 환경(Zone)을 담은 CoreConfig 객체입니다. CoreConfig.CreateBuilder로 생성합니다.
assemble 빌더 콜백 Required 사용할 기능 모듈을 등록하는 빌더 콜백입니다. Tencent CloudBase 기능을 사용하려면 builder.AddTcb()를 포함합니다.


호출 예시

using Hive.Axyl.Core;
using Hive.Axyl.Core.Unity; // HiveBootstrap
using Hive.Axyl.Tcb;         // AddTcb 확장

var config = CoreConfig.CreateBuilder("{appId}")
    .SetZone(Zone.Sandbox)   // 개발·테스트 환경. 상용 빌드는 Zone.Real
    .Build();

HiveBootstrap.Initialize(config, builder =>
{
    builder.AddTcb();
});

이미 다른 모듈을 초기화하고 있다면 같은 Initialize 호출에 AddTcb()만 추가하면 됩니다. 등록한 모듈은 이후 HiveCore.Resolve<ITcbService>()로 가져와 사용합니다.

TCB 모듈의 기본 AddTcb()는 TCB API 기본 운영 호스트를 등록합니다. TCB API 스펙에는 별도의 sandbox 호스트가 정의되어 있지 않으므로 sandbox 여부를 전달하는 AddTcb() 오버로드는 제공되지 않습니다. 별도 환경의 호스트를 직접 지정해야 하는 경우에만 AddTcb(baseUrl)을 사용합니다.

Note

TCB API 역시 다른 모듈과 같이 로그인 세션 정보가 필요합니다. 호출 전에 로그인과 세션 설정을 완료해야 합니다.


응답 데이터

성공 시 별도 반환 데이터가 없습니다.


응답 예시

ITcbService tcb = HiveCore.Resolve<ITcbService>();


응답 상태

코드에서 HiveCore.Resolve<ITcbService>()를 호출했을 때 예외가 발생하지 않고 TCB 모듈 핸들을 반환하면 초기화와 모듈 등록을 완료한 것입니다.

초기화에 실패하는 경우 아래와 같이 예외가 발생합니다.

  • config에 null을 넘기면 ArgumentNullException이 발생합니다.
  • 이미 초기화를 완료한 상태에서 초기화 메서드를 다시 호출하면 InvalidOperationException이 발생합니다.


다음 단계

TCB Connector 설정 환경 구성을 진행하세요.