您可以使用 Firebase SDK 將網頁式一般 OAuth 登入整合到應用程式中,讓使用者利用自己的 Twitter 帳戶進行驗證,完成端對端的登入流程。
事前準備
如要使用 Twitter 帳戶登入使用者,您必須先針對 Firebase 專案將 Twitter 啟用為登入供應商:
如果您尚未將 Firebase 新增至 Android 專案,請先完成這項作業。
- 在 Firebase 控制台,開啟「Auth」(驗證) 區段。
- 在「Sign in method」分頁中,啟用 Twitter 供應商。
- 將該供應商的開發人員控制台中的 API 金鑰和 API 密鑰,新增至提供者設定:
- 在 Twitter 上將應用程式註冊為開發人員應用程式,並取得應用程式的 OAuth API 金鑰和 API 密鑰。
- 前往 Twitter 應用程式的設定頁面,確認 Firebase OAuth 重新導向 URI (例如
my-app-12345.firebaseapp.com/__/auth/handler
) 已設為「授權回呼網址」。
- 點選「Save」。
在模組 (應用程式層級) Gradle 檔案 (通常是
<project>/<app-module>/build.gradle.kts
或<project>/<app-module>/build.gradle
) 中,新增 Android 適用的 Firebase 驗證程式庫的依附元件。建議您使用 Firebase Android BoM 來控管程式庫版本管理。dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.1.1")) // Add the dependency for the Firebase Authentication library // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth") }
如果使用 Firebase Android BoM,應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代方法) 新增 Firebase 程式庫依附元件,「不必」使用 BoM
如果選擇不使用 Firebase BoM,請務必在依附元件行中指定各個 Firebase 程式庫版本。
請注意,如果在應用程式中使用多個 Firebase 程式庫,強烈建議您使用 BoM 管理程式庫版本,確保所有版本都相容。
dependencies { // Add the dependency for the Firebase Authentication library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-auth:23.0.0") }
如果您尚未指定應用程式的 SHA-1 指紋,請前往 Firebase 控制台的設定頁面指定。如要進一步瞭解如何取得應用程式的 SHA-1 指紋,請參閱「驗證用戶端」一文。
透過 Firebase SDK 處理登入流程
如果您要建構 Android 應用程式,最簡單的方法是使用 Firebase 帳戶以透過 Firebase 驗證使用者,最簡單的方法是使用 Firebase Android SDK 處理整個登入流程。
如要透過 Firebase Android SDK 處理登入流程,請按照下列步驟操作:
使用供應商 ID Twitter.com 的 Builder 建構 OAuthProvider 的執行個體
Kotlin+KTX
val provider = OAuthProvider.newBuilder("twitter.com")
Java
OAuthProvider.Builder provider = OAuthProvider.newBuilder("twitter.com");
選用:指定要與 OAuth 要求一併傳送的其他自訂 OAuth 參數。
Kotlin+KTX
// Localize to French. provider.addCustomParameter("lang", "fr")
Java
// Localize to French. provider.addCustomParameter("lang", "fr");
如需 Twitter 支援的參數,請參閱 Twitter OAuth 說明文件。請注意,您無法透過
setCustomParameters()
傳遞 Firebase 必要參數。這些參數分別是 client_id、response_type、redirect_uri、state、scope 和 response_mode。使用 OAuth 提供者物件進行 Firebase 驗證。請注意,與其他 FirebaseAuth 作業不同,系統會彈出自訂 Chrome 分頁來控管 UI。因此,請勿參照您附加的
OnSuccessListener
和OnFailureListener
中的活動,因為當作業啟動 UI 時,這些活動會立即卸離。請先檢查是否已收到回覆。如果您透過這種方式登入,活動會在背景中保留,這表示系統可以在登入流程中取回活動。為確保使用者不會遇到這種情況,請檢查結果是否已存在。
如要查看是否有待處理的結果,請呼叫
getPendingAuthResult
:Kotlin+KTX
val pendingResultTask = firebaseAuth.pendingAuthResult if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. } } else { // There's no pending result so you need to start the sign-in flow. // See below. }
Java
Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult(); if (pendingResultTask != null) { // There's something already here! Finish the sign-in for your user. pendingResultTask .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } }); } else { // There's no pending result so you need to start the sign-in flow. // See below. }
如要啟動登入流程,請呼叫
startActivityForSignInWithProvider
:Kotlin+KTX
firebaseAuth .startActivityForSignInWithProvider(activity, provider.build()) .addOnSuccessListener { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } .addOnFailureListener { // Handle failure. }
Java
firebaseAuth .startActivityForSignInWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is signed in. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // ((OAuthCredential)authResult.getCredential()).getAccessToken(). // The OAuth secret can be retrieved by calling: // ((OAuthCredential)authResult.getCredential()).getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
成功完成後,就能從傳回的
OAuthCredential
物件中擷取與提供者相關聯的 OAuth 存取權杖。您可以使用 OAuth 存取權杖呼叫 Twitter API。
舉例來說,如要取得基本個人資料,您可以呼叫 REST API,並在
Authorization
標頭中傳遞存取憑證:雖然上述範例以登入流程為主,但您也可以使用
startActivityForLinkWithProvider
將 Twitter 供應商連結至現有使用者。舉例來說,您可以將多個提供者連結至同一使用者,讓他們能夠使用任一提供者登入。Kotlin+KTX
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForLinkWithProvider(activity, provider.build()) .addOnSuccessListener { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForLinkWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // Provider credential is linked to the current user. // IdP data available in // authResult.getAdditionalUserInfo().getProfile(). // The OAuth access token can also be retrieved: // authResult.getCredential().getAccessToken(). // The OAuth secret can be retrieved by calling: // authResult.getCredential().getSecret(). } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
相同的模式可與
startActivityForReauthenticateWithProvider
搭配使用,用於針對需要近期登入的敏感作業擷取新的憑證。Kotlin+KTX
// The user is already signed-in. val firebaseUser = firebaseAuth.currentUser!! firebaseUser .startActivityForReauthenticateWithProvider(activity, provider.build()) .addOnSuccessListener { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } .addOnFailureListener { // Handle failure. }
Java
// The user is already signed-in. FirebaseUser firebaseUser = firebaseAuth.getCurrentUser(); firebaseUser .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build()) .addOnSuccessListener( new OnSuccessListener<AuthResult>() { @Override public void onSuccess(AuthResult authResult) { // User is re-authenticated with fresh tokens and // should be able to perform sensitive operations // like account deletion and email or password // update. } }) .addOnFailureListener( new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { // Handle failure. } });
後續步驟
使用者首次登入後,系統會建立新的使用者帳戶,並連結至用來登入的使用者憑證,也就是使用者名稱與密碼、電話號碼或驗證提供者資訊。這個新帳戶以 Firebase 專案的形式儲存,無論使用者以何種方式登入,都能從專案中的每個應用程式識別使用者。
-
在應用程式中,您可以從
FirebaseUser
物件取得使用者的基本個人資料。請參閱「 管理使用者」一文。 在 Firebase 即時資料庫和 Cloud Storage 安全性規則中,您可以從
auth
變數取得已登入使用者的專屬 ID,並使用該 ID 控管使用者可存取的資料。
您可以將驗證提供者憑證連結至現有的使用者帳戶,讓使用者透過多個驗證提供者登入您的應用程式。
如要登出使用者,請呼叫
signOut
:
Kotlin+KTX
Firebase.auth.signOut()
Java
FirebaseAuth.getInstance().signOut();