您可以将 Facebook 登录服务集成到您的应用中,让您的用户可使用自己的 Facebook 账号进行 Firebase 身份验证。集成 Facebook 登录的方法有两种:使用 Firebase SDK 执行登录流程;手动执行 Facebook 登录流程并将生成的访问令牌传递给 Firebase。
准备工作
- 将 Firebase 添加至您的 JavaScript 项目。
- 在 Facebook for Developers 网站上,为您的应用获取应用 ID (App ID) 和应用密钥 (App Secret)。
- 启用 Facebook 登录方式:
- 在 Firebase 控制台中,打开 Auth 部分。
- 在登录方法标签页中,启用 Facebook 登录方法,并指定您之前从 Facebook 获得的应用 ID 和应用密钥。
- 然后,请务必前往 Facebook for Developers 网站,依次点击 Product Settings(产品设置)> Facebook Login(Facebook 登录)配置,然后在您的 Facebook 应用的设置页面中,确保您的 OAuth 重定向 URI(例如
my-app-12345.firebaseapp.com/__/auth/handler
)出现在 OAuth redirect URIs(OAuth 重定向 URI)列表中。
使用 Firebase SDK 处理登录流程
如果您是在构建 Web 应用,想要通过用户的 Facebook 账号对其进行 Firebase 身份验证,最简单的方法是使用 Firebase JavaScript SDK 来处理登录流程。(如果您希望在 Node.js 或其他非浏览器环境中对用户进行身份验证,则必须手动处理登录流程)。
如需使用 Firebase JavaScript SDK 处理登录流程,请按以下步骤操作:
- 创建 Facebook 提供方对象实例:
import { FacebookAuthProvider } from "firebase/auth"; const provider = new FacebookAuthProvider();
var provider = new firebase.auth.FacebookAuthProvider();
- 可选:指定您希望向身份验证提供方申请的额外 OAuth 2.0 范围。如需添加范围,请调用
addScope
。例如:provider.addScope('user_birthday');
provider.addScope('user_birthday');
- 可选:如需将提供方的 OAuth 流程本地化为用户偏好的语言,而不明确传递相关自定义 OAuth 参数,请在启动 OAuth 流程之前先更新 Auth 实例中的语言代码。例如:
import { getAuth } from "firebase/auth"; const auth = getAuth(); auth.languageCode = 'it'; // To apply the default browser preference instead of explicitly setting it. // auth.useDeviceLanguage();
firebase.auth().languageCode = 'it'; // To apply the default browser preference instead of explicitly setting it. // firebase.auth().useDeviceLanguage();
- 可选:指定您希望通过 OAuth 请求发送的其他自定义 OAuth 提供方参数。如需添加自定义参数,请使用包含 OAuth 提供方文档中指定的键及相应值的对象,对已初始化的提供方调用
setCustomParameters
方法。例如:provider.setCustomParameters({ 'display': 'popup' });
provider.setCustomParameters({ 'display': 'popup' });
- 使用 Facebook 提供方对象进行 Firebase 身份验证。您可以打开弹出式窗口或将用户重定向至登录页面,提示用户使用自己的 Facebook 账号登录。在移动设备上最好使用重定向方法。
- 如需使用弹出式窗口登录,请调用
signInWithPopup
:import { getAuth, signInWithPopup, FacebookAuthProvider } from "firebase/auth"; const auth = getAuth(); signInWithPopup(auth, provider) .then((result) => { // The signed-in user info. const user = result.user; // This gives you a Facebook Access Token. You can use it to access the Facebook API. const credential = FacebookAuthProvider.credentialFromResult(result); const accessToken = credential.accessToken; // IdP data available using getAdditionalUserInfo(result) // ... }) .catch((error) => { // Handle Errors here. const errorCode = error.code; const errorMessage = error.message; // The email of the user's account used. const email = error.customData.email; // The AuthCredential type that was used. const credential = FacebookAuthProvider.credentialFromError(error); // ... });
firebase .auth() .signInWithPopup(provider) .then((result) => { /** @type {firebase.auth.OAuthCredential} */ var credential = result.credential; // The signed-in user info. var user = result.user; // IdP data available in result.additionalUserInfo.profile. // ... // This gives you a Facebook Access Token. You can use it to access the Facebook API. var accessToken = credential.accessToken; // ... }) .catch((error) => { // Handle Errors here. var errorCode = error.code; var errorMessage = error.message; // The email of the user's account used. var email = error.email; // The firebase.auth.AuthCredential type that was used. var credential = error.credential; // ... });
您还可以在此处捕获并处理错误。如需获取错误代码列表,请参阅身份验证参考文档。
- 需重定向到登录页面进行登录,请调用
signInWithRedirect
:使用“signInWithRedirect”时,请遵循最佳实践。import { getAuth, signInWithRedirect } from "firebase/auth"; const auth = getAuth(); signInWithRedirect(auth, provider);
firebase.auth().signInWithRedirect(provider);
getRedirectResult
来检索 Facebook 提供方的 OAuth 令牌:import { getAuth, getRedirectResult, FacebookAuthProvider } from "firebase/auth"; const auth = getAuth(); getRedirectResult(auth) .then((result) => { // This gives you a Facebook Access Token. You can use it to access the Facebook API. const credential = FacebookAuthProvider.credentialFromResult(result); const token = credential.accessToken; const user = result.user; // IdP data available using getAdditionalUserInfo(result) // ... }).catch((error) => { // Handle Errors here. const errorCode = error.code; const errorMessage = error.message; // The email of the user's account used. const email = error.customData.email; // AuthCredential type that was used. const credential = FacebookAuthProvider.credentialFromError(error); // ... });
firebase.auth() .getRedirectResult() .then((result) => { if (result.credential) { /** @type {firebase.auth.OAuthCredential} */ var credential = result.credential; // This gives you a Facebook Access Token. You can use it to access the Facebook API. var token = credential.accessToken; // ... } // The signed-in user info. var user = result.user; // IdP data available in result.additionalUserInfo.profile. // ... }).catch((error) => { // Handle Errors here. var errorCode = error.code; var errorMessage = error.message; // The email of the user's account used. var email = error.email; // The firebase.auth.AuthCredential type that was used. var credential = error.credential; // ... });
- 如需使用弹出式窗口登录,请调用
处理“account-exists-with-different-credential”错误
如果您在 Firebase 控制台中启用了每个电子邮件地址一个账号设置,当用户尝试使用一个 Firebase 用户的提供方(例如 Google)中已存在的电子邮件地址登录另一个提供方(例如 Facebook)时,系统会抛出 auth/account-exists-with-different-credential
错误及 AuthCredential
对象(Facebook 访问令牌)。如需登录所需的提供方,用户必须首先登录现有提供方 (Google),然后再关联到之前的 AuthCredential
(Facebook 访问令牌)。
弹出模式
如果您使用 signInWithPopup
,可以通过与下例类似的代码来处理 auth/account-exists-with-different-credential
错误:
import { getAuth, linkWithCredential, signInWithPopup, FacebookAuthProvider, } from "firebase/auth"; try { // Step 1: User tries to sign in using Facebook. let result = await signInWithPopup(getAuth(), new FacebookAuthProvider()); } catch (error) { // Step 2: User's email already exists. if (error.code === "auth/account-exists-with-different-credential") { // The pending Facebook credential. let pendingCred = error.credential; // Step 3: Save the pending credential in temporary storage, // Step 4: Let the user know that they already have an account // but with a different provider, and let them choose another // sign-in method. } } // ... try { // Step 5: Sign the user in using their chosen method. let result = await signInWithPopup(getAuth(), userSelectedProvider); // Step 6: Link to the Facebook credential. // TODO: implement `retrievePendingCred` for your app. let pendingCred = retrievePendingCred(); if (pendingCred !== null) { // As you have access to the pending credential, you can directly call the // link method. let user = await linkWithCredential(result.user, pendingCred); } // Step 7: Continue to app. } catch (error) { // ... }
重定向模式
在重定向模式下,处理该错误的方法类似,不同的是待处理凭据必须在页面重定向之间缓存(例如,使用会话存储空间缓存)。
高级:手动处理登录流程
您还可以通过 Facebook 登录 JavaScript SDK 处理登录流程,以便使用 Facebook 账号进行 Firebase 身份验证:
- 按开发者文档中的说明操作,将 Facebook 登录服务集成到您的应用中。确保使用您的 Facebook 应用 ID 来配置 Facebook 登录服务:
<script src="//connect.facebook.net/en_US/sdk.js"></script> <script> FB.init({ /********************************************************************** * TODO(Developer): Change the value below with your Facebook app ID. * **********************************************************************/ appId: '<YOUR_FACEBOOK_APP_ID>', status: true, xfbml: true, version: 'v2.6', }); </script>
-
我们还要针对 Facebook 身份验证状态设置监听器:
FB.Event.subscribe('auth.authResponseChange', checkLoginState);
-
在集成 Facebook 登录服务之后,在您的网页上添加一个 Facebook 登录按钮:
<fb:login-button data-auto-logout-link="true" scope="public_profile,email" size="large" ></fb:login-button>
- 在 Facebook 身份验证状态回调中,使用 Facebook 身份验证响应返回的身份验证令牌换取 Firebase 凭据,然后登录 Firebase:
import { getAuth, onAuthStateChanged, signInWithCredential, signOut, FacebookAuthProvider } from "firebase/auth"; const auth = getAuth(); function checkLoginState(response) { if (response.authResponse) { // User is signed-in Facebook. const unsubscribe = onAuthStateChanged(auth, (firebaseUser) => { unsubscribe(); // Check if we are already signed-in Firebase with the correct user. if (!isUserEqual(response.authResponse, firebaseUser)) { // Build Firebase credential with the Facebook auth token. const credential = FacebookAuthProvider.credential( response.authResponse.accessToken); // Sign in with the credential from the Facebook user. signInWithCredential(auth, credential) .catch((error) => { // Handle Errors here. const errorCode = error.code; const errorMessage = error.message; // The email of the user's account used. const email = error.customData.email; // The AuthCredential type that was used. const credential = FacebookAuthProvider.credentialFromError(error); // ... }); } else { // User is already signed-in Firebase with the correct user. } }); } else { // User is signed-out of Facebook. signOut(auth); } }
function checkLoginState(response) { if (response.authResponse) { // User is signed-in Facebook. var unsubscribe = firebase.auth().onAuthStateChanged((firebaseUser) => { unsubscribe(); // Check if we are already signed-in Firebase with the correct user. if (!isUserEqual(response.authResponse, firebaseUser)) { // Build Firebase credential with the Facebook auth token. var credential = firebase.auth.FacebookAuthProvider.credential( response.authResponse.accessToken); // Sign in with the credential from the Facebook user. firebase.auth().signInWithCredential(credential) .catch((error) => { // Handle Errors here. var errorCode = error.code; var errorMessage = error.message; // The email of the user's account used. var email = error.email; // The firebase.auth.AuthCredential type that was used. var credential = error.credential; // ... }); } else { // User is already signed-in Firebase with the correct user. } }); } else { // User is signed-out of Facebook. firebase.auth().signOut(); } }
- 此外,您应确保 Facebook 用户尚未登录 Firebase,以避免不必要的重复身份验证:
import { FacebookAuthProvider } from "firebase/auth"; function isUserEqual(facebookAuthResponse, firebaseUser) { if (firebaseUser) { const providerData = firebaseUser.providerData; for (let i = 0; i < providerData.length; i++) { if (providerData[i].providerId === FacebookAuthProvider.PROVIDER_ID && providerData[i].uid === facebookAuthResponse.userID) { // We don't need to re-auth the Firebase connection. return true; } } } return false; }
function isUserEqual(facebookAuthResponse, firebaseUser) { if (firebaseUser) { var providerData = firebaseUser.providerData; for (var i = 0; i < providerData.length; i++) { if (providerData[i].providerId === firebase.auth.FacebookAuthProvider.PROVIDER_ID && providerData[i].uid === facebookAuthResponse.userID) { // We don't need to re-auth the Firebase connection. return true; } } } return false; }
高级:在 Node.js 中进行 Firebase 身份验证
如需在 Node.js 应用中进行 Firebase 身份验证,请按以下步骤操作:
- 使用用户的 Facebook 账号登录,获取用户的 Facebook 访问令牌。例如,如手动处理登录流程部分中所述,让用户在浏览器中登录,不过应将访问令牌发送到 Node.js 应用,而不是在客户端应用中使用该访问令牌。
- 取得用户的 Facebook 访问令牌之后,使用该令牌构建 Credential 对象,然后使用该凭据进行登录:
import { getAuth, signInWithCredential, FacebookAuthProvider } from "firebase/auth"; // Sign in with the credential from the Facebook user. const auth = getAuth(); signInWithCredential(auth, credential) .then((result) => { // Signed in const credential = FacebookAuthProvider.credentialFromResult(result); }) .catch((error) => { // Handle Errors here. const errorCode = error.code; const errorMessage = error.message; // The email of the user's account used. const email = error.customData.email; // The AuthCredential type that was used. const credential = FacebookAuthProvider.credentialFromError(error); // ... });
// Sign in with the credential from the Facebook user. firebase.auth().signInWithCredential(credential) .then((result) => { // Signed in var credential = result.credential; // ... }) .catch((error) => { // Handle Errors here. var errorCode = error.code; var errorMessage = error.message; // The email of the user's account used. var email = error.email; // The firebase.auth.AuthCredential type that was used. var credential = error.credential; // ... });
在 Chrome 扩展程序中进行 Firebase 身份验证
如果您正在构建 Chrome 扩展程序应用,请参阅“屏幕外文档”指南。
为 Facebook 登录服务自定义重定向网域
在创建项目时,Firebase 将为您的项目预配一个唯一的子网域:https://my-app-12345.firebaseapp.com
。
它也将用作 OAuth 登录的重定向机制。该网域需要列入所有受支持的 OAuth 提供方的许可名单。但是,这意味着用户在登录 Facebook 时可能会先看到该网域(前往:https://my-app-12345.firebaseapp.com),然后才重定向回应用。
如需避免显示子网域,您可以使用 Firebase Hosting 设置自定义网域:
- 按照设置您的 Hosting 网域中的第 1 步到第 3 步执行操作。当您验证网域所有权时,Hosting 会为您的自定义网域预配一个 SSL 证书。
- 在 Firebase 控制台中,将您的自定义域名添加到已获授权的域名列表:
auth.custom.domain.com
。 - 在 Facebook 开发者控制台或 OAuth 设置页面中,将可通过该自定义网域访问的重定向页面的网址 (
https://auth.custom.domain.com/__/auth/handler
) 加入许可名单。 - 初始化 JavaScript 库时,使用
authDomain
字段指定您的自定义网域:var config = { apiKey: '...', // Changed from '
PROJECT_ID .firebaseapp.com'. authDomain: 'auth.custom.domain.com', databaseURL: 'https://PROJECT_ID .firebaseio.com', projectId: 'PROJECT_ID ', storageBucket: ' ', messagingSenderId: 'PROJECT_ID .firebasestorage.appSENDER_ID ' }; firebase.initializeApp(config);
后续步骤
在用户首次登录后,系统会创建一个新的用户账号,并将其与该用户登录时使用的凭据(即用户名和密码、电话号码或者身份验证提供方信息)相关联。此新账号存储在您的 Firebase 项目中,无论用户采用何种方式登录,您项目中的每个应用都可以使用此账号来识别用户。
-
在您的应用中,建议通过在
Auth
对象上设置观测器来了解用户的身份验证状态。然后,您便可从User
对象获取用户的基本个人资料信息。请参阅管理用户。 在您的 Firebase Realtime Database 和 Cloud Storage 安全规则中,您可以从
auth
变量获取已登录用户的唯一用户 ID,然后利用此 ID 来控制用户可以访问哪些数据。
您可以通过将身份验证提供方凭据关联至现有用户账号,让用户可以使用多个身份验证提供方登录您的应用。
如需将用户退出登录,请调用 signOut
:
import { getAuth, signOut } from "firebase/auth"; const auth = getAuth(); signOut(auth).then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });
firebase.auth().signOut().then(() => { // Sign-out successful. }).catch((error) => { // An error happened. });