Cloud Firestore Android Codelab

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

1. 개요

목표

이 Codelab에서는 Android에서 Cloud Firestore가 지원하는 레스토랑 추천 앱을 빌드합니다. 다음 방법을 배우게 됩니다.

  • Android 앱에서 Firestore로 데이터 읽기 및 쓰기
  • 실시간으로 Firestore 데이터의 변경 사항 듣기
  • Firebase 인증 및 보안 규칙을 사용하여 Firestore 데이터 보호
  • 복잡한 Firestore 쿼리 작성

전제 조건

이 Codelab을 시작하기 전에 다음을 확인하세요.

  • 안드로이드 스튜디오 4.0 이상
  • API 19 이상이 있는 Android 에뮬레이터
  • Node.js 버전 10 이상
  • 자바 버전 8 이상

2. Firebase 프로젝트 생성

  1. Google 계정으로 Firebase 콘솔 에 로그인합니다.
  2. Firebase 콘솔 에서 프로젝트 추가 를 클릭합니다.
  3. 아래 화면 캡처에 표시된 대로 Firebase 프로젝트의 이름(예: "Friendly Eats")을 입력하고 계속 을 클릭합니다.

9d2f625aebcab6af.png

  1. Google 애널리틱스를 사용 설정하라는 메시지가 표시될 수 있습니다. 이 Codelab의 목적상 선택은 중요하지 않습니다.
  2. 1분 정도 지나면 Firebase 프로젝트가 준비됩니다. 계속 을 클릭합니다.

3. 샘플 프로젝트 설정

코드 다운로드

다음 명령어를 실행하여 이 Codelab의 샘플 코드를 복제합니다. 이렇게 하면 컴퓨터에 friendlyeats-android 라는 폴더가 생성됩니다.

$ git clone https://github.com/firebase/friendlyeats-android

컴퓨터에 git이 없는 경우 GitHub에서 직접 코드를 다운로드할 수도 있습니다.

Firebase 구성 추가

  1. Firebase 콘솔 의 왼쪽 탐색 메뉴에서 프로젝트 개요 를 선택합니다. Android 버튼을 클릭하여 플랫폼을 선택합니다. 패키지 이름을 입력하라는 메시지가 표시되면 com.google.firebase.example.fireeats 를 사용합니다.

73d151ed16016421.png

  1. 앱 등록 을 클릭하고 안내에 따라 google-services.json 파일을 다운로드하고 방금 다운로드한 코드의 app/ 폴더로 이동합니다. 그런 다음 다음 을 클릭합니다.

프로젝트 가져오기

안드로이드 스튜디오를 엽니다. File > New > Import Project 를 클릭하고 friendlyeats-android 폴더를 선택합니다.

4. Firebase 에뮬레이터 설정

이 Codelab에서는 Firebase Emulator Suite 를 사용하여 Cloud Firestore 및 기타 Firebase 서비스를 로컬에서 에뮬레이션합니다. 이는 앱을 빌드할 수 있는 안전하고 빠르며 비용이 들지 않는 로컬 개발 환경을 제공합니다.

Firebase CLI 설치

먼저 Firebase CLI 를 설치해야 합니다. macOS 또는 Linux를 사용하는 경우 다음 cURL 명령을 실행할 수 있습니다.

curl -sL https://firebase.tools | bash

Windows를 사용하는 경우 독립 실행형 바이너리를 얻거나 npm 을 통해 설치하려면 설치 지침 을 읽으십시오.

CLI를 설치한 후 firebase --version 을 실행하면 9.0.0 이상의 버전이 보고되어야 합니다.

$ firebase --version
9.0.0

로그인

firebase login 을 실행하여 CLI를 Google 계정에 연결합니다. 로그인 프로세스를 완료하기 위해 새 브라우저 창이 열립니다. 이전에 Firebase 프로젝트를 만들 때 사용한 것과 동일한 계정을 선택해야 합니다.

