Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Kết nối ứng dụng của bạn với Trình giả lập Cloud Firestore

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Trước khi kết nối ứng dụng của bạn với trình giả lập Cloud Firestore, hãy đảm bảo rằng bạn hiểu quy trình làm việc tổng thể của Firebase Local Emulator Suite và bạn cài đặt cũng như định cấu hình Local Emulator Suite và xem lại các lệnh CLI của nó.

Chọn một dự án Firebase

Bộ mô phỏng cục bộ Firebase mô phỏng các sản phẩm cho một dự án Firebase duy nhất.

Để chọn dự án để sử dụng, trước khi bạn khởi động trình giả lập, trong CLI, hãy chạy firebase use trong thư mục làm việc của bạn. Hoặc, bạn có thể chuyển cờ --project cho mỗi lệnh giả lập.

Local Emulator Suite hỗ trợ mô phỏng các dự án Firebase thực và các dự án demo .

Loại dự án Đặc trưng Sử dụng với trình giả lập
Có thật

Dự án Firebase thực là dự án bạn đã tạo và định cấu hình (rất có thể là thông qua bảng điều khiển Firebase).

Các dự án thực có các tài nguyên trực tiếp, chẳng hạn như các phiên bản cơ sở dữ liệu, nhóm lưu trữ, chức năng hoặc bất kỳ tài nguyên nào khác mà bạn thiết lập cho dự án Firebase đó.

Khi làm việc với các dự án Firebase thực, bạn có thể chạy trình giả lập cho bất kỳ hoặc tất cả các sản phẩm được hỗ trợ.

Đối với bất kỳ sản phẩm nào bạn không mô phỏng, ứng dụng và mã của bạn sẽ tương tác với tài nguyên trực tiếp (phiên bản cơ sở dữ liệu, nhóm lưu trữ, chức năng, v.v.).

Thử nghiệm

Dự án Firebase demo không có cấu hình Firebase thực và không có tài nguyên trực tiếp. Các dự án này thường được truy cập thông qua codelabs hoặc các hướng dẫn khác.

ID dự án cho các dự án demo có tiền tố demo- .

Khi làm việc với các dự án Firebase demo, các ứng dụng và mã của bạn chỉ tương tác với trình giả lập. Nếu ứng dụng của bạn cố gắng tương tác với tài nguyên mà trình mô phỏng không chạy, thì mã đó sẽ không thành công.

Chúng tôi khuyên bạn nên sử dụng các dự án demo bất cứ khi nào có thể. Lợi ích bao gồm:

  • Thiết lập dễ dàng hơn, vì bạn có thể chạy trình giả lập mà không cần tạo dự án Firebase
  • An toàn hơn, vì nếu mã của bạn vô tình gọi các tài nguyên không được mô phỏng (sản xuất), sẽ không có cơ hội thay đổi dữ liệu, sử dụng và thanh toán
  • Hỗ trợ ngoại tuyến tốt hơn, vì không cần truy cập internet để tải xuống cấu hình SDK của bạn.

Tạo công cụ cho ứng dụng của bạn để nói chuyện với trình giả lập

Nền tảng Android, Apple và SDK web

Thiết lập cấu hình trong ứng dụng của bạn hoặc các lớp thử nghiệm để tương tác với Cloud Firestore như sau.

Android
// 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);
Nhanh
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);
}

Không cần thiết lập bổ sung để kiểm tra Chức năng đám mây được kích hoạt bởi các sự kiện Firestore bằng trình mô phỏng. Khi trình giả lập Firestore và Cloud Functions đều chạy, chúng sẽ tự động hoạt động cùng nhau.

SDK dành cho quản trị viên

SDK quản trị Firebase tự động kết nối với trình mô phỏng Cloud Firestore khi biến môi trường FIRESTORE_EMULATOR_HOST được đặt:

export FIRESTORE_EMULATOR_HOST="localhost:8080"

Nếu mã của bạn đang chạy bên trong trình giả lập Chức năng đám mây, ID dự án và cấu hình khác của bạn sẽ được tự động đặt khi gọi initalizeApp .

Nếu bạn muốn mã SDK quản trị viên của mình kết nối với trình mô phỏng dùng chung đang chạy trong môi trường khác, bạn sẽ cần chỉ định cùng một ID dự án mà bạn đã đặt bằng cách sử dụng Firebase CLI . Bạn có thể chuyển một ID dự án để initializeApp ứng dụng trực tiếp hoặc đặt biến môi trường GCLOUD_PROJECT .

SDK quản trị Node.js
admin.initializeApp({ projectId: "your-project-id" });
Biến môi trường
export GCLOUD_PROJECT="your-project-id"

Xóa cơ sở dữ liệu của bạn giữa các lần kiểm tra

Sản xuất Firestore không cung cấp phương pháp SDK nền tảng để xóa cơ sở dữ liệu, nhưng trình giả lập Firestore cung cấp cho bạn một điểm cuối REST đặc biệt cho mục đích này, có thể được gọi từ bước thiết lập khung thử nghiệm / xé nhỏ, từ lớp thử nghiệm hoặc từ trình bao (ví dụ: , với curl ) trước khi bắt đầu thử nghiệm. Bạn có thể sử dụng phương pháp này để thay thế cho việc tắt quá trình giả lập.

