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

توضّح هذه الصفحة كيفية دمج حزمة تطوير البرامج Navigation SDK في مشروع التطوير.

إضافة حزمة تطوير البرامج (SDK) لنظام التنقّل إلى مشروعك

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

  1. أضِف الاعتمادية التالية إلى إعدادات Gradle أو Maven، استبدِل العنصر النائب VERSION_NUMBER بالإصدار المطلوب من "حزمة تطوير البرامج للتنقّل على أجهزة 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 لتطبيق "خرائط Google"، عليك استبعاد التبعية في كلّ تبعية معلَن عنها تعتمد على حزمة SDK لتطبيق "خرائط Google".

    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>

ضبط عملية الإنشاء

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

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

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

تعديل خصائص Gradle

  • في مجلد نصوص Gradle البرمجية، افتح الملف 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 المُبسّط لمزيد من المعلومات. اطّلِع على مثال المقتطف من نص البرمجة الخاص بالإنشاء أدناه لمعرفة كيفية الترجمة وخيارات التبعية.
    • ننصحك باستخدام الإصدار 8.4 من Gradle والإصدار 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 للتطبيق. اطّلِع على عيّنات التطبيقات لمعرفة مجموعات التبعيات المعدَّلة، لأنّ إصدار IDE Navigation 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}" />

    Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

  10. In Android Studio, open your module-level build.gradle.kts or build.gradle file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other 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 في تطبيقك، يجب تضمين نص الإسناد وتراخيص المصادر المفتوحة كجزء من القسم "الإشعارات القانونية" في تطبيقك.

يمكنك العثور على نص الإسناد المطلوب وتراخيص المصادر المفتوحة فيملف zip الخاص بملف "حزمة تطوير البرامج للتنقّل على أجهزة Android":

  • NOTICE.txt
  • LICENSES.txt

إذا كنت عميلًا في برنامج Mobility أو Fleet Engine Deliveries

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