設定 Xcode 專案

啟用計費功能並建立 API 金鑰後,您就可以設定要用來開發應用程式的 Xcode 專案。

每個版本都會提供版本資訊

步驟 1:安裝必要軟體

如要使用 Maps SDK for iOS 建立專案,您必須下載並安裝:

  • Xcode 14.0 版以上
  • 眼鏡蛇

步驟 2:建立 Xcode 專案,並安裝 Maps SDK for iOS

使用 CocoaPods

Maps SDK for iOS 以 CocoaPods Pod 的形式提供。CocoaPods 是一種適用於 Swift 和 Objective-C Cocoa 專案的開放原始碼依附元件管理員。

如果您還沒有 CocoaPods 工具,請在終端機上執行下列指令,即可在 macOS 中安裝這項工具。詳情請參閱 CocoaPods 入門指南

sudo gem install cocoapods

為 Maps SDK for iOS 建立 Podfile,並使用該檔案安裝 API 及其依附元件:

  1. 如果尚未建立 Xcode 專案,請立即建立一個專案並儲存至本機電腦。如果你是 iOS 開發新手:
    1. 建立新專案。
    2. 依序選取「iOS」>「應用程式」範本。
    3. 在專案選項畫面上:
      1. 輸入專案名稱
      2. 記錄「Bundle ID」欄位的值。 您可以使用該值限制下方的 API 金鑰。
      3. 將專案的「Interface」設為「Storyboard」
      4. 將「Language」(語言) 設為「Swift」或「Goal-C」
  2. 在專案目錄中建立名為 Podfile 的檔案。這個檔案定義了專案的依附元件。
  3. 編輯 Podfile 並新增依附元件及其版本。以下範例包含 Maps SDK for iOS 所需的依附元件:
    source 'https://github.com/CocoaPods/Specs.git'
    
    platform :ios, '14.0'
    
    target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
      pod 'GoogleMaps', '8.2.0'
    end
    
    請務必定期執行 pod outdated,偵測是否有更新版本,確保您保持在最新版本。如有需要,請升級至最新版本
  4. 儲存 Podfile
  5. 開啟終端機並前往包含 Podfile 的目錄:

    cd <path-to-project>
  6. 執行 pod install 指令。此動作會安裝 Podfile 中指定的 API 及其所有依附元件。

    pod install
  7. 關閉 Xcode,接著按兩下來開啟專案的 .xcworkspace 檔案來啟動 Xcode。從現在起,您必須使用 .xcworkspace 檔案來開啟專案。

如要更新現有專案的 API,請按照下列步驟操作:

  1. 開啟終端機,然後前往包含 Podfile 的專案目錄。
  2. 執行 pod update 指令。這會將 Podfile 中指定的所有 API 更新為最新版本。

安裝 XCFramework

XCFramework 是一種二進位套件,可在多個平台上使用,包括使用 M1 晶片組安裝 Maps SDK for iOS 的機器。本指南說明如何在專案中新增包含 Maps SDK for iOS 的 XCFramework,並在 Xcode 中調整建構設定。

手動

本指南說明如何手動將 Maps SDK for iOS 新增到專案,並在 Xcode 中調整建構設定。

  1. 下載 SDK 來源檔案:GoogleMaps-8.2.0
  2. 將來源檔案解除封裝。前往「Frameworks」資料夾即可存取這個 XCFramework。
  3. 如果尚未建立 Xcode 專案,請立即建立一個專案並儲存至本機電腦。如果你是 iOS 開發新手:
    1. 建立新專案。
    2. 依序選取「iOS」>「應用程式」範本。
    3. 在專案選項畫面上:
      1. 輸入專案名稱
      2. 記錄「Bundle ID」欄位的值。 您可以使用該值限制下方的 API 金鑰。
      3. 將專案的「Interface」設為「Storyboard」
      4. 將「Language」(語言) 設為「Swift」或「Goal-C」
  4. 將下列 XCFrameworks 將其拖曳至「Frameworks、Library and Embedded Content」之下,請務必為每個 XCFramework 勾選「Do Not Embed」
    • GoogleMaps-x.x.x/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/GoogleMapsCore.xcframework
    • (僅適用於付費方案客戶) GoogleMaps-x.x.x/GoogleMapsM4B.xcframework
  5. 在專案中的 GoogleMaps.xcframework 上按一下滑鼠右鍵,然後選取「Show In Finder」
  6. GoogleMaps.bundleios-arm64_x86_64-simulator/GoogleMaps.framework/Resources 資料夾拖曳至 Xcode 專案的頂層目錄。系統提示時,請確保您「沒有」選取「Copy items if needed」
  7. 從 Project Navigator 中選取專案,然後選擇應用程式的目標。
  8. 開啟應用程式目標的「Build Phases」分頁,然後在「Link Binary with Libraries」內加入下列架構和程式庫:
    • Accelerate.framework
    • CoreData.framework
    • CoreGraphics.framework
    • CoreImage.framework
    • CoreLocation.framework
    • CoreTelephony.framework
    • CoreText.framework
    • GLKit.framework
    • ImageIO.framework
    • libc++.tbd
    • libz.tbd
    • Metal.framework
    • OpenGLES.framework
    • QuartzCore.framework
    • SystemConfiguration.framework
    • UIKit.framework
  9. 選擇專案 (而不是特定目標),然後開啟「Build Settings」分頁。在「Other Linker Flags」(其他連結器旗標) 區段中,新增 -ObjC如果找不到這些設定,請將「Build Settings」列中的篩選器從「Basic」變更為「All」

  10. 如要安裝 Places SDK for iOS XCFramework,請參閱「開始使用 Places SDK for iOS」一文。

