데이터 저장

시작하기 전에

Realtime Database을 사용하려면 먼저 다음 작업을 해야 합니다.

  • Unity 프로젝트를 등록하고 Firebase를 사용하도록 구성합니다.

    • Unity 프로젝트에서 현재 Firebase를 사용하고 있다면 이미 등록되어 Firebase용으로 구성된 것입니다.

    • Unity 프로젝트가 없는 경우 샘플 앱을 다운로드하면 됩니다.

  • Firebase Unity SDK(특히 FirebaseDatabase.unitypackage)를 Unity 프로젝트에 추가합니다.

Unity 프로젝트에 Firebase를 추가할 때 Firebase Console 및 열려 있는 Unity 프로젝트 모두에서 작업을 수행해야 합니다. 예를 들어 Console에서 Firebase 구성 파일을 다운로드한 후 이 파일을 Unity 프로젝트로 이동하는 작업이 필요합니다.

데이터 저장

Firebase Realtime Database에 데이터를 쓰는 메서드는 다음과 같이 5가지입니다.

메서드 일반적인 용도
SetValueAsync() 정의된 경로(예: users/<user-id>/<username>)에 데이터를 쓰거나 대체합니다.
SetRawJsonValueAsync() 원시 JSON(예: users/<user-id>/<username>)으로 데이터를 쓰거나 대체합니다.
Push() 데이터 목록에 추가합니다. Push()를 호출할 때마다 Firebase에서 고유 식별자로도 사용할 수 있는 고유 키(예: user-scores/<user-id>/<unique-score-id>)가 생성됩니다.
UpdateChildrenAsync() 정의된 경로에서 모든 데이터를 대체하지 않고 일부 키를 업데이트합니다.
RunTransaction() 동시 업데이트에 의해 손상될 수 있는 복잡한 데이터를 업데이트합니다.

DatabaseReference 가져오기

데이터베이스에 데이터를 쓰려면 DatabaseReference의 인스턴스가 필요합니다.

using Firebase;
using Firebase.Database;

public class MyScript: MonoBehaviour {
  void Start() {
    // Get the root reference location of the database.
    DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference;
  }
}

참조 위치에서 데이터 쓰기, 업데이트 또는 삭제

기본 쓰기 작업

기본 쓰기 작업은 SetValueAsync() 코드를 사용하여 지정된 참조에 데이터를 저장하고 해당 경로의 기존 데이터를 모두 바꿉니다. 이 메서드를 통해 사용 가능한 JSON 유형에 해당하는 다음과 같은 유형을 전달할 수 있습니다.

  • string
  • long
  • double
  • bool
  • Dictionary<string, Object>
  • List<Object>

형식이 지정된 C# 객체를 사용하는 경우, 기본 제공된 JsonUtility.ToJson()을 사용하여 객체를 원시 JSON으로 변환하고 SetRawJsonValueAsync()를 호출할 수 있습니다. 예를 들어 다음과 같은 User 클래스가 있다고 가정해 보겠습니다.

public class User {
    public string username;
    public string email;

    public User() {
    }

    public User(string username, string email) {
        this.username = username;
        this.email = email;
    }
}

다음과 같이 SetRawJsonValueAsync()로 사용자를 추가할 수 있습니다.

private void writeNewUser(string userId, string name, string email) {
    User user = new User(name, email);
    string json = JsonUtility.ToJson(user);

    mDatabaseRef.Child("users").Child(userId).SetRawJsonValueAsync(json);
}

이 방법으로 SetValueAsync() 또는 SetRawJsonValueAsync()를 사용하면 지정된 위치에서 하위 노드를 포함하여 모든 데이터를 덮어씁니다. 그러나 전체 객체를 다시 쓰지 않고도 하위 항목을 업데이트하는 방법이 있습니다. 사용자가 프로필을 업데이트하도록 허용하려면 다음과 같이 사용자 이름을 업데이트할 수 있습니다.

mDatabaseRef.Child("users").Child(userId).Child("username").SetValueAsync(name);

