解决 FCM 'Sender ID Mismatch' 错误：原因与解决方案

2024-12-18 07:59:51

解决FCM "Sender ID Mismatch" 错误

当使用Firebase Cloud Messaging (FCM) 发送消息时，遇到 "Sender ID Mismatch" 错误是一个常见问题。此错误通常表示发送请求时使用的 Sender ID 与 FCM 项目配置中的 Sender ID 不匹配。本文将深入探讨此问题的原因，并提供多种解决方案。

问题分析

“Sender ID Mismatch” 错误核心在于身份验证不匹配。FCM 通过 Sender ID 验证发送消息的身份。此ID通常与你的Firebase项目关联。当你发送消息时，FCM 会检查请求中的 Sender ID 是否与你在Firebase控制台中配置的 Sender ID 一致。若不一致，则会拒绝请求并返回 "Sender ID Mismatch" 错误。

可能导致此问题的原因包括：

使用了错误的凭证文件： 服务帐户凭证文件可能与实际的 Firebase 项目不对应。
Sender ID 配置错误： 代码中设置的 Sender ID 可能不正确。
API 密钥与项目不匹配： 如果你使用传统的服务器密钥进行身份验证，该密钥可能与目标FCM项目不匹配。
多项目配置混淆： 如果你管理多个Firebase项目，可能在代码中混淆了不同项目的配置信息。
权限问题： 用于身份验证的服务帐户可能没有足够的权限发送消息。

解决方案

以下是几种解决 "Sender ID Mismatch" 错误的方案:

1. 验证服务帐户凭证

确保你使用的服务帐户凭证文件是正确的，并且与你想要发送消息的 Firebase 项目关联。

操作步骤:
1. 登录 Firebase 控制台，选择你的项目。
2. 进入 “项目设置” -> “服务帐户”。
3. 生成新的私钥 JSON 文件或确认现有文件。
4. 将此 JSON 文件放在你的项目目录下安全位置。
5. 在代码中，确保 SERVICE_ACCOUNT_FILE 常量指向正确的路径。

代码示例 (PHP):

// 修改getAuthToken方法
public function getAuthToken()
{
    $keyFilePath = 'path/to/your/serviceAccountKey.json'; // 更新为你的服务帐户文件路径

    // ... 其余代码保持不变 ...
}

安全建议： 妥善保管服务帐户凭证文件，不要将其提交到代码库中。可以使用环境变量或安全配置存储路径。

2. 检查并设置正确的 Sender ID

Sender ID 可以在 Firebase 控制台中找到。对于较新的 FCM HTTP v1 API，Sender ID 通常是你的 Firebase 项目 ID，格式通常为 projects/<YOUR_PROJECT_ID>。在较老的 API 版本中，它可能是服务器密钥中的数字 ID。

操作步骤：
1. 登录 Firebase 控制台，选择你的项目。
2. 进入 “项目设置” -> “云消息传递”。
3. 找到并复制 “Sender ID”。
4. 确认代码中使用的 fcmEndpoint 是否包含了正确的 Sender ID。

代码示例 (PHP):

public function notif(Request $req)
{
    try
    {
        // ... 其他代码 ...

        $projectId = 'your-project-id'; // 替换为你的 Firebase 项目 ID
        $fcmEndpoint = "https://fcm.googleapis.com/v1/projects/$projectId/messages:send"; // 包含 Sender ID 的 API endpoint

        // ... 其余代码 ...
    }
     // ... 错误处理代码 ...
}

3. 使用正确的 API 和授权方法

FCM 提供了多种 API 版本和身份验证机制。 确保你正在使用与你的项目配置兼容的 API 版本和授权方法。较新的 HTTP v1 API  推荐使用服务帐户进行身份验证，而较老的 API 可能使用服务器密钥。

操作步骤：
1. 确定你正在使用的FCM API 版本。
2. 如果是 HTTP v1 API，请确保使用服务帐户凭据进行身份验证。
3. 如果是旧版 API，请检查服务器密钥是否正确配置，并且与你的项目匹配。

代码示例（HTTP v1 API，使用服务账户凭证，已在原始代码中体现）：

// 使用服务帐户凭证
$credentials = new ServiceAccountCredentials(
    'https://www.googleapis.com/auth/firebase.messaging',
    $keyFilePath
);

$accessToken = $credentials->fetchAuthToken()['access_token'];

4. 检查项目配置

如果你管理多个 Firebase 项目，务必仔细检查代码中的配置，确保所有的配置信息（包括服务帐户凭证、API密钥、Sender ID 等）都指向正确的项目。

操作步骤：
1. 仔细审查你的代码和配置文件。
2. 确保所有 Firebase 相关的配置项都属于同一个项目。
3. 如果有硬编码的项目 ID，考虑使用环境变量或配置文件来管理。

5. 检查服务帐户权限

确保用于身份验证的服务帐户具有 "Firebase Admin SDK Admin" 或 "Firebase Cloud Messaging Admin" 角色，这些角色拥有发送 FCM 消息的权限。

操作步骤：
1. 登录 Google Cloud 控制台，选择你的项目。
2. 进入 “IAM & Admin” -> “IAM”。
3. 找到你正在使用的服务帐户。
4. 点击 “编辑”，为其添加必要的角色。

调试技巧

打印详细错误信息： 捕获 FCM 返回的完整错误响应，包括 HTTP 状态码和详细的错误信息。这些信息能提供关于问题原因的线索。

catch(Throwable $e)
{
    Log::error($e);
    return response()->json([
        'errors' => $e->getMessage(),      // 获取错误信息
        'responseBody' => $responseBody,  // 如果有 responseBody，也打印出来
        'message' => __('fails.errors.500')
    ], 500, [], JSON_PRETTY_PRINT);
}