Menambahkan login secara mudah ke aplikasi Android dengan FirebaseUI

FirebaseUI adalah library yang di-build berdasarkan Firebase Authentication SDK yang menyediakan alur UI drop-in untuk digunakan di aplikasi Anda. FirebaseUI memberikan manfaat berikut:

Beragam Penyedia - alur login untuk email/sandi, link email, autentikasi dengan ponsel, Login dengan Google, Login dengan Facebook, Login dengan Twitter, dan Login dengan GitHub.
Pengelolaan Akun - alur untuk menangani tugas pengelolaan akun, seperti pembuatan akun dan reset sandi.
Penautan Akun - alur untuk menautkan akun pengguna secara aman lintas penyedia identitas.
Upgrade Pengguna Anonim - alur untuk mengupgrade pengguna anonim dengan aman.
Tema Kustom - menyesuaikan tampilan FirebaseUI agar sesuai dengan aplikasi. Selain itu, karena FirebaseUI adalah open source, Anda dapat menyalin project tersebut dan menyesuaikannya dengan kebutuhan.
Smart Lock untuk Sandi - integrasi otomatis dengan Smart Lock untuk Sandi untuk login lintas perangkat dengan cepat.

Sebelum memulai

Tambahkan Firebase ke project Android jika Anda belum melakukannya.

Tambahkan dependensi untuk FirebaseUI ke file build.gradle level aplikasi Anda. Jika Anda ingin mendukung login dengan Facebook atau Twitter, sertakan juga Facebook SDK dan 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 memiliki dependensi transitif pada Firebase SDK dan SDK layanan Google Play.

Di Firebase console, buka bagian Authentication, lalu aktifkan metode login yang ingin Anda dukung. Beberapa metode login memerlukan informasi tambahan yang biasanya tersedia di konsol developer layanan.
Jika Anda mengaktifkan Login dengan Google:
1. Saat diminta di konsol, download file konfigurasi Firebase yang telah diupdate (google-services.json), yang sekarang berisi informasi klien OAuth yang diperlukan untuk login dengan Google.
2. Pindahkan file konfigurasi yang diupdate ini ke project Android Studio, dengan mengganti file konfigurasi terkait yang sudah usang. (Lihat Menambahkan Firebase ke project Android.)
3. Jika Anda belum menentukan sidik jari SHA aplikasi, lakukanlah dari halaman Settings di Firebase console. Baca bagian Mengautentikasi Klien untuk mengetahui detail tentang cara mendapatkan sidik jari SHA aplikasi.

Jika Anda mendukung login dengan Facebook atau Twitter, tambahkan resource string ke strings.xml yang menentukan informasi pengenal yang diperlukan oleh setiap penyedia:


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

Login

Buat ActivityResultLauncher yang mendaftarkan callback untuk kontrak hasil Aktivitas FirebaseUI:

Kotlin+KTX

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

Java

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

Untuk memulai alur login FirebaseUI, buat intent login dengan metode login yang Anda pilih:

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

Ketika alur login selesai, Anda akan menerima hasilnya dalam 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

Menyiapkan metode login

Autentikasi link email

Di Firebase console, buka bagian Authentication. Di tab Sign in method, aktifkan penyedia Email/Password. Perlu diketahui bahwa login dengan email/sandi harus diaktifkan untuk menggunakan metode login dengan link email.
Di bagian yang sama, aktifkan metode login dengan Email link (passwordless sign-in), lalu klik Save.
Anda juga harus mengaktifkan Firebase Dynamic Links untuk menggunakan metode login dengan link email. Di Firebase console, klik Dynamic Links di bagian Engage di menu navigasi. Klik Getting started, lalu tambahkan domain. Domain yang Anda pilih di sini akan tercermin dalam link email yang dikirim kepada pengguna.

Anda dapat mengaktifkan login dengan link email di FirebaseUI dengan memanggil enableEmailLinkSignIn pada instance EmailBuilder. Anda juga perlu memberikan objek ActionCodeSettings yang valid dengan menyetel setHandleCodeInApp ke true. Selain itu, Anda perlu memberi akses pada URL yang diteruskan ke setUrl, yang dapat dilakukan di Firebase console, di bagian 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

Jika ingin mendapatkan link dalam aktivitas tertentu, ikuti langkah-langkah yang diuraikan di sini. Jika tidak, link akan dialihkan ke aktivitas peluncur Anda.

Setelah mendapatkan deep link, Anda perlu menghubungi kami untuk memastikan apakah kami dapat menanganinya. Jika kami bisa, Anda bisa meneruskannya kepada kami melalui 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

Opsional Metode login dengan link email lintas perangkat didukung. Artinya, link yang dikirim melalui aplikasi Android dapat digunakan untuk login di aplikasi web atau aplikasi Apple. Secara default, dukungan lintas perangkat diaktifkan. Anda dapat menonaktifkannya dengan memanggil setForceSameDevice pada instance EmailBuilder.

Baca FirebaseUI-Web dan FirebaseUI-iOS untuk mengetahui informasi lebih lanjut.

Logout

FirebaseUI menyediakan cara mudah untuk logout dari Firebase Authentication dan semua penyedia identitas sosial:

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

Anda juga dapat menghapus akun pengguna sepenuhnya:

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

Penyesuaian

Secara default, FirebaseUI menggunakan AppCompat untuk penentuan tema, yang berarti FirebaseUI akan secara alami menggunakan skema warna aplikasi Anda. Jika memerlukan penyesuaian lebih lanjut, Anda dapat meneruskan tema dan logo ke builder Intent login:

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

Anda juga dapat menetapkan kebijakan privasi dan persyaratan layanan khusus:

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

Langkah Berikutnya

Untuk mengetahui informasi lebih lanjut mengenai penggunaan dan penyesuaian FirebaseUI, baca file README di GitHub.
Jika Anda menemukan masalah di FirebaseUI dan ingin melaporkannya, gunakan Issue Tracker GitHub.