Firebase Summit에서 발표된 모든 내용을 살펴보고 Firebase로 앱을 빠르게 개발하고 안심하고 앱을 실행하는 방법을 알아보세요. 자세히 알아보기

Android에서 데이터 읽기 및 쓰기

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

이 문서는 Firebase 데이터 읽기 및 쓰기의 기본 사항을 다룹니다.

Firebase 데이터는 FirebaseDatabase 참조에 기록되고 참조에 비동기 리스너를 연결하여 검색됩니다. 리스너는 데이터의 초기 상태에 대해 한 번 트리거되고 데이터가 변경될 때마다 다시 트리거됩니다.

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

앱이 실시간 데이터베이스에서 읽고 쓰는 방법에 대해 이야기하기 전에 실시간 데이터베이스 기능의 프로토타입을 만들고 테스트하는 데 사용할 수 있는 일련의 도구인 Firebase 로컬 에뮬레이터 도구 모음을 소개하겠습니다. 다른 데이터 모델을 시도하거나 보안 규칙을 최적화하거나 백엔드와 상호 작용하는 가장 비용 효율적인 방법을 찾기 위해 노력하는 경우 라이브 서비스를 배포하지 않고 로컬에서 작업할 수 있는 것이 좋습니다.

실시간 데이터베이스 에뮬레이터는 앱이 에뮬레이트된 데이터베이스 콘텐츠 및 구성은 물론 선택적으로 에뮬레이트된 프로젝트 리소스(함수, 기타 데이터베이스 및 보안 규칙)와 상호 작용할 수 있도록 하는 로컬 에뮬레이터 도구 모음의 일부입니다.

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

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

실시간 데이터베이스 및 Cloud Functions와 관련된 자세한 연습 이 제공됩니다. Local Emulator Suite 소개 도 살펴봐야 합니다.

데이터베이스 참조 가져오기

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

Kotlin+KTX

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference

Java

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();

데이터 쓰기

기본 쓰기 작업

기본 쓰기 작업의 경우 setValue() 를 사용하여 지정된 참조에 데이터를 저장하고 해당 경로에 있는 기존 데이터를 대체할 수 있습니다. 이 방법을 사용하여 다음을 수행할 수 있습니다.

  • 다음과 같이 사용 가능한 JSON 유형에 해당하는 전달 유형:
    • String
    • Long
    • Double
    • Boolean
    • Map<String, Object>
    • List<Object>
  • 사용자 지정 Java 개체를 정의하는 클래스에 인수를 사용하지 않는 기본 생성자가 있고 할당할 속성에 대한 공용 getter가 있는 경우 사용자 지정 Java 개체를 전달합니다.

Java 개체를 사용하는 경우 개체의 내용이 중첩된 방식으로 하위 위치에 자동으로 매핑됩니다. Java 개체를 사용하면 일반적으로 코드를 더 읽기 쉽고 유지 관리하기 쉬워집니다. 예를 들어 기본 사용자 프로필이 있는 앱이 있는 경우 User 개체는 다음과 같을 수 있습니다.

Kotlin+KTX

@IgnoreExtraProperties
data class User(val username: String? = null, val email: String? = null) {
    // Null default values create a no-argument default constructor, which is needed
    // for deserialization from a DataSnapshot.
}

Java

@IgnoreExtraProperties
public class User {

    public String username;
    public String email;

    public User() {
        // Default constructor required for calls to DataSnapshot.getValue(User.class)
    }

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

}

다음과 같이 setValue() 를 사용하여 사용자를 추가할 수 있습니다.

Kotlin+KTX

fun writeNewUser(userId: String, name: String, email: String) {
    val user = User(name, email)

    database.child("users").child(userId).setValue(user)
}

Java

public void writeNewUser(String userId, String name, String email) {
    User user = new User(name, email);

    mDatabase.child("users").child(userId).setValue(user);
}

