此页面由 Cloud Translation API 翻译。

使用 FirebaseUI 轻松将登录添加到您的 Android 应用

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 登录并且尚未指定应用的 SHA-1 指纹，请从 Firebase 控制台的“设置”页面执行此操作。有关如何获取应用的 SHA-1 指纹的详细信息，请参阅验证您的客户端。

如果您支持使用 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>

// 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

要启动 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)FirebaseUIActivity.kt

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

登录流程完成后，您将在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.
        // ...
    }
}FirebaseUIActivity.kt

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

设置登录方法

电子邮件链接认证

在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)FirebaseUIActivity.kt

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

如果您想在特定活动中获取链接，请按照此处列出的步骤操作。否则，该链接将重定向到您的启动器活动。

一旦捕获到深层链接，您需要致电验证我们是否可以为您处理。如果可以，您需要通过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)
    }
}FirebaseUIActivity.kt

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

支持可选的跨设备电子邮件链接登录，这意味着通过您的 Android 应用程序发送的链接可用于登录您的 Web 或 Apple 应用程序。默认情况下，启用跨设备支持。您可以通过在EmailBuilder实例上调用setForceSameDevice来禁用它。
有关详细信息，请参阅FirebaseUI-Web和FirebaseUI-iOS 。

登出

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

Kotlin+KTX

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

Java

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

您也可以完全删除用户的帐户：

Kotlin+KTX

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

Java

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

客制化

默认情况下，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)FirebaseUIActivity.kt

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

您还可以设置自定义隐私政策和服务条款：

Kotlin+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

Java

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

下一步

有关使用和自定义 FirebaseUI 的更多信息，请参阅 GitHub 上的README文件。
如果您在 FirebaseUI 中发现问题并想报告它，请使用GitHub 问题跟踪器。

使用 FirebaseUI 轻松将登录添加到您的 Android 应用

在你开始之前

登入

Kotlin+KTX

Java

Kotlin+KTX

Java

Kotlin+KTX

Java

设置登录方法

电子邮件链接认证

Kotlin+KTX

Java

Kotlin+KTX

Java

登出

Kotlin+KTX

Java

Kotlin+KTX

Java

客制化

Kotlin+KTX

Java

Kotlin+KTX

Java

下一步