Trong một phương pháp thích hợp, hãy thực hiện thao tác XÓA HTTP, cung cấp ID dự án Firebase của bạn, chẳng hạn như firestore-emulator-example , cho điểm cuối sau:

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

Đương nhiên, mã của bạn sẽ chờ xác nhận REST rằng quá trình xả đã hoàn thành hoặc không thành công.

Bạn có thể thực hiện thao tác này từ shell:

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

Sau khi triển khai một bước như thế này, bạn có thể trình tự các thử nghiệm và kích hoạt các chức năng của mình với sự tự tin rằng dữ liệu cũ sẽ được xóa giữa các lần chạy và bạn đang sử dụng cấu hình thử nghiệm cơ sở mới.

Nhập và xuất dữ liệu

Cơ sở dữ liệu và Lưu trữ đám mây cho trình giả lập Firebase cho phép bạn xuất dữ liệu từ một phiên bản trình mô phỏng đang chạy. Xác định tập hợp dữ liệu cơ bản để sử dụng trong các bài kiểm tra đơn vị của bạn hoặc quy trình công việc tích hợp liên tục, sau đó xuất nó để chia sẻ giữa các nhóm.

firebase emulators:export ./dir

Trong các thử nghiệm, khi khởi động trình mô phỏng, hãy nhập dữ liệu cơ sở.

firebase emulators:start --import=./dir

Bạn có thể hướng dẫn trình giả lập xuất dữ liệu khi tắt máy, chỉ định đường dẫn xuất hoặc chỉ cần sử dụng đường dẫn được chuyển đến cờ --import .

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

Các tùy chọn nhập và xuất dữ liệu này cũng hoạt động với firebase emulators:exec lệnh execute. Để biết thêm, hãy tham khảo tham chiếu lệnh giả lập .

Trực quan hóa hoạt động Quy tắc bảo mật

Khi bạn làm việc qua các vòng lặp thử nghiệm và nguyên mẫu, bạn có thể sử dụng các công cụ trực quan hóa và báo cáo được cung cấp bởi Local Emulator Suite.

Sử dụng Trình theo dõi yêu cầu

Trình giả lập Cloud Firestore cho phép bạn trực quan hóa các yêu cầu của khách hàng trong Giao diện người dùng của Emulator Suite, bao gồm theo dõi đánh giá đối với Quy tắc bảo mật của Firebase.

Mở tab Firestore> Yêu cầu để xem trình tự đánh giá chi tiết cho từng yêu cầu.

Màn hình yêu cầu trình giả lập Firestore hiển thị đánh giá Quy tắc bảo mật

Trực quan hóa báo cáo đánh giá Quy tắc

Khi bạn thêm Quy tắc bảo mật vào nguyên mẫu của mình, bạn có thể gỡ lỗi chúng bằng các công cụ gỡ lỗi Local Emulator Suite.

Sau khi chạy một bộ thử nghiệm, bạn có thể truy cập các báo cáo phạm vi thử nghiệm cho biết từng quy tắc bảo mật của bạn đã được đánh giá như thế nào.

Để nhận các báo cáo, hãy truy vấn một điểm cuối được tiếp xúc trên trình giả lập khi nó đang chạy. Đối với phiên bản thân thiện với trình duyệt, hãy sử dụng URL sau:

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

Điều này phá vỡ các quy tắc của bạn thành các biểu thức và biểu thức con mà bạn có thể di chuột qua để biết thêm thông tin, bao gồm số lượng đánh giá và giá trị được trả về. Đối với phiên bản JSON thô của dữ liệu này, hãy bao gồm URL sau trong truy vấn của bạn:

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

Ở đây, phiên bản HTML của báo cáo nêu bật các đánh giá gây ra lỗi không xác định và giá trị rỗng:

Trình giả lập Cloud Firestore khác với phiên bản sản xuất như thế nào

Trình giả lập Cloud Firestore cố gắng tái tạo trung thực hành vi của dịch vụ sản xuất với một số hạn chế đáng chú ý.

Giao dịch

Trình giả lập hiện không triển khai tất cả các hành vi giao dịch được thấy trong quá trình sản xuất. Khi bạn đang thử nghiệm các tính năng liên quan đến nhiều lần ghi đồng thời vào một tài liệu, trình giả lập có thể chậm hoàn thành các yêu cầu ghi. Trong một số trường hợp, có thể mất tới 30 giây để mở ổ khóa. Cân nhắc điều chỉnh thời gian chờ kiểm tra cho phù hợp, nếu cần.

Chỉ mục

Trình giả lập không theo dõi các chỉ mục phức hợp và thay vào đó sẽ thực hiện bất kỳ truy vấn hợp lệ nào. Đảm bảo kiểm tra ứng dụng của bạn so với phiên bản Cloud Firestore thực để xác định chỉ mục nào bạn sẽ cần.

Hạn mức

Trình giả lập không thực thi tất cả các giới hạn được thực thi trong quá trình sản xuất. Ví dụ: trình giả lập có thể cho phép các giao dịch bị dịch vụ sản xuất từ ​​chối vì quá lớn. Đảm bảo rằng bạn đã quen với các giới hạn được ghi lại và bạn thiết kế ứng dụng của mình để chủ động tránh chúng.

Tiếp theo là gì?