Supabase Apple Login on Android

前提条件

本指南将帮助您在 Android 上将 Apple Sign-In 与 Supabase 身份验证集成。假设您已经完成：

• the Supabase Apple 登录 - 一般设置.

重要

Apple Sign-In on Android 需要一个后端服务器，因为 Apple 没有提供 native Android 支持。我们将使用 Supabase Edge Function 作为后端。

步骤 1：部署后端 Edge Function

首先，我们需要部署 Supabase Edge Function 来处理 Apple OAuth 回调。

1. 前往您的 Supabase 项目目录

   cd your-project/supabase

2. 创建边缘函数 (如果不存在)

   supabase functions new apple-signin-callback

3. 复制边缘函数 code

   完整的边缘函数实现可在 示例应用.

   复制以下文件到您的项目:

   • supabase/functions/apple-signin-callback/index.ts - 主边缘函数 code
   • supabase/functions/apple-signin-callback/deno.json - 依赖项的导入映射（包括 jose 用于 JWT 签名的库

4. 配置 JWT 验证

   Apple OAuth 回调端点必须是公共的（无需身份验证），因为 Apple 将重定向到它。更新您的 supabase/config.toml 复制到剪贴板

   [functions.apple-signin-callback]
   enabled = true
   verify_jwt = false  # Important: Set to false for public OAuth callback
   import_map = "./functions/apple-signin-callback/deno.json"
   entrypoint = "./functions/apple-signin-callback/index.ts"

   The Apple OAuth callback endpoint must be public (no authentication required) because Apple will redirect to it. Update your

   设置 verify_jwt = false 使这个端点公开。这是必需的，因为苹果的OAuth重定向不包含Supabase身份验证头。端点验证OAuth流程本身。

5. 部署函数

   supabase functions deploy apple-signin-callback

6. 获取函数URL

   部署后，您将获得一个类似这样的URL：

   https://your-project-ref.supabase.co/functions/v1/apple-signin-callback

   如果您找不到它，可以尝试以下方法：

   1. 打开 https://supabase.com/dashboard/project/YOUR_PROJECT_REF/functions
   2. 点击 apple-signin-callback 函数URL以复制它。

   保存此 URL

   在下一步中配置 Apple Developer Portal 时，您需要此 URL。

步骤 2：配置 Apple Developer Portal

现在我们需要使用后端 URL 配置 Apple Developer Portal，并获取所需的所有值。

函数 URL

请确保在进行下一步之前，您已经从步骤 1 中获得 Supabase Edge Function URL。您需要它来配置 Apple Developer Portal 中的 Return URL。

1. 遵循 Apple Login Android 设置指南

   完成 Apple Login Android 设置指南 到：

   • 创建服务 ID
   • 生成私钥 (.p8 文件)
   • 获取您的团队 ID 和密钥 ID
   • 配置返回 URL

2. 在 Apple 开发者门户中设置返回 URL

   在 Apple 开发者门户中配置返回 URL（Apple 指南第 6.9 步）时，请使用您的 Supabase Edge Function URL：

   https://your-project-ref.supabase.co/functions/v1/apple-signin-callback

   重要提示：使用 Supabase Edge Function URL

   不要 不要使用从 Supabase 中的重定向 URL Apple Login Android 设置指南. 这个指南使用自定义后端服务器 URL。对于 Supabase 集成， 必须 使用您的 Supabase Edge Function URL。

   精确匹配要求

   返回 URL 必须与这里配置的完全匹配。苹果对重定向 URI 匹配非常严格。 收集所有必需的值 完成 Apple 设置指南后，您应该有：

