Supabase Apple Login on Android

前提条件

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

• the Supabase Apple Login - General Setup.

重要

Apple Sign-In 在 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

   完整的边缘函数实现可在示例应用中找到 复制以下文件到您的项目中:.

   - 主边缘函数 __CAPGO_KEEP_0__

   • supabase/functions/apple-signin-callback/index.ts - Main edge function code
   • supabase/functions/apple-signin-callback/deno.json 用于 JWT 签名的库 jose 配置 JWT 验证

4. Copy the following files to your project:

   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"

   重要

   设置 verify_jwt = false 使此端点公开。这是必需的，因为 Apple 的 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

请在第一步中获取 Supabase Edge Function URL，之后再进行下一步。您需要它来配置 Apple Developer Portal 中的 Return URL。

1. 遵循 Apple Login Android Setup 指南

   完成 Apple Login Android Setup 指南 到：

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

2. 在 Apple Developer Portal 中设置 Return URL

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

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

   重要提示：使用 Supabase Edge Function URL

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

   精确匹配要求

   Return URL 必须匹配 确切地配置这里的内容。苹果对重定向 URI 匹配非常严格。 什么你配置这里的内容。苹果对重定向 URI 匹配非常严格。

3. 收集所有所需的值

   完成 Apple 设置指南后，您应该有：

   • __CAPGO_KEEP_0__:您的 Apple 开发者团队 ID
   • :来自 Apple 开发者门户的密钥 ID:您的 .p8 私钥文件（需要 base64 编码）
   • :您的 Apple 服务 ID（例如什么你配置这里的内容。苹果对重定向 URI 匹配非常严格。
   • 什么你配置这里的内容。苹果对重定向 URI 匹配非常严格。什么你配置这里的内容。苹果对重定向 URI 匹配非常严格。 com.example.app.service)
   • BASE_REDIRECT_URLdeep link URL (例如， capgo-demo-app://path)

   深度链接 URL

   是您在 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. 如果您更喜欢使用仪表板：

   如果您更喜欢使用仪表板：

   1. 前往您的 Supabase 项目仪表板
   2. 导航至 边缘功能 → 设置 → 密钥
   3. 为每个密钥变量添加其值

安卓应用配置

The Apple Login Android Setup guide 已经涵盖了配置您的 Android 应用程序的步骤：

• 在 AndroidManifest.xml
• Adding the onNewIntent handler to MainActivity.java

在进行下一步之前，请确保您已经完成了这些步骤。您在那里配置的深度链接方案将是您的 BASE_REDIRECT_URL 在步骤 3 中。

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

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

实现

The complete implementation is available in the example app的 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 您必须 更新以下值以匹配您的配置： __CAPGO_KEEP_0__

1. 更新 redirectUrl - 将其设置为您的 Supabase Edge Function URL:

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

2. 更新 clientId - 将其设置为您的 Apple Service ID:

   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 Service ID（您在步骤 3 中使用的相同值） ANDROID_SERVICE_ID 参见

_CAPGO_KEEP_0_ 完整实现 请参阅。

第 5 步：测试集成

1. 构建并运行您的 Android 应用

   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. 边缘函数交换code为令牌
   6. 边缘函数重定向到： your-app://path?id_token=...&access_token=...
   7. 安卓应用程序接收深度链接并处理身份令牌
   8. 应用程序使用身份令牌登录Supabase

故障排除

If authentication fails:

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

标题为“如何工作”的部分

初始化

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

此流程是必要的，因为 Apple 没有为 Android 提供 native Sign in with Apple 支持。

从 Supabase Apple 登录继续

如果您正在使用 苹果 Supabase 登录 为了规划认证和账户流程，连接它 使用 @capgo/capacitor-social-login 对于 @capgo/capacitor-social-login 原生能力的实现细节 使用 @capgo/capacitor-social-login 对于 @capgo/capacitor-social-login 的实现细节 使用 @capgo/capacitor-passkey 对于 @capgo/capacitor-passkey 的实现细节 使用 @capgo/capacitor-native-biometric 对于 @capgo/capacitor-native-biometric 的实现细节 双因素认证 对于双因素认证的实现细节