Google I/O 2023에서 Firebase의 주요 소식을 확인하세요. 자세히 알아보기

데이터 읽기 및 쓰기

(선택사항) Firebase 에뮬레이터 도구 모음으로 프로토타입 제작 및 테스트

앱에서 실시간 데이터베이스의 데이터를 읽고 쓰는 방법에 대해 논의하기 전에 실시간 데이터베이스 기능을 프로토타입으로 제작하고 테스트하는 데 사용할 수 있는 도구 모음인 Firebase 에뮬레이터 도구 모음을 소개합니다. 다양한 데이터 모델을 사용해 보거나, 보안 규칙을 최적화하거나, 백엔드와 상호작용할 수 있는 가장 비용 효율적인 방법을 찾는 경우 라이브 서비스를 배포하지 않고 로컬에서 작업할 수 있다면 큰 도움이 될 것입니다.

실시간 데이터베이스 에뮬레이터는 에뮬레이터 도구 모음에 포함되어 있으며 앱에서 에뮬레이션된 데이터베이스 콘텐츠 및 구성은 물론 필요할 경우 에뮬레이션된 프로젝트 리소스(함수, 기타 데이터베이스, 보안 규칙)와도 상호작용할 수 있게 해줍니다.emulator_suite_short

실시간 데이터베이스 에뮬레이터를 사용하려면 다음 몇 단계만 거치면 됩니다.

에뮬레이터에 연결하기 위해 앱의 테스트 구성에 코드 줄을 추가합니다.
로컬 프로젝트 디렉터리의 루트에서 firebase emulators:start를 실행합니다.
평소와 같이 실시간 데이터베이스 플랫폼 SDK를 사용하거나 Realtime Database REST API를 사용하여 앱의 프로토타입 코드에서 호출합니다.

자세한 내용은 실시간 데이터베이스 및 Cloud Functions 관련 둘러보기를 참조하세요. 에뮬레이터 도구 모음 소개도 살펴보세요.

DatabaseReference 가져오기

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

DatabaseReference ref = FirebaseDatabase.instance.ref();

데이터 쓰기

이 문서에서는 Firebase 데이터를 읽고 쓰는 기초적인 방법을 설명합니다.

Firebase 데이터는 DatabaseReference에 기록되고, 참조에서 내보낸 이벤트를 대기하거나 리슨하여 검색합니다. 이벤트를 데이터의 초기 상태에 한 번 내보내고 데이터가 변경될 때마다 다시 내보냅니다.

기본 쓰기 작업

기본 쓰기 작업의 경우 set()을 사용하여 지정된 참조에 데이터를 저장하고 해당 경로의 기존 데이터를 모두 바꿉니다. String, boolean, int, double, Map, List 유형으로 참조를 설정할 수 있습니다.

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

DatabaseReference ref = FirebaseDatabase.instance.ref("users/123");

await ref.set({
  "name": "John",
  "age": 18,
  "address": {
    "line1": "100 Mountain View"
  }
});

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

DatabaseReference ref = FirebaseDatabase.instance.ref("users/123");

// Only update the name, leave the age and address!
await ref.update({
  "age": 19,
});

update() 메서드는 노드에 대한 하위 경로를 허용하여 데이터베이스의 노드 여러 개를 한 번에 업데이트할 수 있습니다.

DatabaseReference ref = FirebaseDatabase.instance.ref("users");

await ref.update({
  "123/age": 19,
  "123/address/line1": "1 Mountain View",
});

데이터 읽기

값 이벤트를 수신 대기하여 데이터 읽기

경로의 데이터를 읽고 변경사항을 리슨하려면 DatabaseReference의 onValue 속성을 사용하여 DatabaseEvent를 리슨합니다.

DatabaseEvent를 사용하면 이벤트 발생 시점에 존재하는 지정된 경로에서 데이터를 읽을 수 있습니다. 이 이벤트는 리스너가 연결될 때 한 번 트리거된 후 하위 요소를 포함하여 데이터가 변경될 때마다 다시 트리거됩니다. 이벤트에는 하위 데이터를 포함하여 해당 위치의 모든 데이터를 포함하는 snapshot 속성이 있습니다. 데이터가 없으면 스냅샷의 exists 속성은 false이고 value 속성은 null입니다.