friendlyeats-android 폴더 내에서 firebase를 실행 firebase use --add 를 사용하여 로컬 프로젝트를 Firebase 프로젝트에 연결합니다. 프롬프트에 따라 이전에 만든 프로젝트를 선택하고 별칭을 선택하라는 메시지가 표시되면 default 를 입력합니다.

5. 앱 실행

이제 Firebase Emulator Suite와 FriendlyEats Android 앱을 처음으로 실행할 차례입니다.

에뮬레이터 실행

터미널의 friendlyeats-android 디렉토리에서 firebase emulators:start 를 실행하여 Firebase 에뮬레이터를 시작합니다. 다음과 같은 로그가 표시되어야 합니다.

$ firebase emulators:start
i  emulators: Starting emulators: auth, firestore
i  firestore: Firestore Emulator logging to firestore-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

이제 컴퓨터에서 실행되는 완전한 로컬 개발 환경이 있습니다! Codelab의 나머지 부분에서는 이 명령어를 실행 상태로 두어야 합니다. Android 앱을 에뮬레이터에 연결해야 합니다.

앱을 에뮬레이터에 연결

Android 스튜디오에서 util/FirestoreInitializer.ktutil/AuthInitializer.kt 파일을 엽니다. 이 파일에는 애플리케이션 시작 시 Firebase SDK를 컴퓨터에서 실행 중인 로컬 에뮬레이터에 연결하는 논리가 포함되어 있습니다.

FirestoreInitializer 클래스의 create() 메서드에서 다음 코드를 검사합니다.

    // Use emulators only in debug builds
    if (BuildConfig.DEBUG) {
        firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
    }

우리는 BuildConfig 를 사용하여 앱이 debug 모드에서 실행될 때만 에뮬레이터에 연결되도록 합니다. release 모드에서 앱을 컴파일하면 이 조건은 false가 됩니다.

Firebase SDK를 로컬 Firestore 에뮬레이터에 연결하기 위해 useEmulator(host, port) 메서드를 사용하고 있음을 알 수 있습니다. 앱 전체에서 FirebaseUtil.getFirestore() 를 사용하여 이 FirebaseFirestore 인스턴스에 액세스하므로 debug 모드에서 실행할 때 항상 Firestore 에뮬레이터에 연결하고 있는지 확인합니다.

앱 실행

google-services.json 파일을 제대로 추가했으면 이제 프로젝트가 컴파일됩니다. Android Studio에서 Build > Rebuild Project 를 클릭하고 남은 오류가 없는지 확인합니다.

Android Studio에서 Android 에뮬레이터에서 앱을 실행 합니다. 처음에는 "로그인" 화면이 표시됩니다. 이메일과 비밀번호를 사용하여 앱에 로그인할 수 있습니다. 이 로그인 프로세스는 Firebase 인증 에뮬레이터에 연결되므로 실제 사용자 인증 정보가 전송되지 않습니다.

이제 웹 브라우저에서 http://localhost:4000 으로 이동하여 에뮬레이터 UI를 엽니다. 그런 다음 인증 탭을 클릭하면 방금 만든 계정이 표시됩니다.

Firebase 인증 에뮬레이터

로그인 프로세스를 완료하면 앱 홈 화면이 표시됩니다.

de06424023ffb4b9.png

곧 우리는 홈 화면을 채우기 위해 일부 데이터를 추가할 것입니다.

6. Firestore에 데이터 쓰기

이 섹션에서는 현재 비어 있는 홈 화면을 채울 수 있도록 Firestore에 일부 데이터를 씁니다.

우리 앱의 주요 모델 개체는 레스토랑입니다( model/Restaurant.kt 참조). Firestore 데이터는 문서, 컬렉션, 하위 컬렉션으로 분할됩니다. 우리는 각 레스토랑을 "restaurants" 이라는 최상위 컬렉션에 문서로 저장할 것입니다. Firestore 데이터 모델에 대해 자세히 알아보려면 문서에서 문서 및 컬렉션에 대해 읽어보세요.

