Trước khi kết nối ứng dụng của bạn với trình mô phỏng Cloud Firestore, hãy đảm bảo rằng bạn nắm rõ quy trình công việc tổng thể của Bộ mô phỏng cục bộ của Firebase, đồng thời cài đặt và định cấu hình Bộ mô phỏng cục bộ cũng như xem xét các lệnh CLI của bộ công cụ này.
Chọn một dự án Firebase
Bộ công cụ 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ẽ sử dụng, trước khi bạn khởi động trình mô phỏng, trong CLI, hãy chạy
firebase use trong thư mục đang hoạt động của bạn. Bạn cũng có thể chuyển cờ --project vào từng lệnh của trình mô phỏng.
Bộ công cụ mô phỏng cục bộ hỗ trợ việc mô phỏng các dự án Firebase thực và các 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 tế là dự án do bạn tạo và định cấu hình (nhiều khả năng là thông qua bảng điều khiển của Firebase). Các dự án thực tế 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, 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 tế, bạn có thể chạy trình mô phỏng cho bất kỳ hoặc tất 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 (thực thể cơ sở dữ liệu, bộ chứa lưu trữ, 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. Những dự án này thường được truy cập thông qua lớp học lập trình hoặc các hướng dẫn khác. Mã dự án của các dự án minh hoạ có tiền tố |
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:
- Thiết lập dễ dàng hơn vì bạn có thể chạy trình mô phỏng mà không cần tạo dự án Firebase
- Mức độ an toàn cao 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 (chính thức), thì sẽ không có khả năng thay đổi dữ liệu, mức 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 cấu hình SDK xuống.
Đo lường ứng dụng của bạn để trò chuyện 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 từng cấu hình firestore trong tệp firebase.json.
Các 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 API REST hoặc SDK đến trình mô phỏng tham chiếu đến một cơ sở dữ liệu cụ thể. Những cơ sở dữ liệu được tạo ngầm như vậy hoạt động với các quy tắc mở.
Để làm việc với các cơ sở dữ liệu mặc định và cơ sở dữ liệu được đặt tên theo cách tương tác trong giao diện người dùng của Bộ mô phỏng, 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 xem 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ênlocalhost:4000/firestore/ecommerce/data.
Nền tảng Android, 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 mặc định của dự án. Để xem các ví dụ liên quan đến các cơ sở dữ liệu khác của Cloud Firestore ngoài cơ sở dữ liệu mặc định, hãy tham khảo hướng dẫn dành cho 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
}
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);
Swift
let settings = Firestore.firestore().settings settings.host = "127.0.0.1:8080" settings.cacheSettings = MemoryCacheSettings() settings.isSSLEnabled = false Firestore.firestore().settings = settings
Web
import { getFirestore, connectFirestoreEmulator } from "firebase/firestore";
// firebaseApps previously initialized using initializeApp()
const db = getFirestore();
connectFirestoreEmulator(db, '127.0.0.1', 8080);
Web
// Firebase previously initialized using firebase.initializeApp().
var db = firebase.firestore();
if (location.hostname === "localhost") {
db.useEmulator("127.0.0.1", 8080);
}
Bạn không cần thiết lập thêm để kiểm thử Cloud Functions được kích hoạt bởi các sự kiện Firestore bằng trình mô phỏng. Khi cả hai trình mô phỏng Firestore và Cloud Functions đang chạy, chúng sẽ tự động phối hợp hoạt động cùng nhau.
SDK dành cho quản trị viên
SDK quản trị của 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="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, mã dự án và các cấu hình khác sẽ tự động được đặt khi gọi initializeApp.
Nếu muốn mã SDK quản trị của mình kết nối với một trình mô phỏng dùng chung 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 giao diện dòng lệnh (CLI) của Firebase.
Bạn có thể truyền trực tiếp 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ử
Production Firestore không cung cấp phương thức SDK nền tảng để đẩy 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 REST từ bước thiết lập khung kiểm thử/tearDown, từ mộ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 của trình mô phỏng.
Thực hiện thao tác XÓA HTTP trong một phương thức thích hợp, cung cấp mã 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 phải chờ REST xác nhận rằng việc xả dữ liệu đã hoàn tất hay 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ư vậy, bạn có thể sắp xếp trình tự kiểm thử và kích hoạt các hàm của mình một cách tự tin rằng dữ liệu cũ sẽ bị xoá hoàn toàn 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
Cơ sở dữ liệu và trình mô phỏng Cloud Storage cho 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 dữ liệu cơ sở để sử dụng trong các kiểm thử đơn vị hoặc quy trình tích hợp liên tục, sau đó xuất tập dữ liệu đó để chia sẻ trong nhóm.
firebase emulators:export ./dir
Trong các chương trình kiểm thử, 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 đơn giản là 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 trình mô phỏng.
Trực quan hoá hoạt động trong Quy tắc bảo mật
Khi thực hiện 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 hoá và báo cáo do Bộ mô phỏng cục bộ 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 trực quan hoá các yêu cầu của ứng dụng trong giao diện người dùng của Bộ công cụ mô phỏng, bao gồm cả hoạt động theo dõi hoạt động đánh giá cho Quy tắc bảo mật của Firebase.
Mở thẻ Firestore > Yêu cầu để xem trình tự đánh giá chi tiết cho từng yêu cầu.
Trực quan 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 của mình, bạn có thể gỡ lỗi bằng các công cụ gỡ lỗi Bộ mô phỏng cục bộ.
Sau khi chạy một bộ kiểm thử, bạn có thể truy cập vào báo cáo kiểm thử mức độ phù hợp, cho biết cách đánh giá từng quy tắc bảo mật của bạn.
Để nhận báo cáo, hãy truy vấn một điểm cuối hiển thị trên trình mô phỏng 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 chia các quy tắc của bạn thành các biểu thức và biểu thức phụ mà bạn có thể di chuột qua để biết thêm thông tin, bao gồm cả 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 đưa 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 đánh giá gửi lỗi không xác định và có giá trị rỗng:
Điểm khác biệt giữa trình mô phỏng Cloud Firestore và bản phát hành công khai
Trình mô phỏng Cloud Firestore cố gắng sao chép một cách trung thực hành vi của dịch vụ chính thức, kèm theo một số hạn chế đáng chú ý.
Hỗ trợ nhiều cơ sở dữ liệu cho Cloud Firestore
Hiện tại, giao diện người dùng của Trình mô phỏng hỗ trợ tính năng tạo, chỉnh sửa, xoá, giám sát yêu cầu và trực quan hoá tính bảo mật tương tác cho một cơ sở dữ liệu mặc định, chứ không hỗ trợ các cơ sở dữ liệu khác có tên.
Tuy nhiên, trình mô phỏng sẽ tự 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 API SDK hoặc 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 đã thấy trong phiên bản chính thức. Khi bạn kiểm thử các tính năng liên quan đến nhiều lượt ghi đồng thời vào một tài liệu, trình mô phỏng có thể hoàn tất các yêu cầu ghi đồng thời bị chậm. Trong một số trường hợp, có thể mất đến 30 giây thì khoá mới xuất hiện. Hãy cân nhắc việc điều chỉnh thời gian chờ thử nghiệm sao cho phù hợp (nếu cần).
Chỉ số
Trình mô phỏng không theo dõi các chỉ mục phức hợp mà thay vào đó, 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 với một phiên bản Cloud Firestore thực để xác định những chỉ mục bạn sẽ cần.
Các 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 bị dịch vụ sản xuất từ chối vì lý do quá lớn. Hãy đảm bảo bạn đã nắm rõ các giới hạn trong tài liệu và bạn thiết kế ứng dụng để chủ động tránh các giới hạn đó.
Tiếp theo là gì?
- Để xem tập hợp các video được tuyển chọn và ví dụ chi tiết về cách thực hiện, hãy theo dõi Danh sách phát đào tạo về trình mô phỏng Firebase.
- Điều tra các trường hợp sử dụng nâng cao liên quan đến kiểm thử Quy tắc bảo mật và SDK thử nghiệm Firebase: Kiểm thử Quy tắc bảo mật (Firestore).
- Vì hàm được kích hoạt là một dạng tích hợp điển hình với Cloud Firestore, nên bạn có thể tìm hiểu thêm về Trình mô phỏng Cloud Functions cho Firebase trong bài viết Chạy các hàm cục bộ.