将 Facebook Login 迁移至 @capgo/social-login

概览

本指南提供了从 @capacitor-community/facebook-login 改为 @capgo/capacitor-social-login迁移的详细步骤。新插件通过统一的 API 现代化了 Facebook 身份验证，支持多种社交提供商，并改进了 TypeScript 支持和功能。

安装

1. 移除旧 package：

   npm uninstall @capacitor-community/facebook-login

2. 安装新包：

   npm install @capgo/capacitor-social-login
   npx cap sync

Code 变更

导入变更

import { FacebookLogin } from '@capacitor-community/facebook-login';
import { SocialLogin } from '@capgo/capacitor-social-login';

初始化

关键变更：新包需要在你的 code 中显式配置：

// Old package required no explicit initialization in code
// Configuration was done only in native platforms

// New package requires explicit initialization
await SocialLogin.initialize({
  facebook: {
    appId: 'YOUR_FACEBOOK_APP_ID',        // Required for web and Android
    clientToken: 'YOUR_CLIENT_TOKEN'       // Required for Android
  }
});

登录

登录方法现在接受一个 provider 参数：

const FACEBOOK_PERMISSIONS = ['email', 'public_profile'];
const result = await FacebookLogin.login({ permissions: FACEBOOK_PERMISSIONS });

const result = await SocialLogin.login({
  provider: 'facebook',
  options: {
    permissions: ['email', 'public_profile'],
    limitedLogin: false,
    nonce: 'optional_nonce'
  }
});

响应类型变更

响应结构已现代化，包含更全面的 profile 对象：

// Old response type
interface FacebookLoginResponse {
  accessToken: {
    applicationId: string;
    userId: string;
    token: string;
    expires: string;
  };
  recentlyGrantedPermissions: string[];
  recentlyDeniedPermissions: string[];
}

// New response type
interface FacebookLoginResponse {
  provider: 'facebook';
  result: {
    accessToken: {
      token: string;
      applicationId?: string;
      expires?: string;
      userId?: string;
      permissions?: string[];
      declinedPermissions?: string[];
    } | null;
    idToken: string | null;
    profile: {
      userID: string;
      email: string | null;
      friendIDs: string[];
      birthday: string | null;
      ageRange: { min?: number; max?: number } | null;
      gender: string | null;
      location: { id: string; name: string } | null;
      hometown: { id: string; name: string } | null;
      profileURL: string | null;
      name: string | null;
      imageURL: string | null;
    };
  };
}

核心差异:

• 响应现在包含一个 provider 字段，用于标识身份验证提供商
• 更详细的 profile 包含额外用户信息的对象
• 所有社交登录提供商的结构保持一致

检查登录状态

const result = await FacebookLogin.getCurrentAccessToken();
const isLoggedIn = result && result.accessToken;

const status = await SocialLogin.isLoggedIn({
  provider: 'facebook'
});
const isLoggedIn = status.isLoggedIn;

退出登录

await FacebookLogin.logout();

await SocialLogin.logout({
  provider: 'facebook'
});

平台特定变更

Android 配置

现在通过 initialize 方法进行配置：

// AndroidManifest.xml changes remain the same
// strings.xml become irrelevant
// Additionally initialize in your code:
await SocialLogin.initialize({
  facebook: {
    appId: 'your-app-id',
    clientToken: 'your-client-token'  // New requirement
  }
});

重要提示：Android 身份验证现在需要 Client token。

iOS 配置

1. iOS 设置 AppDelegate.swift 保持不变：

import FBSDKCoreKit

// In application:didFinishLaunchingWithOptions:
FBSDKCoreKit.ApplicationDelegate.shared.application(
    application,
    didFinishLaunchingWithOptions: launchOptions
)

// In application:openURL:options:
ApplicationDelegate.shared.application(
    app,
    open: url,
    sourceApplication: options[UIApplication.OpenURLOptionsKey.sourceApplication] as? String,
    annotation: options[UIApplication.OpenURLOptionsKey.annotation]
)

2. 本指南中介绍的 Info.plist 配置保持不变：

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>fb[APP_ID]</string>
        </array>
    </dict>
</array>
<key>FacebookAppID</key>
<string>[APP_ID]</string>
<key>FacebookClientToken</key>
<string>[CLIENT_TOKEN]</string>
<key>FacebookDisplayName</key>
<string>[APP_NAME]</string>
<key>LSApplicationQueriesSchemes</key>
<array>
    <string>fbapi</string>
    <string>fbauth</string>
    <string>fb-messenger-share-api</string>
    <string>fbauth2</string>
    <string>fbshareextension</string>
</array>

破坏性变更

迁移时的破坏性变更摘要：

1. 现在需要显式初始化 - 必须调用 initialize() 后才能使用
2. Response 对象结构发生了重大变化 - 采用全新的嵌套 result 格式，提供更丰富的 profile 数据
3. Android 端现在需要 Client token - 需要额外配置
4. 方法名和参数结构已变更 - 基于 Provider 的方案
5. 错误处理机制及错误类型已变更 - 更详细的错误信息

核心优势

新插件提供：

• 统一的 API 支持多个社交平台 (Google, Apple, Facebook)
• 更出色的 TypeScript 支持 具备更完善的类型定义
• 增强的用户资料数据 包含更丰富的用户信息
• 持续维护 以及社区支持
• 统一的错误处理 覆盖所有提供商
• 更好的 token 管理 并妥善处理过期

如需更详细的配置说明，请参阅 官方文档.

从 Facebook Login 迁移继续前往 @capgo/social-login

如果你正在使用 将 Facebook Login 迁移至 @capgo/social-login 用来规划身份验证和账户流程，并将它与 使用 @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 中的实现细节， 双因素认证 有关双重身份验证的实现细节。