التعرّف على المعالم بأمان من خلال Cloud Vision باستخدام مصادقة Firebase ووظائفها على Android

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

إحدى طرق إنشاء واجهة برمجة تطبيقات REST هذه هي استخدام "مصادقة Firebase" و"وظائف Firebase"، ما يمنحك بوابة مُدارة وبدون خادم إلى Google Cloud APIs تتعامل مع المصادقة ويمكن استدعاؤها من تطبيقك للأجهزة الجوّالة باستخدام حِزم SDK المعدّة مسبقًا.

يوضّح هذا الدليل كيفية استخدام هذه التقنية لاستدعاء Cloud Vision API من تطبيقك. ستسمح هذه الطريقة لجميع المستخدمين الذين تمّت المصادقة عليهم بالوصول إلى الخدمات المدفوعة في Cloud Vision من خلال مشروعك على Google Cloud، لذا عليك تحديد ما إذا كانت آلية المصادقة هذه كافية لحالة الاستخدام قبل المتابعة.

قبل البدء

ضبط مشروعك

1. أضِف Firebase إلى مشروع Android الخاص بك، في حال لم يسبق لك إجراء ذلك، .

2. إذا لم يسبق لك تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية لمشروعك، يمكنك إجراء ذلك الآن:

   1. افتح صفحة Firebase ML APIs في Firebase Console.

   2. إذا لم يسبق لك ترقية مشروعك إلى خطة أسعار Blaze للدفع حسب الاستخدام، انقر على ترقية لإجراء ذلك. (لن يُطلب منك الترقية إلا إذا لم يكن مشروعك ضمن خطة أسعار Blaze).

      لا يمكن استخدام واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية إلا في المشاريع التي تستخدم خطة أسعار Blaze.

   3. إذا لم يسبق لك تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية، انقر على تفعيل واجهات برمجة التطبيقات المستندة إلى السحابة الإلكترونية.
3. اضبط مفاتيح Firebase API الحالية لرفض الوصول إلى Cloud Vision API:
   1. افتح صفحة بيانات الاعتماد في Cloud Console.
   2. لكل مفتاح واجهة برمجة تطبيقات في القائمة، افتح طريقة العرض الخاصة بالتعديل، وفي قسم "قيود المفتاح" ، أضِف جميع واجهات برمجة التطبيقات المتاحة إلى القائمة باستثناء Cloud Vision API.

نشر الدالة القابلة للاستدعاء

بعد ذلك، انشر Cloud Function التي ستستخدمها لربط تطبيقك وCloud Vision API. يحتوي مستودع functions-samples على مثال يمكنك استخدامه.

بشكلٍ تلقائي، سيسمح الوصول إلى Cloud Vision API من خلال هذه الدالة للمستخدمين الذين تمّت المصادقة عليهم فقط في تطبيقك بالوصول إلى Cloud Vision API. يمكنك تعديل الدالة لتلبية متطلبات مختلفة.

لنشر الدالة، اتّبِع الخطوات التالية:

1. استنسِخ مستودع functions-samples أو نزِّله، وانتقِل إلى الدليل Node-1st-gen/vision-annotate-image

   git clone https://github.com/firebase/functions-samples
   cd Node-1st-gen/vision-annotate-image
   

2. ثبِّت التبعيّات:

   cd functions
   npm install
   cd ..

3. إذا لم يكن لديك Firebase CLI، ثبِّته.
4. ابدأ مشروع Firebase في الدليل vision-annotate-image. عندما يُطلب منك ذلك، اختَر مشروعك في القائمة.

   firebase init

5. انشر الدالة:

   firebase deploy --only functions:annotateImage

إضافة "مصادقة Firebase" إلى تطبيقك

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

إضافة التبعيات اللازمة إلى تطبيقك

implementation("com.google.firebase:firebase-functions:22.1.1")
implementation("com.google.code.gson:gson:2.8.6")

1. تجهيز الصورة المُدخَلة