이러한 방식으로 setValue() 를 사용하면 자식 노드를 포함하여 지정된 위치의 데이터를 덮어씁니다. 그러나 전체 개체를 다시 작성하지 않고 하위 개체를 계속 업데이트할 수 있습니다. 사용자가 자신의 프로필을 업데이트하도록 허용하려면 다음과 같이 사용자 이름을 업데이트할 수 있습니다.

Kotlin+KTX

database.child("users").child(userId).child("username").setValue(name)

Java

mDatabase.child("users").child(userId).child("username").setValue(name);

데이터 읽기

영구 리스너로 데이터 읽기

경로에서 데이터를 읽고 변경 사항을 수신하려면 addValueEventListener() 메서드를 사용하여 ValueEventListenerDatabaseReference 에 추가합니다.

경청자 이벤트 콜백 일반적인 사용법
ValueEventListener onDataChange() 경로의 전체 내용에 대한 변경 사항을 읽고 듣습니다.

onDataChange() 메서드를 사용하여 이벤트 시점에 존재했던 콘텐츠의 정적 스냅샷을 지정된 경로에 읽을 수 있습니다. 이 메서드는 리스너가 연결될 때 한 번 트리거되고 자식을 포함한 데이터가 변경될 때마다 다시 트리거됩니다. 이벤트 콜백에는 하위 데이터를 포함하여 해당 위치의 모든 데이터가 포함된 스냅샷이 전달됩니다. 데이터가 없는 경우 스냅샷은 exists() 를 호출하면 false 를 반환하고 getValue() 를 호출하면 null 을 반환합니다.

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

Kotlin+KTX

val postListener = object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        // Get Post object and use the values to update the UI
        val post = dataSnapshot.getValue<Post>()
        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
    }
}
postReference.addValueEventListener(postListener)

Java

ValueEventListener postListener = new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        // Get Post object and use the values to update the UI
        Post post = dataSnapshot.getValue(Post.class);
        // ..
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
    }
};
mPostReference.addValueEventListener(postListener);

리스너는 이벤트 발생 시 데이터베이스의 지정된 위치에 있는 데이터가 포함된 DataSnapshot 을 수신합니다. 스냅샷에서 getValue() 를 호출하면 데이터의 Java 객체 표현이 반환됩니다. 해당 위치에 데이터가 없으면 getValue() 를 호출하면 null 이 반환됩니다.

이 예제에서 ValueEventListener 는 읽기가 취소된 경우 호출되는 onCancelled() 메서드도 정의합니다. 예를 들어 클라이언트에 Firebase 데이터베이스 위치에서 읽을 수 있는 권한이 없는 경우 읽기를 취소할 수 있습니다. 이 메서드에는 실패가 발생한 이유를 나타내는 DatabaseError 개체가 전달됩니다.

데이터 한 번 읽기

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

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

일반적으로 위에서 설명한 ValueEventListener 기술을 사용하여 백엔드에서 데이터 업데이트 알림을 받으려면 데이터를 읽어야 합니다. 리스너 기술은 사용량과 요금 청구를 줄이고 사용자가 온라인과 오프라인을 이동할 때 최상의 경험을 제공하도록 최적화되어 있습니다.

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

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

Kotlin+KTX

mDatabase.child("users").child(userId).get().addOnSuccessListener {
    Log.i("firebase", "Got value ${it.value}")
}.addOnFailureListener{
    Log.e("firebase", "Error getting data", it)
}

Java

mDatabase.child("users").child(userId).get().addOnCompleteListener(new OnCompleteListener<DataSnapshot>() {
    @Override
    public void onComplete(@NonNull Task<DataSnapshot> task) {
        if (!task.isSuccessful()) {
            Log.e("firebase", "Error getting data", task.getException());
        }
        else {
            Log.d("firebase", String.valueOf(task.getResult().getValue()));
        }
    }
});

리스너를 사용하여 한 번 읽기

