Cloud Firestore Android Codelab

1. 개요

목표

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

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

전제 조건

이 코드랩을 시작하기 전에 다음 사항을 확인하세요.

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

2. Firebase 프로젝트 생성

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

9d2f625aebcab6af.png

  1. 이 코드랩에서는 선택이 중요하지 않으므로 Google Analytics를 활성화하라는 메시지가 표시될 수 있습니다.
  2. 1분 정도 지나면 Firebase 프로젝트가 준비됩니다. 계속 을 클릭합니다.

3. 샘플 프로젝트 설정

코드 다운로드

다음 명령을 실행하여 이 코드랩의 샘플 코드를 복제합니다. 그러면 컴퓨터에 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/ 폴더로 이동합니다. 그런 다음 다음 을 클릭합니다.

프로젝트 가져오기

안드로이드 스튜디오를 엽니다. 파일 > 새로 만들기 > 프로젝트 가져오기 를 클릭하고 friendlyeats-android 폴더를 선택합니다.

4. Firebase 에뮬레이터 설정

이 코드랩에서는 Firebase 에뮬레이터 제품군 을 사용하여 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 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 Studio에서 FirebaseUtil.java 파일을 엽니다. 이 파일에는 Firebase SDK를 머신에서 실행되는 로컬 에뮬레이터에 연결하는 로직이 포함되어 있습니다.

파일 상단에서 다음 줄을 검사합니다.

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

앱이 debug 모드에서 실행 중일 때만 에뮬레이터에 연결하도록 BuildConfig 를 사용하고 있습니다. release 모드에서 앱을 컴파일하면 이 조건은 거짓이 됩니다.

이제 getFirestore() 메소드를 살펴보십시오.

    public static FirebaseFirestore getFirestore() {
        if (FIRESTORE == null) {
            FIRESTORE = FirebaseFirestore.getInstance();

            // Connect to the Cloud Firestore emulator when appropriate. The host '10.0.2.2' is a
            // special IP address to let the Android emulator connect to 'localhost'.
            if (sUseEmulators) {
                FIRESTORE.useEmulator("10.0.2.2", 8080);
            }
        }

        return FIRESTORE;
    }

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.java 참조). Firestore 데이터는 문서, 컬렉션 및 하위 컬렉션으로 분할됩니다. 각 레스토랑을 "restaurants" 라는 최상위 컬렉션에 문서로 저장합니다. Firestore 데이터 모델에 대해 자세히 알아보려면 설명서에서 문서 및 컬렉션에 대해 읽어보세요.

시연을 위해 오버플로 메뉴에서 "임의 항목 추가" 버튼을 클릭하면 10개의 임의 레스토랑을 만드는 기능을 앱에 추가합니다. MainActivity.java 파일을 열고 onAddItemsClicked() 메서드의 내용을 다음으로 바꿉니다.

    private void onAddItemsClicked() {
        // Get a reference to the restaurants collection
        CollectionReference restaurants = mFirestore.collection("restaurants");

        for (int i = 0; i < 10; i++) {
            // Get a random Restaurant POJO
            Restaurant restaurant = RestaurantUtil.getRandom(this);

            // Add a new document to the restaurants collection
            restaurants.add(restaurant);
        }
    }

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

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

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

95691e9b71ba55e3.png

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

Firebase 인증 에뮬레이터

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

축하합니다. 방금 Firestore에 데이터를 썼습니다! 다음 단계에서는 이 데이터를 앱에 표시하는 방법을 배웁니다.

7. Firestore의 데이터 표시

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

        mFirestore = FirebaseUtil.getFirestore();

        // Get the 50 highest rated restaurants
        mQuery = mFirestore.collection("restaurants")
                .orderBy("avgRating", Query.Direction.DESCENDING)
                .limit(LIMIT);

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

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