附卡丁車

手動安插

本指南說明如何手動將 Maps SDK for iOS 新增到專案,並在 Xcode 中調整建構設定。

  1. 下載 SDK 來源檔案:GoogleMaps-8.2.0
  2. 將來源檔案解除封裝。
  3. 如果尚未建立 Xcode 專案,請立即建立一個專案並儲存至本機電腦。如果你是 iOS 開發新手:
    1. 建立新專案。
    2. 依序選取「iOS」>「應用程式」範本。
    3. 在專案選項畫面上:
      1. 輸入專案名稱
      2. 記錄「Bundle ID」欄位的值。 您可以使用該值限制下方的 API 金鑰。
      3. 將專案的「Interface」設為「Storyboard」
      4. 將「Language」(語言) 設為「Swift」或「Goal-C」
  4. 將下列套件拖曳至專案中:(當系統提示時,選取「Copy items if needed, please use the same version as above.」)
    • GoogleMaps-x.x.x/Base/Frameworks/GoogleMapsBase.xcframework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMaps.xcframework
    • GoogleMaps-x.x.x/Maps/Frameworks/GoogleMapsCore.xcframework
    • (僅適用於付費方案客戶) GoogleMaps-x.x.x/M4B/Frameworks/GoogleMapsM4B.xcframework
  5. 以滑鼠右鍵按一下專案中的 GoogleMaps.xcframework,然後選取 [Show in Finder]
  6. GoogleMaps.bundleResources 資料夾拖曳至 Xcode 專案的頂層目錄。系統提示時,請確保您選取「Copy items into destination group's folder」
  7. 從「Project Navigator」中選取您的專案,然後為您的應用程式選擇目標。
  8. 開啟應用程式目標的「Build Phases」分頁,然後在「Link Binary with Libraries」內加入下列架構和程式庫:
    • Accelerate.framework
    • CoreData.framework
    • CoreGraphics.framework
    • CoreImage.framework
    • CoreLocation.framework
    • CoreTelephony.framework
    • CoreText.framework
    • GLKit.framework
    • ImageIO.framework
    • libc++.tbd
    • libz.tbd
    • Metal.framework
    • OpenGLES.framework
    • QuartzCore.framework
    • SystemConfiguration.framework
    • UIKit.framework
  9. 選擇您的專案 (而不是特定目標),然後開啟 [Build Settings] 分頁標籤。在「Other Linker Flags」部分中,新增 -ObjC如果您沒有看到這些設定,請將「Build Settings」列中的篩選器從「Basic」變更為「All」

  10. 如要安裝 Places SDK for iOS,請參閱「開始使用 Places SDK for iOS」一文。

步驟 3:將 API 金鑰加進專案

我們已在「取得 API 金鑰」中為應用程式產生 API 金鑰,現在請將這個金鑰加進 Xcode 專案。

請將以下範例中的 YOUR_API_KEY 替換成您的 API 金鑰。

Swift

將 API 金鑰新增到您的 AppDelegate.swift 中,如下所示:

  1. 新增下列匯入陳述式:
    import GoogleMaps
  2. 使用您的 API 金鑰,將以下內容加入 application(_:didFinishLaunchingWithOptions:) 方法:
    GMSServices.provideAPIKey("YOUR_API_KEY")
  3. 如果您也有使用 Places API,請再次新增金鑰,如下所示:
    GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

Objective-C