1. احصل على الصورة ككائن Bitmap:

   Kotlin

   var bitmap: Bitmap = MediaStore.Images.Media.getBitmap(contentResolver, uri)

   Java

   Bitmap bitmap = MediaStore.Images.Media.getBitmap(getContentResolver(), uri);

2. (اختياري) قلِّل حجم الصورة لتوفير النطاق الترددي. راجِع أحجام الصور المقترَحة في Cloud Vision.

   Kotlin

   private fun scaleBitmapDown(bitmap: Bitmap, maxDimension: Int): Bitmap {
       val originalWidth = bitmap.width
       val originalHeight = bitmap.height
       var resizedWidth = maxDimension
       var resizedHeight = maxDimension
       if (originalHeight > originalWidth) {
           resizedHeight = maxDimension
           resizedWidth =
               (resizedHeight * originalWidth.toFloat() / originalHeight.toFloat()).toInt()
       } else if (originalWidth > originalHeight) {
           resizedWidth = maxDimension
           resizedHeight =
               (resizedWidth * originalHeight.toFloat() / originalWidth.toFloat()).toInt()
       } else if (originalHeight == originalWidth) {
           resizedHeight = maxDimension
           resizedWidth = maxDimension
       }
       return Bitmap.createScaledBitmap(bitmap, resizedWidth, resizedHeight, false)
   }

   Java

   private Bitmap scaleBitmapDown(Bitmap bitmap, int maxDimension) {
       int originalWidth = bitmap.getWidth();
       int originalHeight = bitmap.getHeight();
       int resizedWidth = maxDimension;
       int resizedHeight = maxDimension;
   
       if (originalHeight > originalWidth) {
           resizedHeight = maxDimension;
           resizedWidth = (int) (resizedHeight * (float) originalWidth / (float) originalHeight);
       } else if (originalWidth > originalHeight) {
           resizedWidth = maxDimension;
           resizedHeight = (int) (resizedWidth * (float) originalHeight / (float) originalWidth);
       } else if (originalHeight == originalWidth) {
           resizedHeight = maxDimension;
           resizedWidth = maxDimension;
       }
       return Bitmap.createScaledBitmap(bitmap, resizedWidth, resizedHeight, false);
   }

   Kotlin

   // Scale down bitmap size
   bitmap = scaleBitmapDown(bitmap, 640)

   Java

   // Scale down bitmap size
   bitmap = scaleBitmapDown(bitmap, 640);

3. حوِّل كائن الصورة النقطية إلى سلسلة بترميز base64:

   Kotlin

   // Convert bitmap to base64 encoded string
   val byteArrayOutputStream = ByteArrayOutputStream()
   bitmap.compress(Bitmap.CompressFormat.JPEG, 100, byteArrayOutputStream)
   val imageBytes: ByteArray = byteArrayOutputStream.toByteArray()
   val base64encoded = Base64.encodeToString(imageBytes, Base64.NO_WRAP)

   Java

   // Convert bitmap to base64 encoded string
   ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
   bitmap.compress(Bitmap.CompressFormat.JPEG, 100, byteArrayOutputStream);
   byte[] imageBytes = byteArrayOutputStream.toByteArray();
   String base64encoded = Base64.encodeToString(imageBytes, Base64.NO_WRAP);

يجب أن تكون الصورة الممثّلة بكائن Bitmap في وضع مستقيم ، بدون الحاجة إلى أي تدوير إضافي.

2. استدعاء الدالة القابلة للاستدعاء للتعرّف على المعالم

1. أولاً، ابدأ مثيلاً من Cloud Functions:

   Kotlin

   private lateinit var functions: FirebaseFunctions
   // ...
   functions = Firebase.functions
   

   Java

   private FirebaseFunctions mFunctions;
   // ...
   mFunctions = FirebaseFunctions.getInstance();
   