다음 예시는 데이터베이스에서 게시물의 세부정보를 검색하는 소셜 블로깅 애플리케이션을 보여줍니다.

DatabaseReference starCountRef =
        FirebaseDatabase.instance.ref('posts/$postId/starCount');
starCountRef.onValue.listen((DatabaseEvent event) {
    final data = event.snapshot.value;
    updateStarCount(data);
});

리스너는 이벤트 발생 시점에 데이터베이스에서 지정된 위치에 있는 데이터를 포함한 DataSnapshot을 value 속성에 수신합니다.

데이터 한 번 읽기

get()을 사용하여 한 번 읽기

SDK는 앱이 온라인이든 오프라인이든 상관없이 데이터베이스 서버와의 상호작용을 관리하도록 설계되었습니다.

일반적으로 위에서 설명한 값 이벤트 기법을 사용하여 데이터를 읽어 백엔드에서 데이터에 대한 업데이트 알림을 수신해야 합니다. 이러한 기법은 사용량과 청구 비용을 줄여주고 사용자가 온라인과 오프라인으로 진행할 때 최상의 환경을 제공하도록 최적화되어 있습니다.

데이터가 한 번만 필요한 경우 get()을 사용하여 데이터베이스에서 데이터의 스냅샷을 가져올 수 있습니다. 어떠한 이유로든 get()가 서버 값을 반환할 수 없는 경우 클라이언트는 로컬 스토리지 캐시를 프로브하고 값을 여전히 찾을 수 없으면 오류를 반환합니다.

다음 예시에서는 사용자의 공개 사용자 이름을 데이터베이스에서 한 번 검색하는 방법을 보여줍니다.

final ref = FirebaseDatabase.instance.ref();
final snapshot = await ref.child('users/$userId').get();
if (snapshot.exists) {
    print(snapshot.value);
} else {
    print('No data available.');
}

불필요한 get() 사용은 대역폭 사용을 증가시키고 성능 저하를 유발할 수 있지만 위와 같이 실시간 리스너를 사용하면 이를 방지할 수 있습니다.

once()로 데이터 한 번 읽기

경우에 따라 서버의 업데이트된 값을 확인하는 대신 로컬 캐시의 값을 즉시 반환하고 싶을 수 있습니다. 이 경우에는 once()를 사용하여 로컬 디스크 캐시에서 데이터를 즉시 가져올 수 있습니다.

이 방법은 한 번 로드된 후 자주 변경되지 않거나 능동적으로 수신 대기할 필요가 없는 데이터에 유용합니다. 예를 들어 위 예시의 블로깅 앱에서는 사용자가 새 글을 작성하기 시작할 때 이 메서드로 사용자의 프로필을 로드합니다.

final event = await ref.once(DatabaseEventType.value);
final username = event.snapshot.value?.username ?? 'Anonymous';

데이터 업데이트 또는 삭제

특정 필드 업데이트

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

update()를 호출할 때 키 경로를 지정하여 더 낮은 수준의 하위 항목 값을 업데이트할 수 있습니다. 확장성 개선을 위해 데이터를 여러 위치에 저장한 경우 데이터 팬아웃을 사용하여 해당 데이터의 모든 인스턴스를 업데이트할 수 있습니다. 예를 들어 소셜 블로깅 앱에서 게시물을 생성한 후 최근 활동 피드 및 게시자의 활동 피드에 동시에 업데이트해야 할 수 있습니다. 이러한 경우 블로깅 애플리케이션에서는 다음과 같은 코드를 사용합니다.

void writeNewPost(String uid, String username, String picture, String title,
        String body) async {
    // A post entry.
    final postData = {
        'author': username,
        'uid': uid,
        'body': body,
        'title': title,
        'starCount': 0,
        'authorPic': picture,
    };

    // Get a key for a new Post.
    final newPostKey =
        FirebaseDatabase.instance.ref().child('posts').push().key;

    // Write the new post's data simultaneously in the posts list and the
    // user's post list.
    final Map<String, Map> updates = {};
    updates['/posts/$newPostKey'] = postData;
    updates['/user-posts/$uid/$newPostKey'] = postData;

    return FirebaseDatabase.instance.ref().update(updates);
}

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

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

완료 콜백 추가

