المصادقة مع 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:34.13.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:24.1.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-1 لتطبيقك إذا لم يسبق لك إجراء ذلك.

   1. في وحدة تحكّم Firebase، انتقِل إلى علامة التبويب settings الإعدادات > الإعدادات العامة.

   2. انتقِل للأسفل إلى بطاقة تطبيقاتك ، واختَر تطبيق Android، وأضِف الملف المرجعي SHA-1 في حقل الملفات المرجعية لشهادة SHA.

   يمكنك الاطّلاع على المصادقة على العميل للحصول على تفاصيل حول كيفية الحصول على الملف المرجعي SHA لتطبيقك.

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

5. عدِّل ملف إعداد Firebase.

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

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

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

1. يمكنك دمج ميزة "تسجيل الدخول باستخدام حساب Google" في تطبيقك باتّباع الخطوات الواردة في مستندات Credential Manager. في ما يلي التعليمات العامة:
   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()
      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 باستخدام بيانات اعتماد 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. عليك أيضًا محو حالة بيانات اعتماد المستخدم الحالية من جميع مزوّدي بيانات الاعتماد، كما هو مقترَح في مستندات "إدارة بيانات الاعتماد":

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

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