데이터 목록에 추가

멀티 사용자 애플리케이션에서 목록에 데이터를 추가하려면 Push() 메서드를 사용합니다. Push() 메서드는 지정된 Firebase 참조에 새 하위 요소가 추가될 때마다 고유 키를 생성합니다. 목록의 새 요소마다 이러한 자동 생성 키를 사용하면 여러 클라이언트에서 쓰기 충돌 없이 동시에 하위 요소를 같은 위치에 추가할 수 있습니다. Push()가 생성하는 고유 키는 타임스탬프에 기반하므로 목록 항목은 시간순으로 자동 정렬됩니다.

Push() 메서드가 반환하는 새 데이터에 대한 참조를 사용하여 하위 요소의 자동 생성 키 값을 가져오거나 하위 데이터를 설정할 수 있습니다. Push() 참조에 대해 Key를 호출하면 자동 생성 키 값이 반환됩니다.

특정 필드 업데이트

다른 하위 노드를 덮어쓰지 않고 특정 하위 노드에 동시에 쓰려면 UpdateChildrenAsync() 메서드를 사용합니다.

UpdateChildrenAsync()을 호출할 때 키 경로를 지정하여 더 낮은 수준의 하위 항목 값을 업데이트할 수 있습니다. 확장성 개선을 위해 데이터를 여러 위치에 저장한 경우 데이터 팬아웃을 사용하여 해당 데이터의 모든 인스턴스를 업데이트할 수 있습니다. 예를 들어 게임은 다음과 같은 LeaderboardEntry 클래스를 사용할 수 있습니다.

public class LeaderboardEntry {
    public string uid;
    public int score = 0;

    public LeaderboardEntry() {
    }

    public LeaderboardEntry(string uid, int score) {
        this.uid = uid;
        this.score = score;
    }

    public Dictionary<string, Object> ToDictionary() {
        Dictionary<string, Object> result = new Dictionary<string, Object>();
        result["uid"] = uid;
        result["score"] = score;

        return result;
    }
}

LeaderboardEntry를 만들고 최근 점수 피드 및 사용자의 점수 목록을 동시에 업데이트하려는 경우 게임은 다음과 같은 코드를 사용합니다.

private void WriteNewScore(string userId, int score) {
    // Create new entry at /user-scores/$userid/$scoreid and at
    // /leaderboard/$scoreid simultaneously
    string key = mDatabase.Child("scores").Push().Key;
    LeaderBoardEntry entry = new LeaderBoardEntry(userId, score);
    Dictionary<string, Object> entryValues = entry.ToDictionary();

    Dictionary<string, Object> childUpdates = new Dictionary<string, Object>();
    childUpdates["/scores/" + key] = entryValues;
    childUpdates["/user-scores/" + userId + "/" + key] = entryValues;

    mDatabase.UpdateChildrenAsync(childUpdates);
}

이 예시에서는 Push()를 사용하여 모든 사용자의 항목을 포함하는 노드(/scores/$key)에서 항목을 작성하는 동시에 Key로 키를 검색합니다. 그런 다음 이 키로 /user-scores/$userid/$key에서 사용자의 두 번째 항목을 작성합니다.

이러한 경로를 사용하면 이 예시에서 두 위치에 새 항목을 생성한 것처럼 UpdateChildrenAsync()를 한 번만 호출하여 JSON 트리의 여러 위치에 동시에 업데이트할 수 있습니다. 이러한 동시 업데이트는 원자적 성격을 갖습니다. 즉, 모든 업데이트가 한꺼번에 성공하거나 실패합니다.

데이터 삭제

데이터를 삭제하는 가장 간단한 방법은 해당 데이터 위치의 참조에 RemoveValue()를 호출하는 것입니다.

SetValueAsync() 또는 UpdateChildrenAsync() 등의 다른 쓰기 작업 값으로 null을 지정하여 삭제할 수도 있습니다. UpdateChildrenAsync()에 이 방법을 사용하면 API 호출 한 번으로 여러 하위 항목을 삭제할 수 있습니다.