경우에 따라 서버에서 업데이트된 값을 확인하는 대신 로컬 캐시의 값이 즉시 반환되기를 원할 수 있습니다. 이러한 경우 addListenerForSingleValueEvent 를 사용하여 로컬 디스크 캐시에서 즉시 데이터를 가져올 수 있습니다.

이는 한 번만 로드하면 되고 자주 변경되거나 적극적인 수신이 필요하지 않은 데이터에 유용합니다. 예를 들어 이전 예제의 블로깅 앱은 이 메서드를 사용하여 사용자가 새 게시물 작성을 시작할 때 사용자 프로필을 로드합니다.

데이터 업데이트 또는 삭제

특정 필드 업데이트

다른 자식 노드를 덮어쓰지 않고 노드의 특정 자식에 동시에 쓰려면 updateChildren() 메서드를 사용합니다.

updateChildren() 을 호출할 때 키의 경로를 지정하여 하위 수준 자식 값을 업데이트할 수 있습니다. 더 나은 확장을 위해 데이터가 여러 위치에 저장된 경우 데이터 팬아웃 을 사용하여 해당 데이터의 모든 인스턴스를 업데이트할 수 있습니다. 예를 들어 소셜 블로깅 앱에는 다음과 같은 Post 클래스가 있을 수 있습니다.

Kotlin+KTX

@IgnoreExtraProperties
data class Post(
    var uid: String? = "",
    var author: String? = "",
    var title: String? = "",
    var body: String? = "",
    var starCount: Int = 0,
    var stars: MutableMap<String, Boolean> = HashMap()
) {

    @Exclude
    fun toMap(): Map<String, Any?> {
        return mapOf(
                "uid" to uid,
                "author" to author,
                "title" to title,
                "body" to body,
                "starCount" to starCount,
                "stars" to stars
        )
    }
}

Java

@IgnoreExtraProperties
public class Post {

    public String uid;
    public String author;
    public String title;
    public String body;
    public int starCount = 0;
    public Map<String, Boolean> stars = new HashMap<>();

    public Post() {
        // Default constructor required for calls to DataSnapshot.getValue(Post.class)
    }

    public Post(String uid, String author, String title, String body) {
        this.uid = uid;
        this.author = author;
        this.title = title;
        this.body = body;
    }

    @Exclude
    public Map<String, Object> toMap() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("uid", uid);
        result.put("author", author);
        result.put("title", title);
        result.put("body", body);
        result.put("starCount", starCount);
        result.put("stars", stars);

        return result;
    }
}

게시물을 생성하고 이를 최근 활동 피드와 게시 사용자의 활동 피드로 동시에 업데이트하기 위해 블로깅 애플리케이션은 다음과 같은 코드를 사용합니다.

Kotlin+KTX

private fun writeNewPost(userId: String, username: String, title: String, body: String) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    val key = database.child("posts").push().key
    if (key == null) {
        Log.w(TAG, "Couldn't get push key for posts")
        return
    }

    val post = Post(userId, username, title, body)
    val postValues = post.toMap()

    val childUpdates = hashMapOf<String, Any>(
            "/posts/$key" to postValues,
            "/user-posts/$userId/$key" to postValues
    )

    database.updateChildren(childUpdates)
}

Java

private void writeNewPost(String userId, String username, String title, String body) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    String key = mDatabase.child("posts").push().getKey();
    Post post = new Post(userId, username, title, body);
    Map<String, Object> postValues = post.toMap();

    Map<String, Object> childUpdates = new HashMap<>();
    childUpdates.put("/posts/" + key, postValues);
    childUpdates.put("/user-posts/" + userId + "/" + key, postValues);

    mDatabase.updateChildren(childUpdates);
}

이 예제는 push() 를 사용하여 /posts/$postid 의 모든 사용자에 대한 게시물을 포함하는 노드에 게시물을 생성하고 동시에 getKey() 를 사용하여 키를 검색합니다. 그런 다음 이 키를 사용하여 /user-posts/$userid/$postid 의 사용자 게시물에 두 번째 항목을 만들 수 있습니다.

