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

Cloud Firestore 에뮬레이터에 앱 연결

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

앱을 Cloud Firestore 에뮬레이터에 연결하기 전에 전체 Firebase 로컬 에뮬레이터 도구 모음 워크플로를 이해하고 로컬 에뮬레이터 도구 모음설치 및 구성 하고 해당 CLI 명령 을 검토해야 합니다.

Firebase 프로젝트 선택

Firebase 로컬 에뮬레이터 도구 모음은 단일 Firebase 프로젝트용 제품을 에뮬레이션합니다.

사용할 프로젝트를 선택하려면 에뮬레이터를 시작하기 전에 CLI에서 작업 디렉터리의 firebase use 를 실행합니다. 또는 각 에뮬레이터 명령에 --project 플래그를 전달할 수 있습니다.

로컬 에뮬레이터 도구 모음은 실제 Firebase 프로젝트 및 데모 프로젝트의 에뮬레이션을 지원합니다.

프로젝트 유형 특징 에뮬레이터와 함께 사용
진짜

실제 Firebase 프로젝트는 사용자가 만들고 구성한 것입니다(대부분 Firebase 콘솔을 통해).

실제 프로젝트에는 데이터베이스 인스턴스, 스토리지 버킷, 함수 또는 해당 Firebase 프로젝트에 대해 설정한 기타 리소스와 같은 라이브 리소스가 있습니다.

실제 Firebase 프로젝트로 작업할 때 지원되는 제품의 일부 또는 전부에 대해 에뮬레이터를 실행할 수 있습니다.

에뮬레이트하지 않는 제품의 경우 앱과 코드가 라이브 리소스(데이터베이스 인스턴스, 저장소 버킷, 함수 등)와 상호 작용합니다.

데모

데모 Firebase 프로젝트에는 실제 Firebase 구성과 라이브 리소스가 없습니다. 이러한 프로젝트는 일반적으로 Codelab 또는 기타 가이드를 통해 액세스합니다.

데모 프로젝트의 프로젝트 ID에는 demo- 접두사가 있습니다.

데모 Firebase 프로젝트로 작업할 때 앱과 코드는 에뮬레이터와 상호작용합니다. 앱이 에뮬레이터가 실행되고 있지 않은 리소스와 상호작용을 시도하면 해당 코드가 실패합니다.

가능하면 데모 프로젝트를 사용하는 것이 좋습니다. 이점은 다음과 같습니다.

  • Firebase 프로젝트를 만들지 않고도 에뮬레이터를 실행할 수 있으므로 더 쉬운 설정
  • 코드가 실수로 에뮬레이트되지 않은(프로덕션) 리소스를 호출하는 경우 데이터 변경, 사용 및 청구 가능성이 없기 때문에 더 강력한 안전성
  • SDK 구성을 다운로드하기 위해 인터넷에 액세스할 필요가 없으므로 오프라인 지원이 향상됩니다.

앱을 계측하여 에뮬레이터와 통신

Android, Apple 플랫폼 및 웹 SDK

다음과 같이 Cloud Firestore와 상호작용하도록 인앱 구성 또는 테스트 클래스를 설정합니다.

Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val firestore = Firebase.firestore
firestore.useEmulator("10.0.2.2", 8080)

firestore.firestoreSettings = firestoreSettings {
    isPersistenceEnabled = false
}
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFirestore firestore = FirebaseFirestore.getInstance();
firestore.useEmulator("10.0.2.2", 8080);

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(false)
        .build();
firestore.setFirestoreSettings(settings);
빠른
let settings = Firestore.firestore().settings
settings.host = "localhost:8080"
settings.isPersistenceEnabled = false 
settings.isSSLEnabled = false
Firestore.firestore().settings = settings

Web version 9

import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, 'localhost', 8080);

Web version 8

// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
  db.useEmulator("localhost", 8080);
}

에뮬레이터를 사용하여 Firestore 이벤트에 의해 트리거되는 Cloud Functions를 테스트하는 데 추가 설정이 필요하지 않습니다. Firestore와 Cloud Functions 에뮬레이터가 모두 실행 중이면 자동으로 함께 작동합니다.

관리자 SDK

Firebase Admin SDK는 FIRESTORE_EMULATOR_HOST 환경 변수가 설정되면 자동으로 Cloud Firestore 에뮬레이터에 연결됩니다.

export FIRESTORE_EMULATOR_HOST="localhost:8080"

코드가 Cloud Functions 에뮬레이터 내에서 실행 중인 경우 initalizeApp 을 호출할 때 프로젝트 ID 및 기타 구성이 자동으로 설정됩니다.

Admin SDK 코드를 다른 환경에서 실행 중인 공유 에뮬레이터에 연결 하려면 Firebase CLI를 사용하여 설정한 것과 동일한 프로젝트 ID 를 지정해야 합니다. 프로젝트 ID를 initializeApp 에 직접 전달하거나 GCLOUD_PROJECT 환경 변수를 설정할 수 있습니다.

Node.js 관리자 SDK
admin.initializeApp({ projectId: "your-project-id" });
환경 변수
export GCLOUD_PROJECT="your-project-id"

테스트 사이에 데이터베이스 지우기

프로덕션 Firestore는 데이터베이스를 플러시하기 위한 플랫폼 SDK 메서드를 제공하지 않지만 Firestore 에뮬레이터는 테스트 프레임워크 설정/tearDown 단계, 테스트 클래스 또는 셸(예: , curl ) 테스트가 시작되기 전에. 단순히 에뮬레이터 프로세스를 종료하는 대신 이 방법을 사용할 수 있습니다.

