إعداد مشروع "استوديو Android"

تشرح هذه الصفحة كيفية دمج حزمة SDK للتنقل في مشروع التطوير لديك.

إضافة حزمة SDK للتنقّل إلى مشروعك

تتوفر حزمة SDK للتنقل من خلال مستودع Google Maven. يمكنك إضافة حزمة تطوير البرامج (SDK) إلى مشروعك باستخدام إعدادات Gradle build.gradle أو Maven pom.xml.

  1. أضِف التبعية التالية إلى إعدادات Gradle أو Maven، واستبدِل العنصر النائب VERSION_NUMBER بالإصدار المطلوب من حزمة تطوير البرامج (SDK) للتنقل لنظام التشغيل Android.

    Gradle

    أضِف ما يلي إلى build.gradle على مستوى الوحدة:

    dependencies {
        ...
        implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
}

    Maven

    أضِف ما يلي إلى pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

  2. إذا كانت لديك أي تبعيات تستخدم حزمة SDK للخرائط، يجب استبعاد التبعية في كل اعتمادية تم الإعلان عنها تعتمد على حزمة SDK للخرائط.

    Gradle

    أضِف ما يلي إلى build.gradle من المستوى الأعلى:

    allprojects {
        ...
        // Required: you must exclude the Google Play service Maps SDK from
        // your transitive dependencies. This is to ensure there won't be
        // multiple copies of Google Maps SDK in your binary, as the Navigation
        // SDK already bundles the Google Maps SDK.
        configurations {
            implementation {
                exclude group: 'com.google.android.gms', module: 'play-services-maps'
            }
        }
}

    Maven

    أضِف ما يلي إلى pom.xml:

    <dependencies>
  <dependency>
  <groupId>project.that.brings.in.maps</groupId>
  <artifactId>MapsConsumer</artifactId>
  <version>1.0</version>
    <exclusions>
      <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
      <exclusion>  <!-- declare the exclusion here -->
        <groupId>com.google.android.gms</groupId>
        <artifactId>play-services-maps</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

ضبط الإصدار

بعد إنشاء المشروع، يمكنك ضبط الإعدادات لإنشاء واستخدام ناجح لحزمة تطوير البرامج (SDK) للتنقل.

تعديل المواقع المحلية

  • في مجلد Gradle Scripts، افتح ملف local.properties وأضف android.useDeprecatedNdk=true.

تعديل خصائص Gradle

  • في مجلد Gradle Scripts، افتح ملف gradle.properties وأضف ما يلي إذا لم يكن موجودًا بالفعل:

    1. android.useAndroidX=true
    2. android.enableJetifier=true

تعديل نص إنشاء Gradle

  • افتح ملف build.gradle (Module:app) واستخدِم الإرشادات التالية لتحديث الإعدادات لاستيفاء متطلبات Navigation SDK، وفكِّر في ضبط خيارات التحسين أيضًا.

    الإعدادات المطلوبة لحزمة تطوير البرامج (SDK) الخاصة بالتنقّل

    1. اضبط minSdkVersion على 23 أو أعلى.
    2. اضبط targetSdkVersion على 34 أو أعلى.
    3. أضِف إعداد dexOptions يؤدي إلى زيادة javaMaxHeapSize.
    4. حدِّد الموقع الجغرافي للمكتبات الإضافية.
    5. أضِف repositories وdependencies لحزمة تطوير البرامج (SDK) للتنقل.
    6. استبدِل أرقام الإصدارات في التبعيات بأحدث الإصدارات المتاحة.

    إعدادات اختيارية لتقليل وقت الإصدار

    • تفعيل تقليص الرموز وتقليص الموارد باستخدام R8/ProGuard لإزالة الرموز والموارد غير المستخدمة من التبعيات. إذا كانت خطوة R8/ProGuard تستغرق وقتًا طويلاً جدًا لتنفيذها، ننصحك بتفعيل multidex لعملية التطوير.
    • تقليل عدد ترجمات اللغات المضمّنة في الإصدار: اضبط resConfigs على لغة واحدة أثناء التطوير. في الإصدار النهائي، اضبط القيمة resConfigs على اللغات التي تستخدمها فعليًا. يتضمّن Gradle تلقائيًا سلاسل الموارد لجميع اللغات المتوافقة مع IDE IDE Navigation SDK.

    إضافة ميزة إزالة الترميز لتوفير دعم Java8

    • إذا كنت تنشئ تطبيقك باستخدام الإصدار 4.0.0 من المكوّن الإضافي لنظام Gradle المتوافق مع Android أو الإصدارات الأحدث، سيوسِّع المكوّن الإضافي الدعم لاستخدام عدد من واجهات برمجة التطبيقات بلغة Java 8. راجِع دعم إزالة رمز Java 8 المُحلَّى لمزيد من المعلومات. اطّلِع على مثال المقتطف من نص إنشاء الإصدار أدناه لمعرفة كيفية استخدام خيارات الترجمة والتبعية.
    • ننصحك باستخدام Gradle 8.4 والإصدار 8.3.0 من المكوّن الإضافي لنظام Gradle المتوافق مع Android، ومكتبة Desugar com.android.tools:desugar_jdk_libs_nio:2.0.3. يتوافق هذا الإعداد مع حزمة Navigation SDK لنظام التشغيل Android 6.0.0 والإصدارات الأحدث.
    • يجب تفعيل مكتبة Desugar لوحدة app وأي وحدة تعتمد مباشرةً على حزمة Navigation SDK.

