使用 FirebaseUI 輕鬆將登錄添加到您的 Android 應用

FirebaseUI是建立在火力地堡認證SDK的頂庫，提供了您的應用程序使用插入式UI流。 FirebaseUI 具有以下優勢：

  • 多個供應商-登錄電子郵件/密碼，電子郵件中的鏈接，電話驗證流程，谷歌帳戶登錄，Facebook的登錄，Twitter的登錄和GitHub上登錄。
  • 帳戶管理-流處理帳戶管理任務，如賬戶創建和密碼重置。
  • 帳戶鏈接-流向安全鏈路的用戶跨越身份提供者帳戶。
  • 匿名用戶升級-流向安全升級匿名用戶。
  • 自定義主題-定制FirebaseUI的外觀，以符合您的應用程序。此外，由於 FirebaseUI 是開源的，您可以分叉該項目並完全根據您的需要對其進行自定義。
  • 智能鎖的密碼-自動集成的Smart Lock密碼快速跨設備登錄。

在你開始之前

  1. 如果你還沒有，添加火力地堡到您的Android項目。

  2. 對於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 具有傳遞依賴關係。

  3. 在火力地堡控制台，打開驗證部分，並啟用登錄你想支持的方法。某些登錄方法需要其他信息，通常可在服務的開發人員控制台中找到。

  4. 如果支持谷歌登錄和尚未指定應用的SHA-1指紋，從這樣做設置頁面的火力地堡控制台。請參閱驗證您的客戶，了解如何讓你的應用程序的SHA-1指紋細節。

  5. 如果你支持登錄與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活動結果合同的回調：

爪哇

// 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);
            }
        }
);
FirebaseUIActivity.java

科特林+KTX

// See: https://developer.android.com/training/basics/intents/result
private val signInLauncher = registerForActivityResult(
        FirebaseAuthUIActivityResultContract()
) { res ->
    this.onSignInResult(res)
}
FirebaseUIActivity.kt

要啟動 FirebaseUI 登錄流程，請使用您首選的登錄方法創建登錄意圖：

爪哇

// 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);
FirebaseUIActivity.java

科特林+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)
FirebaseUIActivity.kt

當登錄流程完成後，您會收到結果onSignInResult ：

爪哇

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.
        // ...
    }
}
FirebaseUIActivity.java

科特林+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.
        // ...
    }
}
FirebaseUIActivity.kt

設置登錄方法

  1. 在火力地堡控制台，打開驗證部分。在登錄方法選項卡，選中電子郵件/密碼提供商。請注意，必須啟用電子郵件/密碼登錄才能使用電子郵件鏈接登錄。

  2. 在同一節，使電子郵件的鏈接（無密碼登錄）登錄方法，然後單擊保存。

  3. 您還必須啟用火力地堡動態鏈接在使用電子郵件鏈接的標誌。在火力地堡控制台，點擊動態鏈接下的導航條嚙合。點擊入門和添加域。您在此處選擇的域將反映在發送給您的用戶的電子郵件鏈接中。

  4. 您可以通過調用允許在FirebaseUI電子郵件中的鏈接符號enableEmailLinkSignIn上EmailBuilder實例。您還需要提供一個有效的ActionCodeSettings與對象setHandleCodeInApp設置為true。此外，您還需要白名單，你傳遞給URL setUrl ，可在完成火力地堡控制台，驗證下- >登錄方法- >授權域。

    爪哇

    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);
    FirebaseUIActivity.java

    科特林+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)
    FirebaseUIActivity.kt

  5. 如果你想趕上在特定的活動鏈接，請按照列出的步驟這裡。否則，該鏈接將重定向到您的啟動器活動。

  6. 捕獲深層鏈接後，您需要致電驗證我們是否可以為您處理。如果能，你需要然後通過它傳遞給我們setEmailLink 。

    爪哇

    if (AuthUI.canHandleIntent(getIntent())) {
    if (getIntent().getExtras() == null) {
        return;
    }
    String link = getIntent().getExtras().getString(ExtraConstants.EMAIL_LINK_SIGN_IN);
    if (link != null) {
        Intent signInIntent = AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setEmailLink(link)
                .setAvailableProviders(providers)
                .build();
        signInLauncher.launch(signInIntent);
    }
}
    FirebaseUIActivity.java

    科特林+KTX

    if (AuthUI.canHandleIntent(intent)) {
    val extras = intent.extras ?: return
    val link = extras.getString(ExtraConstants.EMAIL_LINK_SIGN_IN)
    if (link != null) {
        val signInIntent = AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setEmailLink(link)
                .setAvailableProviders(providers)
                .build()
        signInLauncher.launch(signInIntent)
    }
}
    FirebaseUIActivity.kt

  7. 可選跨設備的電子郵件鏈接登錄支持，這意味著通過鏈接Android應用發送可用於登錄您的網站或應用程式的蘋果上。默認情況下，啟用跨設備支持。你可以通過調用禁用它setForceSameDevice在EmailBuilder實例。

    見FirebaseUI的Web和FirebaseUI-IOS了解更多信息。

登出

FirebaseUI 提供了退出 Firebase 身份驗證以及所有社交身份提供商的便捷方法：

爪哇

AuthUI.getInstance()
        .signOut(this)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            public void onComplete(@NonNull Task<Void> task) {
                // ...
            }
        });
FirebaseUIActivity.java

科特林+KTX

AuthUI.getInstance()
        .signOut(this)
        .addOnCompleteListener {
            // ...
        }
FirebaseUIActivity.kt

您還可以完全刪除用戶的帳戶：

爪哇

AuthUI.getInstance()
        .delete(this)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // ...
            }
        });
FirebaseUIActivity.java

科特林+KTX

AuthUI.getInstance()
        .delete(this)
        .addOnCompleteListener {
            // ...
        }
FirebaseUIActivity.kt

定制

默認情況下，FirebaseUI 使用 AppCompat 進行主題化，這意味著它會自然地採用您應用的配色方案。如果您需要進一步的自定義，你可以傳遞一個主題和標識的登錄Intent建設者：

爪哇

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);
FirebaseUIActivity.java

科特林+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)
FirebaseUIActivity.kt

您還可以設置自定義隱私政策和服務條款：

爪哇

Intent signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .setTosAndPrivacyPolicyUrls(
                "https://example.com/terms.html",
                "https://example.com/privacy.html")
        .build();
signInLauncher.launch(signInIntent);
FirebaseUIActivity.java

科特林+KTX

val signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .setTosAndPrivacyPolicyUrls(
                "https://example.com/terms.html",
                "https://example.com/privacy.html")
        .build()
signInLauncher.launch(signInIntent)
FirebaseUIActivity.kt

下一步

  • 有關使用和定制FirebaseUI的更多信息，請參閱README GitHub上的文件。
  • 如果您發現FirebaseUI的問題，並希望報告它，使用GitHub的問題跟踪。