Firestore-db-and-auth-rs 使用教程

1. 项目介绍

Firestore-db-and-auth-rs 是一个Rust语言编写的库，它提供了对Google Firestore数据库的访问和认证功能。这个库支持异步API，并且可以处理认证和令牌刷新。它允许用户通过服务账号或OAuth临时Google Firebase Auth证书轻松访问Firestore数据库。

2. 项目快速启动

在开始使用前，确保你已经安装了Rust环境，并且版本至少为1.64。

安装依赖

首先，将firestore-db-and-auth添加到你的Cargo.toml文件中的依赖项：

[dependencies]
firestore-db-and-auth = "0.5.0"

配置服务账号

你需要从Google Cloud Console下载服务账号的JSON文件，并添加一个api_key字段，其值为你的Web API密钥。

{
  "private_key_id": "...",
  "private_key": "...",
  "client_email": "...",
  "token_uri": "...",
  "api_key": "YOUR_WEB_API_KEY"
}

初始化Session

创建一个Credentials对象，并使用服务账号的JSON文件来初始化：

use firestore_db_and_auth::{Credentials, ServiceSession};

let credentials = Credentials::from_service_account_file("path/to/your/firebase-service-account.json").unwrap();
let session = ServiceSession::new(credentials);

写入和读取文档

下面是如何写入和读取Firestore文档的例子：

use firestore_db_and_auth::{documents, errors::Result};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize)]
struct DemoDTO {
    a_string: String,
    an_int: u32,
    another_int: u32,
}

let obj = DemoDTO {
    a_string: "示例文本".to_owned(),
    an_int: 42,
    another_int: 24,
};

// 写入文档
let result = documents::write(&session, "tests", Some("example_id"), &obj, documents::WriteOptions::default()).unwrap();

// 读取文档
let obj: DemoDTO = documents::read(&session, "tests", "example_id").unwrap();

3. 应用案例和最佳实践

严格类型的文档读写

使用firestore-db-and-auth库，你可以定义数据传输对象（DTOs），这样可以确保你的读写操作是类型安全的。

#[derive(Serialize, Deserialize)]
struct User {
    name: String,
    age: u32,
}

// 使用DTO进行写操作

云函数访问Firestore

如果你的应用使用Google Cloud Functions或AWS Lambda，firestore-db-and-auth库可以帮助你轻松地从云函数中访问Firestore。

// 初始化Session，并在云函数中执行Firestore操作

4. 典型生态项目

目前，firestore-db-and-auth-rs库可以与Rust的Web框架Rocket集成，提供了一种简便的方式来保护你的端点，确保只有通过Firestore Auth认证的请求才能通过。

// 使用Rocket框架和firestore-db-and-auth-rs库来保护你的Web服务

以上是firestore-db-and-auth-rs库的基本使用介绍和快速启动指南。你可以根据自己的项目需求，进一步探索和利用这个库提供的功能。