快速入门：使用 Web 或移动客户端库创建 Firestore 数据库

使用 Web 或移动客户端库创建 Firestore 数据库

本快速入门介绍如何使用 Android、Apple 平台、Web、Unity 或 C++ 客户端库设置 Firestore、添加数据和读取数据。

创建 Firestore 数据库

如果您还没有 Firebase 项目，请创建一个：在 Firebase 控制台中，点击添加项目，然后按照屏幕上的说明创建 Firebase 项目或将 Firebase 服务添加到现有 GCP 项目。
在 Firebase 控制台的导航窗格中，选择 Firestore，然后点击 Firestore 的创建数据库。
为 Firestore 安全规则选择测试模式：

测试模式

此模式适合刚开始使用移动和 Web 客户端库的用户，但会允许任何人读取和覆盖您的数据。测试完成后，请务必查看保护您的数据部分。
选择数据库的位置。
- 此位置设置是您项目的默认 Google Cloud Platform (GCP) 资源位置。请注意：此位置将用于项目中需要位置设置的 GCP 服务，具体来说就是您的默认 Cloud Storage 存储桶和 App Engine 应用（如果您使用 Cloud Scheduler，就需要该应用）。
- 如果您无法选择位置，表明您的项目已经具有默认 GCP 资源位置。它可能是在项目创建期间设置，也可能是在设置需要位置设置的其他服务时设置。
警告：项目的默认 GCP 资源位置一经设置便无法更改。
点击完成。

启用 Firestore 时，也会在 Cloud API 管理器中启用相应 API。

设置开发环境

将所需的依赖项和客户端库添加到您的应用。

Web 版本 9

按照相关说明将 Firebase 添加到您的 Web 应用。

导入 Firebase 和 Firestore：

import { initializeApp } from "firebase/app";
import { getFirestore } from "firebase/firestore";

Web 版本 8

按照相关说明将 Firebase 添加到您的 Web 应用。

将 Firebase 库和 Firestore 库添加到您的应用中：

<script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-app.js"></script>
<script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-firestore.js"></script>

Firestore SDK 也可以作为 npm 软件包提供。

npm install firebase@8.10.1 --save

您需要手动通过 require() 函数同时引入 Firebase 和 Firestore。

const firebase = require("firebase");
// Required for side-effects
require("firebase/firestore");

Apple 平台

按照相关说明将 Firebase 添加到您的 Apple 应用。

使用 Swift Package Manager 安装和管理 Firebase 依赖项。

在 Xcode 中打开您的应用项目，依次点击 File（文件）> Swift Packages（Swift 软件包）> Add Package Dependency（添加软件包依赖项）。
出现提示时，添加 Firebase Apple 平台 SDK 代码库：

  https://github.com/firebase/firebase-ios-sdk

选择 Firestore 库。
完成之后，Xcode 将会自动开始在后台解析和下载您的依赖项。

Java
Android

按照相关说明将 Firebase 添加到您的 Android 应用。
在您的模块（应用级）Gradle 文件（通常为 app/build.gradle）中声明 Firestore Android 库的依赖项：
```
implementation 'com.google.firebase:firebase-firestore:24.2.2'
```
如果您的应用使用多个 Firebase 库，请考虑使用 Firebase Android BoM，这样可以确保您应用的 Firebase 库版本始终兼容。

Kotlin+KTX
Android

按照相关说明将 Firebase 添加到您的 Android 应用。
在您的模块（应用级）Gradle 文件（通常为 app/build.gradle）中声明 Firestore Android 库的依赖项：
```
implementation 'com.google.firebase:firebase-firestore-ktx:24.2.2'
```
如果您的应用使用多个 Firebase 库，请考虑使用 Firebase Android BoM，这样可以确保您应用的 Firebase 库版本始终兼容。

Dart

如果您尚未在 Flutter 应用中配置并初始化 Firebase，请先配置并进行初始化。
从 Flutter 项目的根目录运行以下命令，安装该插件：
```
flutter pub add cloud_firestore
```
完成后，重新构建您的 Flutter 应用：
```
flutter run
```

C++

按照相关说明将 Firebase 添加到您的 C++ 项目。
Android 版 C++ 接口。

Gradle 依赖项。将以下内容添加到您的模块（应用级）Gradle 文件（通常为 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
        }

二进制依赖项。同样，获取二进制依赖项的推荐方法是将以下内容添加到 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}")

如需设置桌面集成，请参阅将 Firebase 添加到您的 C++ 项目。

Unity