시연을 위해 더보기 메뉴에서 "무작위 항목 추가" 버튼을 클릭하면 10개의 임의 레스토랑을 생성하는 기능을 앱에 추가합니다. MainFragment.kt 파일을 열고 onAddItemsClicked() 메서드의 콘텐츠를 다음으로 바꿉니다.

    private fun onAddItemsClicked() {
        val restaurantsRef = firestore.collection("restaurants")
        for (i in 0..9) {
            // Create random restaurant / ratings
            val randomRestaurant = RestaurantUtil.getRandom(requireContext())

            // Add restaurant
            restaurantsRef.add(randomRestaurant)
        }
    }

위의 코드에 대해 주목해야 할 몇 가지 중요한 사항이 있습니다.

  • 우리는 "restaurants" 컬렉션에 대한 참조를 얻는 것으로 시작했습니다. 컬렉션은 문서가 추가될 때 암시적으로 생성되므로 데이터를 쓰기 전에 컬렉션을 생성할 필요가 없습니다.
  • 각 식당 문서를 만드는 데 사용하는 Kotlin 데이터 클래스를 사용하여 문서를 만들 수 있습니다.
  • add() 메서드는 자동 생성된 ID로 컬렉션에 문서를 추가하므로 각 레스토랑에 고유한 ID를 지정할 필요가 없습니다.

이제 앱을 다시 실행하고 오버플로 메뉴(오른쪽 상단 모서리)에서 "무작위 항목 추가" 버튼을 클릭하여 방금 작성한 코드를 호출합니다.

95691e9b71ba55e3.png

이제 웹 브라우저에서 http://localhost:4000 으로 이동하여 에뮬레이터 UI를 엽니다. 그런 다음 Firestore 탭을 클릭하면 방금 추가한 데이터가 표시됩니다.

Firebase 인증 에뮬레이터

이 데이터는 컴퓨터에 100% 로컬입니다. 실제로 실제 프로젝트에는 아직 Firestore 데이터베이스가 포함되어 있지 않습니다! 이것은 결과 없이 이 데이터를 수정하고 삭제하는 실험이 안전하다는 것을 의미합니다.

축하합니다. 방금 Firestore에 데이터를 작성했습니다! 다음 단계에서는 이 데이터를 앱에 표시하는 방법을 알아봅니다.

7. Firestore의 데이터 표시

이 단계에서는 Firestore에서 데이터를 검색하여 앱에 표시하는 방법을 배웁니다. Firestore에서 데이터를 읽는 첫 번째 단계는 Query 를 만드는 것입니다. MainFragment.kt 파일을 열고 다음 코드를 onViewCreated() 메서드의 시작 부분에 추가합니다.

        // Firestore
        firestore = Firebase.firestore

        // Get the 50 highest rated restaurants
        query = firestore.collection("restaurants")
            .orderBy("avgRating", Query.Direction.DESCENDING)
            .limit(LIMIT.toLong())

이제 쿼리를 듣고 일치하는 모든 문서를 가져오고 향후 업데이트에 대한 알림을 실시간으로 받으려고 합니다. 최종 목표는 이 데이터를 RecyclerView 에 바인딩하는 것이므로 데이터를 수신할 RecyclerView.Adapter 클래스를 만들어야 합니다.

이미 부분적으로 구현된 FirestoreAdapter 클래스를 엽니다. 먼저 어댑터가 EventListener 를 구현하고 Firestore 쿼리에 대한 업데이트를 수신할 수 있도록 onEvent 함수를 정의해 보겠습니다.

abstract class FirestoreAdapter<VH : RecyclerView.ViewHolder>(private var query: Query?) :
        RecyclerView.Adapter<VH>(),
        EventListener<QuerySnapshot> { // Add this implements
    
    // ...

    // Add this method
    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {
        
        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e)
            return
        }

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        // TODO: handle document added
                    }
                    DocumentChange.Type.MODIFIED -> {
                        // TODO: handle document changed
                    }
                    DocumentChange.Type.REMOVED -> {
                        // TODO: handle document removed
                    }
                }
            }
        }

        onDataChanged()
    }
    
    // ...
}