3. APPLE_TEAM_ID

   Exact Match Required

   • The Return URL must match exactly what you configure here.: Your Apple Developer Team ID
   • APPLE_KEY_ID: The Key ID from Apple Developer Portal
   • APPLE_PRIVATE_KEY: Your .p8 private key file (needs to be base64 encoded)
   • ANDROID_SERVICE_ID: Your Apple Service ID (e.g., com.example.app.service)
   • BASE_REDIRECT_URL: Your deep link URL (e.g., capgo-demo-app://path)

   Deep Link URL

   The BASE_REDIRECT_URL 是否配置了您的深度链接方案? AndroidManifest.xml这是后端在身份验证后将重定向到的位置。

   您的深度链接值取决于 android:scheme="capgo-demo-app" code。如果您已设置 android:scheme="capgo-demo-app" 在您的 AndroidManifest.xml，则您的深度链接将是 capgo-demo-app://path.

步骤 3：设置 Supabase 秘密

现在，我们需要配置 Supabase Edge Function 的环境变量（秘密）。

1. 编码您的私钥

   首先，编码您的 Apple 私钥 (.p8 文件) 到 base64:

   base64 -i AuthKey_XXXXX.p8

   复制整个输出（它是一个长的字符串）。

2. 使用 Supabase 设置密钥 CLI

   supabase secrets set APPLE_TEAM_ID=your_team_id
   supabase secrets set APPLE_KEY_ID=your_key_id
   supabase secrets set APPLE_PRIVATE_KEY=your_base64_encoded_key
   supabase secrets set ANDROID_SERVICE_ID=your.service.id
   supabase secrets set BASE_REDIRECT_URL=your-app://path
   supabase secrets set APPLE_REDIRECT_URI=https://your-project-ref.supabase.co/functions/v1/apple-signin-callback

   替换占位符

   将所有占位符值替换为您的实际值（第 2 步）。

3. 替代方案：在 Supabase 控制台中设置密钥

   如果您更喜欢使用控制台：

   1. 前往您的 Supabase 项目控制台
   2. 导航到 边缘函数 → 设置 → 密钥
   3. 添加每个密钥变量及其值

Android 应用配置

The Apple 登录 Android 设置指南 已经涵盖了配置您的 Android 应用：

• 添加深度链接意图过滤器到 AndroidManifest.xml
• 添加 onNewIntent 处理程序到 MainActivity.java

确保您已经完成了这些步骤，才能继续。您在那里配置的深度链接方案将是您的 BASE_REDIRECT_URL 在步骤 3 中

步骤 4：使用身份验证助手

现在您可以在应用程序中使用身份验证助手 code。

实现

完整的实现可在 示例应用程序的 supabaseAuthUtils.ts 文件中找到。

使用身份验证助手

import { authenticateWithAppleSupabase } from './supabaseAuthUtils';

const result = await authenticateWithAppleSupabase();
if (result.success) {
  console.log('Signed in:', result.user);
  // Navigate to your authenticated area
} else {
  console.error('Error:', result.error);
}

更新助手函数

当使用助手函数时， authenticateWithAppleSupabase 您必须 更新以下值以匹配您的配置： 更新

1. - 将其设置为您的 Supabase Edge 功能 URL： redirectUrl 复制到剪贴板

   const redirectUrl = platform === 'android'
     ? 'https://your-project-ref.supabase.co/functions/v1/apple-signin-callback'
     : undefined;

2. - 将其设置为您的 Apple 服务 ID： clientId 复制到剪贴板

   await SocialLogin.initialize({
     apple: {
       clientId: isIOS
         ? undefined // iOS uses bundle ID automatically
         : 'your.service.id.here', // Your Apple Service ID for Android
       redirectUrl: redirectUrl,
     },
   });

   重要

   替换 'your.service.id.here' 使用您的实际Apple服务ID（与步骤3中使用的相同值）。 ANDROID_SERVICE_ID 参见

完整的实现 测试集成 第五步：测试集成

第五步：测试集成

1. Build and run your Android app

   npx cap sync android
   npx cap run android

2. 测试认证流程

   • 点击“使用 Apple 登录”按钮
   • 您应该在浏览器中看到 Apple OAuth 页面
   • 认证后，您应该被重定向回您的应用
   • 检查控制台日志以查看是否有错误

3. 验证流程

   完整的流程应该是：

   1. 用户点击“使用 Apple 登录”
   2. 应用程序打开 Apple OAuth 的浏览器
   3. 用户使用 Apple 进行身份验证
   4. Apple 重定向到： https://your-project-ref.supabase.co/functions/v1/apple-signin-callback
   5. Edge 函数将 code 替换为令牌
   6. Edge 函数重定向到： your-app://path?id_token=...&access_token=...
   7. Android 应用接收深度链接并处理身份令牌
   8. 应用使用身份令牌登录 Supabase

故障排除

如果身份验证失败：

• 重定向 URI 不匹配：：验证 Apple Developer Portal 中的 Return URL 与 APPLE_REDIRECT_URI secret
• 深度链接未工作: 检查 AndroidManifest.xml intent 过滤器是否与您的 BASE_REDIRECT_URL
• 缺少密钥: 使用 supabase secrets list
• Token 交换失败: 检查 Supabase 控制台中的 Edge Function 日志以获取详细的错误消息
• 应用程序未接收回调: 确保 onNewIntent 已在 MainActivity 中正确实现
• 查看 示例应用程序 code 以获取参考

如何工作

在 Android 上，Apple Sign-In 使用 OAuth 重定向流程：

1. 初始化: 使用您的 Service ID 和后端重定向 URL 初始化插件
2. OAuth 流程: 打开 Apple 的 OAuth 页面的浏览器/Chrome 自定义标签
3. 后端回调: Apple 重定向到您的 Supabase Edge Function 中的授权 code
4. 令牌交换: 使用 Apple 的令牌端点，边缘函数交换 code 为令牌
5. 深度链接重定向: Apple 边缘函数重定向回您的应用程序，带有身份令牌
6. Supabase 身份验证: 应用程序接收令牌并登录 Supabase

由于 Apple 没有提供 native Android 支持，因此需要此流程

从 Supabase Apple 登录 Android 中继续

如果您正在使用 Supabase Apple 登录 Android 来规划身份验证和帐户流程，连接它 使用 @capgo/capacitor-social-login 为 native 能力在使用 @capgo/capacitor-social-login 中 使用 @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, and Two-factor authentication for the implementation detail in Two-factor authentication.