Аутентификация с помощью Google на Android

Вы можете разрешить своим пользователям проходить аутентификацию в Firebase, используя их учетные записи Google.

Прежде чем начать

  1. Если вы еще этого не сделали, добавьте Firebase в свой проект Android .

  2. В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте зависимость для библиотеки Firebase Authentication для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.

    Кроме того, в рамках настройки Firebase Authentication вам необходимо добавить SDK Credential Manager в ваше приложение.

    dependencies {     // Import the BoM for the Firebase platform     implementation(platform("com.google.firebase:firebase-bom:33.12.0"))      // Add the dependency for the Firebase Authentication library     // When using the BoM, you don't specify versions in Firebase library dependencies     implementation("com.google.firebase:firebase-auth")
    // Also add the dependencies for the Credential Manager libraries and specify their versions implementation("androidx.credentials:credentials:1.3.0") implementation("androidx.credentials:credentials-play-services-auth:1.3.0") implementation("com.google.android.libraries.identity.googleid:googleid:1.1.1")
    }

    Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.

    (Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM

    Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.

    Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.

    dependencies {     // Add the dependency for the Firebase Authentication library     // When NOT using the BoM, you must specify versions in Firebase library dependencies     implementation("com.google.firebase:firebase-auth:23.2.0")
    // Also add the dependencies for the Credential Manager libraries and specify their versions implementation("androidx.credentials:credentials:1.3.0") implementation("androidx.credentials:credentials-play-services-auth:1.3.0") implementation("com.google.android.libraries.identity.googleid:googleid:1.1.1")
    }
    Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).
  3. Если вы еще не указали отпечаток SHA своего приложения, сделайте это на странице настроек консоли Firebase . Подробную информацию о том, как получить отпечаток SHA вашего приложения, см. в разделе Аутентификация вашего клиента .

  4. Включите Google в качестве метода входа в консоли Firebase :
    1. В консоли Firebase откройте раздел Auth .
    2. На вкладке «Метод входа» включите метод входа Google и нажмите «Сохранить» .
  5. При появлении запроса в консоли загрузите обновленный файл конфигурации Firebase ( google-services.json ), который теперь содержит информацию клиента OAuth, необходимую для входа в Google.

  6. Переместите этот обновленный файл конфигурации в свой проект Android Studio, заменив устаревший соответствующий файл конфигурации. (См. раздел «Добавление Firebase в проект Android ».)