이러한 경로를 사용하면 이 예제가 두 위치에서 새 게시물을 생성하는 방법과 같이 updateChildren() 에 대한 단일 호출로 JSON 트리의 여러 위치에 대한 동시 업데이트를 수행할 수 있습니다. 이러한 방식으로 이루어진 동시 업데이트는 원자적입니다. 즉, 모든 업데이트가 성공하거나 모든 업데이트가 실패합니다.

완료 콜백 추가

데이터가 언제 커밋되었는지 알고 싶다면 완료 리스너를 추가할 수 있습니다. setValue()updateChildren() 모두 쓰기가 데이터베이스에 성공적으로 커밋되었을 때 호출되는 선택적 완료 리스너를 사용합니다. 호출이 실패하면 리스너에 실패 이유를 나타내는 오류 객체가 전달됩니다.

Kotlin+KTX

database.child("users").child(userId).setValue(user)
        .addOnSuccessListener {
            // Write was successful!
            // ...
        }
        .addOnFailureListener {
            // Write failed
            // ...
        }

Java

mDatabase.child("users").child(userId).setValue(user)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                // Write was successful!
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Write failed
                // ...
            }
        });

데이터 삭제

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

setValue() 또는 updateChildren() 과 같은 다른 쓰기 작업의 값으로 null 을 지정하여 삭제할 수도 있습니다. 이 기술을 updateChildren() 과 함께 사용하여 단일 API 호출에서 여러 하위를 삭제할 수 있습니다.

리스너 분리

Firebase 데이터베이스 참조에서 removeEventListener() 메서드를 호출하면 콜백이 제거됩니다.

리스너가 데이터 위치에 여러 번 추가된 경우 각 이벤트에 대해 여러 번 호출되며 완전히 제거하려면 같은 횟수만큼 분리해야 합니다.

부모 리스너에서 removeEventListener() 를 호출해도 자식 노드에 등록된 리스너가 자동으로 제거되지 않습니다. 콜백을 제거하려면 자식 리스너에서 removeEventListener() 도 호출해야 합니다.

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

증분 카운터와 같은 동시 수정으로 인해 손상될 수 있는 데이터로 작업할 때 트랜잭션 작업 을 사용할 수 있습니다. 이 작업에 업데이트 함수와 선택적 완료 콜백이라는 두 가지 인수를 제공합니다. 업데이트 함수는 데이터의 현재 상태를 인수로 사용하고 작성하려는 새로운 원하는 상태를 반환합니다. 새 값이 성공적으로 기록되기 전에 다른 클라이언트가 해당 위치에 기록하면 업데이트 함수가 새로운 현재 값으로 다시 호출되고 쓰기가 다시 시도됩니다.

예를 들어 소셜 블로깅 앱 예제에서 사용자가 게시물에 별표를 표시하거나 별표를 취소하고 게시물이 받은 별의 수를 다음과 같이 추적하도록 허용할 수 있습니다.

Kotlin+KTX

private fun onStarClicked(postRef: DatabaseReference) {
    // ...
    postRef.runTransaction(object : Transaction.Handler {
        override fun doTransaction(mutableData: MutableData): Transaction.Result {
            val p = mutableData.getValue(Post::class.java)
                    ?: return Transaction.success(mutableData)

            if (p.stars.containsKey(uid)) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1
                p.stars.remove(uid)
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1
                p.stars[uid] = true
            }

            // Set value and report transaction success
            mutableData.value = p
            return Transaction.success(mutableData)
        }

        override fun onComplete(
                databaseError: DatabaseError?,
                committed: Boolean,
                currentData: DataSnapshot?
        ) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError!!)
        }
    })
}

Java