public abstract class FirestoreAdapter<VH extends RecyclerView.ViewHolder>
        extends RecyclerView.Adapter<VH>
        implements EventListener<QuerySnapshot> { // Add this "implements"

    // ...

    // Add this method
    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

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

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    // TODO: handle document added
                    break;
                case MODIFIED:
                    // TODO: handle document modified
                    break;
                case REMOVED:
                    // TODO: handle document removed
                    break;
            }
        }

        onDataChanged();
    }

  // ...
}

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

    protected void onDocumentAdded(DocumentChange change) {
        mSnapshots.add(change.getNewIndex(), change.getDocument());
        notifyItemInserted(change.getNewIndex());
    }

    protected void onDocumentModified(DocumentChange change) {
        if (change.getOldIndex() == change.getNewIndex()) {
            // Item changed but remained in same position
            mSnapshots.set(change.getOldIndex(), change.getDocument());
            notifyItemChanged(change.getOldIndex());
        } else {
            // Item changed and changed position
            mSnapshots.remove(change.getOldIndex());
            mSnapshots.add(change.getNewIndex(), change.getDocument());
            notifyItemMoved(change.getOldIndex(), change.getNewIndex());
        }
    }

    protected void onDocumentRemoved(DocumentChange change) {
        mSnapshots.remove(change.getOldIndex());
        notifyItemRemoved(change.getOldIndex());
    }

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

    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

        // ...

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    onDocumentAdded(change); // Add this line
                    break;
                case MODIFIED:
                    onDocumentModified(change); // Add this line
                    break;
                case REMOVED:
                    onDocumentRemoved(change); // Add this line
                    break;
            }
        }

        onDataChanged();
    }

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

    public void startListening() {
        if (mQuery != null && mRegistration == null) {
            mRegistration = mQuery.addSnapshotListener(this);
        }
    }

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

9e45f40faefce5d0.png

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

8. 데이터 정렬 및 필터링

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

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

67898572a35672a5.png

MainActivity.javaonFilter() 메소드를 수정해 봅시다. 이 메서드는 필터 대화 상자의 출력을 캡처하기 위해 만든 도우미 개체인 Filters 개체를 받습니다. 필터에서 쿼리를 구성하도록 이 메서드를 변경합니다.

    @Override
    public void onFilter(Filters filters) {
        // Construct basic query
        Query query = mFirestore.collection("restaurants");

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo("category", filters.getCategory());
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo("city", filters.getCity());
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo("price", filters.getPrice());
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.getSortBy(), filters.getSortDirection());
        }

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

        // Update the query
        mQuery = query;
        mAdapter.setQuery(query);

        // Set header
        mCurrentSearchView.setText(Html.fromHtml(filters.getSearchDescription(this)));
        mCurrentSortByView.setText(filters.getOrderDescription(this));

        // Save filters
        mViewModel.setFilters(filters);
    }

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

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

7a67a8a400c80c50.png

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

a670188398c3c59.png

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

9. 하위 컬렉션의 데이터 구성

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

컬렉션 및 하위 컬렉션

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

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

CollectionReference subRef = mFirestore.collection("restaurants")
        .document("abc123")
        .collection("ratings");

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

트랜잭션에 데이터 쓰기

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

평가가 제대로 추가되었는지 확인하기 위해 트랜잭션을 사용하여 레스토랑에 평가를 추가합니다. 이 트랜잭션은 몇 가지 작업을 수행합니다.

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

RestaurantDetailActivity.java 를 열고 addRating 기능을 구현합니다.

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

        // In a transaction, add the new rating and update the aggregate totals
        return mFirestore.runTransaction(new Transaction.Function<Void>() {
            @Override
            public Void apply(Transaction transaction)
                    throws FirebaseFirestoreException {

                Restaurant restaurant = transaction.get(restaurantRef)
                        .toObject(Restaurant.class);

                // Compute new number of ratings
                int newNumRatings = restaurant.getNumRatings() + 1;

                // Compute new average rating
                double oldRatingTotal = restaurant.getAvgRating() *
                        restaurant.getNumRatings();
                double newAvgRating = (oldRatingTotal + rating.getRating()) /
                        newNumRatings;

                // Set new restaurant info
                restaurant.setNumRatings(newNumRatings);
                restaurant.setAvgRating(newAvgRating);

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

                return 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에 대해 계속 배우려면 다음과 같이 시작하는 것이 좋습니다.

이 코드랩의 레스토랑 앱은 "Friendly Eats" 예제 애플리케이션을 기반으로 했습니다. 여기 에서 해당 앱의 소스 코드를 탐색할 수 있습니다.

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

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

12. (선택 사항) 앱 배포

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

Firebase 인증

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

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

로그인 제공자.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 콘솔에서 진행 상황을 모니터링할 수 있습니다.

앱 구성

FirebaseUtil 클래스에서 디버그 모드에 있을 때 에뮬레이터에 연결하도록 Firebase SDK를 구성했습니다.

public class FirebaseUtil {

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

    // ...
}

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

  1. 릴리스 모드에서 앱을 빌드하고 기기에서 실행합니다.
  2. 일시적으로 sUseEmulatorsfalse 로 변경하고 앱을 다시 실행합니다.

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