فيما يلي مثال على النص البرمجي لإصدار Gradle للتطبيق. راجِع نموذج التطبيقات للحصول على مجموعات مُعدَّلة من الاعتمادات، حيث قد يكون إصدار حزمة تطوير البرامج (SDK) للتنقل الذي تستخدمه متقدمًا بعض الشيء أو خلفه.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 34
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.3'
}

إضافة مفتاح واجهة برمجة التطبيقات إلى تطبيقك

يوضّح هذا القسم طريقة تخزين مفتاح واجهة برمجة التطبيقات كي يتمكّن تطبيقك من الرجوع إليه بشكل آمن. ويجب عدم التحقّق من مفتاح واجهة برمجة التطبيقات في نظام التحكّم في الإصدار، لذا ننصحك بتخزينه في ملف secrets.properties ضمن الدليل الجذري لمشروعك. لمزيد من المعلومات عن ملف secrets.properties، اطّلِع على ملفات سمات Gradle.

لتبسيط هذه المهمة، ننصحك باستخدام المكوّن الإضافي Secrets Gradle لأجهزة Android.

لتثبيت المكوّن الإضافي Secrets Gradle لأجهزة Android في مشروعك على "خرائط Google"، اتّبِع الخطوات التالية:

  1. في Android Studio، افتح ملف build.gradle.kts أو build.gradle الأولي وأضِف الرمز البرمجي التالي إلى عنصر dependencies ضمن buildscript.

    Kotlin

    buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

    رائع

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}
  2. افتح ملف build.gradle.kts أو build.gradle على مستوى الوحدة وأضِف رمز الربط التالي إلى عنصر plugins.

    Kotlin

    plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    رائع

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. في ملف build.gradle.kts أو build.gradle على مستوى الوحدة، تأكَّد من ضبط targetSdk وcompileSdk على 34.
  4. احفظ الملف وزامن مشروعك مع Gradle.
  5. افتح ملف secrets.properties في الدليل من المستوى الأعلى، ثم أضِف الرمز التالي: استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات الخاص بك. عليك تخزين مفتاحك في هذا الملف لأنّه تم استبعاد secrets.properties من التحقق من الوصول إلى نظام التحكم في الإصدار. 
    NAV_API_KEY=YOUR_API_KEY
  6. احفظ الملف.

  7. أنشِئ ملف local.defaults.properties في دليل المستوى الأعلى والمجلد نفسه الذي يتضمّن ملف secrets.properties، ثم أضِف الرمز التالي.

    NAV_API_KEY=DEFAULT_API_KEY

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

  8. احفظ الملف.
  9. في ملف AndroidManifest.xml، انتقِل إلى com.google.android.geo.API_KEY وعدِّل android:value attribute. في حال عدم توفّر العلامة <meta-data>، أنشِئها كعلامة فرعية للعلامة <application>. 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    ملاحظة: com.google.android.geo.API_KEY هو اسم البيانات الوصفية المقترَح لمفتاح واجهة برمجة التطبيقات. يمكن استخدام مفتاح بهذا الاسم للمصادقة مع عدة واجهات برمجة تطبيقات مستندة إلى "خرائط Google" على نظام التشغيل Android، بما في ذلك حزمة تطوير البرامج (SDK) لتطبيق Navigation على Android. للتوافق مع الأنظمة القديمة، تتيح واجهة برمجة التطبيقات أيضًا استخدام الاسم com.google.android.maps.v2.API_KEY. ويسمح هذا الاسم القديم بالمصادقة على الإصدار الثاني من واجهة برمجة تطبيقات Android Maps API فقط. يمكن للتطبيق تحديد اسم واحد فقط من أسماء البيانات الوصفية لمفتاح واجهة برمجة التطبيقات. في حال تحديد الاثنين، تطرح واجهة برمجة التطبيقات استثناءً.

  10. في "استوديو Android"، افتح الملف build.gradle.kts أو build.gradle على مستوى الوحدة وعدِّل السمة secrets. إذا لم تكن السمة secrets متوفّرة، أضِفها.

    عدِّل سمات المكوّن الإضافي لضبط propertiesFileName على secrets.properties، وdefaultPropertiesFileName على local.defaults.properties، وأي سمات أخرى.

    Kotlin

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

    رائع

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

تضمين الإحالات المطلوبة في تطبيقك

إذا كنت تستخدم حزمة Navigation SDK لنظام التشغيل Android في تطبيقك، يجب تضمين نص الإسناد وتراخيص المصادر المفتوحة كجزء من القسم "الإشعارات القانونية" في تطبيقك.

يمكنك العثور على نص الإحالة المطلوبة وتراخيص البرامج المفتوحة المصدر في حزمة تطوير البرامج (SDK) للتنقل لملف zip لنظام التشغيل Android:

  • NOTICE.txt
  • LICENSES.txt

إذا كنت أحد عملاء نقل المركبات أو خدمات توصيل مركبات الأسطول

إذا كنت أحد عملاء نقل المركبات أو خدمات توصيل المركبات، يمكنك التعرّف على الفوترة في مستندات الجوّال. لمزيد من المعلومات حول تسجيل المعاملات، يُرجى الاطّلاع على مقالتَي إعداد الفوترة وتسجيل المعاملات التي يمكن تحصيل رسومها وإعداد التقارير وتسجيل المعاملات التي يمكن تحصيل رسومها (Android).