2. حدِّد طريقة لاستدعاء الدالة:

   Kotlin

   private fun annotateImage(requestJson: String): Task<JsonElement> {
       return functions
           .getHttpsCallable("annotateImage")
           .call(requestJson)
           .continueWith { task ->
               // This continuation runs on either success or failure, but if the task
               // has failed then result will throw an Exception which will be
               // propagated down.
               val result = task.result?.data
               JsonParser.parseString(Gson().toJson(result))
           }
   }
   

   Java

   private Task<JsonElement> annotateImage(String requestJson) {
       return mFunctions
               .getHttpsCallable("annotateImage")
               .call(requestJson)
               .continueWith(new Continuation<HttpsCallableResult, JsonElement>() {
                   @Override
                   public JsonElement then(@NonNull Task<HttpsCallableResult> task) {
                       // This continuation runs on either success or failure, but if the task
                       // has failed then getResult() will throw an Exception which will be
                       // propagated down.
                       return JsonParser.parseString(new Gson().toJson(task.getResult().getData()));
                   }
               });
   }
   

3. أنشِئ طلب JSON مع النوع LANDMARK_DETECTION

   Kotlin

   // Create json request to cloud vision
   val request = JsonObject()
   // Add image to request
   val image = JsonObject()
   image.add("content", JsonPrimitive(base64encoded))
   request.add("image", image)
   // Add features to the request
   val feature = JsonObject()
   feature.add("maxResults", JsonPrimitive(5))
   feature.add("type", JsonPrimitive("LANDMARK_DETECTION"))
   val features = JsonArray()
   features.add(feature)
   request.add("features", features)
   

   Java

   // Create json request to cloud vision
   JsonObject request = new JsonObject();
   // Add image to request
   JsonObject image = new JsonObject();
   image.add("content", new JsonPrimitive(base64encoded));
   request.add("image", image);
   //Add features to the request
   JsonObject feature = new JsonObject();
   feature.add("maxResults", new JsonPrimitive(5));
   feature.add("type", new JsonPrimitive("LANDMARK_DETECTION"));
   JsonArray features = new JsonArray();
   features.add(feature);
   request.add("features", features);
   

4. أخيرًا، استدعِ الدالة:

   Kotlin

   annotateImage(request.toString())
       .addOnCompleteListener { task ->
           if (!task.isSuccessful) {
               // Task failed with an exception
               // ...
           } else {
               // Task completed successfully
               // ...
           }
       }
   

   Java

   annotateImage(request.toString())
           .addOnCompleteListener(new OnCompleteListener<JsonElement>() {
               @Override
               public void onComplete(@NonNull Task<JsonElement> task) {
                   if (!task.isSuccessful()) {
                       // Task failed with an exception
                       // ...
                   } else {
                       // Task completed successfully
                       // ...
                   }
               }
           });
   

3. الحصول على معلومات عن المعالم التي تم التعرّف عليها

for (label in task.result!!.asJsonArray[0].asJsonObject["landmarkAnnotations"].asJsonArray) {
    val labelObj = label.asJsonObject
    val landmarkName = labelObj["description"]
    val entityId = labelObj["mid"]
    val score = labelObj["score"]
    val bounds = labelObj["boundingPoly"]
    // Multiple locations are possible, e.g., the location of the depicted
    // landmark and the location the picture was taken.
    for (loc in labelObj["locations"].asJsonArray) {
        val latitude = loc.asJsonObject["latLng"].asJsonObject["latitude"]
        val longitude = loc.asJsonObject["latLng"].asJsonObject["longitude"]
    }
}

for (JsonElement label : task.getResult().getAsJsonArray().get(0).getAsJsonObject().get("landmarkAnnotations").getAsJsonArray()) {
    JsonObject labelObj = label.getAsJsonObject();
    String landmarkName = labelObj.get("description").getAsString();
    String entityId = labelObj.get("mid").getAsString();
    float score = labelObj.get("score").getAsFloat();
    JsonObject bounds = labelObj.get("boundingPoly").getAsJsonObject();
    // Multiple locations are possible, e.g., the location of the depicted
    // landmark and the location the picture was taken.
    for (JsonElement loc : labelObj.get("locations").getAsJsonArray()) {
        JsonObject latLng = loc.getAsJsonObject().get("latLng").getAsJsonObject();
        double latitude = latLng.get("latitude").getAsDouble();
        double longitude = latLng.get("longitude").getAsDouble();
    }
}