Kết nối ứng dụng với Trình mô phỏng Cloud Firestore

Trước khi kết nối ứng dụng với trình mô phỏng 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, cài đặt và định cấu hình Local Emulator Suite cũng như xem lại các lệnh CLI của trình mô phỏng này.

Chọn một dự án Firebase

Firebase Local Emulator Suite mô phỏng các sản phẩm cho một dự án Firebase.

Để chọn dự án cần sử dụng, trước khi khởi động trình mô phỏng, trong CLI, hãy chạy firebase use trong thư mục đang hoạt động. Hoặc bạn có thể truyền cờ --project đến từng lệnh của trình mô phỏng.

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

Loại dự án Tính năng Sử dụng với trình mô phỏng
Thực

Dự án Firebase thực là dự án mà 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ó tài nguyên trực tiếp, chẳng hạn như các thực thể cơ sở dữ liệu, bộ chứa bộ nhớ, hàm 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 mô phỏng cho bất kỳ hoặc tất cả các sản phẩm được hỗ trợ.

Đối với mọi sản phẩm mà 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, bộ chứa bộ nhớ, hàm, v.v.).

Bản trình diễn

Dự án Firebase minh hoạ không có cấu hình Firebase thực và không có tài nguyên trực tiếp. Bạn thường truy cập vào các dự án này thông qua các lớp học lập trình hoặc các hướng dẫn khác.

Mã dự án cho các dự án minh hoạ có tiền tố demo-.

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

Bạn nên sử dụng các dự án minh hoạ bất cứ khi nào có thể. Các lợi ích bao gồm:

  • Dễ thiết lập hơn vì bạn có thể chạy trình mô phỏng 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 (thực tế), thì sẽ không có khả năng thay đổi dữ liệu, mức sử dụng và thông tin thanh toán
  • Hỗ trợ tốt hơn khi không có mạng, vì bạn không cần truy cập Internet để tải cấu hình SDK xuống.

Đo lường ứng dụng của bạn để giao tiếp với trình mô phỏng

Khi khởi động, trình mô phỏng Cloud Firestore sẽ tạo một cơ sở dữ liệu mặc định và một cơ sở dữ liệu được đặt tên cho mỗi cấu hình firestore trong tệp firebase.json.

Cơ sở dữ liệu được đặt tên cũng được tạo ngầm để phản hồi mọi lệnh gọi SDK hoặc API REST đến trình mô phỏng tham chiếu đến một cơ sở dữ liệu cụ thể. Các cơ sở dữ liệu được tạo ngầm ẩn như vậy hoạt động theo quy tắc mở.

Để tương tác với cơ sở dữ liệu mặc định và cơ sở dữ liệu được đặt tên trong Emulator Suite UI, trong thanh địa chỉ của trình duyệt, hãy cập nhật URL để chọn cơ sở dữ liệu mặc định hoặc cơ sở dữ liệu được đặt tên.

  • Ví dụ: để duyệt dữ liệu trong thực thể mặc định, hãy cập nhật URL thành localhost:4000/firestore/default/data
  • Để duyệt xem trong một thực thể có tên ecommerce, hãy cập nhật lên localhost:4000/firestore/ecommerce/data.

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

Thiết lập cấu hình trong ứng dụng hoặc các lớp kiểm thử để tương tác với Cloud Firestore như sau. Xin lưu ý rằng trong các mẫu sau, mã ứng dụng đang kết nối với cơ sở dữ liệu dự án mặc định. Để biết các ví dụ liên quan đến cơ sở dữ liệu Cloud Firestore bổ sung ngoài cơ sở dữ liệu mặc định, hãy tham khảo hướng dẫn về nhiều cơ sở dữ liệu.

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
}
EmulatorSuite.kt
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);
EmulatorSuite.java
Swift
let settings = Firestore.firestore().settings
settings.host = "127.0.0.1:8080"
settings.cacheSettings = MemoryCacheSettings()
settings.isSSLEnabled = false
Firestore.firestore().settings = settings
ViewController.swift

Web

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

// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
fs_emulator_connect.js

Web

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

Bạn không cần thiết lập thêm để kiểm thử các Hàm trên đám mây do các sự kiện Firestore kích hoạt bằng trình mô phỏng. Khi trình mô phỏng Firestore và Cloud Functions đều đang chạy, các trình mô phỏng này sẽ tự động hoạt động cùng nhau.

Admin SDK giây

Firebase Admin SDK sẽ tự động kết nối với trình mô phỏng Cloud Firestore khi bạn đặt biến môi trường FIRESTORE_EMULATOR_HOST:

export FIRESTORE_EMULATOR_HOST="127.0.0.1:8080"

Nếu mã của bạn đang chạy bên trong trình mô phỏng Cloud Functions, thì mã nhận dạng dự án và cấu hình khác sẽ tự động được đặt khi gọi initializeApp.

