Hướng dẫn nhanh này cho bạn biết cách thiết lập Cloud Firestore, thêm dữ liệu, sau đó xem dữ liệu bạn vừa thêm trong bảng điều khiển của Firebase.
Tạo cơ sở dữ liệu Cloud Firestore
Nếu chưa có, bạn cần tạo một dự án Firebase: Trong bảng điều khiển Firebase, hãy nhấp vào Thêm dự án, sau đó làm theo hướng dẫn trên màn hình để tạo một dự án Firebase hoặc thêm các dịch vụ của Firebase vào một dự án Google Cloud hiện có.
Mở dự án của bạn trong bảng điều khiển Firebase. Trong bảng điều khiển bên trái, hãy mở rộng Build (Xây dựng) rồi chọn Cơ sở dữ liệu Firestore.
Nhấp vào Tạo cơ sở dữ liệu.
Chọn một vị trí cho cơ sở dữ liệu của bạn.
Nếu không chọn được vị trí, tức là bạn đã đặt "vị trí cho tài nguyên Google Cloud mặc định" của dự án. Một số tài nguyên của dự án (chẳng hạn như thực thể Cloud Firestore mặc định) dùng chung một phần phụ thuộc vị trí và vị trí của các tài nguyên này có thể được đặt trong quá trình tạo dự án hoặc khi thiết lập một dịch vụ khác dùng chung phần phụ thuộc vị trí này.
Chọn chế độ khởi động cho Cloud Firestore Security Rules:
- Chế độ kiểm thử
Phù hợp để bắt đầu với các thư viện ứng dụng di động và ứng dụng web, nhưng cho phép mọi người đọc và ghi đè dữ liệu của bạn. Sau khi kiểm thử, hãy nhớ xem xét phần Bảo mật dữ liệu của bạn.
Để bắt đầu với SDK web, SDK cho các nền tảng của Apple hoặc SDK Android, hãy chọn chế độ kiểm thử.
- Chế độ khoá
Từ chối mọi hoạt động đọc và ghi từ ứng dụng di động và ứng dụng web. Các máy chủ ứng dụng đã xác thực (C#, Go, Java, Node.js, PHP, Python hoặc Ruby) vẫn có thể truy cập vào cơ sở dữ liệu của bạn.
Để bắt đầu sử dụng thư viện ứng dụng máy chủ C#, Go, Java, Node.js, PHP, Python hoặc Ruby, hãy chọn chế độ khoá.
Nhóm Cloud Firestore Security Rules ban đầu sẽ áp dụng cho cơ sở dữ liệu Cloud Firestore mặc định của bạn. Nếu tạo nhiều cơ sở dữ liệu cho dự án, bạn có thể triển khai Cloud Firestore Security Rules cho từng cơ sở dữ liệu.
Nhấp vào Tạo.
Khi bạn bật Cloud Firestore, API này cũng sẽ được bật trong Trình quản lý API trên đám mây.
Thiết lập môi trường phát triển
Thêm các phần phụ thuộc và thư viện ứng dụng bắt buộc vào ứng dụng của bạn.
Web
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng web.
-
SDK Cloud Firestore có sẵn dưới dạng một gói npm.
Bạn cần nhập cả Firebase và Cloud Firestore.npm install firebase@12.0.0 --save
import { initializeApp } from "firebase/app"; import { getFirestore } from "firebase/firestore";
Web
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng web.
- Thêm thư viện Firebase và Cloud Firestore vào ứng dụng của bạn:
SDK Cloud Firestore cũng có sẵn dưới dạng một gói npm.<script src="https://www.gstatic.com/firebasejs/12.0.0/firebase-app-compat.js"></script> <script src="https://www.gstatic.com/firebasejs/12.0.0/firebase-firestore-compat.js"></script>
Bạn cần phải yêu cầu cả Firebase và Cloud Firestore theo cách thủ công.npm install firebase@12.0.0 --save
import firebase from "firebase/compat/app"; // Required for side-effects import "firebase/firestore";
iOS+
Làm theo hướng dẫn để thêm Firebase vào ứng dụng Apple.
Sử dụng Swift Package Manager để cài đặt và quản lý các phần phụ thuộc của Firebase.
- Trong Xcode, khi dự án ứng dụng của bạn đang mở, hãy chuyển đến File (Tệp) > Swift Packages (Gói Swift) > Add Package Dependency (Thêm phần phụ thuộc của gói).
- Khi được nhắc, hãy thêm kho lưu trữ SDK Firebase cho các nền tảng của Apple:
- Chọn thư viện Firestore.
- Khi hoàn tất, Xcode sẽ tự động bắt đầu phân giải và tải các phần phụ thuộc của bạn xuống ở chế độ nền.
https://github.com/firebase/firebase-ios-sdk
Android
- Làm theo hướng dẫn để thêm Firebase vào ứng dụng Android.
- Bằng cách sử dụng BoM trên Android cho Firebase, hãy khai báo phần phụ thuộc cho thư viện Cloud Firestore cho Android trong tệp Gradle của mô-đun (cấp ứng dụng) (thường là
app/build.gradle.kts
hoặcapp/build.gradle
).dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.16.0")) // Declare the dependency for the Cloud Firestore library // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-firestore") }
Bằng cách sử dụng BoM trên Android cho Firebase, ứng dụng của bạn sẽ luôn sử dụng những phiên bản tương thích của thư viện Android trên Firebase.
(Tuỳ chọn) Khai báo phần phụ thuộc của thư viện Firebase mà không cần dùng BoM
Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc của phiên bản đó.
Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện, nhằm đảm bảo rằng tất cả các phiên bản đều tương thích.
dependencies { // Declare the dependency for the Cloud Firestore library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-firestore:25.1.4") }
Bạn đang tìm kiếm một mô-đun thư viện dành riêng cho Kotlin? Bắt đầu từ bản phát hành tháng 10 năm 2023, cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).
Dart
- Nếu chưa thực hiện, hãy định cấu hình và khởi động Firebase trong ứng dụng Flutter của bạn.
- Từ gốc của dự án Flutter, hãy chạy lệnh sau để cài đặt trình bổ trợ:
flutter pub add cloud_firestore
- Sau khi hoàn tất, hãy tạo lại ứng dụng Flutter:
flutter run
- Không bắt buộc: Cải thiện thời gian tạo bản dựng iOS và macOS bằng cách thêm khung được biên dịch trước.
Hiện tại, Firestore SDK cho iOS phụ thuộc vào mã có thể mất hơn 5 phút để tạo trong Xcode. Để giảm đáng kể thời gian tạo bản dựng, bạn có thể sử dụng phiên bản được biên dịch trước bằng cách thêm dòng này vào khối
target 'Runner' do
trong Podfile:target 'Runner' do use_frameworks! use_modular_headers! pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => 'IOS_SDK_VERSION' flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) target 'RunnerTests' do inherit! :search_paths end end
Thay thế IOS_SDK_VERSION bằng phiên bản SDK Firebase iOS được chỉ định trong tệp
firebase_sdk_version.rb
củafirebase_core
. Nếu bạn không sử dụng phiên bản mới nhất củafirebase_core
, hãy tìm tệp này trong bộ nhớ đệm gói Pub cục bộ (thường là~/.pub-cache
).Ngoài ra, hãy đảm bảo bạn đã nâng cấp CocoaPods lên phiên bản 1.9.1 trở lên:
gem install cocoapods
Để biết thêm thông tin, hãy xem vấn đề trên GitHub.
Java
- Thêm Firebase Admin SDK vào ứng dụng của bạn:
-
Sử dụng Gradle:
compile 'com.google.firebase:firebase-admin:1.32.0'
-
Sử dụng Maven:
<dependency> <groupId>com.google.firebase</groupId> <artifactId>firebase-admin</artifactId> <version>1.32.0</version> </dependency>
-
Sử dụng Gradle:
- Hãy làm theo hướng dẫn bên dưới để khởi tạo Cloud Firestore bằng thông tin đăng nhập thích hợp trong môi trường của bạn.
Python
- Thêm Firebase Admin SDK vào ứng dụng Python của bạn:
pip install --upgrade firebase-admin
- Hãy làm theo hướng dẫn bên dưới để khởi tạo Cloud Firestore bằng thông tin đăng nhập thích hợp trong môi trường của bạn.
C++
- Làm theo hướng dẫn để thêm Firebase vào dự án C++.
- Giao diện C++ cho Android.
- Phần phụ thuộc Gradle. Thêm phần sau vào tệp Gradle của mô-đun (cấp ứng dụng) (thường là
app/build.gradle
):android.defaultConfig.externalNativeBuild.cmake { arguments "-DFIREBASE_CPP_SDK_DIR=$gradle.firebase_cpp_sdk_dir" } apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle" firebaseCpp.dependencies { // earlier entries auth firestore }
- Phần phụ thuộc nhị phân. Tương tự, cách được đề xuất để nhận các phần phụ thuộc nhị phân là thêm nội dung sau vào tệp
CMakeLists.txt
:add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL) set(firebase_libs firebase_auth firebase_firestore firebase_app) # Replace the target name below with the actual name of your target, # for example, "native-lib". target_link_libraries(${YOUR_TARGET_NAME_HERE} "${firebase_libs}")
- Để thiết lập tích hợp trên máy tính, hãy xem phần Thêm Firebase vào dự án C++.
Unity
- Làm theo hướng dẫn để thêm Firebase vào dự án Unity.
- Sử dụng giao diện Unity để định cấu hình dự án nhằm giảm thiểu các bản dựng Android.
- Bạn có thể tìm thấy lựa chọn này trong phần Player Settings > Android > Publishing Settings > Minify (Cài đặt trình phát > Android > Cài đặt xuất bản > Giảm thiểu).
- Các lựa chọn có thể khác nhau trong các phiên bản Unity. Vì vậy, hãy tham khảo tài liệu chính thức của Unity và Hướng dẫn gỡ lỗi bản dựng Firebase Unity.
-
Nếu sau khi bật tính năng rút gọn, số lượng phương thức được tham chiếu vẫn vượt quá giới hạn, thì bạn có thể bật
multidex
trong:-
mainTemplate.gradle
nếu bạn bật Custom Gradle Template (Mẫu Gradle tuỳ chỉnh) trong phần Player Settings (Cài đặt trình phát) -
hoặc tệp
build.gradle
cấp mô-đun nếu bạn dùng Android Studio để tạo dự án đã xuất.
-
Bạn phải giảm thiểu bản dựng để tránh thông báo Error while merging dex archives
.
Node.js
-
Thêm Firebase Admin SDK vào ứng dụng của bạn:
npm install firebase-admin --save
- Hãy làm theo hướng dẫn bên dưới để khởi tạo Cloud Firestore bằng thông tin đăng nhập thích hợp trong môi trường của bạn.
Tìm
- Thêm Firebase Admin SDK vào ứng dụng Go của bạn:
go get firebase.google.com/go
- Hãy làm theo hướng dẫn bên dưới để khởi tạo Cloud Firestore bằng thông tin đăng nhập thích hợp trong môi trường của bạn.
PHP
-
Thư viện ứng dụng máy chủ Cloud Firestore (Java, Node.js, Python, Go, PHP, C# và Ruby) sử dụng Thông tin xác thực mặc định của ứng dụng trên Google để xác thực.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
GOOGLE_APPLICATION_CREDENTIALS
để trỏ đến một tệp khoá tài khoản dịch vụ JSON. Bạn có thể tạo một tệp khoá trên trang Thông tin xác thực API Console.export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Trong môi trường phát hành chính thức, bạn không cần xác thực nếu chạy ứng dụng trên App Engine hoặc Compute Engine, bằng cách sử dụng cùng một dự án mà bạn dùng cho Cloud Firestore. Nếu không, hãy thiết lập tài khoản dịch vụ.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
- Cài đặt và bật tiện ích gRPC cho PHP. Bạn sẽ cần sử dụng tiện ích này để dùng thư viện ứng dụng.
-
Thêm thư viện Cloud Firestore PHP vào ứng dụng của bạn:
composer require google/cloud-firestore
C#
-
Thư viện ứng dụng máy chủ Cloud Firestore (Java, Node.js, Python, Go, PHP, C# và Ruby) sử dụng Thông tin xác thực mặc định của ứng dụng trên Google để xác thực.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
GOOGLE_APPLICATION_CREDENTIALS
để trỏ đến một tệp khoá tài khoản dịch vụ JSON. Bạn có thể tạo một tệp khoá trên trang Thông tin xác thực API Console.export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Trong môi trường phát hành chính thức, bạn không cần xác thực nếu chạy ứng dụng trên App Engine hoặc Compute Engine, bằng cách sử dụng cùng một dự án mà bạn dùng cho Cloud Firestore. Nếu không, hãy thiết lập tài khoản dịch vụ.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
-
Thêm thư viện Cloud Firestore C# vào ứng dụng của bạn trong tệp
.csproj
:<ItemGroup> <PackageReference Include="Google.Cloud.Firestore" Version="1.1.0-beta01" /> </ItemGroup>
-
Thêm đoạn mã sau vào tệp
Program.cs
:using Google.Cloud.Firestore;
Ruby
-
Thư viện ứng dụng máy chủ Cloud Firestore (Java, Node.js, Python, Go, PHP, C# và Ruby) sử dụng Thông tin xác thực mặc định của ứng dụng trên Google để xác thực.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
GOOGLE_APPLICATION_CREDENTIALS
để trỏ đến một tệp khoá tài khoản dịch vụ JSON. Bạn có thể tạo một tệp khoá trên trang Thông tin xác thực API Console.export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Trong môi trường phát hành chính thức, bạn không cần xác thực nếu chạy ứng dụng trên App Engine hoặc Compute Engine, bằng cách sử dụng cùng một dự án mà bạn dùng cho Cloud Firestore. Nếu không, hãy thiết lập tài khoản dịch vụ.
-
Để xác thực từ môi trường phát triển, hãy đặt biến môi trường
-
Thêm thư viện Cloud Firestore Ruby vào ứng dụng của bạn trong
Gemfile
:gem "google-cloud-firestore"
-
Cài đặt các phần phụ thuộc từ
Gemfile
bằng cách sử dụng:bundle install
(Không bắt buộc) Tạo mẫu và kiểm thử bằng Firebase Local Emulator Suite
Đối với nhà phát triển ứng dụng di động, trước khi nói về cách ứng dụng của bạn ghi và đọc từ Cloud Firestore, hãy giới thiệu một bộ công cụ mà bạn có thể dùng để tạo mẫu và kiểm thử chức năng Cloud Firestore:Firebase Local Emulator Suite. Nếu bạn đang thử nghiệm các mô hình dữ liệu khác nhau, tối ưu hoá các quy tắc bảo mật hoặc tìm cách tương tác với phần phụ trợ hiệu quả nhất về chi phí, thì việc có thể làm việc cục bộ mà không cần triển khai các dịch vụ trực tiếp có thể là một ý tưởng hay.
Trình mô phỏng Cloud Firestore là một phần của Local Emulator Suite, cho phép ứng dụng của bạn tương tác với nội dung và cấu hình cơ sở dữ liệu được mô phỏng, cũng như các tài nguyên dự án được mô phỏng (các hàm, cơ sở dữ liệu khác và quy tắc bảo mật) (nếu có).
Bạn chỉ cần thực hiện vài bước để sử dụng trình mô phỏng Cloud Firestore:
- Thêm một dòng mã vào cấu hình kiểm thử của ứng dụng để kết nối với trình mô phỏng.
- Từ gốc của thư mục dự án cục bộ, hãy chạy
firebase emulators:start
. - Thực hiện các lệnh gọi từ mã nguyên mẫu của ứng dụng bằng SDK nền tảng Cloud Firestore như thường lệ.
Bạn có thể xem hướng dẫn chi tiết liên quan đến Cloud Firestore và Cloud Functions. Bạn cũng nên xem phần giới thiệu về Local Emulator Suite.
Khởi chạy Cloud Firestore
Khởi chạy một thực thể của Cloud Firestore:
Web
import { initializeApp } from "firebase/app"; import { getFirestore } from "firebase/firestore"; // TODO: Replace the following with your app's Firebase project configuration // See: https://support.google.com/firebase/answer/7015592 const firebaseConfig = { FIREBASE_CONFIGURATION }; // Initialize Firebase const app = initializeApp(firebaseConfig); // Initialize Cloud Firestore and get a reference to the service const db = getFirestore(app);
Thay thế FIREBASE_CONFIGURATION bằng firebaseConfig
của ứng dụng web.
Để duy trì dữ liệu khi thiết bị mất kết nối, hãy xem tài liệu Bật dữ liệu ngoại tuyến.
Web
import firebase from "firebase/app"; import "firebase/firestore"; // TODO: Replace the following with your app's Firebase project configuration // See: https://support.google.com/firebase/answer/7015592 const firebaseConfig = { FIREBASE_CONFIGURATION }; // Initialize Firebase firebase.initializeApp(firebaseConfig); // Initialize Cloud Firestore and get a reference to the service const db = firebase.firestore();
Thay thế FIREBASE_CONFIGURATION bằng firebaseConfig
của ứng dụng web.
Để duy trì dữ liệu khi thiết bị mất kết nối, hãy xem tài liệu Bật dữ liệu ngoại tuyến.
Swift
import FirebaseCore import FirebaseFirestore
FirebaseApp.configure() let db = Firestore.firestore()
Objective-C
@import FirebaseCore; @import FirebaseFirestore; // Use Firebase library to configure APIs [FIRApp configure];
FIRFirestore *defaultFirestore = [FIRFirestore firestore];
Kotlin
// Access a Cloud Firestore instance from your Activity
val db = Firebase.firestore
Java
// Access a Cloud Firestore instance from your Activity
FirebaseFirestore db = FirebaseFirestore.getInstance();
Dart
db = FirebaseFirestore.instance;
Java
SDK Cloud Firestore được khởi chạy theo nhiều cách tuỳ thuộc vào môi trường của bạn. Dưới đây là những phương pháp phổ biến nhất. Để biết thông tin tham khảo đầy đủ, hãy xem phần Khởi chạy Admin SDK.import com.google.auth.oauth2.GoogleCredentials; import com.google.cloud.firestore.Firestore; import com.google.firebase.FirebaseApp; import com.google.firebase.FirebaseOptions; // Use the application default credentials GoogleCredentials credentials = GoogleCredentials.getApplicationDefault(); FirebaseOptions options = new FirebaseOptions.Builder() .setCredentials(credentials) .setProjectId(projectId) .build(); FirebaseApp.initializeApp(options); Firestore db = FirestoreClient.getFirestore();
Để sử dụng Firebase Admin SDK trên máy chủ của riêng bạn, hãy sử dụng một tài khoản dịch vụ.
Chuyển đến IAM và quản trị > Tài khoản dịch vụ trong bảng điều khiển Google Cloud. Tạo khoá riêng tư mới và lưu tệp JSON. Sau đó, hãy dùng tệp này để khởi chạy SDK:
import com.google.auth.oauth2.GoogleCredentials; import com.google.cloud.firestore.Firestore; import com.google.firebase.FirebaseApp; import com.google.firebase.FirebaseOptions; // Use a service account InputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json"); GoogleCredentials credentials = GoogleCredentials.fromStream(serviceAccount); FirebaseOptions options = new FirebaseOptions.Builder() .setCredentials(credentials) .build(); FirebaseApp.initializeApp(options); Firestore db = FirestoreClient.getFirestore();
Python
SDK Cloud Firestore được khởi chạy theo nhiều cách tuỳ thuộc vào môi trường của bạn. Dưới đây là những phương pháp phổ biến nhất. Để biết thông tin tham khảo đầy đủ, hãy xem phần Khởi chạy Admin SDK.import firebase_admin from firebase_admin import firestore # Application Default credentials are automatically created. app = firebase_admin.initialize_app() db = firestore.client()
Bạn cũng có thể dùng thông tin đăng nhập mặc định hiện có của ứng dụng để khởi chạy SDK.
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore # Use the application default credentials. cred = credentials.ApplicationDefault() firebase_admin.initialize_app(cred) db = firestore.client()
Để sử dụng Firebase Admin SDK trên máy chủ của riêng bạn, hãy sử dụng một tài khoản dịch vụ.
Chuyển đến IAM và quản trị > Tài khoản dịch vụ trong bảng điều khiển Google Cloud. Tạo khoá riêng tư mới và lưu tệp JSON. Sau đó, hãy dùng tệp này để khởi chạy SDK:
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore # Use a service account. cred = credentials.Certificate('path/to/serviceAccount.json') app = firebase_admin.initialize_app(cred) db = firestore.client()
Python
SDK Cloud Firestore được khởi chạy theo nhiều cách tuỳ thuộc vào môi trường của bạn. Dưới đây là những phương pháp phổ biến nhất. Để biết thông tin tham khảo đầy đủ, hãy xem phần Khởi chạy Admin SDK.import firebase_admin from firebase_admin import firestore_async # Application Default credentials are automatically created. app = firebase_admin.initialize_app() db = firestore_async.client()
Bạn cũng có thể dùng thông tin đăng nhập mặc định hiện có của ứng dụng để khởi chạy SDK.
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore_async # Use the application default credentials. cred = credentials.ApplicationDefault() firebase_admin.initialize_app(cred) db = firestore_async.client()
Để sử dụng Firebase Admin SDK trên máy chủ của riêng bạn, hãy sử dụng một tài khoản dịch vụ.
Chuyển đến IAM và quản trị > Tài khoản dịch vụ trong bảng điều khiển Google Cloud. Tạo khoá riêng tư mới và lưu tệp JSON. Sau đó, hãy dùng tệp này để khởi chạy SDK:
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore_async # Use a service account. cred = credentials.Certificate('path/to/serviceAccount.json') app = firebase_admin.initialize_app(cred) db = firestore_async.client()
C++
// Make sure the call to `Create()` happens some time before you call Firestore::GetInstance(). App::Create(); Firestore* db = Firestore::GetInstance();
Node.js
SDK Cloud Firestore được khởi chạy theo nhiều cách tuỳ thuộc vào môi trường của bạn. Dưới đây là những phương pháp phổ biến nhất. Để biết thông tin tham khảo đầy đủ, hãy xem phần Khởi chạy Admin SDK.-
Khởi chạy vào ngày Cloud Functions
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue, Filter } = require('firebase-admin/firestore');
initializeApp(); const db = getFirestore();
-
Khởi chạy vào ngày Google Cloud
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue, Filter } = require('firebase-admin/firestore');
initializeApp({ credential: applicationDefault() }); const db = getFirestore();
-
Khởi động trên máy chủ của riêng bạn
Để sử dụng Firebase Admin SDK trên máy chủ của riêng bạn (hoặc bất kỳ môi trường Node.js nào khác), hãy sử dụng tài khoản dịch vụ. Chuyển đến phần IAM và quản trị > Tài khoản dịch vụ trong bảng điều khiển Google Cloud. Tạo khoá riêng tư mới và lưu tệp JSON. Sau đó, hãy dùng tệp này để khởi chạy SDK:
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue, Filter } = require('firebase-admin/firestore');
const serviceAccount = require('./path/to/serviceAccountKey.json'); initializeApp({ credential: cert(serviceAccount) }); const db = getFirestore();
Tìm
SDK Cloud Firestore được khởi chạy theo nhiều cách tuỳ thuộc vào môi trường của bạn. Dưới đây là những phương pháp phổ biến nhất. Để biết thông tin tham khảo đầy đủ, hãy xem phần Khởi chạy Admin SDK.import ( "log" firebase "firebase.google.com/go" "google.golang.org/api/option" ) // Use the application default credentials ctx := context.Background() conf := &firebase.Config{ProjectID: projectID} app, err := firebase.NewApp(ctx, conf) if err != nil { log.Fatalln(err) } client, err := app.Firestore(ctx) if err != nil { log.Fatalln(err) } defer client.Close()
Để sử dụng Firebase Admin SDK trên máy chủ của riêng bạn, hãy sử dụng một tài khoản dịch vụ.
Chuyển đến IAM và quản trị > Tài khoản dịch vụ trong bảng điều khiển Google Cloud. Tạo khoá riêng tư mới và lưu tệp JSON. Sau đó, hãy dùng tệp này để khởi chạy SDK:
import ( "log" firebase "firebase.google.com/go" "google.golang.org/api/option" ) // Use a service account ctx := context.Background() sa := option.WithCredentialsFile("path/to/serviceAccount.json") app, err := firebase.NewApp(ctx, nil, sa) if err != nil { log.Fatalln(err) } client, err := app.Firestore(ctx) if err != nil { log.Fatalln(err) } defer client.Close()
PHP
PHP
Để biết thêm thông tin về cách cài đặt và tạo ứng dụng Cloud Firestore, hãy tham khảo Thư viện ứng dụng Cloud Firestore.
Unity
using Firebase.Firestore; using Firebase.Extensions;
FirebaseFirestore db = FirebaseFirestore.DefaultInstance;
C#
C#
Để biết thêm thông tin về cách cài đặt và tạo ứng dụng Cloud Firestore, hãy tham khảo Thư viện ứng dụng Cloud Firestore.
Ruby
Thêm dữ liệu
Cloud Firestore lưu trữ dữ liệu trong Tài liệu, được lưu trữ trong Bộ sưu tập. Cloud Firestore sẽ tạo các bộ sưu tập và tài liệu một cách ngầm định vào lần đầu tiên bạn thêm dữ liệu vào tài liệu. Bạn không cần phải tạo rõ ràng các bộ sưu tập hoặc tài liệu.
Tạo một bộ sưu tập và tài liệu mới bằng mã ví dụ sau.
Web
import { collection, addDoc } from "firebase/firestore"; try { const docRef = await addDoc(collection(db, "users"), { first: "Ada", last: "Lovelace", born: 1815 }); console.log("Document written with ID: ", docRef.id); } catch (e) { console.error("Error adding document: ", e); }
Web
db.collection("users").add({ first: "Ada", last: "Lovelace", born: 1815 }) .then((docRef) => { console.log("Document written with ID: ", docRef.id); }) .catch((error) => { console.error("Error adding document: ", error); });
Swift
// Add a new document with a generated ID do { let ref = try await db.collection("users").addDocument(data: [ "first": "Ada", "last": "Lovelace", "born": 1815 ]) print("Document added with ID: \(ref.documentID)") } catch { print("Error adding document: \(error)") }
Objective-C
// Add a new document with a generated ID __block FIRDocumentReference *ref = [[self.db collectionWithPath:@"users"] addDocumentWithData:@{ @"first": @"Ada", @"last": @"Lovelace", @"born": @1815 } completion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error adding document: %@", error); } else { NSLog(@"Document added with ID: %@", ref.documentID); } }];
Kotlin
// Create a new user with a first and last name val user = hashMapOf( "first" to "Ada", "last" to "Lovelace", "born" to 1815, ) // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener { documentReference -> Log.d(TAG, "DocumentSnapshot added with ID: ${documentReference.id}") } .addOnFailureListener { e -> Log.w(TAG, "Error adding document", e) }
Java
// Create a new user with a first and last name Map<String, Object> user = new HashMap<>(); user.put("first", "Ada"); user.put("last", "Lovelace"); user.put("born", 1815); // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener(new OnSuccessListener<DocumentReference>() { @Override public void onSuccess(DocumentReference documentReference) { Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId()); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "Error adding document", e); } });
Dart
// Create a new user with a first and last name final user = <String, dynamic>{ "first": "Ada", "last": "Lovelace", "born": 1815 }; // Add a new document with a generated ID db.collection("users").add(user).then((DocumentReference doc) => print('DocumentSnapshot added with ID: ${doc.id}'));
Java
Python
Python
C++
// Add a new document with a generated ID Future<DocumentReference> user_ref = db->Collection("users").Add({{"first", FieldValue::String("Ada")}, {"last", FieldValue::String("Lovelace")}, {"born", FieldValue::Integer(1815)}}); user_ref.OnCompletion([](const Future<DocumentReference>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot added with ID: " << future.result()->id() << std::endl; } else { std::cout << "Error adding document: " << future.error_message() << std::endl; } });
Node.js
Tìm
PHP
PHP
Để biết thêm thông tin về cách cài đặt và tạo ứng dụng Cloud Firestore, hãy tham khảo Thư viện ứng dụng Cloud Firestore.
Unity
DocumentReference docRef = db.Collection("users").Document("alovelace"); Dictionary<string, object> user = new Dictionary<string, object> { { "First", "Ada" }, { "Last", "Lovelace" }, { "Born", 1815 }, }; docRef.SetAsync(user).ContinueWithOnMainThread(task => { Debug.Log("Added data to the alovelace document in the users collection."); });
C#
Ruby
Bây giờ, hãy thêm một tài liệu khác vào bộ sưu tập users
. Xin lưu ý rằng giấy tờ này có một cặp khoá-giá trị (tên đệm) không xuất hiện trong giấy tờ đầu tiên. Các tài liệu trong một bộ sưu tập có thể chứa nhiều nhóm thông tin.
Web
// Add a second document with a generated ID. import { addDoc, collection } from "firebase/firestore"; try { const docRef = await addDoc(collection(db, "users"), { first: "Alan", middle: "Mathison", last: "Turing", born: 1912 }); console.log("Document written with ID: ", docRef.id); } catch (e) { console.error("Error adding document: ", e); }
Web
// Add a second document with a generated ID. db.collection("users").add({ first: "Alan", middle: "Mathison", last: "Turing", born: 1912 }) .then((docRef) => { console.log("Document written with ID: ", docRef.id); }) .catch((error) => { console.error("Error adding document: ", error); });
Swift
// Add a second document with a generated ID. do { let ref = try await db.collection("users").addDocument(data: [ "first": "Alan", "middle": "Mathison", "last": "Turing", "born": 1912 ]) print("Document added with ID: \(ref.documentID)") } catch { print("Error adding document: \(error)") }
Objective-C
// Add a second document with a generated ID. __block FIRDocumentReference *ref = [[self.db collectionWithPath:@"users"] addDocumentWithData:@{ @"first": @"Alan", @"middle": @"Mathison", @"last": @"Turing", @"born": @1912 } completion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error adding document: %@", error); } else { NSLog(@"Document added with ID: %@", ref.documentID); } }];
Kotlin
// Create a new user with a first, middle, and last name val user = hashMapOf( "first" to "Alan", "middle" to "Mathison", "last" to "Turing", "born" to 1912, ) // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener { documentReference -> Log.d(TAG, "DocumentSnapshot added with ID: ${documentReference.id}") } .addOnFailureListener { e -> Log.w(TAG, "Error adding document", e) }
Java
// Create a new user with a first, middle, and last name Map<String, Object> user = new HashMap<>(); user.put("first", "Alan"); user.put("middle", "Mathison"); user.put("last", "Turing"); user.put("born", 1912); // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener(new OnSuccessListener<DocumentReference>() { @Override public void onSuccess(DocumentReference documentReference) { Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId()); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "Error adding document", e); } });
Dart
// Create a new user with a first and last name final user = <String, dynamic>{ "first": "Alan", "middle": "Mathison", "last": "Turing", "born": 1912 }; // Add a new document with a generated ID db.collection("users").add(user).then((DocumentReference doc) => print('DocumentSnapshot added with ID: ${doc.id}'));
Java
Python
Python
C++
db->Collection("users") .Add({{"first", FieldValue::String("Alan")}, {"middle", FieldValue::String("Mathison")}, {"last", FieldValue::String("Turing")}, {"born", FieldValue::Integer(1912)}}) .OnCompletion([](const Future<DocumentReference>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot added with ID: " << future.result()->id() << std::endl; } else { std::cout << "Error adding document: " << future.error_message() << std::endl; } });
Node.js
Tìm
PHP
PHP
Để biết thêm thông tin về cách cài đặt và tạo ứng dụng Cloud Firestore, hãy tham khảo Thư viện ứng dụng Cloud Firestore.
Unity
DocumentReference docRef = db.Collection("users").Document("aturing"); Dictionary<string, object> user = new Dictionary<string, object> { { "First", "Alan" }, { "Middle", "Mathison" }, { "Last", "Turing" }, { "Born", 1912 } }; docRef.SetAsync(user).ContinueWithOnMainThread(task => { Debug.Log("Added data to the aturing document in the users collection."); });
C#
Ruby
Đọc dữ liệu
Sử dụng trình xem dữ liệu trong bảng điều khiển của Firebase để nhanh chóng xác minh rằng bạn đã thêm dữ liệu vào Cloud Firestore.
Bạn cũng có thể dùng phương thức "get" để truy xuất toàn bộ tập hợp.
Web
import { collection, getDocs } from "firebase/firestore"; const querySnapshot = await getDocs(collection(db, "users")); querySnapshot.forEach((doc) => { console.log(`${doc.id} => ${doc.data()}`); });
Web
db.collection("users").get().then((querySnapshot) => { querySnapshot.forEach((doc) => { console.log(`${doc.id} => ${doc.data()}`); }); });
Swift
do { let snapshot = try await db.collection("users").getDocuments() for document in snapshot.documents { print("\(document.documentID) => \(document.data())") } } catch { print("Error getting documents: \(error)") }
Objective-C
[[self.db collectionWithPath:@"users"] getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot, NSError * _Nullable error) { if (error != nil) { NSLog(@"Error getting documents: %@", error); } else { for (FIRDocumentSnapshot *document in snapshot.documents) { NSLog(@"%@ => %@", document.documentID, document.data); } } }];
Kotlin
db.collection("users") .get() .addOnSuccessListener { result -> for (document in result) { Log.d(TAG, "${document.id} => ${document.data}") } } .addOnFailureListener { exception -> Log.w(TAG, "Error getting documents.", exception) }
Java
db.collection("users") .get() .addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() { @Override public void onComplete(@NonNull Task<QuerySnapshot> task) { if (task.isSuccessful()) { for (QueryDocumentSnapshot document : task.getResult()) { Log.d(TAG, document.getId() + " => " + document.getData()); } } else { Log.w(TAG, "Error getting documents.", task.getException()); } } });
Dart
await db.collection("users").get().then((event) { for (var doc in event.docs) { print("${doc.id} => ${doc.data()}"); } });
Java
Python
users_ref = db.collection("users") docs = users_ref.stream() for doc in docs: print(f"{doc.id} => {doc.to_dict()}")
Python
C++
Future<QuerySnapshot> users = db->Collection("users").Get(); users.OnCompletion([](const Future<QuerySnapshot>& future) { if (future.error() == Error::kErrorOk) { for (const DocumentSnapshot& document : future.result()->documents()) { std::cout << document << std::endl; } } else { std::cout << "Error getting documents: " << future.error_message() << std::endl; } });
Node.js
Tìm
PHP
PHP
Để biết thêm thông tin về cách cài đặt và tạo ứng dụng Cloud Firestore, hãy tham khảo Thư viện ứng dụng Cloud Firestore.
Unity
CollectionReference usersRef = db.Collection("users"); usersRef.GetSnapshotAsync().ContinueWithOnMainThread(task => { QuerySnapshot snapshot = task.Result; foreach (DocumentSnapshot document in snapshot.Documents) { Debug.Log(String.Format("User: {0}", document.Id)); Dictionary<string, object> documentDictionary = document.ToDictionary(); Debug.Log(String.Format("First: {0}", documentDictionary["First"])); if (documentDictionary.ContainsKey("Middle")) { Debug.Log(String.Format("Middle: {0}", documentDictionary["Middle"])); } Debug.Log(String.Format("Last: {0}", documentDictionary["Last"])); Debug.Log(String.Format("Born: {0}", documentDictionary["Born"])); } Debug.Log("Read all data from the users collection."); });
C#
Ruby
Bảo mật dữ liệu của bạn
Nếu bạn đang sử dụng SDK của nền tảng web, Android hoặc Apple, hãy sử dụng Xác thực Firebase và Cloud Firestore Security Rules để bảo mật dữ liệu của bạn trong Cloud Firestore.
Sau đây là một số bộ quy tắc cơ bản mà bạn có thể sử dụng để bắt đầu. Bạn có thể sửa đổi các quy tắc bảo mật trong thẻ Quy tắc của bảng điều khiển.
Cần có quyền truy cập
// Allow read/write access to a document keyed by the user's UID
service cloud.firestore {
match /databases/{database}/documents {
match /users/{uid} {
allow read, write: if request.auth != null && request.auth.uid == uid;
}
}
}
Chế độ khoá
// Deny read/write access to all users under any conditions
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if false;
}
}
}
Trước khi triển khai ứng dụng web, Android hoặc iOS vào quy trình phát hành công khai, hãy thực hiện các bước để đảm bảo rằng chỉ các ứng dụng khách của bạn mới có thể truy cập vào dữ liệu Cloud Firestore. Xem tài liệu về App Check.
Nếu bạn đang sử dụng một trong các SDK máy chủ, hãy dùng Quản lý danh tính và quyền truy cập (IAM) để bảo mật dữ liệu của bạn trong Cloud Firestore.
Xem video hướng dẫn
Để biết hướng dẫn chi tiết về cách bắt đầu sử dụng thư viện ứng dụng di động Cloud Firestore, hãy xem một trong các video hướng dẫn sau:
Web
iOS+
Android
Bạn có thể xem thêm video trên kênh YouTube của Firebase.
Các bước tiếp theo
Mở rộng kiến thức của bạn với các chủ đề sau:
- Lớp học lập trình – Tìm hiểu cách sử dụng Cloud Firestore trong một ứng dụng thực tế bằng cách làm theo lớp học lập trình cho Android, iOS hoặc web.
- Mô hình dữ liệu – Tìm hiểu thêm về cách dữ liệu được cấu trúc trong Cloud Firestore, bao gồm cả dữ liệu phân cấp và các bộ sưu tập con.
- Thêm dữ liệu – Tìm hiểu thêm về cách tạo và cập nhật dữ liệu trong Cloud Firestore.
- Nhận dữ liệu – Tìm hiểu thêm về cách truy xuất dữ liệu.
- Thực hiện các truy vấn đơn giản và phức tạp – Tìm hiểu cách chạy các truy vấn đơn giản và phức tạp.
- Sắp xếp và giới hạn truy vấn Tìm hiểu cách sắp xếp và giới hạn dữ liệu do truy vấn của bạn trả về.