將 API 金鑰新增到您的 AppDelegate.m 中,如下所示:

  1. 新增下列匯入陳述式:
    @import GoogleMaps;
  2. 使用您的 API 金鑰,將以下內容加入 application:didFinishLaunchingWithOptions: 方法:
    [GMSServices provideAPIKey:@"YOUR_API_KEY"];
  3. 如果您也有使用 Places API,請再次新增金鑰,如下所示:
    [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

步驟 4 (選用):選擇使用 Metal 轉譯架構

Maps SDK for iOS 可讓您選擇使用 Apple 的 Metal 算繪架構。如要在應用程式中試用 Metal 轉譯器,請在 goal-C 中呼叫 [GMSServices setMetalRendererEnabled:YES],或在 Swift 中呼叫 GMSServices.setMetalRendererEnabled(true),然後再建立任何地圖檢視。

如果您要手動安裝 SDK,也必須在 Xcode 中加入 Metal.framework

步驟 5:新增地圖

以下程式碼示範如何在現有的 ViewController 中新增簡易地圖:

  1. 在應用程式的預設 ViewController 中新增或更新方法,以建立並初始化 GMSMapView 的執行個體。

    Swift

    /*
     * Copyright 2020 Google Inc. All rights reserved.
     *
     *
     * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
     * file except in compliance with the License. You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software distributed under
     * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
     * ANY KIND, either express or implied. See the License for the specific language governing
     * permissions and limitations under the License.
     */
    
    import UIKit
    import GoogleMaps
    
    class ViewController: UIViewController {
    
        override func viewDidLoad() {
            super.viewDidLoad()
            // Do any additional setup after loading the view.
            // Create a GMSCameraPosition that tells the map to display the
            // coordinate -33.86,151.20 at zoom level 6.
            let camera = GMSCameraPosition.camera(withLatitude: -33.86, longitude: 151.20, zoom: 6.0)
            let mapView = GMSMapView.map(withFrame: self.view.frame, camera: camera)
            self.view.addSubview(mapView)
    
            // Creates a marker in the center of the map.
            let marker = GMSMarker()
            marker.position = CLLocationCoordinate2D(latitude: -33.86, longitude: 151.20)
            marker.title = "Sydney"
            marker.snippet = "Australia"
            marker.map = mapView
      }
    }
    
          

    Objective-C

    /*
    * Copyright 2020 Google Inc. All rights reserved.
    *
    *
    * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
    * file except in compliance with the License. You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, software distributed under
    * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
    * ANY KIND, either express or implied. See the License for the specific language governing
    * permissions and limitations under the License.
    */
    
    #import "ViewController.h"
    #import <GoogleMaps/GoogleMaps.h>
    
    @interface ViewController ()
    
    @end
    
    @implementation ViewController
    
    - (void)viewDidLoad {
        [super viewDidLoad];
      // Do any additional setup after loading the view.
      // Create a GMSCameraPosition that tells the map to display the
      // coordinate -33.86,151.20 at zoom level 6.
      GMSCameraPosition *camera = [GMSCameraPosition cameraWithLatitude:-33.86
                                                              longitude:151.20
                                                                   zoom:6];
      GMSMapView *mapView = [GMSMapView mapWithFrame:self.view.frame camera:camera];
      mapView.myLocationEnabled = YES;
      [self.view addSubview:mapView];
    
      // Creates a marker in the center of the map.
      GMSMarker *marker = [[GMSMarker alloc] init];
      marker.position = CLLocationCoordinate2DMake(-33.86, 151.20);
      marker.title = @"Sydney";
      marker.snippet = @"Australia";
      marker.map = mapView;
    }
    
    @end
    
          
  2. 執行您的應用程式。您應該會看到以澳洲雪梨為中心的地圖,其中有一個標記。如果您看到標記,但看不到地圖,請確認您提供了 API 金鑰。

步驟 6 (選用):宣告 API 使用的網址架構

從 iOS 9 和 Xcode 7 開始,應用程式可以在應用程式的 Info.plist 檔案中指定配置,以宣告想要開啟的網址配置。Maps SDK for iOS 會在使用者點按地圖上的 Google 標誌時,開啟 Google 地圖行動應用程式,因此應用程式可以宣告相關網址配置。

如要宣告 Maps SDK for iOS 使用的網址配置,請在 Info.plist 中加入下列程式碼:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>googlechromes</string>
    <string>comgooglemaps</string>
</array>

以下螢幕截圖顯示 Xcode 使用者介面中的設定:

Xcode 中的 LSApplicationQueriesSchemes 設定

如果沒有上述宣告,使用者輕觸地圖上的 Google 標誌時,可能會發生下列錯誤:

-canOpenURL: failed for URL: "comgooglemaps://" - error: "This app is not allowed to query for scheme comgooglemaps"
-canOpenURL: failed for URL: "googlechromes://" - error: "This app is not allowed to query for scheme googlechromes"

如要解決這些錯誤,請按照上述方式將宣告新增至 Info.plist

後續步驟

取得 API 金鑰和 Xcode 專案後,接下來請建立並執行應用程式。Maps SDK for iOS 提供許多教學課程和範例應用程式,協助您踏出第一步。相關詳情請參閱: