启用结算功能并创建 API 密钥后,您就可以设置用于开发应用的 Xcode 项目了。
每个版本都有相应的版本说明。
第 1 步:安装所需的软件
若要使用 Maps SDK for iOS 构建项目,您必须下载并安装:
- Xcode 版本 15.0 或更高版本
第 2 步:创建 Xcode 项目并安装 Maps SDK for iOS
Swift Package Manager
您可以通过 Swift Package Manager 安装 Maps SDK for iOS。如需添加此 SDK,请确保您已移除所有现有的 Maps SDK for iOS 依赖项。
如需将 SDK 添加到新项目或现有项目,请按以下步骤操作:
-
打开 Xcode
project
或workspace
,然后依次点击 File > Add Package Dependencies。 - 输入 https://github.com/googlemaps/ios-maps-sdk 作为网址,按 Enter 键提取软件包,然后点击“添加软件包”。
-
如需安装特定的
version
,请将依赖项规则字段设置为某个基于版本的选项。对于新项目,我们建议指定最新版本并使用“确切版本”选项。完成后,点击“添加软件包”。 -
在 Choose Package Products 窗口中,验证
GoogleMaps
(对于 9.0.0 之前的版本,请验证GoogleMaps
、GoogleMapsBase
和GoogleMapsCore
)是否会添加到您指定的main
目标。完成后,点击“添加软件包”。 -
如需验证您的安装,请前往目标的
General
窗格。在框架、库和嵌入式内容中,您应该会看到已安装的软件包。 您还可以查看“Project Navigator”的“Package Dependencies”部分,验证软件包及其版本。
如需更新现有项目的 package
,请按以下步骤操作:
如果您要从 9.0.0 之前的版本升级,则必须在升级后移除以下依赖项:
GoogleMapsBase
、GoogleMapsCore
和GoogleMapsM4B
。请勿移除GoogleMaps
的依赖项。如需了解详情,请参阅版本 9.0.0 版本说明。在您的 Xcode 项目配置设置中,找到框架、库和嵌入式内容。使用减号(-) 移除以下框架:
GoogleMapsBase
(仅适用于从 9.0.0 之前的版本进行的升级)GoogleMapsCore
(仅适用于从 9.0.0 之前的版本进行的升级)GoogleMapsM4B
(仅适用于从 9.0.0 之前的版本进行的升级)
- 在 Xcode 中,转到“File”(文件)>“Packages”(软件包)>“Update To Latest Package Versions”(更新到最新软件包版本)。
- 如需验证安装,请前往 Project Navigator 的 Package Dependencies 部分,验证软件包及其版本。
如需移除使用 CocoaPods
添加的现有 Maps SDK for iOS 依赖项,请按以下步骤操作:
- 关闭 Xcode 工作区。打开终端并执行以下命令:
sudo gem install cocoapods-deintegrate cocoapods-clean pod deintegrate pod cache clean --all
-
如果您不将
Podfile
、Podfile.resolved
和 Xcodeworkspace
用于 CocoaPods 之外的任何其他项目,请移除它们。
-
在您的 Xcode 项目配置设置中,找到框架、库和嵌入式内容。使用减号(-) 移除以下框架:
GoogleMaps
GoogleMapsBase
(仅适用于 9.0.0 之前的安装版本)GoogleMapsCore
(仅适用于 9.0.0 之前的安装版本)GoogleMapsM4B
(仅适用于 9.0.0 之前的安装版本)
-
从 Xcode 项目的顶级目录中,移除
GoogleMaps
软件包。
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 及其依赖项:
- 如果您还没有 Xcode 项目,请立即创建一个并将其保存到您的本地机器。如果您是 iOS 开发新手:
- 创建新项目。
- 依次选择 iOS > App 模板。
- 在项目选项屏幕上:
- 输入项目名称。
- 记录 Bundle identifier 字段的值。 您可以使用该值在下方限制您的 API 密钥。
- 将项目的 Interface 设置为 Storyboard。
- 将语言设置为 Swift 或 Objective-C。
- 在您的项目目录中创建一个名为
Podfile
的文件。此文件可定义您项目的依赖项。 - 修改
Podfile
并添加您的依赖项及其versions。 以下示例包含 Maps SDK for iOS 所需的依赖项:source 'https://github.com/CocoaPods/Specs.git' platform :ios, '15.0' target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleMaps', '8.4.0' end
请务必定期运行pod outdated
以检测何时有更新版本,从而确保您始终使用最新版本。如有必要,请升级到最新版本。 - 保存
Podfile
。 打开终端并转到包含
Podfile
的目录:cd <path-to-project>
运行
pod install
命令。此操作会安装Podfile
中指定的 API 及其可能具有的任何依赖项。pod install
关闭 Xcode,然后打开(双击)您项目的
.xcworkspace
文件以启动 Xcode。从此刻开始,您必须使用.xcworkspace
文件打开项目。
如需更新现有项目的 API,请按以下步骤操作:
- 打开终端,转到包含
Podfile
的项目目录。 - 运行
pod update
命令。这会将Podfile
中指定的所有 API 更新到最新版本。
手动安装
本指南介绍了如何将包含 Maps SDK for iOS 的 XCFrameworks 手动添加到您的项目中,以及如何在 Xcode 中配置您的构建设置。XCFramework 是一个二进制软件包,可在多个平台(包括使用 Apple 芯片的计算机)上使用。- 下载以下 SDK 二进制文件和资源文件:
- 解压缩文件以访问 XCFrameworks 和资源。
- 如果您还没有 Xcode 项目,请立即创建一个并将其保存到您的本地机器。如果您是 iOS 开发新手:
- 创建新项目。
- 依次选择 iOS > App 模板。
- 在项目选项屏幕上:
- 输入项目名称。
- 记录 Bundle identifier 字段的值。 您可以使用该值在下方限制您的 API 密钥。
- 将项目的 Interface 设置为 Storyboard。
- 将语言设置为 Swift 或 Objective-C。
-
打开常规标签页。将以下 XCFrameworks 拖动到项目中的 Frameworks, Libraries and Embedded Content 下。请务必为每个 XCFramework 选择 Do Not Embed:
GoogleMaps.xcframework
GoogleMapsBase.xcframework
GoogleMapsCore.xcframework
-
将您下载的 GoogleMapsResources 中的
GoogleMaps.bundle
复制到 Xcode 项目的顶级目录中。出现提示时,请务必选择 Copy items into destination group's folder。 - 从项目导航器中选择您的项目,然后选择应用的目标。
-
打开应用目标的 Build Phases 标签页。在将二进制文件与库关联中,添加以下框架和库:
Accelerate.framework
Contacts.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
(仅适用于使用 OpenGL)QuartzCore.framework
SystemConfiguration.framework
UIKit.framework
-
选择您的项目(而不是具体的目标),并打开 Build Settings(构建设置)标签页。在 Linking - General -> Other Linker Flags 部分,将
-ObjC
添加到“Debug”和“Release”。如果看不到这些设置,请将“Build Settings”(构建设置)栏中的过滤条件从 Basic(基本)更改为 All(全部)。 -
如需安装 Places SDK for iOS XCFramework,请参阅 Places SDK for iOS 使用入门。
第 3 步:检查 Apple 隐私清单文件
Apple 要求为 App Store 中的应用提供应用隐私权详细信息。如需了解最新动态和更多信息,请访问 Apple App Store 隐私权详情页面。
Apple 隐私清单文件包含在 SDK 的资源包中。如需验证隐私清单文件是否包含在内并检查其内容,请创建应用的归档,并从归档中生成隐私报告。
第 4 步:将您的 API 密钥添加到项目中
在获取 API 密钥部分中,您为应用生成了一个 API 密钥。现在,请将该密钥添加到您的 Xcode 项目中。
在下例中,请将 YOUR_API_KEY
替换为您的 API 密钥。
Swift
按照以下方法向 AppDelegate.swift
添加 API 密钥:
- 添加以下 import 语句:
import GoogleMaps
- 使用您的 API 密钥将以下内容添加到
application(_:didFinishLaunchingWithOptions:)
方法中:GMSServices.provideAPIKey("YOUR_API_KEY")
- 如果您还使用 Places API,请再次添加密钥,如下所示:
GMSPlacesClient.provideAPIKey("YOUR_API_KEY")
Objective-C
按照以下方法向 AppDelegate.m
添加 API 密钥:
- 添加以下 import 语句:
@import GoogleMaps;
- 使用您的 API 密钥将以下内容添加到
application:didFinishLaunchingWithOptions:
方法中:[GMSServices provideAPIKey:@"YOUR_API_KEY"];
- 如果您还使用 Places API,请再次添加密钥,如下所示:
[GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];
第 5 步:添加地图
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 options = GMSMapViewOptions() options.camera = GMSCameraPosition.camera(withLatitude: -33.86, longitude: 151.20, zoom: 6.0) options.frame = self.view.bounds let mapView = GMSMapView(options: options) 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. GMSMapViewOptions *options = [[GMSMapViewOptions alloc] init]; options.camera = [GMSCameraPosition cameraWithLatitude:-33.8683 longitude:151.2086 zoom:6]; options.frame = self.view.bounds; GMSMapView *mapView = [[GMSMapView alloc] initWithOptions:options]; [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
第 5 步(可选):声明 API 使用的网址架构
从 iOS 9 和 Xcode 7 开始,应用可以通过在 Info.plist
文件中指定架构来声明它们打算打开的网址架构。当用户点击地图上的 Google 徽标时,Maps SDK for iOS 会打开 Google 地图移动应用,因此您的应用可以声明相关的网址架构。
如需声明 Maps SDK for iOS 使用的网址架构,请将以下代码行添加到 Info.plist
中:
下面的屏幕截图显示了 Xcode 用户界面中的配置:
如果没有上述声明,当用户点按地图上的 Google 徽标时可能会出现以下错误:
- -canOpen网址:无法运行网址:“comgooglemaps://”- 错误:“此应用无法查询 comgooglemaps 架构”
- -canOpen网址:无法运行网址:“googlechromes://”- 错误:“This app is not allowed to query googlechromes”
为了消除这些错误,请将声明添加到 Info.plist
中。
后续步骤
现在,您已经有了 API 密钥和 Xcode 项目,接下来就可以创建和运行应用了。Navigation SDK for iOS 提供了许多可帮助您入门的教程和示例应用。如需了解详情,请参阅以下文档: