Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

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

FirebaseUI 是以 Firebase 驗證 SDK 為基礎建構的程式庫，提供可直接使用的 UI 流程，方便您在應用程式中使用。FirebaseUI 具有下列優點：

多個供應商 - 支援電子郵件/密碼、電子郵件連結、電話驗證、Google 登入、Facebook 登入、Twitter 登入和 GitHub 登入的登入流程。
帳戶管理：處理帳戶管理工作的流程，例如建立帳戶和重設密碼。
帳戶連結：安全地連結不同身分識別供應商的使用者帳戶。
匿名使用者升級 - 安全升級匿名使用者的流程。
自訂主題 - 自訂 FirebaseUI 的外觀，與應用程式風格一致。此外，由於 FirebaseUI 是開放原始碼，您可以將專案分叉，並完全根據需求自訂。
Credential Manager - 自動整合Credential Manager，方便使用者在不同裝置上快速登入。

事前準備

如果您尚未將 Firebase 新增至 Android 專案，請先新增。

將 FirebaseUI 的依附元件加入應用程式層級的 build.gradle(.kts) 檔案。如要支援使用 Facebook 或 Twitter 登入，請一併加入 Facebook 和 Twitter SDK：

    dependencies {
        // ...

        implementation("com.firebaseui:firebase-ui-auth:9.0.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 控制台中，依序前往「安全性」 >「驗證」。
在「Sign-in method」(登入方式) 分頁中，啟用要支援的登入供應商。部分登入供應商會要求提供額外資訊，通常可在服務的開發人員控制台中取得。
如果您已啟用 Google 登入功能：
1. 更新 Firebase 設定檔。
  1. 在 Firebase 控制台中收到提示時，請下載更新後的 Firebase 設定檔 (google-services.json)，其中現在包含 Google 登入所需的 OAuth 用戶端資訊。
  2. 將這個更新後的設定檔移至 Android Studio 專案，取代現在已過時的對應設定檔。(請參閱「將 Firebase 新增至 Android 專案」一文)。
2. 指定應用程式的 SHA-1 指紋 (如果尚未指定)。
  1. 在 Firebase 控制台中，依序前往「設定」 >「一般」分頁。
  2. 向下捲動至「您的應用程式」資訊卡，選取 Android 應用程式，然後在「SHA 憑證指紋」欄位中新增 SHA-1 指紋。
  如要瞭解如何取得應用程式的 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

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

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 Dynamic Links：
1. 在 Firebase 控制台中，依序前往「DevOps & Engagement」(DevOps 與參與度) >「Dynamic Links」(動態連結)。
2. 按一下「開始使用」，然後新增網域。您在此選擇的網域會顯示在傳送給使用者的電子郵件連結中。

如要在 FirebaseUI 中啟用電子郵件連結登入功能，請在 EmailBuilder 執行個體上呼叫 enableEmailLinkSignIn。您也需要提供有效的 ActionCodeSettings 物件，並將 setHandleCodeInApp 設為 true。

此外，您還需要將傳遞至 setUrl 的網址加入許可清單：

在 Firebase 控制台中，依序前往「Security」(安全性) >「Authentication」(驗證) >「Settings」(設定) 分頁。
在「Authorized domains」(已授權網域) 區段，按一下「Add domain」(新增網域)，並新增您的網域。

Kotlin

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

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

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

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

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

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。

透過 FirebaseUI 輕鬆將登入程序新增至 Android 應用程式 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

事前準備

登入

Kotlin

Java

Kotlin

Java

Kotlin

Java

設定登入方式

透過電子郵件連結驗證

Kotlin

Java

Kotlin

Java

登出

Kotlin

Java

Kotlin

Java

自訂

Kotlin

Java

Kotlin

Java

後續步驟

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