초기 로드 시 리스너는 각 새 문서에 대해 하나의 ADDED 이벤트를 수신합니다. 쿼리의 결과 집합이 시간이 지남에 따라 변경되면 수신기는 변경 사항이 포함된 더 많은 이벤트를 수신하게 됩니다. 이제 리스너 구현을 마치겠습니다. 먼저 onDocumentAdded , onDocumentModifiedonDocumentRemoved 의 세 가지 새 메서드를 추가합니다.

    private fun onDocumentAdded(change: DocumentChange) {
        snapshots.add(change.newIndex, change.document)
        notifyItemInserted(change.newIndex)
    }

    private fun onDocumentModified(change: DocumentChange) {
        if (change.oldIndex == change.newIndex) {
            // Item changed but remained in same position
            snapshots[change.oldIndex] = change.document
            notifyItemChanged(change.oldIndex)
        } else {
            // Item changed and changed position
            snapshots.removeAt(change.oldIndex)
            snapshots.add(change.newIndex, change.document)
            notifyItemMoved(change.oldIndex, change.newIndex)
        }
    }

    private fun onDocumentRemoved(change: DocumentChange) {
        snapshots.removeAt(change.oldIndex)
        notifyItemRemoved(change.oldIndex)
    }

그런 다음 onEvent 에서 다음 새 메서드를 호출합니다.

    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {

        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e)
            return
        }

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        onDocumentAdded(change) // Add this line
                    }
                    DocumentChange.Type.MODIFIED -> {
                        onDocumentModified(change) // Add this line
                    }
                    DocumentChange.Type.REMOVED -> {
                        onDocumentRemoved(change) // Add this line
                    }
                }
            }
        }

        onDataChanged()
    }

마지막으로 startListening() 메서드를 구현하여 리스너를 연결합니다.

    fun startListening() {
        if (registration == null) {
            registration = query.addSnapshotListener(this)
        }
    }

이제 앱이 Firestore에서 데이터를 읽도록 완전히 구성되었습니다. 앱을 다시 실행 하면 이전 단계에서 추가한 레스토랑이 표시됩니다.

9e45f40faefce5d0.png

이제 브라우저의 에뮬레이터 UI로 돌아가 레스토랑 이름 중 하나를 편집합니다. 앱에서 거의 즉시 변경되는 것을 볼 수 있습니다!

8. 데이터 정렬 및 필터링

앱은 현재 전체 컬렉션에서 최고 평점 레스토랑을 표시하지만 실제 레스토랑 앱에서는 사용자가 데이터를 정렬하고 필터링하기를 원할 것입니다. 예를 들어 앱은 "필라델피아 최고의 해산물 레스토랑" 또는 "가장 저렴한 피자"를 표시할 수 있어야 합니다.

앱 상단의 흰색 막대를 클릭하면 필터 대화 상자가 나타납니다. 이 섹션에서는 Firestore 쿼리를 사용하여 이 대화상자가 작동하도록 합니다.

67898572a35672a5.png

MainFragment.kt 의 MainFragment.kt onFilter() 메서드를 편집해 보겠습니다. 이 메서드는 필터 대화 상자의 출력을 캡처하기 위해 만든 도우미 개체인 Filters 개체를 허용합니다. 필터에서 쿼리를 구성하도록 이 메서드를 변경합니다.

    override fun onFilter(filters: Filters) {
        // Construct query basic query
        var query: Query = firestore.collection("restaurants")

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo(Restaurant.FIELD_CATEGORY, filters.category)
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo(Restaurant.FIELD_CITY, filters.city)
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo(Restaurant.FIELD_PRICE, filters.price)
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.sortBy.toString(), filters.sortDirection)
        }

        // Limit items
        query = query.limit(LIMIT.toLong())

        // Update the query
        adapter.setQuery(query)

        // Set header
        binding.textCurrentSearch.text = HtmlCompat.fromHtml(
            filters.getSearchDescription(requireContext()),
            HtmlCompat.FROM_HTML_MODE_LEGACY
        )
        binding.textCurrentSortBy.text = filters.getOrderDescription(requireContext())

        // Save filters
        viewModel.filters = filters
    }