데이터가 커밋되는 시점을 파악하려면 완료 콜백을 등록하면 됩니다. set() 및 update() 모두 Future를 반환하며 이를 통해 쓰기가 데이터베이스에 커밋되고 호출이 실패할 때 호출되는 성공 및 오류 콜백을 연결할 수 있습니다.

FirebaseDatabase.instance
    .ref('users/$userId/email')
    .set(emailAddress)
    .then((_) {
        // Data saved successfully!
    })
    .catchError((error) {
        // The write failed...
    });

데이터 삭제

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

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

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

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

예를 들어 소셜 블로깅 앱에서는 다음과 같이 사용자가 게시물에 별표를 주거나 삭제할 수 있고 게시물이 별표를 몇 개 받았는지 집계할 수 있습니다.

void toggleStar(String uid) async {
  DatabaseReference postRef =
      FirebaseDatabase.instance.ref("posts/foo-bar-123");

  TransactionResult result = await postRef.runTransaction((Object? post) {
    // Ensure a post at the ref exists.
    if (post == null) {
      return Transaction.abort();
    }

    Map<String, dynamic> _post = Map<String, dynamic>.from(post as Map);
    if (_post["stars"] is Map && _post["stars"][uid] != null) {
      _post["starCount"] = (_post["starCount"] ?? 1) - 1;
      _post["stars"][uid] = null;
    } else {
      _post["starCount"] = (_post["starCount"] ?? 0) + 1;
      if (!_post.containsKey("stars")) {
        _post["stars"] = {};
      }
      _post["stars"][uid] = true;
    }

    // Return the new data.
    return Transaction.success(_post);
  });
}

기본적으로 트랜잭션 업데이트 함수가 실행될 때마다 이벤트가 발생하므로 함수를 여러 번 실행하면 중간 상태가 표시될 수 있습니다. 이러한 중간 상태를 표시하지 않도록 applyLocally를 false로 설정하고 대신 트랜잭션이 완료될 때까지 기다린 후에 이벤트를 발생시킬 수 있습니다.

await ref.runTransaction((Object? post) {
  // ...
}, applyLocally: false);

트랜잭션 결과는 TransactionResult이며 여기에는 트랜잭션의 커밋 여부, 새 스냅샷과 같은 정보가 포함됩니다.

DatabaseReference ref = FirebaseDatabase.instance.ref("posts/123");

TransactionResult result = await ref.runTransaction((Object? post) {
  // ...
});

print('Committed? ${result.committed}'); // true / false
print('Snapshot? ${result.snapshot}'); // DataSnapshot

거래 취소

트랜잭션을 안전하게 취소하려면 Transaction.abort()를 호출하여 AbortTransactionException을 발생시킵니다.

TransactionResult result = await ref.runTransaction((Object? user) {
  if (user !== null) {
    return Transaction.abort();
  }

  // ...
});

print(result.committed); // false

서버 측 원자적 증분

위의 사용 사례에서는 두 가지 값, 즉 게시물에 별표표시를 하거나 별표를 삭제한 사용자의 ID와 증가된 별표 수를 데이터베이스에 씁니다. 사용자가 게시물에 별표표시를 하고 있다는 것을 이미 안다면 트랜잭션 대신 원자적 증분 작업을 사용할 수 있습니다.

void addStar(uid, key) async {
  Map<String, Object?> updates = {};
  updates["posts/$key/stars/$uid"] = true;
  updates["posts/$key/starCount"] = ServerValue.increment(1);
  updates["user-posts/$key/stars/$uid"] = true;
  updates["user-posts/$key/starCount"] = ServerValue.increment(1);
  return FirebaseDatabase.instance.ref().update(updates);
}

이 코드는 트랜잭션 작업을 사용하지 않으므로 충돌하는 업데이트가 있는 경우 코드가 자동으로 다시 실행되지 않습니다. 하지만 증분 작업은 데이터베이스 서버에서 직접 이루어지므로 충돌이 발생할 가능성은 없습니다.

사용자가 이전에 이미 별표표시한 게시물에 별표를 표시하는 상황처럼 애플리케이션별 충돌을 감지하고 거부하려면 해당 사용 사례에 대한 커스텀 보안 규칙을 작성해야 합니다.

오프라인으로 데이터 작업하기

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

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

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

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

오프라인 동작에 대한 자세한 내용은 온라인 및 오프라인 기능에 대해 자세히 알아보기에서 살펴보겠습니다.