איך מגדירים פרויקט Android Studio

בדף הזה נסביר איך להגדיר בפרויקט Android Studio להשתמש SDK של מפות ל-Android בלי להשתמש בתבנית של מפות Google כפי שמפורט במדריך למתחילים.

התבנית של מפות Google מגדירה באופן אוטומטי ומוסיפה מפה בסיסית למפה חדשה פרויקט Android Studio. אבל אפשר גם להוסיף מפה לפרויקט Android שמשתמש בתבנית אחרת של Android Studio. כדי לעשות את זה ידנית מגדירים את הפרויקט ומוסיפים את המפה.

שלב 1: הגדרת Android Studio

במסמך הזה מתוארת סביבת פיתוח באמצעות קיפוד ב-Android Studio פלאגין של Android Gradle גרסה 8.2.

שלב 2. הגדרת ה-SDK

ה-SDK של מפות Google ל-Android זמין דרך מאגר Maven של Google. שפת תרגום להוסיף את ה-SDK לאפליקציה, לבצע את הפעולות הבאות:

1. בקובץ settings.gradle.kts ברמה העליונה, יש לכלול את התחילית פורטל הפלאגין של Gradle, במאגר Google Maven, ומאגר מרכזי של Maven מתחת לבלוק pluginManagement. בלוק pluginManagement חייבות להופיע לפני כל הצהרה אחרת בסקריפט.

   pluginManagement {
       repositories {
           gradlePluginPortal()
           google()
           mavenCentral()
       }
   } 

2. בקובץ settings.gradle.kts ברמה העליונה, יש לכלול את התחילית מאגר Maven של Google ו-המאגר המרכזי של Maven בקטע dependencyResolutionManagement:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. בקובץ build.gradle.kts או build.gradle ברמת המודול, מוסיפים את הפקודה תלות של Google Play Services עבור SDK של מפות ל-Android.

   Kotlin

   dependencies {
   
       // Maps SDK for Android
       implementation("com.google.android.gms:play-services-maps:19.0.0")
   }

   Groovy

   dependencies {
   
       // Maps SDK for Android
       implementation "com.google.android.gms:play-services-maps:19.0.0"
   }

4. בקובץ build.gradle.kts או build.gradle ברמת המודול, מגדירים את compileSdk ואת minSdk לערכים הבאים:

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 21
           // ...
       }
   }

   Groovy

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 21
           // ...
       }
   }

5. בקטע buildFeatures של build.gradle.kts ברמת המודול או build.gradle. מוסיפים את המחלקה BuildConfig, ואפשר להשתמש בה גישה לערכי מטא-נתונים שמוגדרים בהמשך התהליך הזה:

   Kotlin

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

   Groovy

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

שלב 3: מוסיפים את מפתח ה-API לפרויקט

בקטע הזה מוסבר איך לאחסן את מפתח ה-API כדי שתהיה אפשרות להפנות אליו באופן מאובטח באפליקציה שלך. אין לבדוק את מפתח ה-API במערכת ניהול הגרסאות, לכן מומלץ תאחסן אותו בקובץ 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")
       }
   }

   Groovy

   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")
   }

   Groovy

   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 במפתח ה-API שלכם. אחסון המפתח בקובץ הזה כי secrets.properties לא נכלל בבדיקה לניהול גרסאות המערכת.

   MAPS_API_KEY=YOUR_API_KEY

6. שומרים את הקובץ.

