本頁面由 Cloud Translation API 翻譯而成。

使用 FirebaseUI 輕鬆將登入程序新增至 Android 應用程式

FirebaseUI 是以 Firebase 驗證 SDK 為基礎建構的程式庫，可為應用程式提供內建的 UI 流程。FirebaseUI 具有下列優點：

多重供應商 - 電子郵件/密碼、電子郵件連結、電話驗證、Google 登入、Facebook 登入、Twitter 登入和 GitHub 登入的登入流程。
帳戶管理 - 處理帳戶管理工作的流程，例如帳戶建立和密碼重設。
帳戶連結：在識別資訊提供者之間安全地連結使用者帳戶的流程。
匿名使用者升級：此流程可安全升級匿名使用者。
自訂主題 - 自訂 FirebaseUI 的外觀，使其與應用程式相符。此外，由於 FirebaseUI 是開放原始碼，您可以依據自身需求建立專案分支，並依據自身需求自訂專案。
密碼專用 Smart Lock：自動整合密碼專用 Smart Lock，即可快速跨裝置登入。

事前準備

如果您尚未將 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 驗證 SDK 具有 Firebase SDK 和 Google Play 服務 SDK 的遞移依附元件。

在 Firebase 控制台開啟「Authentication」區段，並啟用您要支援的登入方式。某些登入方法需要額外資訊，通常可在服務的開發人員控制台中找到。
如果您已經啟用 Google 登入功能：
1. 當控制台中出現提示時，請下載更新後的 Firebase 設定檔 (google-services.json)，其中包含 Google 登入所需的 OAuth 用戶端資訊。
2. 將此更新過的設定檔移至您的 Android Studio 專案，並取代現已過時的對應設定檔。(請參閱「將 Firebase 新增至 Android 專案」一節)。
3. 如果您尚未指定應用程式的 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>

// 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 控制台，開啟「驗證」部分。在「Sign in method」分頁中，啟用「Email/Password」提供者。請注意，您必須啟用電子郵件/密碼登入才能使用電子郵件連結登入。
在同一部分中，啟用「電子郵件連結 (無密碼登入)」登入方法，然後按一下「儲存」。
您必須啟用 Firebase Dynamic Links，才能使用電子郵件連結登入。在 Firebase 控制台中，按一下導覽列的「Engage」下方的「Dynamic Links」。按一下「Getting started」新增網域。您在這裡選擇的網域會反映在傳送給使用者的電子郵件連結中。

您可以在 EmailBuilder 執行個體上呼叫 enableEmailLinkSignIn，以啟用 FirebaseUI 電子郵件連結登入功能。您還必須提供有效的 ActionCodeSettings 物件，並將 setHandleCodeInApp 設為 true。此外，您也必須將傳遞到 setUrl 的網址加入許可清單。您可以在 Firebase 控制台的「Authentication」->「Sign in Methods」->「Authorized domain」(授權網域) 底下完成。

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 應用程式傳送的連結可用來登入網路或 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 Issue Tracker。