private void onStarClicked(DatabaseReference postRef) {
    postRef.runTransaction(new Transaction.Handler() {
        @NonNull
        @Override
        public Transaction.Result doTransaction(@NonNull MutableData mutableData) {
            Post p = mutableData.getValue(Post.class);
            if (p == null) {
                return Transaction.success(mutableData);
            }

            if (p.stars.containsKey(getUid())) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1;
                p.stars.remove(getUid());
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1;
                p.stars.put(getUid(), true);
            }

            // Set value and report transaction success
            mutableData.setValue(p);
            return Transaction.success(mutableData);
        }

        @Override
        public void onComplete(DatabaseError databaseError, boolean committed,
                               DataSnapshot currentData) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError);
        }
    });
}

트랜잭션을 사용하면 여러 사용자가 동시에 동일한 게시물에 별표를 표시하거나 클라이언트에 오래된 데이터가 있는 경우 별표 수가 잘못되는 것을 방지할 수 있습니다. 트랜잭션이 거부되면 서버는 현재 값을 클라이언트에 반환하고 클라이언트는 업데이트된 값으로 트랜잭션을 다시 실행합니다. 이것은 트랜잭션이 수락되거나 너무 많은 시도가 이루어질 때까지 반복됩니다.

원자적 서버측 증분

위의 사용 사례에서 우리는 데이터베이스에 두 가지 값을 씁니다. 게시물에 별표를 표시하거나 별표를 취소한 사용자의 ID와 증가된 별표 수입니다. 사용자가 게시물에 별표를 표시하고 있음을 이미 알고 있는 경우 트랜잭션 대신 원자적 증분 작업을 사용할 수 있습니다.

Kotlin+KTX

private fun onStarClicked(uid: String, key: String) {
    val updates: MutableMap<String, Any> = hashMapOf(
        "posts/$key/stars/$uid" to true,
        "posts/$key/starCount" to ServerValue.increment(1),
        "user-posts/$uid/$key/stars/$uid" to true,
        "user-posts/$uid/$key/starCount" to ServerValue.increment(1)
    )
    database.updateChildren(updates)
}

Java

private void onStarClicked(String uid, String key) {
    Map<String, Object> updates = new HashMap<>();
    updates.put("posts/"+key+"/stars/"+uid, true);
    updates.put("posts/"+key+"/starCount", ServerValue.increment(1));
    updates.put("user-posts/"+uid+"/"+key+"/stars/"+uid, true);
    updates.put("user-posts/"+uid+"/"+key+"/starCount", ServerValue.increment(1));
    mDatabase.updateChildren(updates);
}

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

사용자가 이전에 이미 별표를 표시한 게시물에 별표를 표시하는 것과 같은 애플리케이션 관련 충돌을 감지하고 거부하려면 해당 사용 사례에 대한 사용자 지정 보안 규칙을 작성해야 합니다.

오프라인에서 데이터 작업

클라이언트의 네트워크 연결이 끊어져도 앱은 계속해서 올바르게 작동합니다.

Firebase 데이터베이스에 연결된 모든 클라이언트는 리스너가 사용 중이거나 서버와 동기화되도록 플래그가 지정된 모든 데이터의 자체 내부 버전을 유지합니다. 데이터를 읽거나 쓸 때 이 로컬 버전의 데이터가 먼저 사용됩니다. 그런 다음 Firebase 클라이언트는 해당 데이터를 원격 데이터베이스 서버 및 다른 클라이언트와 "최선의 노력"으로 동기화합니다.

결과적으로 데이터베이스에 대한 모든 쓰기는 서버와의 상호 작용 전에 즉시 로컬 이벤트를 트리거합니다. 즉, 네트워크 대기 시간이나 연결에 관계없이 앱이 응답성을 유지합니다.

연결이 다시 설정되면 사용자 지정 코드를 작성할 필요 없이 클라이언트가 현재 서버 상태와 동기화되도록 앱에서 적절한 이벤트 집합을 수신합니다.

온라인 및 오프라인 기능에 대해 자세히 알아보기 에서 오프라인 동작에 대해 자세히 설명합니다.

다음 단계