SDK trình điều khiển là một thư viện mà bạn tích hợp vào ứng dụng trình điều khiển. Đó là chịu trách nhiệm cập nhật cho Fleet Engine bằng thông tin về vị trí, tuyến đường, quãng đường còn lại và giờ đến dự kiến. Google Play cũng tích hợp với SDK điều hướng, cung cấp các hướng dẫn điều hướng từng chặng cho người lái xe.
Yêu cầu tối thiểu về hệ thống
Điều kiện tiên quyết
Hướng dẫn này giả định rằng ứng dụng của bạn đã triển khai thành phần Điều hướng SDK và Nhóm Công cụ phần phụ trợ đã được thiết lập và có sẵn. Tuy nhiên, mã ví dụ này cung cấp mẫu cách thiết lập SDK điều hướng.
Bạn cũng phải bật SDK Maps dành cho iOS trong dự án Google Cloud của bạn và Nhận API Khoá.
Phát triển cục bộ
Để phát triển cục bộ, bạn chỉ cần đăng nhập bằng Cloud SDK.
Google Cloud
gcloud auth login
Email dùng để đăng nhập phải là thành viên của Nhóm Workspace.
Tự động hoá (hệ thống xây dựng hoặc tích hợp liên tục)
Thiết lập máy chủ tự động theo các phương pháp hay nhất:
Nếu quy trình của bạn chạy trong môi trường Google Cloud, hãy dùng tự động phát hiện thông tin xác thực.
Nếu không, hãy lưu trữ tệp khoá tài khoản dịch vụ ở một vị trí an toàn trên hệ thống tệp của máy chủ lưu trữ và đặt giá trị GOOGLE_APPLICATION_CREDENTIALS biến môi trường một cách thích hợp.
Email tài khoản dịch vụ được liên kết với thông tin xác thực phải là thành viên của Nhóm Workspace.
Cấu hình dự án
Trình quản lý gói Swift
Có thể cài đặt SDK Trình điều khiển qua Trình quản lý gói Swift. Để thêm SDK, hãy đảm bảo bạn có xoá mọi phần phụ thuộc hiện có của SDK Trình điều khiển.
Để thêm SDK vào dự án mới hoặc dự án hiện có, hãy làm theo các bước sau:
-
Mở Xcode
project
hoặcworkspace
của bạn, sau đó chuyển đến Tệp > Thêm phần phụ thuộc của gói. - Nhập https://github.com/googlemaps/ios-driver-sdk làm URL, nhấn Enter để lấy gói rồi nhấp vào "Add Package" (Thêm gói).
-
Để cài đặt một
version
cụ thể, hãy đặt trường Quy tắc phần phụ thuộc thành một trong các tuỳ chọn dựa trên phiên bản. Đối với các dự án mới, bạn nên chỉ định phiên bản mới nhất và bằng cách sử dụng "Phiên bản chính xác" . Sau khi hoàn tất, hãy nhấp vào "Add Package" (Thêm gói). -
Trong cửa sổ Choose Package Products (Chọn sản phẩm gói), xác minh để đảm bảo
GoogleRidesharingDriver
sẽ được thêm vào mục tiêumain
bạn chỉ định. Sau khi hoàn tất, hãy nhấp vào "Add Package" (Thêm gói). -
Để xác minh chế độ cài đặt của bạn, hãy chuyển đến ngăn
General
của mục tiêu. Trong Khung, Thư viện và Nội dung được nhúng, bạn sẽ thấy các gói đã cài đặt. Bạn cũng có thể xem phần "Phần phụ thuộc của gói" của "Project Navigator" (Trình điều hướng dự án) để xác minh gói và phiên bản của gói.
Để cập nhật package
cho một dự án hiện có, hãy làm theo các bước sau:
Nếu đang nâng cấp từ một phiên bản cũ hơn 9.0.0,bạn phải gỡ bỏ các phần phụ thuộc sau:
GoogleMapsBase
,GoogleMapsCore
vàGoogleMapsM4B
sau khi nâng cấp. Không xoá phần phụ thuộc củaGoogleMaps
. Để biết thêm thông tin, hãy xem Ghi chú phát hành phiên bản 9.0.0.Trong phần cài đặt cấu hình dự án Xcode của bạn, hãy tìm Khung, Thư viện và Nội dung được nhúng. Sử dụng dấu trừ(-) để loại bỏ khung sau:
GoogleMapsBase
(Chỉ dành cho bản nâng cấp từ các phiên bản cũ hơn 9.0.0)GoogleMapsCore
(Chỉ dành cho bản nâng cấp từ các phiên bản cũ hơn 9.0.0)GoogleMapsM4B
(Chỉ dành cho bản nâng cấp từ các phiên bản cũ hơn 9.0.0)
- Từ Xcode, hãy chuyển đến "Tệp > Gói hàng > Hãy cập nhật lên phiên bản gói mới nhất".
- Để xác minh việc cài đặt của bạn, hãy chuyển đến phần Package Dependencies (Phần phụ thuộc gói) của Project Navigator (Trình điều hướng dự án) để xác minh gói và phiên bản của gói.
Cách xoá các phần phụ thuộc hiện có của SDK Trình điều khiển đã thêm bằng cách sử dụng
CocoaPods
, hãy làm theo các bước sau:
- Đóng không gian làm việc Xcode của bạn. Mở terminal và thực thi lệnh sau:
sudo gem install cocoapods-deintegrate cocoapods-clean pod deintegrate pod cache clean --all
-
Xoá
Podfile
,Podfile.resolved
và Xcodeworkspace
nếu bạn không sử dụng chúng cho bất kỳ mục đích nào khác không phải là CocoaPods.
Cách xoá SDK Trình điều khiển đã cài đặt hiện có theo cách thủ công, hãy làm theo các bước sau:
Trong phần cài đặt cấu hình dự án Xcode của bạn, hãy tìm Frameworks, Thư viện và nội dung được nhúng. Dùng dấu trừ
(-)
để xoá khung sau:GoogleRidesharingDriver.xcframework
Từ thư mục cấp cao nhất của dự án Xcode của bạn, hãy xóa Gói
GoogleRidesharingDriver
.
CocoaPods
Để định cấu hình SDK trình điều khiển bằng CocoaPods, bạn cần có các mục sau:
- Công cụ CocoaPods: Để cài đặt công cụ này, hãy mở Terminal và chạy sau đây.
sudo gem install cocoapods
Tạo một Podfile cho SDK trình điều khiển rồi dùng tệp này để cài đặt API và phần phụ thuộc của tệp: Tạo một tệp có tên Podfile trong thư mục dự án. Tệp này xác định các phần phụ thuộc của dự án. Chỉnh sửa Podfile và thêm các phần phụ thuộc. Sau đây là ví dụ về các phần phụ thuộc:
source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' end
Dưới đây là ví dụ bao gồm nhóm Alpha và Beta cho SDK trình điều khiển làm phần phụ thuộc:
source "https://cpdc-eap.googlesource.com/ridesharing-driver-sdk.git" source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' end
Lưu Podfile. Mở cửa sổ dòng lệnh và chuyển đến thư mục chứa Tệp nhóm:
cd <path-to-project>
Chạy lệnh cài đặt nhóm. Thao tác này sẽ cài đặt các API được chỉ định trong Podfile, cùng với mọi phần phụ thuộc có thể có.
pod install
Đóng Xcode rồi mở (nhấp đúp) .xcworkspace của dự án để khởi chạy Xcode. Từ thời điểm này trở đi, bạn phải sử dụng Tệp .xcworkspace để mở dự án.
Hãy tham khảo Hướng dẫn bắt đầu sử dụng CocoaPods hướng dẫn để biết thêm thông tin chi tiết.
Cài đặt theo cách thủ công
XCFramework là một gói nhị phân mà bạn dùng để cài đặt SDK trình điều khiển. Bạn có thể sử dụng gói này trên nhiều nền tảng, bao gồm cả các máy sử dụng Apple silicon. Hướng dẫn này chỉ cho bạn cách thêm XCFramework theo cách thủ công, trong đó chứa Trình điều khiển SDK cho dự án và định cấu hình bản dựng cài đặt trong Xcode.
Tải tệp nhị phân và tài nguyên SDK xuống:
Giải nén các tệp để truy cập vào XCFramework và tài nguyên.
Khởi động Xcode rồi mở một dự án hiện có hoặc tạo một dự án mới dự án. Nếu bạn mới sử dụng iOS, hãy tạo một dự án mới rồi chọn iOS Mẫu ứng dụng.
Tạo một nhóm Khung trong nhóm dự án của bạn nếu chưa có nhóm Khung này rồi.
Để cài đặt SDK Trình điều khiển, hãy kéo
GoogleRidesharingDriver.xcframework
tệp vào dự án của bạn trong Khung, thư viện và nội dung được nhúng. Khi được nhắc, hãy chọn Sao chép các mục nếu cần.Kéo
GoogleRidesharingDriver.bundle
đã tải xuống vào cấp cao nhất của dự án Xcode của bạn. Khi được nhắc, hãy chọnCopy items if needed
.Chọn dự án của bạn trên Project Navigator rồi chọn mục tiêu của ứng dụng.
Mở tab Build Phases (Giai đoạn xây dựng) và trong Link Binary with Libraries (Liên kết nhị phân với Thư viện), hãy thêm các khung và thư viện sau đây nếu chưa có:
Accelerate.framework
AudioToolbox.framework
AVFoundation.framework
CoreData.framework
CoreGraphics.framework
CoreLocation.framework
CoreTelephony.framework
CoreText.framework
GLKit.framework
ImageIO.framework
libc++.tbd
libxml2.tbd
libz.tbd
LocalAuthentication.framework
OpenGLES.framework
QuartzCore.framework
SystemConfiguration.framework
UIKit.framework
WebKit.framework
Chọn dự án của bạn, thay vì mục tiêu cụ thể, rồi mở cửa sổ Build Cài đặt. Trong phần Cờ trình liên kết khác, hãy thêm
-ObjC
cho cả gỡ lỗi và phát hành. Nếu các cài đặt này không hiển thị, hãy thay đổi trong thanh Cài đặt bản dựng từ Cơ bản sang Tất cả.
Kiểm tra tệp kê khai về quyền riêng tư của Apple
Apple yêu cầu thông tin chi tiết về quyền riêng tư đối với các ứng dụng trên App Store. Hãy truy cập trang Thông tin chi tiết về quyền riêng tư trong App Store của Apple để biết thông tin cập nhật và thông tin khác.
Tệp kê khai về quyền riêng tư của Apple có trong gói tài nguyên cho SDK. Để xác minh rằng Tệp kê khai về quyền riêng tư đã được đưa vào tệp kê khai về quyền riêng tư, cũng như để kiểm tra nội dung trong đó, hãy tạo một bản lưu trữ ứng dụng rồi tạo báo cáo về quyền riêng tư trong kho lưu trữ đó.
Triển khai hoạt động uỷ quyền và xác thực
Khi ứng dụng Driver của bạn tạo và gửi bản cập nhật đến phần phụ trợ của Fleet Engine,
yêu cầu phải bao gồm mã truy cập hợp lệ. Để uỷ quyền và
xác thực các yêu cầu này, SDK trình điều khiển sẽ gọi
đối tượng tuân thủ GMTDAuthorization
giao thức. Đối tượng chịu trách nhiệm cung cấp mã truy cập cần thiết.
Là nhà phát triển ứng dụng, bạn sẽ chọn cách tạo mã thông báo. Cách triển khai của bạn sẽ cung cấp khả năng làm những việc sau:
- Tìm nạp mã truy cập (có thể ở định dạng JSON) từ một máy chủ HTTPS.
- Phân tích cú pháp và lưu mã thông báo vào bộ nhớ đệm.
- Làm mới mã thông báo khi mã này hết hạn.
Để biết thông tin chi tiết về các mã thông báo mà máy chủ Fleet Engine dự kiến, hãy xem Tạo Mã thông báo web JSON (JWT) để uỷ quyền.
Mã nhà cung cấp giống với mã dự án trên Google Cloud. Xem Hướng dẫn sử dụng API phân phối Fleet Engine để biết thêm thông tin.
Ví dụ sau đây triển khai một trình cung cấp mã truy cập:
#import "SampleAccessTokenProvider.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
// SampleAccessTokenProvider.h
@interface SampleAccessTokenProvider : NSObject<GMTDAuthorization>
@end
static NSString *const PROVIDER_URL = @"INSERT_YOUR_TOKEN_PROVIDER_URL";
// SampleAccessTokenProvider.m
@implementation SampleAccessTokenProvider{
// The cached vehicle token.
NSString *_cachedVehicleToken;
// Keep track of the vehicle ID the cached token is for.
NSString *_lastKnownVehicleID;
// Keep track of when tokens expire for caching.
NSTimeInterval _tokenExpiration;
}
- (void)fetchTokenWithContext:(nullable GMTDAuthorizationContext *)authorizationContext
completion:(nonnull GMTDAuthTokenFetchCompletionHandler)completion {
if (!completion) {
NSAssert(NO, @"%s encountered an unexpected nil completion.", __PRETTY_FUNCTION__);
return;
}
// Get the vehicle ID from the authorizationContext. This is set by the Driver SDK.
NSString *vehicleID = authorizationContext.vehicleID;
if (!vehicleID) {
NSAssert(NO, @"Vehicle ID is missing from authorizationContext.");
return;
}
// Clear cached vehicle token if vehicle ID has changed.
if (![_lastKnownVehicleID isEqual:vehicleID]) {
_tokenExpiration = 0.0;
_cachedVehicleToken = nil;
}
_lastKnownVehicleID = vehicleID;
// Clear cached vehicle token if it has expired.
if ([[NSDate date] timeIntervalSince1970] > _tokenExpiration) {
_cachedVehicleToken = nil;
}
// If appropriate, use the cached token.
if (_cachedVehicleToken) {
completion(_cachedVehicleToken, nil);
return;
}
// Otherwise, try to fetch a new token from your server.
NSURL *requestURL = [NSURL URLWithString:PROVIDER_URL];
NSMutableURLRequest *request =
[[NSMutableURLRequest alloc] initWithURL:requestURL];
request.HTTPMethod = @"GET";
// Replace the following key values with the appropriate keys based on your
// server's expected response.
NSString *vehicleTokenKey = @"VEHICLE_TOKEN_KEY";
NSString *tokenExpirationKey = @"TOKEN_EXPIRATION";
__weak typeof(self) weakSelf = self;
void (^handler)(NSData *_Nullable data, NSURLResponse *_Nullable response,
NSError *_Nullable error) =
^(NSData *_Nullable data, NSURLResponse *_Nullable response, NSError *_Nullable error) {
typeof(self) strongSelf = weakSelf;
if (error) {
completion(nil, error);
return;
}
NSError *JSONError;
NSMutableDictionary *JSONResponse =
[NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&JSONError];
if (JSONError) {
completion(nil, JSONError);
return;
} else {
// Sample code only. No validation logic.
id expirationData = JSONResponse[tokenExpirationKey];
if ([expirationData isKindOfClass:[NSNumber class]]) {
NSTimeInterval expirationTime = ((NSNumber *)expirationData).doubleValue;
strongSelf->_tokenExpiration = [[NSDate date] timeIntervalSince1970] + expirationTime;
}
strongSelf->_cachedVehicleToken = JSONResponse[vehicleTokenKey];
completion(JSONResponse[vehicleTokenKey], nil);
}
};
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
NSURLSession *mainQueueURLSession =
[NSURLSession sessionWithConfiguration:config delegate:nil
delegateQueue:[NSOperationQueue mainQueue]];
NSURLSessionDataTask *task = [mainQueueURLSession dataTaskWithRequest:request completionHandler:handler];
[task resume];
}
@end
Tạo một thực thể DeliveryDriverAPI
Để nhận một phiên bản GMTDDeliveryVehicleReporter
, trước tiên, bạn cần tạo một
Thực thể GMTDDeliveryDriverAPI
sử dụng providerID
, vehicleID
,
driverContext
và accessTokenProvider
. providerID
giống với
Mã dự án trên Google Cloud. Ngoài ra, bạn có thể truy cập vào GMTDDeliveryVehicleReporter
thực thể trực tiếp từ API trình điều khiển.
Ví dụ sau đây sẽ tạo một thực thể GMTDDeliveryDriverAPI
:
#import "SampleViewController.h"
#import "SampleAccessTokenProvider.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
NSString *vehicleID = @"INSERT_CREATED_VEHICLE_ID";
SampleAccessTokenProvider *accessTokenProvider =
[[SampleAccessTokenProvider alloc] init];
GMTDDriverContext *driverContext =
[[GMTDDriverContext alloc] initWithAccessTokenProvider:accessTokenProvider
providerID:PROVIDER_ID
vehicleID:vehicleID
navigator:_mapView.navigator];
GMTDDeliveryDriverAPI *deliveryDriverAPI = [[GMTDDeliveryDriverAPI alloc] initWithDriverContext:driverContext];
}
Tuỳ ý nghe các sự kiện VehicleReporter (Trình báo cáo xe)
GMTDDeliveryVehicleReporter
cập nhật xe định kỳ khi
locationTrackingEnabled
là CÓ. Để phản hồi những bản cập nhật định kỳ này, bất kỳ
có thể đăng ký các sự kiện GMTDDeliveryVehicleReporter
bằng cách tuân thủ
giao thức GMTDVehicleReporterListener
.
Bạn có thể xử lý các sự kiện sau:
vehicleReporter:didSucceedVehicleUpdate
Thông báo cho ứng dụng Driver rằng các dịch vụ phụ trợ đã nhận được thông tin cập nhật về trạng thái và vị trí của xe.
vehicleReporter:didFailVehicleUpdate:withError
Thông báo cho người nghe biết rằng không cập nhật được xe. Miễn là vị trí đã bật tính năng theo dõi,
GMTDDeliveryVehicleReporter
sẽ tiếp tục gửi dữ liệu mới nhất cho phần phụ trợ của Fleet Engine.
Ví dụ sau đây xử lý các sự kiện này:
SampleViewController.h
@interface SampleViewController : UIViewController<GMTDVehicleReporterListener>
@end
SampleViewController.m
#import "SampleViewController.h"
#import "SampleAccessTokenProvider.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
// ASSUMES YOU IMPLEMENTED HAVE THE SAMPLE CODE UP TO THIS STEP.
[ridesharingDriverAPI.vehicleReporter addListener:self];
}
- (void)vehicleReporter:(GMTDDeliveryVehicleReporter *)vehicleReporter didSucceedVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate {
// Handle update succeeded.
}
- (void)vehicleReporter:(GMTDDeliveryVehicleReporter *)vehicleReporter didFailVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate withError:(NSError *)error {
// Handle update failed.
}
@end
Bật tính năng theo dõi vị trí
Để bật tính năng theo dõi vị trí, ứng dụng của bạn có thể đặt locationTrackingEnabled
thành YES
vào GMTDDeliveryVehicleReporter
. Sau đó GMTDDeliveryVehicleReporter
tự động gửi thông tin cập nhật vị trí. Khi GMSNavigator
đang điều hướng
(khi một điểm đến được đặt thông qua setDestinations
) và
locationTrackingEnabled
được đặt thành YES
, GMTDDeliveryVehicleReporter
đồng thời cũng tự động gửi thông tin cập nhật về tuyến đường và giờ đến dự kiến.
Tuyến đường được đặt trong các lần cập nhật đó giống với tuyến đường của người lái xe
di chuyển đến trong phiên điều hướng. Do đó, để tính năng theo dõi hệ thống thiết bị hoạt động
đúng cách, điểm tham chiếu được đặt qua -setDestinations:callback:
phải khớp với
đích đến được thiết lập trong phần phụ trợ Fleet Engine.
Ví dụ sau đây sẽ bật tính năng theo dõi vị trí:
SampleViewController.m
#import "SampleViewController.h"
#import "SampleAccessTokenProvider.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
// ASSUMES YOU IMPLEMENTED HAVE THE SAMPLE CODE UP TO THIS STEP.
deliveryDriverAPI.vehicleReporter.locationTrackingEnabled = YES;
}
@end
Theo mặc định, khoảng thời gian báo cáo là 10 giây, nhưng khoảng thời gian báo cáo có thể
sẽ được thay đổi bằng locationUpdateInterval
. Khoảng thời gian tối thiểu được hỗ trợ giữa những lần cập nhật
là 5 giây. Khoảng thời gian tối đa được hỗ trợ cho một lần cập nhật là 60 giây. Thường xuyên hơn
thì các bản cập nhật có thể dẫn đến yêu cầu và lỗi chậm hơn.
Tắt tính năng cập nhật vị trí và tải xe không có kết nối mạng
Ứng dụng của bạn có thể tắt tính năng cập nhật vị trí cho xe. Ví dụ: khi một
kết thúc ca làm việc của người lái xe, ứng dụng của bạn có thể đặt locationTrackingEnabled
thành NO
.
_vehicleReporter.locationTrackingEnabled = NO