转到控制台

使用 FirebaseUI 轻松向 Android 应用添加登录机制

FirebaseUI 是以 Firebase Authentication SDK 为基础构建的库,提供适合在您应用中使用的普适性界面流程。FirebaseUI 具有以下优势:

  • 多提供方 - 用于电子邮件地址/密码身份验证、电子邮件链接身份验证、电话身份验证、Google 登录机制、Facebook 登录机制、Twitter 登录机制和 GitHub 登录机制的登录流程。
  • 帐号管理 - 用于处理帐号管理任务(如帐号创建和密码重置)的流程。
  • 帐号关联 - 用于将各种身份提供方安全地关联到用户帐号的流程。
  • 匿名用户升级 - 用于安全升级匿名用户的流程。
  • 自定义主题背景 - 自定义 FirebaseUI 的外观以便与您的应用相匹配。另外,FirebaseUI 是开源的,因此您可以克隆 (fork) 项目并对其进行自定义,使之完全符合您的需求。
  • Smart Lock(密码专用)- 与 Smart Lock(密码专用)自动集成,因而能够实现快速跨设备登录。

准备工作

  1. 将 Firebase 添加到您的 Android 项目(如果尚未添加)。

  2. 请务必在您的项目级 build.gradle 文件中的 buildscriptallprojects 部分添加 Google 的 Maven 代码库。

  3. 将 FirebaseUI 的依赖项添加到您的应用级 build.gradle 文件。如果您想支持使用 Facebook 或 Twitter 帐号进行登录,还需要添加 Facebook SDK 和 Twitter SDK:

    dependencies {
        // ...
    
        implementation 'com.firebaseui:firebase-ui-auth:4.3.1'
    
        // 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:4.x'
    
        // Required only if Twitter login support is required
        // Find the latest Twitter SDK releases here: https://goo.gl/E5wZvQ
        implementation 'com.twitter.sdk.android:twitter-core:3.x'
    }
    

    FirebaseUI Auth SDK 需要使用 Firebase SDK 和 Google Play 服务 SDK 提供的传递依赖项。

  4. Firebase 控制台中,打开身份验证部分并启用您希望支持的登录方法。有些登录方法需要额外的信息,这些信息通常可在相应服务的开发者控制台中找到。

  5. 如果您支持 Google 登录机制但尚未指定应用的 SHA-1 指纹,请在 Firebase 控制台的设置页面中进行此操作。如需详细了解如何获取您的应用的 SHA-1 指纹,请参阅对客户端进行身份验证

  6. 如果您支持使用 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>
      <!-- Twitter consumer key and secret -->
      <string name="twitter_consumer_key" translatable="false">YOUR_CONSUMER_KEY</string>
      <string name="twitter_consumer_secret" translatable="false">YOUR_CONSUMER_SECRET</string>
    </resources>
    

登录

要启动 FirebaseUI 登录流程,请使用您偏好的登录方法创建登录 Intent:

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
startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .build(),
        RC_SIGN_IN);

Kotlin

// 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
startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .build(),
        RC_SIGN_IN)

登录流程完成后,您会在 onActivityResult 中收到结果:

Java

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);

    if (requestCode == RC_SIGN_IN) {
        IdpResponse response = IdpResponse.fromResultIntent(data);

        if (resultCode == 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.
            // ...
        }
    }
}

Kotlin

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)

    if (requestCode == RC_SIGN_IN) {
        val response = IdpResponse.fromResultIntent(data)

        if (resultCode == Activity.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.
            // ...
        }
    }
}

设置登录方法

  1. Firebase 控制台中,打开身份验证部分。在登录方法标签中,启用电子邮件地址/密码提供方。请注意,必须启用电子邮件/密码登录才能使用电子邮件链接登录。

  2. 在同一部分中,启用电子邮件链接(无密码登录)登录方法,然后点击保存

  3. 您还必须启用 Firebase 动态链接才能使用电子邮件链接登录。在 Firebase 控制台的导航栏中,点击发展下的动态链接。点击开始使用,并添加一个网域。您在此处选择的网域将反映在发送给用户的电子邮件链接中。

  4. 您可以在 EmailBuilder 实例上调用 enableEmailLinkSignIn,从而在 FirebaseUI 中启用电子邮件链接登录。您还需要提供一个有效的 ActionCodeSettings 对象,并将 setHandleCodeInApp 设置为 true。此外,您需要将传递给 setUrl 的网址列入白名单,此操作可通过在 Firebase 控制台中依次点击“身份验证”->“登录方法”->“已获授权的网域”来完成。

    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();
    
    startActivityForResult(
            AuthUI.getInstance()
                    .createSignInIntentBuilder()
                    .setAvailableProviders(Arrays.asList(
                            new AuthUI.IdpConfig.EmailBuilder().enableEmailLinkSignIn()
                            .setActionCodeSettings(actionCodeSettings).build())
                    .build(),
            RC_SIGN_IN);
    
    
  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) {
                startActivityForResult(
                        AuthUI.getInstance()
                                .createSignInIntentBuilder()
                                .setEmailLink(link)
                                .setAvailableProviders(getAvailableProviders())
                                .build(),
                        RC_SIGN_IN);
            }
    }
    
  7. 可选 支持跨设备电子邮件链接登录,这意味着通过 Android 应用发送的链接可用来在您的 Web 或 iOS 应用上登录。默认情况下,跨设备支持功能是启用的。您可以在 EmailBuilder 实例上调用 setForceSameDevice,以停用此功能。

    如需了解详情,请参阅 FirebaseUI-WebFirebaseUI-iOS

退出登录

FirebaseUI 提供了方便的方法来让用户退出 Firebase 身份验证以及所有社交身份提供方帐号:

Java

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

Kotlin

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

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

Java

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

Kotlin

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

自定义

默认情况下,FirebaseUI 使用 AppCompat 设置主题背景,这意味着它会自动采用应用的配色方案。如要进一步自定义,您可以将主题背景和徽标传递给登录 Intent 构建器:

Java

startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .setLogo(R.drawable.my_great_logo)      // Set logo drawable
                .setTheme(R.style.MySuperAppTheme)      // Set theme
                .build(),
        RC_SIGN_IN);

Kotlin

startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .setLogo(R.drawable.my_great_logo) // Set logo drawable
                .setTheme(R.style.MySuperAppTheme) // Set theme
                .build(),
        RC_SIGN_IN)

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

Java

startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .setTosAndPrivacyPolicyUrls(
                        "https://example.com/terms.html",
                        "https://example.com/privacy.html")
                .build(),
        RC_SIGN_IN);

Kotlin

startActivityForResult(
        AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setAvailableProviders(providers)
                .setTosAndPrivacyPolicyUrls(
                        "https://example.com/terms.html",
                        "https://example.com/privacy.html")
                .build(),
        RC_SIGN_IN)

后续步骤

  • 如需详细了解如何使用和自定义 FirebaseUI,请参阅 GitHub 上的 README 文件。
  • 如果您发现 FirebaseUI 中存在问题并想报告,请使用 GitHub 问题跟踪工具