المصادقة مع 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 للتحكّم في إصدارات المكتبة.

    بالإضافة إلى ذلك، عليك إضافة حزمة تطوير البرامج (SDK) الخاصة بخدمة Firebase Authentication إلى تطبيقك كجزء من عملية الإعداد.

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.0.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متعدّدة في تطبيقك، ننصحك بشدة باستخدام 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:24.0.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")    
}

  3. إذا لم تحدّد بعد بصمة SHA لتطبيقك، يمكنك إجراء ذلك من صفحة "الإعدادات" في وحدة تحكّم Firebase. راجِع مقالة مصادقة العميل للحصول على تفاصيل حول كيفية الحصول على بصمة SHA لتطبيقك.

  4. فعِّل Google كطريقة لتسجيل الدخول في وحدة تحكّم Firebase:
    1. في Firebase وحدة التحكّم، افتح قسم المصادقة.
    2. في علامة التبويب طريقة تسجيل الدخول، فعِّل طريقة تسجيل الدخول Google وانقر على حفظ.

  5. عندما يُطلب منك ذلك في وحدة التحكّم، نزِّل ملف إعداد Firebase المعدَّل (google-services.json)، الذي يتضمّن الآن معلومات عميل OAuth المطلوبة لتسجيل الدخول باستخدام حساب Google.

  6. انقل ملف الإعدادات المعدَّل هذا إلى مشروعك في "استوديو Android"، واستبدِل ملف الإعدادات المقابل الذي أصبح قديمًا. (راجِع مقالة إضافة Firebase إلى مشروع Android).

المصادقة باستخدام Firebase

  1. يمكنك دمج ميزة "تسجيل الدخول باستخدام حساب Google" في تطبيقك باتّباع الخطوات الواردة في مستندات Credential Manager. في ما يلي التعليمات العامة:
    1. إنشاء طلب تسجيل دخول باستخدام حساب Google باستخدام GetGoogleIdOption بعد ذلك، أنشئ طلب Credential Manager باستخدام 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()
      GoogleSignInActivity.kt

      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();
      GoogleSignInActivity.java

      في الطلب أعلاه، يجب تمرير معرّف العميل "للخادم" إلى الطريقة 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!")
    }
}
      GoogleSignInActivity.kt

      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!");
    }
}
      GoogleSignInActivity.java
  2. في طريقة onCreate الخاصة بنشاط تسجيل الدخول، احصل على مثيل FirebaseAuth المشترَك:

    Kotlin

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

    Java

    private FirebaseAuth mAuth;
// ...
// Initialize Firebase Auth
mAuth = FirebaseAuth.getInstance();
    GoogleSignInActivity.java
  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)
}
    GoogleSignInActivity.kt

    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);
}
    GoogleSignInActivity.java
  4. احصل الآن على رمز تعريف Google المميز للمستخدم الذي تم إنشاؤه في الخطوة 1، واستبدِله ببيانات اعتماد 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)
            }
        }
}
    GoogleSignInActivity.kt

    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);
                }
            });
}
    GoogleSignInActivity.java
    في حال نجاح طلب signInWithCredential، يمكنك استخدام طريقة getCurrentUser للحصول على بيانات حساب المستخدم.

الخطوات التالية

بعد أن يسجّل المستخدم الدخول لأول مرة، يتم إنشاء حساب مستخدم جديد وربطه ببيانات الاعتماد التي سجّل الدخول بها، أي اسم المستخدم وكلمة المرور أو رقم الهاتف أو معلومات مقدّم خدمة المصادقة. يتم تخزين هذا الحساب الجديد كجزء من مشروعك على Firebase، ويمكن استخدامه لتحديد هوية المستخدم على مستوى كل تطبيق في مشروعك، بغض النظر عن طريقة تسجيل الدخول.

  • في تطبيقاتك، يمكنك الحصول على معلومات الملف الشخصي الأساسية للمستخدم من عنصر FirebaseUser. راجِع إدارة المستخدمين.

  • في Firebase Realtime Database وCloud Storage قواعد الأمان، يمكنك الحصول على معرّف المستخدم الفريد للمستخدم الذي سجّل الدخول من المتغيّر 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}")
        }
    }
}
GoogleSignInActivity.kt

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());
                }
            });
}
GoogleSignInActivity.java