위의 스니펫에서는 주어진 필터와 일치하도록 whereorderBy 절을 연결하여 Query 개체를 빌드합니다.

앱을 다시 실행 하고 다음 필터를 선택하여 가장 인기 있는 저가 레스토랑을 표시합니다.

7a67a8a400c80c50.png

이제 저렴한 옵션만 포함된 필터링된 레스토랑 목록이 표시됩니다.

a670188398c3c59.png

여기까지 했다면 이제 Firestore에서 완벽하게 작동하는 레스토랑 추천 보기 앱을 구축한 것입니다! 이제 레스토랑을 실시간으로 정렬하고 필터링할 수 있습니다. 다음 몇 섹션에서는 레스토랑에 리뷰를 추가하고 앱에 보안 규칙을 추가합니다.

9. 데이터를 하위 컬렉션으로 구성

이 섹션에서는 사용자가 좋아하는(또는 가장 좋아하지 않는) 레스토랑을 리뷰할 ​​수 있도록 앱에 등급을 추가합니다.

컬렉션 및 하위 컬렉션

지금까지 우리는 "레스토랑"이라는 최상위 컬렉션에 모든 레스토랑 데이터를 저장했습니다. 사용자가 식당을 평가할 때 우리는 식당에 새 Rating 개체를 추가하려고 합니다. 이 작업을 위해 하위 컬렉션을 사용합니다. 하위 컬렉션은 문서에 첨부된 컬렉션으로 생각할 수 있습니다. 따라서 각 식당 문서에는 평가 문서로 가득 찬 평가 하위 컬렉션이 있습니다. 하위 컬렉션은 문서를 부풀리거나 복잡한 쿼리를 요구하지 않고 데이터를 구성하는 데 도움이 됩니다.

하위 컬렉션에 액세스하려면 상위 문서에서 .collection() 을 호출합니다.

val subRef = firestore.collection("restaurants")
        .document("abc123")
        .collection("ratings")

최상위 컬렉션과 마찬가지로 하위 컬렉션에 액세스하고 쿼리할 수 있으며 크기 제한이나 성능 변경이 없습니다. 여기 에서 Firestore 데이터 모델에 대해 자세히 알아볼 수 있습니다.

트랜잭션에 데이터 쓰기

적절한 하위 컬렉션에 Rating 을 추가하려면 .add() 를 호출하기만 하면 되지만 Restaurant 개체의 평균 등급과 등급 수를 업데이트하여 새 데이터를 반영해야 합니다. 별도의 작업을 사용하여 이러한 두 가지 변경을 수행하는 경우 부실하거나 잘못된 데이터를 초래할 수 있는 여러 경쟁 조건이 있습니다.

등급이 제대로 추가되었는지 확인하기 위해 트랜잭션을 사용하여 식당에 등급을 추가합니다. 이 트랜잭션은 몇 가지 작업을 수행합니다.

  • 레스토랑의 현재 등급을 읽고 새 등급을 계산합니다.
  • 하위 컬렉션에 등급 추가
  • 레스토랑의 평균 평점 및 평점 수 업데이트

RestaurantDetailFragment.kt 를 열고 addRating 함수를 구현합니다.

    private fun addRating(restaurantRef: DocumentReference, rating: Rating): Task<Void> {
        // Create reference for new rating, for use inside the transaction
        val ratingRef = restaurantRef.collection("ratings").document()

        // In a transaction, add the new rating and update the aggregate totals
        return firestore.runTransaction { transaction ->
            val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()
                ?: throw Exception("Restaurant not found at ${restaurantRef.path}")

            // Compute new number of ratings
            val newNumRatings = restaurant.numRatings + 1

            // Compute new average rating
            val oldRatingTotal = restaurant.avgRating * restaurant.numRatings
            val newAvgRating = (oldRatingTotal + rating.rating) / newNumRatings

            // Set new restaurant info
            restaurant.numRatings = newNumRatings
            restaurant.avgRating = newAvgRating

            // Commit to Firestore
            transaction.set(restaurantRef, restaurant)
            transaction.set(ratingRef, rating)

            null
        }
    }

