FirebaseUIは、アプリで使用するためのドロップイン UI フローを提供する Firebase Authentication SDK の上に構築されたライブラリです。 FirebaseUI には次の利点があります。
- 複数のプロバイダー- メール/パスワード、メール リンク、電話認証、Google サインイン、Facebook ログイン、Twitter ログイン、GitHub ログインのサインイン フロー。
- アカウント管理- アカウントの作成やパスワードのリセットなど、アカウント管理タスクを処理するフロー。
- アカウントのリンク- ID プロバイダー間でユーザー アカウントを安全にリンクするためのフロー。
- 匿名ユーザーのアップグレード- 匿名ユーザーを安全にアップグレードするためのフロー。
- カスタム テーマ- アプリに合わせて 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>
サインイン
FirebaseUI アクティビティ結果コントラクトのコールバックを登録するActivityResultLauncher
を作成します。
Kotlin+KTX
// See: https://developer.android.com/training/basics/intents/result private val signInLauncher = registerForActivityResult( FirebaseAuthUIActivityResultContract() ) { res -> this.onSignInResult(res) }
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); } } );
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)
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);
サインイン フローが完了すると、 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. // ... } }
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. // ... } }
サインイン方法を設定する
メールリンク認証
Firebase コンソールで、[認証]セクションを開きます。 [サインイン方法] タブで、電子メール/パスワードプロバイダーを有効にします。メール リンク サインインを使用するには、メール/パスワード サインインを有効にする必要があることに注意してください。
同じセクションで、[電子メール リンク (パスワードなしのサインイン) ] サインイン方法を有効にし、[保存] をクリックします。
また、メールリンク サインインを使用するには、Firebase Dynamic Links を有効にする必要があります。 Firebase コンソールで、ナビゲーション バーのEngageの下にあるDynamic Linksをクリックします。 [はじめに] をクリックして、ドメインを追加します。ここで選択したドメインは、ユーザーに送信される電子メール リンクに反映されます。
EmailBuilder
インスタンスでenableEmailLinkSignIn
を呼び出すことにより、FirebaseUI でメール リンクのサインインを有効にできます。また、setHandleCodeInApp
を true に設定して、有効なActionCodeSettings
オブジェクトを提供する必要があります。さらに、setUrl
に渡す URL をホワイトリストに登録する必要があります。これは、 Firebase コンソールの [認証] -> [サインイン方法] -> [承認済みドメイン] で実行できます。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)
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);
特定のアクティビティでリンクをキャッチしたい場合は、こちらで説明されている手順に従ってください。それ以外の場合、リンクはランチャー アクティビティにリダイレクトされます。
ディープリンクをキャッチしたら、verify を呼び出して、それを処理できるか確認する必要があります。可能であれば、
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) } }
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); } }
オプションのクロス デバイス メール リンク サインインがサポートされています。つまり、Android アプリ経由で送信されたリンクを使用して、Web または Apple アプリにログインできます。デフォルトでは、クロス デバイス サポートが有効になっています。これを無効にするには、
EmailBuilder
インスタンスでsetForceSameDevice
を呼び出します。詳細については、 FirebaseUI-WebとFirebaseUI-iOSを参照してください。
サインアウト
FirebaseUI には、Firebase Authentication およびすべてのソーシャル ID プロバイダーからサインアウトするための便利なメソッドが用意されています。
Kotlin+KTX
AuthUI.getInstance() .signOut(this) .addOnCompleteListener { // ... }
Java
AuthUI.getInstance() .signOut(this) .addOnCompleteListener(new OnCompleteListener<Void>() { public void onComplete(@NonNull Task<Void> task) { // ... } });
ユーザーのアカウントを完全に削除することもできます。
Kotlin+KTX
AuthUI.getInstance() .delete(this) .addOnCompleteListener { // ... }
Java
AuthUI.getInstance() .delete(this) .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // ... } });
カスタマイズ
デフォルトでは、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)
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);
カスタムのプライバシー ポリシーと利用規約を設定することもできます。
Kotlin+KTX
val signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setTosAndPrivacyPolicyUrls( "https://example.com/terms.html", "https://example.com/privacy.html") .build() signInLauncher.launch(signInIntent)
Java
Intent signInIntent = AuthUI.getInstance() .createSignInIntentBuilder() .setAvailableProviders(providers) .setTosAndPrivacyPolicyUrls( "https://example.com/terms.html", "https://example.com/privacy.html") .build(); signInLauncher.launch(signInIntent);
次のステップ
- FirebaseUI の使用とカスタマイズの詳細については、GitHub のREADMEファイルを参照してください。
- FirebaseUI で問題を見つけて報告したい場合は、 GitHub イシュー トラッカーを使用してください。