按照相关说明将 Firebase 添加到您的 Unity 项目。
Android 版 Unity 接口。

在构建 Android 版接口时，请启用 ProGuard，以规避 Android DEX 限制。为此，请在 Unity 编辑器中执行以下操作：

选择 File（文件）> Build Settings（构建设置）。
将“Platform（平台）”切换为“Android”，然后点击“Switch Platform（切换平台）”
点击“Player Settings…（播放器设置…）”
在 Unity 主界面的“Settings for Android（Android 设置）”下，选择“Publishing Settings（发布设置）”
在“Minify”部分下，将“Release”和“Debug”设置从“None”改为“ProGuard”

初始化 Firestore

初始化 Firestore 的实例：

Web 版本 9

// Initialize Firestore through Firebase
import { initializeApp } from "firebase/app"
import { getFirestore } from "firebase/firestore"
const firebaseApp = initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FIRESTORE PROJECT ID ###'
});

const db = getFirestore();

您可以在 Web 应用的 `firebaseConfig` 中找到“initializeApp”的值。如需在设备的网络连接中断后仍能保留数据，请参阅启用离线数据文档。

Web 版本 8

// Initialize Firestore through Firebase
firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FIRESTORE PROJECT ID ###'
});

var db = firebase.firestore();

您可以在 Web 应用的 `firebaseConfig` 中找到“initializeApp”的值。如需在设备的网络连接中断后仍能保留数据，请参阅启用离线数据文档。

Swift

注意：此产品不适用于 watchOS 和 App Clip 目标。

import FirebaseCore
import FirebaseFirestore

FirebaseApp.configure()

let db = Firestore.firestore()AppDelegate.swift

Objective-C

注意：此产品不适用于 WatchOS 和 App Clip 目标。

@import FirebaseCore;
@import FirebaseFirestore;

// Use Firebase library to configure APIs
[FIRApp configure];

FIRFirestore *defaultFirestore = [FIRFirestore firestore];AppDelegate.m

Java
Android

// Access a Firestore instance from your Activity
  FirebaseFirestore db = FirebaseFirestore.getInstance();DocSnippets.java

Kotlin+KTX
Android

  // Access a Firestore instance from your Activity
  val db = Firebase.firestoreDocSnippets.kt

Dart

db = FirebaseFirestore.instance;

C++

// Make sure the call to `Create()` happens some time before you call Firestore::GetInstance().
App::Create();
Firestore* db = Firestore::GetInstance();AppDelegate.mm

Unity

using Firebase.Firestore;
using Firebase.Extensions;

FirebaseFirestore db = FirebaseFirestore.DefaultInstance;

添加数据

Firestore 将数据存储在文档中，而文档存储在集合中。在您首次向文档添加数据时，Firestore 就会隐式创建集合和文档。您不需要显式创建集合或文档。

使用以下示例代码创建一个新集合和一个新文档。

网页版 9

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);
}add_ada_lovelace.js

Web 版本 8

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);
});test.firestore.js

Swift

注意：此产品不适用于 watchOS 和 App Clip 目标。

// Add a new document with a generated ID
var ref: DocumentReference? = nil
ref = db.collection("users").addDocument(data: [
    "first": "Ada",
    "last": "Lovelace",
    "born": 1815
]) { err in
    if let err = err {
        print("Error adding document: \(err)")
    } else {
        print("Document added with ID: \(ref!.documentID)")
    }
}ViewController.swift

Objective-C

注意：此产品不适用于 WatchOS 和 App Clip 目标。

// 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);
      }
    }];ViewController.m

Java
Android

// 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);
            }
        });DocSnippets.java

Kotlin+KTX
Android

// 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)
    }DocSnippets.kt

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}'));firestore.dart

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;
  }
});snippets.cpp

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.");
});

现在，将另一个文档添加到 users 集合中。请注意，此文档包含第一个文档中没有的一个键值对（中间名）。集合中的文档可以包含不同的信息集。

Web 版本 9

// 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);
}add_alan_turing.js

Web 版本 8

// 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);
});test.firestore.js

Swift

注意：此产品不适用于 watchOS 和 App Clip 目标。

// Add a second document with a generated ID.
ref = db.collection("users").addDocument(data: [
    "first": "Alan",
    "middle": "Mathison",
    "last": "Turing",
    "born": 1912
]) { err in
    if let err = err {
        print("Error adding document: \(err)")
    } else {
        print("Document added with ID: \(ref!.documentID)")
    }
}ViewController.swift

Objective-C

注意：此产品不适用于 WatchOS 和 App Clip 目标。