addRating() 함수는 전체 트랜잭션을 나타내는 Task 을 반환합니다. onRating() 함수에서 리스너가 작업에 추가되어 트랜잭션 결과에 응답합니다.

이제 앱을 다시 실행 하고 레스토랑 중 하나를 클릭하면 레스토랑 세부 정보 화면이 나타납니다. 리뷰 추가를 시작하려면 + 버튼을 클릭하세요. 여러 개의 별표를 선택하고 텍스트를 입력하여 리뷰를 추가하세요.

78fa16cdf8ef435a.png

제출 을 누르면 거래가 시작됩니다. 거래가 완료되면 아래에 귀하의 리뷰가 표시되고 레스토랑의 리뷰 수에 대한 업데이트가 표시됩니다.

f9e670f40bd615b0.png

축하해요! 이제 Cloud Firestore에 빌드된 소셜, 로컬, 모바일 레스토랑 리뷰 앱이 있습니다. 요즘 아주 인기가 많다고 들었습니다.

10. 데이터 보안

지금까지 우리는 이 애플리케이션의 보안을 고려하지 않았습니다. 사용자가 올바른 자신의 데이터만 읽고 쓸 수 있다는 것을 어떻게 알 수 있습니까? Firestore 데이터베이스는 보안 규칙 이라는 구성 파일로 보호됩니다.

firestore.rules 파일을 열면 다음이 표시됩니다.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      //
      // WARNING: These rules are insecure! We will replace them with
      // more secure rules later in the codelab
      //
      allow read, write: if request.auth != null;
    }
  }
}

원치 않는 데이터 액세스 또는 변경을 방지하기 위해 이러한 규칙을 변경하고 firestore.rules 파일을 열고 콘텐츠를 다음으로 바꿉니다.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Determine if the value of the field "key" is the same
    // before and after the request.
    function isUnchanged(key) {
      return (key in resource.data)
        && (key in request.resource.data)
        && (resource.data[key] == request.resource.data[key]);
    }

    // Restaurants
    match /restaurants/{restaurantId} {
      // Any signed-in user can read
      allow read: if request.auth != null;

      // Any signed-in user can create
      // WARNING: this rule is for demo purposes only!
      allow create: if request.auth != null;

      // Updates are allowed if no fields are added and name is unchanged
      allow update: if request.auth != null
                    && (request.resource.data.keys() == resource.data.keys())
                    && isUnchanged("name");

      // Deletes are not allowed.
      // Note: this is the default, there is no need to explicitly state this.
      allow delete: if false;

      // Ratings
      match /ratings/{ratingId} {
        // Any signed-in user can read
        allow read: if request.auth != null;

        // Any signed-in user can create if their uid matches the document
        allow create: if request.auth != null
                      && request.resource.data.userId == request.auth.uid;

        // Deletes and updates are not allowed (default)
        allow update, delete: if false;
      }
    }
  }
}

이러한 규칙은 클라이언트가 안전한 변경만 수행하도록 액세스를 제한합니다. 예를 들어 식당 문서를 업데이트하면 등급만 변경할 수 있고 이름이나 기타 변경할 수 없는 데이터는 변경할 수 없습니다. 사용자 ID가 로그인한 사용자와 일치하는 경우에만 평점을 생성할 수 있으므로 스푸핑을 방지할 수 있습니다.

보안 규칙에 대한 자세한 내용 은 설명서 를 참조하십시오.

11. 결론

이제 Firestore 위에 모든 기능을 갖춘 앱을 만들었습니다. 다음과 같은 가장 중요한 Firestore 기능에 대해 배웠습니다.

  • 문서 및 컬렉션
  • 데이터 읽기 및 쓰기
  • 쿼리로 정렬 및 필터링
  • 하위 컬렉션
  • 업무