7. יוצרים את הקובץ local.defaults.properties בספרייה שברמה העליונה, אותה לתיקייה בתור הקובץ secrets.properties, ואז מוסיפים את הקוד הבא.

   MAPS_API_KEY=DEFAULT_API_KEY

   מטרת הקובץ הזה היא לספק מיקום לגיבוי של מפתח ה-API אם קובץ secrets.properties לא נמצא כדי שגרסאות ה-build לא ייכשלו. הדבר יכול להתרחש אם משכפלים את האפליקציה ממערכת לניהול גרסאות שמושמטת מ-secrets.properties עדיין לא יצרת קובץ secrets.properties באופן מקומי כדי לספק את מפתח API.

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 הוא השם המומלץ של מטא-נתונים למפתח ה-API. ניתן להשתמש במפתח עם השם הזה כדי לבצע אימות למספר ממשקי API מבוססי מפות Google בפלטפורמת Android, כולל SDK של מפות ל-Android. בתאימות לאחור, ה-API גם יש תמיכה בשם com.google.android.maps.v2.API_KEY. המורשת הזו מאפשר אימות רק ל-Android Maps API גרסה 2. האפליקציה יכולה לציין רק אחד משמות המטא-נתונים של מפתח ה-API. אם מציינים את שניהם, ה-API ויוצרת חריגה.

10. ב-Android Studio, פותחים את 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.*"
    }
            

    Groovy

    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.*"
    }
            

שלב 4: עדכון קובץ המניפסט של האפליקציה

קטע זה מתאר את ההגדרות שיש להוסיף AndroidManifest.xml.

מספר הגרסה של Google Play Services

צריך להוסיף את ההצהרה הבאה בתוך הרכיב application. זה מוטמע הגרסה של Google Play Services שאיתה קומפלה האפליקציה.

<meta-data
    android:name="com.google.android.gms.version"
    android:value="@integer/google_play_services_version" />

הרשאת מיקום

אם האפליקציה שלך צריכה גישה למיקום של המשתמש, עליך לבקש הרשאת מיקום בקובץ AndroidManifest.xml. האפשרויות הן ACCESS_FINE_LOCATION, שמספק את המיקום המדויק של המכשיר, וגם ACCESS_COARSE_LOCATION, והוא פחות מדויק. פרטים נוספים זמינים במאמר המדריך לנתוני מיקום.

כדי לבקש הרשאה לACCESS_FINE_LOCATION, צריך להוסיף את הקוד הזה רכיב manifest:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

הרשאה לניהול אחסון חיצוני

אם אתם מטרגטים גרסה 8.3 ואילך של Google Play Services SDK, אין צורך בהרשאה WRITE_EXTERNAL_STORAGE. אם אתם מטרגטים גרסאות קודמות של Google Play Services SDK, צריך לבקש WRITE_EXTERNAL_STORAGE הרשאה, ברכיב manifest.

<uses-permission
        android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

ספריית Apache HTTP מדור קודם

אם משתמשים ב-com.google.android.gms:play-services-maps:16.0.0 ומטה וב- האפליקציה שלך מטרגטת רמת API 28 (Android 9.0) ומעלה, עליך לכלול את ההצהרה הבאה בתוך הרכיב <application> של AndroidManifest.xml. אחרת, אפשר לדלג על ההצהרה הזו.

<uses-library
    android:name="org.apache.http.legacy"
    android:required="false" />

שלב 5: הגדרת מכשיר Android

כדי להפעיל אפליקציה שמשתמשת ב-SDK של מפות Google ל-Android, צריך לפרוס אותו במכשיר Android או ב-Android אמולטור שמבוסס על Android 5.0 ואילך וכולל ממשקי Google API.

• כדי להשתמש במכשיר Android, יש לפעול לפי ההוראות שבכתובת הפעלת אפליקציות במכשיר חומרה
• כדי להשתמש באמולטור Android, אפשר ליצור מכשיר וירטואלי ולהתקין את האמולטור באמצעות מנהל המכשיר הווירטואלי (AVD) של Android שכלול ב-Android Studio.

שלב 6: (אופציונלי) בודקים אם יש תמיכה ב-Play Service

SDK של מפות Google ל-Android מחייב את המכשיר שבו פורסים את שבהם מותקנים שירותי Google Play. Google מספקת שיטה יכול להתקשר מהאפליקציה כדי לבדוק. לקבלת מידע נוסף, ראו איך לבדוק Play Services מותקנת.

השלבים הבאים

אחרי שמגדירים את הפרויקט, אפשר להוסיף מפה.