데이터가 커밋되는 시점 알기

데이터가 Firebase Realtime Database 서버에 커밋되는 시점을 파악하려면 지속 개체를 추가합니다. SetValueAsync()와 UpdateChildrenAsync()는 작업 완료 시점을 알려주는 Task를 반환합니다. 이유를 불문하고 호출에 실패하면 IsFaulted 작업이 true가 되고 Exception 속성은 실패 이유를 지정합니다.

데이터를 트랜잭션으로 저장

증가 카운터와 같이 동시 수정으로 인해 손상될 수 있는 데이터를 다룰 때 트랜잭션 작업을 사용할 수 있습니다. 이 작업을 Func로 지정합니다. 이 업데이트 Func는 데이터의 현재 상태를 인수로 취하고 새로 기록하려는 상태를 반환합니다. 새 값이 쓰이기 전에 다른 클라이언트에서 해당 위치에 쓰기 작업을 수행하면 새로운 현재 값으로 업데이트 함수가 다시 호출되고 쓰기가 다시 시도됩니다.

예를 들어 게임에서 사용자가 최고 점수 5개로 리더보드를 업데이트하도록 허용할 수 있습니다.

private void AddScoreToLeaders(string email, 
                               long score,
                               DatabaseReference leaderBoardRef) {

    leaderBoardRef.RunTransaction(mutableData => {
      List<object> leaders = mutableData.Value as List<object>

      if (leaders == null) {
        leaders = new List<object>();
      } else if (mutableData.ChildrenCount >= MaxScores) {
        long minScore = long.MaxValue;
        object minVal = null;
        foreach (var child in leaders) {
          if (!(child is Dictionary<string, object>)) continue;
          long childScore = (long)
                      ((Dictionary<string, object>)child)["score"];
          if (childScore < minScore) {
            minScore = childScore;
            minVal = child;
          }
        }
        if (minScore > score) {
          // The new score is lower than the existing 5 scores, abort.
          return TransactionResult.Abort();
        }

        // Remove the lowest score.
        leaders.Remove(minVal);
      }

      // Add the new high score.
      Dictionary<string, object> newScoreMap =
                       new Dictionary<string, object>();
      newScoreMap["score"] = score;
      newScoreMap["email"] = email;
      leaders.Add(newScoreMap);
      mutableData.Value = leaders;
      return TransactionResult.Success(mutableData);
    });
}

트랜잭션을 사용하면 여러 사용자가 동시에 점수를 기록하거나 클라이언트 데이터의 동기화가 어긋나도 리더보드가 잘못되지 않습니다. 트랜잭션이 거부되면 서버에서 현재 값을 클라이언트에 반환하며, 클라이언트는 업데이트된 값으로 트랜잭션을 다시 실행합니다. 트랜잭션이 수락되거나 시도가 일정 횟수를 초과할 때까지 이 과정이 반복됩니다.

오프라인으로 데이터 쓰기

클라이언트의 네트워크 연결이 끊겨도 앱은 계속 정상적으로 작동합니다.

Firebase 데이터베이스에 연결된 모든 클라이언트는 자체적으로 활성 데이터의 내부 버전을 유지합니다. 데이터를 쓰면 우선 로컬 버전에 기록됩니다. 그런 다음 Firebase 클라이언트가 해당 데이터를 원격 데이터베이스 서버 및 다른 클라이언트와 '최선을 다해' 동기화합니다.

이와 같이 데이터베이스에 대한 모든 쓰기 작업은 로컬 이벤트를 즉시 트리거하며, 그 이후에 서버에 데이터가 기록됩니다. 따라서 앱은 네트워크 지연 또는 연결 여부에 관계없이 응답성을 유지합니다.

네트워크에 다시 연결되면 앱에서 적절한 이벤트 세트를 수신하여 클라이언트와 현재 서버 상태를 동기화하므로 맞춤 코드를 별도로 작성할 필요가 없습니다.

다음 단계