적절한 방법으로 Firebase 프로젝트 ID(예: firestore-emulator-example )를 다음 엔드포인트에 제공하여 HTTP DELETE 작업을 수행합니다.

"http://localhost:8080/emulator/v1/projects/firestore-emulator-example/databases/(default)/documents"

당연히 코드는 플러시가 완료되었거나 실패했다는 REST 확인을 기다려야 합니다.

셸에서 이 작업을 수행할 수 있습니다.

// Shell alternative…
$ curl -v -X DELETE "http://localhost:8080/emulator/v1/projects/firestore-emulator-example/databases/(default)/documents"

이와 같은 단계를 구현하면 이전 데이터가 실행 사이에 제거되고 새로운 기본 테스트 구성을 사용하고 있다는 확신을 가지고 테스트를 시퀀싱하고 기능을 트리거할 수 있습니다.

데이터 가져오기 및 내보내기

Firebase 에뮬레이터용 데이터베이스 및 Cloud Storage를 사용하면 실행 중인 에뮬레이터 인스턴스에서 데이터를 내보낼 수 있습니다. 단위 테스트 또는 지속적 통합 워크플로에서 사용할 기준 데이터 집합을 정의한 다음 팀 간에 공유할 수 있도록 내보냅니다.

firebase emulators:export ./dir

테스트에서 에뮬레이터 시작 시 기준 데이터를 가져옵니다.

firebase emulators:start --import=./dir

내보내기 경로를 지정하거나 단순히 --import 플래그에 전달된 경로를 사용하여 종료 시 데이터를 내보내도록 에뮬레이터에 지시할 수 있습니다.

firebase emulators:start --import=./dir --export-on-exit

이러한 데이터 가져오기 및 내보내기 옵션은 firebase emulators:exec 명령에서도 작동합니다. 자세한 내용은 에뮬레이터 명령 참조 를 참조하십시오.

보안 규칙 활동 시각화

프로토타입 및 테스트 루프를 통해 작업하면서 로컬 에뮬레이터 도구 모음에서 제공하는 시각화 도구 및 보고서를 사용할 수 있습니다.

요청 모니터 사용

Cloud Firestore 에뮬레이터를 사용하면 Firebase 보안 규칙에 대한 평가 추적을 포함하여 에뮬레이터 도구 모음 UI에서 클라이언트 요청을 시각화할 수 있습니다.

Firestore > 요청 탭을 열어 각 요청에 대한 자세한 평가 순서를 확인합니다.

보안 규칙 평가를 보여주는 Firestore 에뮬레이터 요청 모니터

규칙 평가 보고서 시각화

프로토타입에 보안 규칙을 추가할 때 로컬 에뮬레이터 도구 모음 디버그 도구를 사용하여 이를 디버깅할 수 있습니다.

일련의 테스트를 실행한 후 각 보안 규칙이 어떻게 평가되었는지 보여주는 테스트 적용 범위 보고서에 액세스할 수 있습니다.

보고서를 가져오려면 실행 중인 에뮬레이터에서 노출된 엔드포인트를 쿼리합니다. 브라우저 친화적 버전의 경우 다음 URL을 사용하십시오.

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage.html

이것은 반환된 평가 및 값의 수를 포함하여 자세한 정보를 위해 마우스를 올려놓을 수 있는 표현식 및 하위 표현식으로 규칙을 나눕니다. 이 데이터의 원시 JSON 버전의 경우 쿼리에 다음 URL을 포함합니다.

http://localhost:8080/emulator/v1/projects/<database_name>:ruleCoverage

여기에서 보고서의 HTML 버전은 정의되지 않은 null 값 오류를 발생시키는 평가를 강조 표시합니다.

Cloud Firestore 에뮬레이터와 프로덕션의 차이점

Cloud Firestore 에뮬레이터는 몇 가지 눈에 띄는 제한 사항이 있는 프로덕션 서비스의 동작을 충실하게 복제하려고 시도합니다.

업무

에뮬레이터는 현재 프로덕션에서 볼 수 있는 모든 트랜잭션 동작을 구현하지 않습니다. 하나의 문서에 대한 여러 동시 쓰기와 관련된 기능을 테스트하는 경우 에뮬레이터가 쓰기 요청을 완료하는 속도가 느릴 수 있습니다. 경우에 따라 잠금이 해제되는 데 최대 30초가 걸릴 수 있습니다. 필요한 경우 그에 따라 테스트 제한 시간을 조정하는 것이 좋습니다.

인덱스

에뮬레이터는 복합 인덱스를 추적하지 않고 대신 유효한 쿼리를 실행합니다. 필요한 색인을 결정하려면 실제 Cloud Firestore 인스턴스에 대해 앱을 테스트해야 합니다.

제한

에뮬레이터는 프로덕션에서 적용되는 모든 제한을 적용하지 않습니다. 예를 들어 에뮬레이터는 프로덕션 서비스에서 너무 커서 거부되는 트랜잭션을 허용할 수 있습니다. 문서화된 제한 사항 을 숙지하고 이를 사전에 방지하도록 앱을 설계해야 합니다.

다음은?

  • 선별된 동영상 모음과 자세한 사용 방법 예시를 보려면 Firebase Emulators Training Playlist 를 따르세요.
  • 보안 규칙 테스트 및 Firebase 테스트 SDK: 테스트 보안 규칙(Firestore) 과 관련된 고급 사용 사례를 조사합니다.
  • 트리거 함수는 Cloud Firestore와의 일반적인 통합이므로 Run functions local 에서 Firebase용 Cloud Functions 에뮬레이터에 대해 자세히 알아보세요.