Bắt đầu với SDK trình điều khiển dành cho iOS

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 dành cho người lái xe. SDK này chịu trách nhiệm cập nhật Fleet Engine về vị trí, tuyến đường, quãng đường còn lại và giờ đến dự kiến của người lái xe. SDK này cũng tích hợp với SDK Điều hướng, cung cấp hướng dẫn chỉ đường từng chặng cho người lái.

Yêu cầu tối thiểu về hệ thống

  • Thiết bị di động phải chạy iOS 13 trở lên.
  • Xcode phiên bản 14 trở lên.
  • Điều kiện tiên quyết

    Hướng dẫn này giả định ứng dụng của bạn đã triển khai SDK điều hướng, cũng như đã thiết lập và sử dụng được phần phụ trợ Fleet Engine. Tuy nhiên, mã ví dụ cung cấp một mẫu về 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 và Lấy khoá API.

    Nhận quyền khiếu nại

    Nếu bạn là khách hàng Google Workspace, hãy tạo một Nhóm Workspace, chẳng hạn như google-maps-platform-sdk-users@workspacedomain.com trong quy trình giới thiệu và cung cấp tên cho Google. Đây là phương pháp được đề xuất. Sau đó, Workspace Group sẽ được thêm vào danh sách cho phép để cấp quyền truy cập vào đúng kho lưu trữ CocoaPods. Xác nhận rằng những email người dùng và email tài khoản dịch vụ cần quyền truy cập đều có trong danh sách này.

    Nếu tổ chức của bạn không thể tạo Nhóm Workspace, hãy gửi cho Google danh sách email tài khoản người dùng và tài khoản dịch vụ cần quyền truy cập vào các cấu phần phần mềm này.

    Phát triển cục bộ

    Để phát triển ứng dụng cục bộ, bạn chỉ cần đăng nhập bằng SDK Cloud.

    gcloud

    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ính năng tích hợp liên tục)

    Thiết lập máy chủ tự động hoá theo các phương pháp hay nhất:

    • Nếu quy trình của bạn chạy trong một môi trường Google Cloud, hãy sử dụng tính năng phát hiện thông tin đăng nhập tự động.

    • 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ủ và đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS một cách thích hợp.

    Email tài khoản dịch vụ liên kết với thông tin xác thực phải là thành viên của Workspace Goup.

    Cấu hình dự án

    Bạn có thể định cấu hình SDK trình điều khiển bằng CocoaPods.

    Sử dụng 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ở cửa sổ dòng lệnh và chạy lệnh sau. shell sudo gem install cocoapods Hãy tham khảo Hướng dẫn bắt đầu sử dụng CocoaPods để biết thêm thông tin.
    1. Tạo một Podfile cho SDK trình điều khiển và dùng nó để cài đặt API và các phần phụ thuộc của API đó: Tạo một tệp có tên là Podfile trong thư mục dự án của bạ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. Dưới đây là ví dụ bao gồm các phần phụ thuộc:

      source "https://github.com/CocoaPods/Specs.git"
      
      target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
        pod 'GoogleRidesharingDriver'
      end
      
    2. Lưu Podfile. Mở cửa sổ dòng lệnh rồi chuyển đến thư mục chứa Podfile:

      cd <path-to-project>
      
    3. Chạy lệnh nhóm cài đặt. 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 mà các API đó có thể có.

      pod install
      
    4. Đóng Xcode, sau đó mở (nhấp đúp) tệp .xcworkspace của dự án để 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.

    Phiên bản SDK Alpha/Beta

    Để định cấu hình phiên bản Alpha hoặc Beta của SDK trình điều khiển cho iOS, 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ở cửa sổ dòng lệnh và chạy lệnh sau.

      sudo gem install cocoapods
      

      Vui lòng tham khảo Hướng dẫn bắt đầu sử dụng CocoaPods để biết thêm thông tin.

    • Tài khoản phát triển của bạn trong danh sách truy cập của Google. Kho lưu trữ nhóm của phiên bản Alpha và Beta của SDK không phải là nguồn công khai. Để truy cập vào các phiên bản đó, hãy liên hệ với Kỹ sư khách hàng của Google. Kỹ sư này thêm tài khoản phát triển của bạn vào danh sách truy cập, sau đó đặt cookie để xác thực.

    Sau khi dự án của bạn có trong danh sách truy cập, bạn có thể truy cập vào nhóm.

    1. Tạo một Podfile cho SDK trình điều khiển dành cho iOS và sử dụng nó để cài đặt API và các phần phụ thuộc của API đó: Tạo một tệp có tên Podfile trong thư mục dự án của bạ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. Dưới đây là ví dụ bao gồm các 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
      
    2. Lưu Podfile. Mở cửa sổ dòng lệnh rồi chuyển đến thư mục chứa Podfile:

      cd <path-to-project>
      
    3. Chạy lệnh nhóm cài đặt. 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 mà các API đó có thể có.

      pod install
      
    4. Đóng Xcode, sau đó mở (nhấp đúp) tệp .xcworkspace của dự án để 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.

    Cài đặt XCFramework

    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 chipset M1. Hướng dẫn này cho bạn biết cách thêm thủ công XCFramework có chứa SDK trình điều khiển vào dự án và định cấu hình các chế độ cài đặt bản dựng trong Xcode.

    Tải tệp nhị phân SDK và các tài nguyên xuống:

    1. Giải nén các tệp nén để truy cập vào XCFramework và các tài nguyên.

    2. Khởi động Xcode rồi mở một dự án hiện có hoặc tạo một dự án mới. Nếu bạn mới sử dụng iOS, hãy tạo một dự án mới và chọn mẫu Ứng dụng iOS.

    3. Hãy tạo một nhóm Khung trong nhóm dự án của bạn nếu chưa có.

    4. Kéo tệp gRPCCertificates.bundle đã tải xuống vào thư mục cấp cao nhất của dự án Xcode. Khi được nhắc, hãy chọn Sao chép các mục nếu cần.

    5. Để cài đặt SDK trình điều khiển, hãy kéo tệp GoogleRidesharingDriver.xcframework vào dự án của bạn trong phần Frameworks, Libraries and Embedded Content (Chương trình 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.

    6. Kéo GoogleRidesharingDriver.bundle đã tải xuống vào thư mục cấp cao nhất của dự án Xcode. Khi được nhắc, hãy chọn Copy items if needed.

    7. Chọn dự án của bạn từ Project Navigator rồi chọn mục tiêu của ứng dụng.

    8. Mở thẻ Build Phases (Giai đoạn bản 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
    9. Chọn dự án của bạn thay vì một mục tiêu cụ thể rồi mở thẻ Build Settings (Cài đặt bản dựng). Trong mục 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 bộ lọc trong thanh Cài đặt bản dựng từ Cơ bản thành Tất cả.

    Triển khai quá trình uỷ quyền và xác thực

    Khi ứng dụng Driver tạo và gửi bản cập nhật đến phần phụ trợ Fleet Engine, các yêu cầu phải bao gồm mã truy cập hợp lệ. Để cho phép 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 của bạn tuân theo giao thức GMTDAuthorization. Đối tượng này 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 chọn cách tạo mã thông báo. Quá trình triển khai của bạn sẽ cung cấp khả năng thực hiện những việc sau:

    • Tìm nạp một mã truy cập, có thể ở định dạng JSON, 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.
    • Hãy làm mới mã thông báo khi hết hạn.

    Để biết thông tin chi tiết về mã thông báo mà máy chủ Fleet Engine dự kiến, hãy xem phần 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 Fleet Engine Deliveries API để biết thêm thông tin.

    Ví dụ sau đây triển khai 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

    Để tải một thực thể GMTDDeliveryVehicleReporter, trước tiên, bạn cần tạo một thực thể GMTDDeliveryDriverAPI bằng cách sử dụng providerID, vehicleID, DriveContext và accessTokenProvider. Mã nhà cung cấp này giống với Mã dự án trên Google Cloud. Bạn có thể truy cập trực tiếp vào thực thể GMTDDeliveryVehicleReporter 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];
    }
    

    Nghe các sự kiện VehicleReporter (không bắt buộc)

    GMTDDeliveryVehicleReporter cập nhật xe định kỳ khi locationTrackingEnabled là CÓ. Để phản hồi các bản cập nhật định kỳ này, mọi đối tượng đều 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ề vị trí và trạng thái của xe.

    • vehicleReporter:didFailVehicleUpdate:withError

      Thông báo cho người nghe rằng không cập nhật được xe. Miễn là bạn bật tính năng theo dõi vị trí, GMTDDeliveryVehicleReporter sẽ tiếp tục gửi dữ liệu mới nhất đến phần phụ trợ 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 trên GMTDDeliveryVehicleReporter. Sau đó, GMTDDeliveryVehicleReporter sẽ = tự động gửi thông tin cập nhật vị trí. Khi GMSNavigator ở chế độ điều hướng (khi đích đến được đặt thông qua setDestinations) và locationTrackingEnabled được đặt thành YES, GMTDDeliveryVehicleReporter cũng sẽ tự động gửi thông tin cập nhật về tuyến đường và ETA.

    Tuyến đường được thiết lập trong các nội dung cập nhật đó sẽ giống với tuyến đường mà người lái xe đang di chuyển đến trong phiên chỉ đường. Do đó, để tính năng theo dõi quá trình vận chuyển hoạt động đúng cách, điểm tham chiếu được đặt thông qua -setDestinations:callback: phải khớp với điểm đến đã đặt trong phần phụ trợ Fleet Engine.

    Ví dụ sau đây 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 bạn có thể thay đổi khoảng thời gian báo cáo này bằng locationUpdateInterval. Khoảng thời gian tối thiểu được hỗ trợ cho việc cập nhật là 5 giây. Khoảng thời gian tối đa được hỗ trợ cho việc cập nhật là 60 giây. Việc cập nhật thường xuyên hơn có thể khiến các yêu cầu và lỗi bị chậm hơn.

    Tắt thông tin cập nhật vị trí

    Ứ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 ca làm việc của người lái xe kết thúc, ứng dụng của bạn có thể đặt locationTrackingEnabled thành NO.

      _vehicleReporter.locationTrackingEnabled = NO
    

    Xử lý lỗi update_mask

    Khi GMTDDeliveryVehicleReporter gửi bản cập nhật xe, lỗi update_mask có thể xảy ra khi mặt nạ trống và thường xảy ra trong lần cập nhật đầu tiên sau khi khởi động. Ví dụ sau đây cho thấy cách xử lý lỗi này:

    Swift

    import GoogleRidesharingDriver
    
    class VehicleReporterListener: NSObject, GMTDVehicleReporterListener {
      func vehicleReporter(
        _ vehicleReporter: GMTDVehicleReporter,
        didFail vehicleUpdate: GMTDVehicleUpdate,
        withError error: Error
      ) {
        let fullError = error as NSError
        if let innerError = fullError.userInfo[NSUnderlyingErrorKey] as? NSError {
          let innerFullError = innerError as NSError
          if innerFullError.localizedDescription.contains("update_mask cannot be empty") {
            emptyMaskUpdates += 1
            return
          }
        }
        failedUpdates += 1
      }
    
      override init() {
        emptyMaskUpdates = 0
        failedUpdates = 0
      }
    }
    
    

    Objective-C

    #import "VehicleReporterListener.h"
    #import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
    
    @implementation VehicleReporterListener {
      NSInteger emptyMaskUpdates = 0;
      NSInteger failedUpdates = 0;
    }
    
    - (void)vehicleReporter:(GMTDVehicleReporter *)vehicleReporter
      didFailVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate
                 withError:(NSError *)error {
      for (NSError *underlyingError in error.underlyingErrors) {
        if ([underlyingError.localizedDescription containsString:@"update_mask cannot be empty"]) {
          emptyMaskUpdates += 1;
          return;
        }
      }
      failedUpdates += 1
    }
    
    @end