Firebase 로컬 에뮬레이터 도구 모음은 일회성 프로토타이핑 세션에서 프로덕션 규모의 지속적 통합 워크플로에 이르기까지 다양한 프로토타입 및 테스트 환경에 맞게 설치하고 구성할 수 있습니다.
로컬 에뮬레이터 제품군 설치
Emulator Suite를 설치하기 전에 다음이 필요합니다.
에뮬레이터 도구 모음을 설치하려면:
- Firebase CLI 를 설치합니다. 아직 Firebase CLI를 설치하지 않았다면 지금 설치하세요 . Emulator Suite를 사용하려면 CLI 버전 8.14.0 이상이 필요합니다. 다음 명령을 사용하여 설치한 버전을 확인할 수 있습니다.
firebase --version
- 아직 수행하지 않은 경우 사용할 제품을 지정하라는 화면 프롬프트에 따라 현재 작업 디렉터리를 Firebase 프로젝트로 초기화합니다.
firebase init
- 에뮬레이터 도구 모음을 설정합니다. 이 명령은 관심 있는 에뮬레이터를 선택하고, 해당 에뮬레이터 바이너리 파일을 다운로드하고, 기본값이 적절하지 않은 경우 에뮬레이터 포트를 설정할 수 있는 구성 마법사를 시작합니다.
firebase init emulators
에뮬레이터가 설치되면 업데이트 확인이 수행되지 않으며 Firebase CLI 버전을 업데이트할 때까지 추가 자동 다운로드가 발생하지 않습니다.
에뮬레이터 제품군 구성
선택적으로 firebase.json 파일에서 에뮬레이터의 네트워크 포트와 보안 규칙 정의 경로를 구성할 수 있습니다.
-
firebase init emulators를 실행하거나firebase.json을 수동으로 편집하여 에뮬레이터 포트를 변경합니다. -
firebase.json을 수동으로 편집하여 보안 규칙 정의에 대한 경로를 변경합니다.
이러한 설정을 구성하지 않으면 에뮬레이터가 기본 포트에서 수신 대기하고 Cloud Firestore, 실시간 데이터베이스 및 Firebase용 Cloud Storage 에뮬레이터가 개방형 데이터 보안으로 실행됩니다.
| 명령 | 설명 |
|---|---|
| 초기화 에뮬레이터 | 에뮬레이터 초기화 마법사를 시작합니다. 설치할 에뮬레이터를 식별하고 선택적으로 에뮬레이터 포트 설정을 지정합니다. init emulators 는 비파괴적입니다. 기본값을 수락하면 현재 에뮬레이터 구성이 유지됩니다. |
포트 구성
각 에뮬레이터는 선호하는 기본값으로 컴퓨터의 다른 포트에 바인딩됩니다.
| 에뮬레이터 | 기본 포트 |
|---|---|
| 입증 | 9099 |
| 에뮬레이터 도구 모음 UI | 4000 |
| 클라우드 기능 | 5001 |
| 이벤타르크 | 9299 |
| 실시간 데이터베이스 | 9000 |
| 클라우드 파이어스토어 | 8080 |
| Firebase용 클라우드 저장소 | 9199 |
| Firebase 호스팅 | 5000 |
| 게시/구독 | 8085 |
프로젝트 ID 구성
에뮬레이터를 호출하는 방법에 따라 서로 다른 Firebase 프로젝트 ID를 사용하여 에뮬레이터의 여러 인스턴스를 실행하거나 지정된 프로젝트 ID에 대해 여러 에뮬레이터 인스턴스를 실행할 수 있습니다. 이러한 경우 에뮬레이터 인스턴스는 별도의 환경에서 실행됩니다.
일반적으로 모든 에뮬레이터 호출에 대해 하나의 프로젝트 ID를 설정하는 것이 좋습니다. 그러면 에뮬레이터 도구 모음 UI, 다른 제품 에뮬레이터 및 특정 에뮬레이터의 실행 중인 모든 인스턴스가 모든 경우에 올바르게 통신할 수 있습니다.
로컬 에뮬레이터 도구 모음은 환경에서 여러 프로젝트 ID를 감지하면 경고를 발생시키지만 firebase.json 에서 singleProjectMode 키를 false 로 설정하여 이 동작을 재정의할 수 있습니다.
다음 항목에서 프로젝트 ID 선언 불일치를 확인할 수 있습니다.
- 명령줄의 기본 프로젝트입니다. 기본적으로 프로젝트 ID는 시작 시
firebase init또는firebase use로 선택한 프로젝트에서 가져옵니다. 프로젝트 목록을 보고 어떤 프로젝트가 선택되었는지 확인하려면firebase projects:list를 사용하세요. - 규칙 단위 테스트. 프로젝트 ID는 Rules Unit Testing 라이브러리 메서드
initializeTestEnvironment또는initializeTestApp에 대한 호출에서 지정되는 경우가 많습니다. - 명령줄
--project플래그. Firebase CLI--project플래그를 전달하면 기본 프로젝트가 재정의됩니다. 단위 테스트 및 앱 초기화에서 플래그 값이 프로젝트 ID와 일치하는지 확인해야 합니다.
또한 Apple 플랫폼 , Android 및 웹 프로젝트를 구성하는 동안 설정한 플랫폼별 프로젝트 ID 구성을 확인하십시오.
보안 규칙 구성
에뮬레이터는 database , firestore 및 firebase.json 의 storage 구성 키에서 보안 규칙 구성을 가져옵니다.
{
// Existing firebase configuration ...
"database": {
"rules": "database.rules.json"
},
"firestore": {
"rules": "firestore.rules"
},
"storage": {
"rules": "storage.rules"
}
// ...
// Optional emulator configuration. Default
// values are used if absent.
"emulators": {
"singleProjectMode": false, // do not warn on detection of multiple project IDs
"firestore": {
"port": "8080"
},
"ui": {
"enabled": true, // Default is `true`
"port": 4000 // If unspecified, see CLI log for selected port
},
"auth": {
"port": "9099"
},
"pubsub": {
"port": "8085"
}
}
}
자바 옵션 지정
실시간 데이터베이스 에뮬레이터, Cloud Firestore 에뮬레이터, Firebase용 Cloud Storage 에뮬레이터의 일부는 환경 변수 JAVA_TOOL_OPTIONS 를 통해 JVM 플래그로 맞춤설정할 수 있는 자바를 기반으로 합니다.
예를 들어 Java 힙 공간 관련 오류가 발생하면 최대 Java 힙 크기를 4GB로 늘릴 수 있습니다.
export JAVA_TOOL_OPTIONS="-Xmx4g"
firebase emulators:start
JAVA_TOOL_OPTIONS="-Xms2g -Xmx4g" 와 같이 공백으로 구분된 따옴표 안에 여러 플래그를 지정할 수 있습니다. 플래그는 에뮬레이터의 자바 기반 구성요소에만 영향을 미치며 에뮬레이터 도구 모음 UI와 같은 Firebase CLI의 다른 부분에는 영향을 주지 않습니다.
에뮬레이터 시작
에뮬레이터를 시작하여 수동으로 종료할 때까지 실행하거나 지정된 테스트 스크립트 기간 동안 실행한 다음 자동으로 종료할 수 있습니다.
| 명령 | 설명 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 에뮬레이터:시작 | firebase.json 에 구성된 firebase.json 제품용 에뮬레이터를 시작합니다. 에뮬레이터 프로세스는 명시적으로 중지될 때까지 계속 실행됩니다. emulators:start 를 호출하면 에뮬레이터가 아직 설치되지 않은 경우 ~/.cache/firebase/emulators/에 다운로드됩니다.
| ||||||||||||
| 에뮬레이터:exec scriptpath | firebase.json에 구성된 firebase.json 제품의 에뮬레이터를 시작한 후 scriptpath 에서 스크립트를 실행합니다. 스크립트 실행이 완료되면 에뮬레이터 프로세스가 자동으로 중지됩니다.
|
firebase emulators:exec 메서드는 일반적으로 지속적 통합 워크플로에 더 적합합니다.
에뮬레이터 데이터 내보내기 및 가져오기
인증, Cloud Firestore, 실시간 데이터베이스, Firebase 에뮬레이터용 Cloud Storage에서 데이터를 내보내 공유 가능한 공통 기준 데이터 세트로 사용할 수 있습니다. 이러한 데이터 세트는 위에서 설명한 대로 --import 플래그를 사용하여 가져올 수 있습니다.
| 에뮬레이터:export export_directory | 인증, Cloud Firestore, 실시간 데이터베이스 또는 Firebase 에뮬레이터용 Cloud Storage 실행 중인 Cloud Firestore, 실시간 데이터베이스 또는 Firebase용 Cloud Storage 에뮬레이터 인스턴스에서 데이터를 내보냅니다. 지정된 위에서 설명한 |
CI 시스템과 통합
컨테이너화된 에뮬레이터 도구 모음 이미지 실행
일반적인 CI 설정에서 컨테이너가 포함된 에뮬레이터 제품군의 설치 및 구성은 간단합니다.
주의해야 할 몇 가지 문제가 있습니다.
JAR 파일은
~/.cache/firebase/emulators/에 설치 및 캐시됩니다.- 반복 다운로드를 피하기 위해 이 경로를 CI 캐시 구성에 추가할 수 있습니다.
저장소에
firebase.json파일이 없는 경우emulators:start또는emulators:exec명령에 명령줄 인수를 추가하여 시작할 에뮬레이터를 지정해야 합니다. 예를 들어,
--only functions,firestore.
인증 토큰 생성(호스팅 에뮬레이터만 해당)
지속적 통합 워크플로가 Firebase 호스팅에 의존하는 경우 firebase emulators:exec 를 실행하려면 토큰을 사용하여 로그인해야 합니다. 다른 에뮬레이터는 로그인이 필요하지 않습니다.
토큰을 생성하려면 로컬 환경에서 firebase login:ci 를 실행합니다. 이것은 CI 시스템에서 수행되어서는 안 됩니다. 안내에 따라 인증합니다. 토큰이 빌드 간에 유효하므로 이 단계는 프로젝트당 한 번만 수행하면 됩니다. 토큰은 암호처럼 취급되어야 합니다. 비밀로 유지되는지 확인하십시오.
CI 환경에서 빌드 스크립트에서 사용할 수 있는 환경 변수를 지정할 수 있는 경우 FIREBASE_TOKEN 이라는 환경 변수를 만들고 값은 액세스 토큰 문자열입니다. Firebase CLI는 자동으로 FIREBASE_TOKEN 환경 변수를 선택하고 에뮬레이터가 제대로 시작됩니다.
최후의 수단으로 빌드 스크립트에 토큰을 포함할 수 있지만 신뢰할 수 없는 당사자가 액세스할 수 없도록 해야 합니다. 이 하드 코딩 방식의 경우 --token "YOUR_TOKEN_STRING_HERE" 를 firebase firebase emulators:exec 명령에 추가할 수 있습니다.
에뮬레이터 허브 REST API 사용
실행 중인 에뮬레이터 나열
현재 실행 중인 에뮬레이터를 나열하려면 에뮬레이터 허브의 /emulators 끝점에 GET 요청을 보냅니다.
curl localhost:4400/emulators
결과는 실행 중인 모든 에뮬레이터와 해당 호스트/포트 구성을 나열하는 JSON 개체입니다. 예를 들면 다음과 같습니다.
{
"hub":{
"name": "hub",
"host": "localhost",
"port": 4400
},
"functions": {
"name": "functions",
"host": "localhost",
"port": 5001
}
"firestore": {
"name": "firestore",
"host": "localhost",
"port": 8080
}
}
백그라운드 기능 트리거 활성화/비활성화
경우에 따라 로컬 기능 및 확장 트리거를 일시적으로 비활성화해야 합니다. 예를 들어 Cloud Functions 또는 Extensions 에뮬레이터에서 실행 중인 onDelete 함수를 트리거하지 않고 Cloud Firestore 에뮬레이터의 모든 데이터를 삭제할 수 있습니다.
로컬 함수 트리거를 일시적으로 비활성화하려면 에뮬레이터 허브의 /functions/disableBackgroundTriggers 끝점에 PUT 요청을 보냅니다.
curl -X PUT localhost:4400/functions/disableBackgroundTriggers
결과는 현재 상태를 자세히 설명하는 JSON 개체입니다.
{
"enabled": false
}
비활성화된 후 로컬 함수 트리거를 활성화하려면 에뮬레이터 허브의 /functions/enableBackgroundTriggers 끝점에 PUT 요청을 보냅니다.
curl -X PUT localhost:4400/functions/enableBackgroundTriggers
결과는 현재 상태를 자세히 설명하는 JSON 개체입니다.
{
"enabled": true
}
에뮬레이터 SDK 통합
이 섹션의 표는 클라이언트 및 Admin SDK에서 지원하는 에뮬레이터를 나타냅니다. 미래 는 에뮬레이터 지원이 계획되었지만 아직 사용할 수 없음을 의미합니다.
클라이언트 SDK 가용성
| 기계적 인조 인간 | 애플 플랫폼 | 편물 | Firebase UI 기계적 인조 인간 | Firebase UI 아이폰 OS | Firebase UI 편물 | |
|---|---|---|---|---|---|---|
| 실시간 데이터베이스 | 19.4.0 | 7.2.0 | 8.0.0 | 6.4.0 | 미래 | 해당 없음 |
| 클라우드 파이어스토어 | 21.6.0 | 7.2.0 | 8.0.0 | 6.4.0 | 미래 | 해당 없음 |
| 입증 | 20.0.0 | 7.0.0 | 8.0.0 | 7.0.0 | 미래 | 4.7.2 |
| Firebase용 클라우드 저장소 | 20.0.0 | 8.0.0 | 8.4.0 | 7.0.0 | 11.0.0 | 해당 없음 |
| 클라우드 기능 | 19.1.0 | 7.2.0 | 8.0.0 | 해당 없음 | 해당 없음 | 해당 없음 |
| 호스팅 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 |
| 확장 프로그램 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 |
Admin SDK 가용성
| 마디 | 자바 | 파이썬 | 가다 | |
|---|---|---|---|---|
| 실시간 데이터베이스 | 8.6.0 | 6.10.0 | 2.18.0 | 미래 |
| 클라우드 파이어스토어 | 8.0.0 | 6.10.0 | 3.0.0 | 1.0.0 |
| 입증 | 9.3.0 | 7.2.0 | 5.0.0 | 4.2.0 |
| Firebase용 클라우드 저장소 | 9.8.0 | 미래 | 미래 | 미래 |
| 클라우드 함수 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 |
| 호스팅 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 |
| 확장 프로그램 | 해당 없음 | 해당 없음 | 해당 없음 | 해당 없음 |