FirebaseUI是一個構建在 Firebase Authentication SDK 之上的庫,它提供了在您的應用中使用的嵌入式 UI 流程。 FirebaseUI 提供以下優勢:
- 多個提供商- 電子郵件/密碼、電子郵件鏈接、電話身份驗證、Google 登錄、Facebook 登錄、Twitter 登錄和 GitHub 登錄的登錄流程。
- 賬戶管理- 處理賬戶管理任務的流程,例如賬戶創建和密碼重置。
- 帳戶鏈接- 跨身份提供者安全鏈接用戶帳戶的流程。
- 匿名用戶升級- 安全升級匿名用戶的流程。
- 自定義主題- 自定義 FirebaseUI 的外觀以匹配您的應用。此外,由於 FirebaseUI 是開源的,您可以分叉該項目並完全根據您的需要對其進行自定義。
- Smart Lock for Passwords - 與Smart Lock for Passwords自動集成以實現快速跨設備登錄。
在你開始之前
如果您還沒有,請將 Firebase 添加到您的 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 in Methods -> Authorized domains 下完成。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 上的README文件。
- 如果您在 FirebaseUI 中發現問題並想報告它,請使用GitHub 問題跟踪器。