如何在Firebase Cloud Functions中配置Cron Job删除过期Firestore记录

一、核心逻辑明确 #

我们需要删除的是endDate字段值**早于当前日期0点（UTC时间）**的文档。比如当前日期为2023年11月22日，就删除所有endDate < 2023-11-22T00:00:00Z的记录。

二、两种可行实现方案 #

方案1：Cloud Functions + Cloud Scheduler（Google云原生推荐方案） #

这是适配Firestore的官方推荐方案，无需维护自己的服务器。

1. 编写Cloud Function（Node.js示例）

先确保本地安装firebase-tools，初始化Functions项目后，编写删除逻辑：

const { initializeApp } = require('firebase-admin/app');
const { getFirestore } = require('firebase-admin/firestore');

initializeApp();
const db = getFirestore();

exports.cleanupExpiredRecords = async (event) => {
  // 获取当前日期的UTC 0点时间
  const today = new Date();
  today.setUTCHours(0, 0, 0, 0);
  
  // 构建查询：筛选endDate早于今天0点的文档
  const query = db.collection('your-collection-name') // 替换为你的集合名称
    .where('endDate', '<', today);

  const snapshot = await query.get();
  if (snapshot.empty) {
    console.log('无过期记录需要删除');
    return;
  }

  // 批量删除（Firestore单次批量操作上限500条）
  const batch = db.batch();
  snapshot.docs.forEach(doc => {
    batch.delete(doc.ref);
  });

  await batch.commit();
  console.log(`成功删除${snapshot.size}条过期记录`);
};

2. 部署Cloud Function

通过Firebase CLI执行部署：

firebase deploy --only functions:cleanupExpiredRecords

3. 配置Cloud Scheduler（每日触发）

• 进入Google Cloud Console的Cloud Scheduler页面
• 创建新任务：
  • 频率设为0 0 * * *（每日UTC时间0点触发，对应北京时间8点，可按需调整时区）
  • 目标选择HTTP，填入Cloud Function的触发URL
  • HTTP方法选POST，身份验证选择服务帐号，使用默认的Cloud Functions服务帐号

方案2：自定义Cron Job + Firestore SDK（非云原生方案） #

如果用自有服务器或第三方Cron服务（如GitHub Actions），可直接调用Firestore SDK执行删除。

1. 编写清理脚本（Python示例）

import firebase_admin
from firebase_admin import credentials, firestore
from datetime import datetime, timezone

# 初始化Firebase Admin
cred = credentials.Certificate('path/to/service-account-key.json')
firebase_admin.initialize_app(cred)
db = firestore.client()

def cleanup_expired_records():
    # 获取UTC时区下的今日0点时间
    today = datetime.now(timezone.utc).replace(hour=0, minute=0, second=0, microsecond=0)
    
    # 查询所有过期记录
    docs = db.collection('your-collection-name').where('endDate', '<', today).stream()
    
    # 分批次批量删除（规避500条上限）
    batch = db.batch()
    count = 0
    for doc in docs:
        batch.delete(doc.reference)
        count += 1
        if count % 500 == 0:
            batch.commit()
            batch = db.batch()
    
    # 提交剩余未处理的批量操作
    if count % 500 != 0:
        batch.commit()
    
    print(f"成功删除{count}条过期记录")

if __name__ == "__main__":
    cleanup_expired_records()

2. 配置Cron任务

在服务器上添加Cron规则，比如每日UTC0点执行脚本：

0 0 * * * /usr/bin/python3 /path/to/cleanup_script.py >> /var/log/firestore_cleanup.log 2>&1

三、关键注意事项 #

• 索引配置：首次执行查询若失败，Firestore控制台会生成索引创建链接，直接点击创建即可。
• 批量操作限制：Firestore单次批量操作最多处理500条文档，脚本需处理超量情况，分批次提交。
• 时区一致性：确保endDate字段存储的是UTC时间，避免时区差异导致删除逻辑错误。
• 权限设置：Cloud Function或脚本使用的服务帐号需具备Firestore的文档删除权限（datastore.entities.delete）。

内容的提问来源于stack exchange，提问作者Heimdallr