Facebook登录迁移到@capgo/social-login

概述

本指南提供了从 @capacitor-community/facebook-login 到 @capgo/capacitor-social-login. The new plugin modernizes Facebook authentication with a unified API that supports multiple social providers, improved TypeScript support, and enhanced capabilities.

安装

1. 终端窗口

   npm uninstall @capacitor-community/facebook-login

2. 终端窗口

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

Code Changes

Import Changes

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
  }
});

登录

现在登录方法接受了一个提供者参数：

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'
  }
});

响应类型变更

响应结构已现代化，使用更全面的用户资料对象：

// 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'
});

平台相关变更

安卓设置

配置现在通过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 客户端令牌现在是必需的。

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>

Section titled “Breaking Changes”

__CAPGO_KEEP_0__:

1. 现在需要显式初始化 - 必须调用 initialize() 使用之前
2. 响应对象结构发生了重大变化 - 新的嵌套结果格式，带有增强的用户资料
3. 现在需要 Android 的客户端令牌 - 需要额外的配置
4. 方法名称和参数结构发生了变化 - 基于提供者的方法
5. 错误处理和错误类型发生了变化 - 更详细的错误信息

主要优势

新插件提供：

• 统一的API 多个社交提供商（Google、Apple、Facebook）中的统一身份认证
• 改进的TypeScript支持 更好的类型定义
• 增强的用户资料 更多的用户信息
• 持续的维护 社区支持
• 一致的错误处理 所有提供商
• 更好的令牌管理 带有适当过期处理

为了获取详细的设置说明，请参阅 官方文档.