Bạn có thể cài đặt và định cấu hình Bộ công cụ mô phỏng trên thiết bị của Firebase cho nhiều môi trường thử nghiệm và nguyên mẫu, từ các phiên tạo nguyên mẫu một lần cho đến quy trình tích hợp liên tục ở quy mô sản xuất.
Cài đặt Bộ công cụ mô phỏng trên thiết bị
Trước khi cài đặt Bộ công cụ mô phỏng, bạn cần có:
Cách cài đặt Bộ công cụ mô phỏng:
- Cài đặt Firebase CLI.
Nếu bạn chưa cài đặt Giao diện dòng lệnh (CLI) của Firebase, hãy cài đặt ngay.
Bạn cần có CLI phiên bản 8.14.0 trở lên để sử dụng Bộ công cụ mô phỏng. Bạn có thể kiểm tra phiên bản đã cài đặt bằng lệnh sau:
firebase --version
- Nếu bạn chưa thực hiện, hãy khởi động thư mục đang hoạt động hiện tại dưới dạng một dự án Firebase, làm theo dấu nhắc trên màn hình để chỉ định sản phẩm cần sử dụng:
firebase init
- Thiết lập Bộ công cụ mô phỏng. Lệnh này sẽ khởi động một trình hướng dẫn cấu hình cho phép bạn chọn trình mô phỏng mong muốn, tải các tệp nhị phân của trình mô phỏng tương ứng xuống và đặt cổng trình mô phỏng nếu cổng mặc định không phù hợp.
firebase init emulators
Sau khi cài đặt trình mô phỏng, hệ thống sẽ không kiểm tra bản cập nhật và không tự động tải thêm nội dung xuống cho đến khi bạn cập nhật phiên bản Giao diện dòng lệnh (CLI) của Firebase.
Định cấu hình Bộ công cụ mô phỏng
Bạn có thể tuỳ ý định cấu hình cổng mạng của trình mô phỏng và đường dẫn đến các định nghĩa Quy tắc bảo mật trong tệp firebase.json:
- Thay đổi cổng trình mô phỏng bằng cách chạy
firebase init emulatorshoặc chỉnh sửafirebase.jsontheo cách thủ công. - Thay đổi đường dẫn đến định nghĩa Quy tắc bảo mật bằng cách chỉnh sửa
firebase.jsontheo cách thủ công.
Nếu bạn không định cấu hình các chế độ cài đặt này, trình mô phỏng sẽ lắng nghe trên các cổng mặc định của chúng, đồng thời trình mô phỏng Cloud Firestore, Realtime Database và Cloud Storage for Firebase sẽ chạy với chế độ bảo mật dữ liệu mở.
| Ra lệnh | Mô tả |
|---|---|
| init emulators | Khởi động trình hướng dẫn khởi chạy trình mô phỏng. Xác định trình mô phỏng cần cài đặt và tuỳ ý chỉ định chế độ cài đặt cổng trình mô phỏng. init emulators không có tính huỷ diệt; việc chấp nhận các giá trị mặc định sẽ giữ nguyên cấu hình trình mô phỏng hiện tại. |
Cấu hình cổng
Mỗi trình mô phỏng liên kết với một cổng khác nhau trên máy của bạn bằng một giá trị mặc định ưu tiên.
| Trình mô phỏng | Cổng mặc định |
|---|---|
| Authentication | 9099 |
| App Hosting | 5002 |
| Emulator Suite UI | 4.000 |
| Cloud Functions | 5001 |
| Eventarc | 9299 |
| Realtime Database | 9000 |
| Cloud Firestore | 8080 |
| Cloud Storage for Firebase | 9199 |
| Firebase Hosting | 5000 |
| Pub/Sub | 8085 |
Cấu hình mã dự án
Tuỳ thuộc vào cách gọi trình mô phỏng, bạn có thể chạy nhiều phiên bản của một trình mô phỏng bằng cách sử dụng nhiều mã dự án Firebase hoặc nhiều phiên bản trình mô phỏng cho một mã dự án nhất định. Trong những trường hợp như vậy, các phiên bản trình mô phỏng sẽ chạy trong một môi trường riêng biệt.
Nhìn chung, bạn nên đặt một mã dự án cho tất cả các lệnh gọi trình mô phỏng để Emulator Suite UI, các trình mô phỏng sản phẩm khác nhau và tất cả các phiên bản đang chạy của một trình mô phỏng cụ thể có thể giao tiếp chính xác trong mọi trường hợp.
Local Emulator Suite sẽ đưa ra cảnh báo khi phát hiện nhiều mã dự án trong môi trường, mặc dù bạn có thể ghi đè hành vi này bằng cách đặt khoá singleProjectMode thành false trong firebase.json.
Bạn có thể kiểm tra (các) nội dung khai báo mã dự án để tìm thông tin không khớp trong:
- Dự án mặc định trong dòng lệnh. Theo mặc định, mã dự án sẽ được lấy khi khởi động từ dự án được chọn bằng
firebase inithoặcfirebase use. Để xem danh sách dự án (và xem dự án nào được chọn), hãy sử dụngfirebase projects:list. - Kiểm thử đơn vị quy tắc. Mã dự án thường được chỉ định trong các lệnh gọi đến các phương thức thư viện Kiểm thử đơn vị quy tắc
initializeTestEnvironmenthoặcinitializeTestApp. - Cờ hiệu dòng lệnh
--project. Việc truyền cờ CLI Firebase--projectsẽ ghi đè dự án mặc định. Bạn cần đảm bảo giá trị của cờ khớp với mã dự án trong các kiểm thử đơn vị và quá trình khởi chạy ứng dụng.
Ngoài ra, hãy kiểm tra cấu hình mã dự án dành riêng cho nền tảng mà bạn đã đặt trong khi định cấu hình các dự án nền tảng của Apple, Android và web.
Cấu hình Quy tắc bảo mật
Trình mô phỏng sẽ lấy cấu hình Quy tắc bảo mật từ các khoá cấu hình database, firestore và storage trong firebase.json.
{
// 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"
}
}
}
Chỉ định các tuỳ chọn Java
Trình mô phỏng Realtime Database, trình mô phỏng Cloud Firestore và một phần của trình mô phỏng Cloud Storage for Firebase dựa trên Java, có thể tuỳ chỉnh bằng cờ JVM thông qua biến môi trường JAVA_TOOL_OPTIONS.
Ví dụ: nếu gặp lỗi liên quan đến dung lượng vùng nhớ khối xếp Java, bạn có thể tăng kích thước vùng nhớ khối xếp Java tối đa lên 4 GB:
export JAVA_TOOL_OPTIONS="-Xmx4g"
firebase emulators:start
Bạn có thể chỉ định nhiều cờ trong dấu ngoặc kép, phân tách bằng dấu cách, chẳng hạn như JAVA_TOOL_OPTIONS="-Xms2g -Xmx4g". Các cờ này chỉ ảnh hưởng đến các thành phần dựa trên Java của trình mô phỏng và không ảnh hưởng đến các phần khác của CLI Firebase, chẳng hạn như Emulator Suite UI.
Khởi động trình mô phỏng
Bạn có thể khởi động trình mô phỏng để chạy cho đến khi kết thúc theo cách thủ công hoặc chạy trong thời gian của một tập lệnh kiểm thử được chỉ định, sau đó tự động tắt.
| Ra lệnh | Mô tả | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
emulators:start
|
Khởi động trình mô phỏng cho các sản phẩm Firebase được định cấu hình trong
|
||||||||||||||
emulators:exec PATH/TO/SCRIPT
|
Chạy tập lệnh tại PATH/TO/SCRIPT sau khi khởi động trình mô phỏng cho
các sản phẩm Firebase được định cấu hình trong
|
Phương thức firebase emulators:exec thường phù hợp hơn với quy trình tích hợp liên tục.
Xuất và nhập dữ liệu trình mô phỏng
Bạn có thể xuất dữ liệu từ trình mô phỏng Authentication, Cloud Firestore, Realtime Database và Cloud Storage for Firebase để dùng làm tập dữ liệu cơ sở chung, có thể chia sẻ. Bạn có thể nhập các tập dữ liệu này bằng cờ --import, như mô tả ở trên.
| emulators:export export_directory |
Trình mô phỏng Authentication, Cloud Firestore, Realtime Database hoặc Cloud Storage for Firebase.
Xuất dữ liệu từ một phiên bản trình mô phỏng Cloud Firestore, Realtime Database hoặc Cloud Storage for Firebase đang chạy.
Bạn có thể hướng dẫn trình mô phỏng tự động xuất dữ liệu khi tắt bằng cách sử dụng cờ |
Tích hợp với hệ thống CI
Chạy hình ảnh Bộ công cụ mô phỏng trong vùng chứa
Việc cài đặt và định cấu hình Bộ công cụ mô phỏng bằng vùng chứa trong một quy trình thiết lập CI thông thường rất đơn giản.
Có một số vấn đề cần lưu ý:
Các tệp JAR được cài đặt và lưu vào bộ nhớ đệm tại
~/.cache/firebase/emulators/.- Bạn nên thêm đường dẫn này vào cấu hình bộ nhớ đệm CI để tránh tải xuống nhiều lần.
Nếu không có tệp
firebase.jsontrong kho lưu trữ, bạn phải thêm một đối số dòng lệnh vào lệnhemulators:starthoặcemulators:execđể chỉ định trình mô phỏng nào sẽ được khởi động. Ví dụ:--only functions,firestore.
Tạo mã thông báo xác thực (Chỉ dành cho trình mô phỏng Lưu trữ)
Nếu quy trình tích hợp liên tục của bạn dựa vào Firebase Hosting , thì bạn sẽ cần đăng nhập bằng mã thông báo để chạy firebase emulators:exec. Các trình mô phỏng khác không yêu cầu đăng nhập.
Để tạo mã thông báo, hãy chạy firebase login:ci trên môi trường cục bộ của bạn; không nên thực hiện việc này từ hệ thống CI. Làm theo hướng dẫn để xác thực. Bạn chỉ cần thực hiện bước này một lần cho mỗi dự án, vì mã thông báo sẽ có hiệu lực trên các bản dựng. Mã thông báo này cần được xử lý như mật khẩu; hãy đảm bảo giữ bí mật mã thông báo này.
Nếu môi trường CI cho phép bạn chỉ định các biến môi trường có thể dùng trong tập lệnh bản dựng, bạn chỉ cần tạo một biến môi trường có tên là FIREBASE_TOKEN, với giá trị là chuỗi mã truy cập. Giao diện dòng lệnh (CLI) của Firebase sẽ tự động chọn biến môi trường FIREBASE_TOKEN và trình mô phỏng sẽ khởi động đúng cách.
Trong trường hợp không còn cách nào khác, bạn chỉ cần đưa mã thông báo vào tập lệnh bản dựng, nhưng hãy đảm bảo rằng các bên không đáng tin cậy không có quyền truy cập. Đối với phương pháp được cố định giá trị trong mã này, bạn có thể thêm --token "YOUR_TOKEN_STRING_HERE" vào lệnh firebase emulators:exec.
Sử dụng API REST của Emulator Hub
Liệt kê các trình mô phỏng đang chạy
Để liệt kê các trình mô phỏng đang chạy, hãy gửi yêu cầu GET đến điểm cuối /emulators của Emulator Hub.
curl localhost:4400/emulatorsKết quả sẽ là một đối tượng JSON liệt kê tất cả trình mô phỏng đang chạy và cấu hình máy chủ/cổng của chúng, ví dụ:
{
"hub":{
"name": "hub",
"host": "localhost",
"port": 4400
},
"functions": {
"name": "functions",
"host": "localhost",
"port": 5001
}
"firestore": {
"name": "firestore",
"host": "localhost",
"port": 8080
}
}
Bật/tắt trình kích hoạt hàm nền
Trong một số trường hợp, bạn sẽ cần tạm thời tắt các trình kích hoạt hàm và tiện ích cục bộ. Ví dụ: bạn có thể muốn xoá tất cả dữ liệu trong trình mô phỏng Cloud Firestore mà không kích hoạt bất kỳ hàm onDelete nào đang chạy trong trình mô phỏng Cloud Functions hoặc Extensions.
Để tạm thời tắt trình kích hoạt hàm cục bộ, hãy gửi yêu cầu PUT đến điểm cuối /functions/disableBackgroundTriggers của Emulator Hub.
curl -X PUT localhost:4400/functions/disableBackgroundTriggersKết quả sẽ là một đối tượng JSON trình bày chi tiết trạng thái hiện tại.
{
"enabled": false
}
Để bật trình kích hoạt hàm cục bộ sau khi đã tắt, hãy gửi yêu cầu PUT đến điểm cuối /functions/enableBackgroundTriggers của Trung tâm trình mô phỏng.
curl -X PUT localhost:4400/functions/enableBackgroundTriggersKết quả sẽ là một đối tượng JSON trình bày chi tiết trạng thái hiện tại.
{
"enabled": true
}
Tích hợp SDK trình mô phỏng
Các bảng trong phần này cho biết trình mô phỏng nào được SDK ứng dụng và SDK dành cho quản trị viên hỗ trợ. Trong tương lai có nghĩa là chúng tôi dự định hỗ trợ trình mô phỏng nhưng chưa hỗ trợ.
Phạm vi cung cấp SDK ứng dụng
| Android | Nền tảng của Apple | Web |
Firebase UI Android |
Giao diện người dùng Firebase iOS |
Giao diện người dùng Firebase Web |
|
|---|---|---|---|---|---|---|
| Realtime Database | 19.4.0 | 7.2.0 | 8.0.0 | 6.4.0 | Tương lai | Không áp dụng |
| Cloud Firestore | 21.6.0 | 7.2.0 | 8.0.0 | 6.4.0 | Tương lai | Không áp dụng |
| Authentication | 20.0.0 | 7.0.0 | 8.0.0 | 7.0.0 | Tương lai | 4.7.2 |
| Cloud Storage for Firebase | 20.0.0 | 8.0.0 | 8.4.0 | 7.0.0 | 11.0.0 | Không áp dụng |
| Cloud Functions | 19.1.0 | 7.2.0 | 8.0.0 | Không áp dụng | Không có | Không có |
| Hosting | Không có | Không có | Không có | Không có | Không có | Không có |
| Extensions | Không có | Không có | Không có | Không có | Không có | Không áp dụng |
Phạm vi cung cấp SDK dành cho quản trị viên
| Nút | Java | Python | Bắt đầu | |
|---|---|---|---|---|
| Realtime Database | 8.6.0 | 6.10.0 | 2.18.0 | Tương lai |
| Cloud Firestore | 8.0.0 | 6.10.0 | 3.0.0 | 1.0.0 |
| Authentication | 9.3.0 | 7.2.0 | 5.0.0 | 4.2.0 |
| Cloud Storage for Firebase | 9.8.0 | Tương lai | Tương lai | Tương lai |
| Cloud Functions | Không áp dụng | Không có | Không có | Không có |
| Hosting | Không có | Không có | Không có | Không có |
| Extensions | Không có | Không có | Không có | Không áp dụng |