Google Auth 迁移至 @capgo/social-login

概述

本指南提供了从 @codetrix-studio/capacitor-google-auth 到 @capgo/capacitor-social-login, ensuring a smooth transition and improved authentication experience. The new plugin unifies multiple social authentication providers under a single, consistent API.

安装

1. 终端窗口

   npm uninstall @codetrix-studio/capacitor-google-auth

2. 终端窗口

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

Google Auth 配置中的重要变化

Web Client ID 的要求

关键变化: 必须在所有平台上使用 Web Client ID 的更新插件。

您需要：

1. 如果您没有，请在 Google Cloud Console 中创建 Web Client ID（获取凭证的方法)
2. 在所有平台上使用此 Web Client ID webClientId 对于 Android，仍然需要使用 SHA1 创建 Android Client ID，但这仅用于验证目的 - 令牌不会被使用（
3. 在 Google Cloud Console 中创建 Web Client IDAndroid 设定指南)

Code Changes

导入更改

import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth';
import { SocialLogin } from '@capgo/capacitor-social-login';

初始化

设定从简单的 GoogleAuth.initialize() 调用转变为更结构化的 SocialLogin.initialize() 具有嵌套的 Google 配置：

GoogleAuth.initialize({
  clientId: 'CLIENT_ID.apps.googleusercontent.com',
  scopes: ['profile', 'email'],
  grantOfflineAccess: true,
});

await SocialLogin.initialize({
  google: {
    webClientId: 'WEB_CLIENT_ID.apps.googleusercontent.com', // Use Web Client ID for all platforms
    iOSClientId: 'IOS_CLIENT_ID', // for iOS
    mode: 'offline' // replaces grantOfflineAccess
  }
});

登录

从 GoogleAuth.signIn() 变为 SocialLogin.login() 使用明确的提供者进行指定：

const user = await GoogleAuth.signIn();
const res = await SocialLogin.login({
  provider: 'google',
  options: {
    scopes: ['email', 'profile'],
    forceRefreshToken: true // if you need refresh token
  }
});

平台相关的更改

Android

1. 更新你的 MainActivity.java (全面的Android设置指南):

 import ee.forgr.capacitor.social.login.GoogleProvider;
 import ee.forgr.capacitor.social.login.SocialLoginPlugin;
 import ee.forgr.capacitor.social.login.ModifiedMainActivityForSocialLoginPlugin;
 import com.getcapacitor.PluginHandle;
 import com.getcapacitor.Plugin;
 import android.content.Intent;
 import android.util.Log;

 public class MainActivity extends BridgeActivity {
 public class MainActivity extends BridgeActivity implements ModifiedMainActivityForSocialLoginPlugin {

   @Override
   public void onActivityResult(int requestCode, int resultCode, Intent data) {
     super.onActivityResult(requestCode, resultCode, data);

     if (requestCode >= GoogleProvider.REQUEST_AUTHORIZE_GOOGLE_MIN && requestCode < GoogleProvider.REQUEST_AUTHORIZE_GOOGLE_MAX) {
       PluginHandle pluginHandle = getBridge().getPlugin("SocialLogin");
       if (pluginHandle == null) {
         Log.i("Google Activity Result", "SocialLogin login handle is null");
         return;
       }
       Plugin plugin = pluginHandle.getInstance();
       if (!(plugin instanceof SocialLoginPlugin)) {
         Log.i("Google Activity Result", "SocialLogin plugin instance is not SocialLoginPlugin");
         return;
       }
       ((SocialLoginPlugin) plugin).handleGoogleLoginIntent(requestCode, data);
     }
   }

   public void IHaveModifiedTheMainActivityForTheUseWithSocialLoginPlugin() {}
}

iOS

1. AppDelegate.swift中没有需要修改的主要代码（iOS设置指南)

2. 更新您的配置在 capacitor.config.json,我们不再使用它在新插件：

{
  "plugins": {
   "GoogleAuth": {
     "scopes": ["profile", "email"],
     "serverClientId": "xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
     "forceCodeForRefreshToken": true
   }
}

Web

1. 如果您曾经使用它们，请从您的 index.html 移除Google Sign-In meta标签

<meta name="google-signin-client_id" content="{your client id here}" />
<meta name="google-signin-scope" content="profile email" />

响应类型变更

认证响应现在提供一个结构化的对象，包含提供商信息、访问令牌、ID令牌和用户资料：

interface GoogleLoginResponse {
  provider: 'google';
  result: {
    accessToken: {
      token: string;
      expires: string;
      // ... other token fields
    } | null;
    idToken: string | null;
    profile: {
      email: string | null;
      familyName: string | null;
      givenName: string | null;
      id: string | null;
      name: string | null;
      imageUrl: string | null;
    };
  };
}

响应结构包括：

• provider: 认证提供商（'google')
• result.accessToken: 过期时间内的访问令牌详细信息
• result.idToken: 用于身份验证的ID令牌
• result.profile用户资料，包括电子邮件、姓名和图片URL

Additional Capabilities

该新包支持Google之外的多个社交身份验证提供商：

• Apple Sign-In
• Facebook Login

这种统一的方法提供：

• 所有提供商中的一致性API
• 改进的TypeScript支持
• 更好的错误处理
• 积极的维护和社区支持

查看 主文档 这些额外提供商的详细设置指南。