Nếu muốn mã Admin SDK kết nối với trình mô phỏng dùng chung đang chạy trong một môi trường khác, bạn cần chỉ định cùng một mã dự án mà bạn đã đặt bằng Firebase CLI. Bạn có thể trực tiếp truyền mã dự án đến initializeApp hoặc đặt biến môi trường GCLOUD_PROJECT.

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

Xoá cơ sở dữ liệu giữa các lần kiểm thử

Firestore phát hành công khai không cung cấp phương thức SDK nền tảng để xoá cơ sở dữ liệu, nhưng trình mô phỏng Firestore cung cấp cho bạn một điểm cuối REST dành riêng cho mục đích này. Bạn có thể gọi điểm cuối này từ bước thiết lập/tearDown của khung kiểm thử, từ lớp kiểm thử hoặc từ shell (ví dụ: với curl) trước khi bắt đầu kiểm thử. Bạn có thể sử dụng phương pháp này thay vì chỉ tắt quy trình trình mô phỏng.

Trong một phương thức thích hợp, hãy thực hiện thao tác XOÁ HTTP, cung cấp projectID Firebase, ví dụ: 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 về việc xả đã hoàn tất 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 bước như vậy, bạn có thể sắp xếp các bài kiểm thử và kích hoạt các hàm của mình mà không lo dữ liệu cũ sẽ bị xoá giữa các lần chạy và bạn đang sử dụng cấu hình kiểm thử cơ sở mới.

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

Trình mô phỏng cơ sở dữ liệu và Cloud Storage for Firebase cho phép bạn xuất dữ liệu từ một thực thể trình mô phỏng đang chạy. Xác định một tập dữ liệu cơ sở để sử dụng trong các quy trình kiểm thử đơn vị hoặc tích hợp liên tục, sau đó xuất tập dữ liệu đó để chia sẻ với 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 mô phỏng xuất dữ liệu khi tắt máy, bằng cách chỉ định đường dẫn xuất hoặc chỉ cần sử dụng đường dẫn được truyền đến cờ --import.

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

Các tuỳ chọn nhập và xuất dữ liệu này cũng hoạt động với lệnh firebase emulators:exec. Để biết thêm thông tin, hãy tham khảo tài liệu tham khảo về lệnh trong trình mô phỏng.

Hình ảnh hoá hoạt động của Quy tắc bảo mật

Khi xử lý vòng lặp nguyên mẫu và kiểm thử, bạn có thể sử dụng các công cụ trực quan hoá và báo cáo do Local Emulator Suite cung cấp.

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

Trình mô phỏng Cloud Firestore cho phép bạn hình dung các yêu cầu của ứng dụng trong Emulator Suite UI, bao gồm cả tính năng theo dõi đánh giá cho Firebase Security Rules.

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

Trình theo dõi yêu cầu của Trình mô phỏng Firestore cho thấy kết quả đánh giá Quy tắc bảo mật

Hình ảnh hoá báo cáo Đánh giá quy tắc

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

Sau khi chạy một bộ kiểm thử, bạn có thể truy cập vào các báo cáo về phạm vi kiểm thử để biết cách đánh giá từng quy tắc bảo mật.

Để nhận báo cáo, hãy truy vấn một điểm cuối được hiển thị trên trình mô phỏng trong khi trình mô phỏng đ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

Thao tác này sẽ chia 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 cả số lượt đá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 thêm URL sau vào 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 làm nổi bật các lượt đánh giá gây ra lỗi không xác định và lỗi giá trị rỗng:

Sự khác biệt giữa trình mô phỏng Cloud Firestore và bản phát hành chính thức

Trình mô phỏng Cloud Firestore cố gắng mô phỏng trung thực hành vi của dịch vụ phát hành công khai với một số hạn chế đáng chú ý.

Hỗ trợ nhiều cơ sở dữ liệu cho Cloud Firestore

Hiện tại, Emulator Suite UI hỗ trợ việc tạo, chỉnh sửa, xoá, giám sát yêu cầu và trực quan hoá bảo mật một cách tương tác cho cơ sở dữ liệu mặc định, nhưng không hỗ trợ các cơ sở dữ liệu được đặt tên khác.

Tuy nhiên, chính trình mô phỏng sẽ tạo một cơ sở dữ liệu được đặt tên dựa trên cấu hình trong tệp firebase.json và ngầm ẩn để phản hồi các lệnh gọi SDK hoặc API REST.

Giao dịch

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

Chỉ mục

Trình mô phỏng không theo dõi các chỉ mục phức hợp mà sẽ thực thi mọi truy vấn hợp lệ. Hãy nhớ kiểm thử ứng dụng của bạn trên một thực thể Cloud Firestore thực để xác định những chỉ mục bạn cần.

Giới hạn

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

Bước tiếp theo là gì?