// 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);
      }
    }];ViewController.m

Java
Android

// 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);
            }
        });DocSnippets.java

Kotlin+KTX
Android

// 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)
    }DocSnippets.kt

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}'));firestore.dart

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;
      }
    });snippets.cpp

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.");
});

读取数据

如需快速验证您已将数据添加到 Firestore，请使用 Firebase 控制台中的数据查看器。

您还可以使用 get 方法来检索整个集合。

Web 版本 9

import { collection, getDocs } from "firebase/firestore";

const querySnapshot = await getDocs(collection(db, "users"));
querySnapshot.forEach((doc) => {
  console.log(`${doc.id} => ${doc.data()}`);
});get_all_users.js

Web 版本 8

db.collection("users").get().then((querySnapshot) => {
    querySnapshot.forEach((doc) => {
        console.log(`${doc.id} => ${doc.data()}`);
    });
});test.firestore.js

Swift

注意：此产品不适用于 watchOS 和 App Clip 目标。

db.collection("users").getDocuments() { (querySnapshot, err) in
    if let err = err {
        print("Error getting documents: \(err)")
    } else {
        for document in querySnapshot!.documents {
            print("\(document.documentID) => \(document.data())")
        }
    }
}ViewController.swift

Objective-C

注意：此产品不适用于 WatchOS 和 App Clip 目标。

[[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);
        }
      }
    }];ViewController.m

Java
Android

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());
                }
            }
        });DocSnippets.java

Kotlin+KTX
Android

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)
        }DocSnippets.kt

Dart

await db.collection("users").get().then((event) {
  for (var doc in event.docs) {
    print("${doc.id} => ${doc.data()}");
  }
});firestore.dart

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;
  }
});snippets.cpp

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.");
});

保护您的数据

使用 Firebase 身份验证和 Firestore 安全规则保护 Firestore 中的数据。

下面是一些可助您入门的基本规则集。您可以在 Firebase 控制台的“规则”标签页中修改安全规则。

需要身份验证

// Allow read/write access on all documents to any user signed in to the application
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}

锁定模式

// Deny read/write access to all users under any conditions
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if false;
    }
  }
}

测试模式

// Allow read/write access to all users under any conditions
// Warning: **NEVER** use this rule set in production; it allows
// anyone to overwrite your entire database.
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if true;
    }
  }
}

在将 Web、Android 或 iOS 应用部署到生产环境之前，请采取措施确保只有应用客户端才能访问您的 Firestore 数据。请参阅 App Check 文档。

观看视频教程

如果需要开始使用 Firestore 移动和 Web 客户端库的详细指南，请观看以下视频教程之一：

Web

iOS

Android

您可以在 Firebase YouTube 频道中找到更多视频。

后续步骤

通过以下各主题深入了解相关知识：

Codelab - 通过学习 Android 版、iOS 版或 Web 版 Codelab，了解如何在实际应用中使用 Firestore。
数据模型 - 详细了解 Firestore 中数据的结构组织形式，包括分层数据和子集合。
添加数据 - 详细了解如何在 Firestore 中创建和更新数据。
获取数据 - 详细了解如何检索数据。
执行简单查询和复合查询 - 了解如何运行简单查询和复合查询。
对查询结果进行排序和限制其数量 - 了解如何对查询返回的数据进行排序和限制其数量。

使用 Web 或移动客户端库创建 Firestore 数据库

创建 Firestore 数据库

设置开发环境

Web 版本 9

Web 版本 8

Apple 平台

JavaAndroid

Kotlin+KTXAndroid

Dart

C++

Unity

初始化 Firestore

Web 版本 9

Web 版本 8

Swift

Objective-C

JavaAndroid

Kotlin+KTXAndroid

Dart

C++

Unity

添加数据

网页版 9

Web 版本 8

Swift

Objective-C

JavaAndroid

Kotlin+KTXAndroid

Dart

C++

Unity

Web 版本 9

Web 版本 8

Swift

Objective-C

JavaAndroid

Kotlin+KTXAndroid

Dart

C++

Unity

读取数据

Web 版本 9

Web 版本 8

Swift

Objective-C

JavaAndroid

Kotlin+KTXAndroid

Dart

C++

Unity

保护您的数据

需要身份验证

锁定模式

测试模式

观看视频教程

Web

iOS

Android

后续步骤

Java
Android

Kotlin+KTX
Android

Java
Android

Kotlin+KTX
Android

Java
Android

Kotlin+KTX
Android

Java
Android

Kotlin+KTX
Android

Java
Android

Kotlin+KTX
Android