FirebaseUI是一個建立在 Firebase 驗證 SDK 之上的程式庫,它提供了可在您的應用程式中使用的嵌入式 UI 流。 FirebaseUI 具有以下優點:
- 多個提供者- 電子郵件/密碼、電子郵件連結、電話身份驗證、Google 登入、Facebook 登入、Twitter 登入和 GitHub 登入的登入流程。
- 帳戶管理- 處理帳戶管理任務的流程,例如帳戶建立和密碼重設。
- 帳戶連結- 跨身分提供者安全連結使用者帳戶的流程。
- 匿名用戶升級- 安全升級匿名用戶的流程。
- 自訂主題- 自訂 FirebaseUI 的外觀以符合您的應用程式。此外,由於 FirebaseUI 是開源的,因此您可以分叉專案並根據您的需求進行自訂。
- 密碼智慧鎖- 與密碼智慧鎖自動集成,實現快速跨裝置登入。
在你開始之前
如果您尚未將 Firebase 新增至您的 Android 專案中,請將其新增至您的 Android 專案中。
將 FirebaseUI 的依賴項新增至應用程式級
build.gradle
檔案。如果您想支持使用 Facebook 或 Twitter 登錄,還需包含 Facebook 和 Twitter SDK:dependencies { // ... implementation 'com.firebaseui:firebase-ui-auth:7.2.0' // Required only if Facebook login support is required // Find the latest Facebook SDK releases here: https://goo.gl/Ce5L94 implementation 'com.facebook.android:facebook-android-sdk:8.x' }
FirebaseUI Auth SDK 對 Firebase SDK 和 Google Play 服務 SDK 具有傳遞依賴性。
在Firebase 控制台中,開啟「驗證」部分並啟用您想要支援的登入方法。某些登入方法需要額外資訊,這些資訊通常可在服務的開發人員控制台中找到。
如果您啟用了 Google 登入:
當控制台中出現提示時,下載更新後的 Firebase 設定檔 (
google-services.json
),該檔案現在包含 Google 登入所需的 OAuth 用戶端資訊。將此更新後的設定檔移至您的 Android Studio 專案中,取代現已過時的相應設定檔。 (請參閱將 Firebase 新增至您的 Android 專案。)
如果您尚未指定已套用的 SHA 指紋,請從 Firebase 控制台的「設定」頁面執行此操作。有關如何取得應用程式的 SHA 指紋的詳細信息,請參閱驗證您的用戶端。
如果您支援使用 Facebook 或 Twitter 登錄,請將字串資源新增至
strings.xml
以指定每個提供者所需的識別資訊:<resources> <!-- Facebook application ID and custom URL scheme (app ID prefixed by 'fb'). --> <string name="facebook_application_id" translatable="false">YOUR_APP_ID</string> <string name="facebook_login_protocol_scheme" translatable="false">fbYOUR_APP_ID</string> </resources>
登入
建立一個ActivityResultLauncher
,為 FirebaseUI 活動結果合約註冊回調:
Kotlin+KTX
// See: https://developer.android.com/training/basics/intents/result private val signInLauncher = registerForActivityResult( FirebaseAuthUIActivityResultContract(), ) { res -> this.onSignInResult(res) }
Java
// See: https://developer.android.com/training/basics/intents/result private final ActivityResultLauncher<Intent> signInLauncher = registerForActivityResult( new FirebaseAuthUIActivityResultContract(), new ActivityResultCallback<FirebaseAuthUIAuthenticationResult>() { @Override public void onActivityResult(FirebaseAuthUIAuthenticationResult result) { onSignInResult(result); } } );
若要啟動 FirebaseUI 登入流程,請使用您首選的登入方法建立登入意圖:
Kotlin+KTX
// Choose authentication providers val providers = arrayListOf( AuthUI.IdpConfig.EmailBuilder().build(), AuthUI.IdpConfig.PhoneBuilder().build(), AuthUI.IdpConfig.GoogleBuilder().build(), AuthUI.IdpConfig.FacebookBuilder().build(), AuthUI.IdpConfig.TwitterBuilder().build(), ) // Create and launch sign-in intent val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .build() signInLauncher.launch(signInIntent)
Java
// Choose authentication providers List<AuthUI.IdpConfig> providers = Arrays.asList( new AuthUI.IdpConfig.EmailBuilder().build(), new AuthUI.IdpConfig.PhoneBuilder().build(), new AuthUI.IdpConfig.GoogleBuilder().build(), new AuthUI.IdpConfig.FacebookBuilder().build(), new AuthUI.IdpConfig.TwitterBuilder().build()); // Create and launch sign-in intent Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .build(); signInLauncher.launch(signInIntent);
登入流程完成後,您將在onSignInResult
中收到結果:
Kotlin+KTX
private fun onSignInResult(result: FirebaseAuthUIAuthenticationResult) { val response = result.idpResponse if (result.resultCode == RESULT_OK) { // Successfully signed in val user = FirebaseAuth.getInstance().currentUser // ... } else { // Sign in failed. If response is null the user canceled the // sign-in flow using the back button. Otherwise check // response.getError().getErrorCode() and handle the error. // ... } }
Java
private void onSignInResult(FirebaseAuthUIAuthenticationResult result) { IdpResponse response = result.getIdpResponse(); if (result.getResultCode() == RESULT_OK) { // Successfully signed in FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser(); // ... } else { // Sign in failed. If response is null the user canceled the // sign-in flow using the back button. Otherwise check // response.getError().getErrorCode() and handle the error. // ... } }
設定登入方法
郵件連結驗證
在Firebase 控制台中,開啟「驗證」部分。在登入方法標籤上,啟用電子郵件/密碼提供者。請注意,必須啟用電子郵件/密碼登入才能使用電子郵件連結登入。
在同一部分中,啟用電子郵件連結(無密碼登入)登入方法,然後按一下「儲存」 。
您還必須啟用 Firebase 動態連結才能使用電子郵件連結登入。在Firebase 控制台中,按一下導覽列中「參與」下的「動態連結」 。點擊“入門”並新增網域。您在此處選擇的網域將反映在發送給您的使用者的電子郵件連結中。
您可以透過在
EmailBuilder
實例上呼叫enableEmailLinkSignIn
來在 FirebaseUI 中啟用電子郵件連結登入。您還需要提供一個有效的ActionCodeSettings
對象,並將setHandleCodeInApp
設為 true。此外,您需要將傳遞給setUrl
URL 列入白名單,這可以在Firebase 控制台的Authentication -> Sign inMethods -> Authorizeddomains 下完成。Kotlin+KTX
val actionCodeSettings = ActionCodeSettings.newBuilder() .setAndroidPackageName( // yourPackageName= "...", // installIfNotAvailable= true, // minimumVersion= null, ) .setHandleCodeInApp(true) // This must be set to true .setUrl("https://google.com") // This URL needs to be whitelisted .build() val providers = listOf( EmailBuilder() .enableEmailLinkSignIn() .setActionCodeSettings(actionCodeSettings) .build(), ) val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .build() signInLauncher.launch(signInIntent)
Java
ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder() .setAndroidPackageName( /* yourPackageName= */ "...", /* installIfNotAvailable= */ true, /* minimumVersion= */ null) .setHandleCodeInApp(true) // This must be set to true .setUrl("https://google.com") // This URL needs to be whitelisted .build(); List<AuthUI.IdpConfig> providers = Arrays.asList( new AuthUI.IdpConfig.EmailBuilder() .enableEmailLinkSignIn() .setActionCodeSettings(actionCodeSettings) .build() ); Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .build(); signInLauncher.launch(signInIntent);
如果您想捕獲特定活動中的鏈接,請按照此處概述的步驟操作。否則,該連結將重定向到您的啟動器活動。
一旦您捕獲深層鏈接,您將需要致電驗證我們是否可以為您處理。如果可以,您需要透過
setEmailLink
將其傳遞給我們。Kotlin+KTX
if (AuthUI.canHandleIntent(intent)) { val extras = intent.extras ?: return val link = extras.getString("email_link_sign_in") if (link != null) { val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setEmailLink(link) .setAvailableProviders(providers) .build() signInLauncher.launch(signInIntent) } }
Java
if (AuthUI.canHandleIntent(getIntent())) { if (getIntent().getExtras() == null) { return; } String link = getIntent().getExtras().getString("email_link_sign_in"); if (link != null) { Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setEmailLink(link) .setAvailableProviders(providers) .build(); signInLauncher.launch(signInIntent); } }
支援可選的跨裝置電子郵件連結登錄,這意味著透過 Android 應用程式發送的連結可用於登入您的 Web 或 Apple 應用程式。預設情況下,啟用跨裝置支援。您可以透過在
EmailBuilder
實例上呼叫setForceSameDevice
來停用它。有關詳細信息,請參閱FirebaseUI-Web和FirebaseUI-iOS 。
登出
FirebaseUI 提供了註銷 Firebase 身份驗證以及所有社交身分提供者的便利方法:
Kotlin+KTX
AuthUI.getInstance() .signOut(this) .addOnCompleteListener { // ... }
Java
AuthUI.getInstance() .signOut(this) .addOnCompleteListener(new OnCompleteListener<Void>() { public void onComplete(@NonNull Task<Void> task) { // ... } });
您也可以完全刪除使用者的帳戶:
Kotlin+KTX
AuthUI.getInstance() .delete(this) .addOnCompleteListener { // ... }
Java
AuthUI.getInstance() .delete(this) .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // ... } });
客製化
預設情況下,FirebaseUI 使用 AppCompat 進行主題化,這意味著它會自然地採用您應用程式的配色方案。如果您需要進一步自訂,您可以將主題和徽標傳遞給登入Intent
建構器:
Kotlin+KTX
val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setLogo(R.drawable.my_great_logo) // Set logo drawable .setTheme(R.style.MySuperAppTheme) // Set theme .build() signInLauncher.launch(signInIntent)
Java
Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setLogo(R.drawable.my_great_logo) // Set logo drawable .setTheme(R.style.MySuperAppTheme) // Set theme .build(); signInLauncher.launch(signInIntent);
您也可以設定自訂隱私權政策和服務條款:
Kotlin+KTX
val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setTosAndPrivacyPolicyUrls( "https://example.com/terms.html", "https://example.com/privacy.html", ) .build() signInLauncher.launch(signInIntent)
Java
Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setTosAndPrivacyPolicyUrls( "https://example.com/terms.html", "https://example.com/privacy.html") .build(); signInLauncher.launch(signInIntent);
下一步
- 有關使用和自訂 FirebaseUI 的更多信息,請參閱 GitHub 上的自述文件。
- 如果您在 FirebaseUI 中發現問題並想要回報該問題,請使用GitHub 問題追蹤器。