더 알아보기

Firestore에 대해 계속 알아보려면 시작하기에 좋은 몇 가지 위치를 소개합니다.

이 Codelab의 레스토랑 앱은 'Friendly Eats' 예시 애플리케이션을 기반으로 합니다. 여기 에서 해당 앱의 소스 코드를 찾아볼 수 있습니다.

선택 사항: 프로덕션에 배포

지금까지 이 앱은 Firebase Emulator Suite만 사용했습니다. 이 앱을 실제 Firebase 프로젝트에 배포하는 방법을 알아보려면 다음 단계를 계속 진행하세요.

12. (선택 사항) 앱 배포

지금까지 이 앱은 완전히 로컬이었고 모든 데이터는 Firebase Emulator Suite에 포함되어 있습니다. 이 섹션에서는 이 앱이 프로덕션 환경에서 작동하도록 Firebase 프로젝트를 구성하는 방법을 알아봅니다.

Firebase 인증

Firebase 콘솔에서 인증 섹션으로 이동하고 시작하기 를 클릭합니다. 로그인 방법 탭으로 이동하고 기본 공급자 에서 이메일/비밀번호 옵션을 선택합니다.

이메일/비밀번호 로그인 방법을 활성화하고 저장 을 클릭합니다.

로그인-providers.png

소방서

데이터베이스 생성

콘솔의 Firestore 데이터베이스 섹션으로 이동하고 데이터베이스 생성 을 클릭합니다.

  1. 보안 규칙에 대한 메시지가 표시되면 프로덕션 모드 에서 시작하도록 선택하면 해당 규칙이 곧 업데이트됩니다.
  2. 앱에 사용할 데이터베이스 위치를 선택합니다. 데이터베이스 위치 선택은 영구적인 결정이며 이를 변경하려면 새 프로젝트를 만들어야 합니다. 프로젝트 위치 선택에 대한 자세한 내용은 설명서 를 참조하십시오.

배포 규칙

이전에 작성한 보안 규칙을 배포하려면 Codelab 디렉터리에서 다음 명령어를 실행하세요.

$ firebase deploy --only firestore:rules

이렇게 하면 firestore.rules 의 콘텐츠가 프로젝트에 배포되며 콘솔의 규칙 탭으로 이동하여 확인할 수 있습니다.

인덱스 배포

FriendlyEats 앱에는 여러 가지 사용자 지정 복합 인덱스가 필요한 복잡한 정렬 및 필터링 기능이 있습니다. Firebase 콘솔에서 직접 생성할 수 있지만 firestore.indexes.json 파일에 정의를 작성하고 Firebase CLI를 사용하여 배포하는 것이 더 간단합니다.

firestore.indexes.json 파일을 열면 필요한 색인이 이미 제공되었음을 알 수 있습니다.

{
  "indexes": [
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    }
  ],
  "fieldOverrides": []
}

이러한 인덱스를 배포하려면 다음 명령을 실행합니다.

$ firebase deploy --only firestore:indexes

색인 생성은 즉시 이루어지지 않으며 Firebase 콘솔에서 진행 상황을 모니터링할 수 있습니다.

앱 구성

util/FirestoreInitializer.ktutil/AuthInitializer.kt 파일에서 디버그 모드에 있을 때 에뮬레이터에 연결하도록 Firebase SDK를 구성했습니다.

    override fun create(context: Context): FirebaseFirestore {
        val firestore = Firebase.firestore
        // Use emulators only in debug builds
        if (BuildConfig.DEBUG) {
            firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
        }
        return firestore
    }

실제 Firebase 프로젝트로 앱을 테스트하려는 경우 다음 중 하나를 수행할 수 있습니다.

  1. 릴리스 모드에서 앱을 빌드하고 장치에서 실행합니다.
  2. 임시로 BuildConfig.DEBUGfalse 로 바꾸고 앱을 다시 실행합니다.

프로덕션에 제대로 연결하려면 앱에서 로그아웃했다가 다시 로그인 해야 할 수 있습니다.