Аутентификация с помощью Firebase

  1. Интегрируйте функцию «Вход с помощью Google» в свое приложение, выполнив действия, описанные в документации по диспетчеру учетных данных . Вот инструкции высокого уровня:
    1. Создайте экземпляр запроса на вход в Google, используя GetGoogleIdOption . Затем создайте запрос диспетчера учетных данных с помощью GetCredentialRequest :

      Kotlin

      // Instantiate a Google sign-in request val googleIdOption = GetGoogleIdOption.Builder()     // Your server's client ID, not your Android client ID.     .setServerClientId(getString(R.string.default_web_client_id))     // Only show accounts previously used to sign in.     .setFilterByAuthorizedAccounts(true)     .build()  // Create the Credential Manager request val request = GetCredentialRequest.Builder()     .addCredentialOption(googleIdOption)     .build()

      Java

      // Instantiate a Google sign-in request GetGoogleIdOption googleIdOption = new GetGoogleIdOption.Builder()         .setFilterByAuthorizedAccounts(true)         .setServerClientId(getString(R.string.default_web_client_id))         .build();  // Create the Credential Manager request GetCredentialRequest request = new GetCredentialRequest.Builder()         .addCredentialOption(googleIdOption)         .build();

      В приведенном выше запросе вы должны передать идентификатор своего «серверного» клиента методу setServerClientId . Чтобы найти идентификатор клиента OAuth 2.0:

      1. Откройте страницу «Учетные данные» в консоли Google Cloud .
      2. Идентификатор клиента типа веб-приложения — это идентификатор клиента OAuth 2.0 вашего внутреннего сервера.
    2. Убедитесь, что после интеграции входа с Google ваша активность входа имеет код, аналогичный следующему:

      Kotlin

      private fun handleSignIn(credential: Credential) {     // Check if credential is of type Google ID     if (credential is CustomCredential && credential.type == TYPE_GOOGLE_ID_TOKEN_CREDENTIAL) {         // Create Google ID Token         val googleIdTokenCredential = GoogleIdTokenCredential.createFrom(credential.data)          // Sign in to Firebase with using the token         firebaseAuthWithGoogle(googleIdTokenCredential.idToken)     } else {         Log.w(TAG, "Credential is not of type Google ID!")     } }

      Java

      private void handleSignIn(Credential credential) {     // Check if credential is of type Google ID     if (credential instanceof CustomCredential customCredential             && credential.getType().equals(TYPE_GOOGLE_ID_TOKEN_CREDENTIAL)) {         // Create Google ID Token         Bundle credentialData = customCredential.getData();         GoogleIdTokenCredential googleIdTokenCredential = GoogleIdTokenCredential.createFrom(credentialData);          // Sign in to Firebase with using the token         firebaseAuthWithGoogle(googleIdTokenCredential.getIdToken());     } else {         Log.w(TAG, "Credential is not of type Google ID!");     } }
  2. В методе onCreate вашего действия входа в систему получите общий экземпляр объекта FirebaseAuth :

    Kotlin

    private lateinit var auth: FirebaseAuth // ... // Initialize Firebase Auth auth = Firebase.auth

    Java

    private FirebaseAuth mAuth; // ... // Initialize Firebase Auth mAuth = FirebaseAuth.getInstance();
  3. При инициализации вашей активности проверьте, вошел ли пользователь в систему:

    Kotlin

    override fun onStart() {     super.onStart()     // Check if user is signed in (non-null) and update UI accordingly.     val currentUser = auth.currentUser     updateUI(currentUser) }

    Java

    @Override public void onStart() {     super.onStart();     // Check if user is signed in (non-null) and update UI accordingly.     FirebaseUser currentUser = mAuth.getCurrentUser();     updateUI(currentUser); }
  4. Теперь получите токен Google ID пользователя, созданный на шаге 1, замените его на учетные данные Firebase и выполните аутентификацию в Firebase, используя учетные данные Firebase:

    Kotlin

    private fun firebaseAuthWithGoogle(idToken: String) {     val credential = GoogleAuthProvider.getCredential(idToken, null)     auth.signInWithCredential(credential)         .addOnCompleteListener(this) { task ->             if (task.isSuccessful) {                 // Sign in success, update UI with the signed-in user's information                 Log.d(TAG, "signInWithCredential:success")                 val user = auth.currentUser                 updateUI(user)             } else {                 // If sign in fails, display a message to the user                 Log.w(TAG, "signInWithCredential:failure", task.exception)                 updateUI(null)             }         } }

    Java

    private void firebaseAuthWithGoogle(String idToken) {     AuthCredential credential = GoogleAuthProvider.getCredential(idToken, null);     mAuth.signInWithCredential(credential)             .addOnCompleteListener(this, task -> {                 if (task.isSuccessful()) {                     // Sign in success, update UI with the signed-in user's information                     Log.d(TAG, "signInWithCredential:success");                     FirebaseUser user = mAuth.getCurrentUser();                     updateUI(user);                 } else {                     // If sign in fails, display a message to the user                     Log.w(TAG, "signInWithCredential:failure", task.getException());                     updateUI(null);                 }             }); }
    Если вызов signInWithCredential завершится успешно, вы можете использовать метод getCurrentUser для получения данных учетной записи пользователя.

Следующие шаги

После того, как пользователь входит в систему в первый раз, создается новая учетная запись пользователя, которая связывается с учетными данными (то есть именем пользователя и паролем, номером телефона или информацией поставщика аутентификации), с которыми пользователь вошел в систему. Эта новая учетная запись хранится как часть вашего проекта Firebase и может использоваться для идентификации пользователя в каждом приложении вашего проекта, независимо от того, как пользователь входит в систему.

  • В ваших приложениях вы можете получить базовую информацию профиля пользователя из объекта FirebaseUser . См. Управление пользователями .

  • В правилах безопасности Firebase Realtime Database и Cloud Storage Firebase вы можете получить уникальный идентификатор пользователя, вошедшего в систему, из переменной auth и использовать его для управления тем, к каким данным пользователь может получить доступ.

Вы можете разрешить пользователям входить в ваше приложение с использованием нескольких поставщиков аутентификации, связав учетные данные поставщика аутентификации с существующей учетной записью пользователя.

Чтобы выйти из системы, вызовите signOut . Вам также необходимо очистить текущее состояние учетных данных пользователя у всех поставщиков учетных данных, как рекомендовано в документации Credential Manager :

Kotlin

private fun signOut() {     // Firebase sign out     auth.signOut()      // When a user signs out, clear the current user credential state from all credential providers.     lifecycleScope.launch {         try {             val clearRequest = ClearCredentialStateRequest()             credentialManager.clearCredentialState(clearRequest)             updateUI(null)         } catch (e: ClearCredentialException) {             Log.e(TAG, "Couldn't clear user credentials: ${e.localizedMessage}")         }     } }

Java

private void signOut() {     // Firebase sign out     mAuth.signOut();      // When a user signs out, clear the current user credential state from all credential providers.     ClearCredentialStateRequest clearRequest = new ClearCredentialStateRequest();     credentialManager.clearCredentialStateAsync(             clearRequest,             new CancellationSignal(),             Executors.newSingleThreadExecutor(),             new CredentialManagerCallback<>() {                 @Override                 public void onResult(@NonNull Void result) {                     updateUI(null);                 }                  @Override                 public void onError(@NonNull ClearCredentialException e) {                     Log.e(TAG, "Couldn't clear user credentials: " + e.getLocalizedMessage());                 }             }); }