מדריך להעברה של Android Driver SDK 3.0

בגרסה של Driver SDK ל-Android 3.0, צריך לעדכן את הקוד לפעולות מסוימות. במדריך הזה מפורטים השינויים ומה צריך לעשות כדי להעביר את הקוד.

שינוי שם החבילה

שם החבילה השתנה מ-com.google.android.libraries.ridesharing.driver ל-com.google.android.libraries.mapsplatform.transportation.driver. צריך לעדכן את ההפניות בקוד.

אתחול ה-SDK

בגרסאות קודמות, הפעלתם את ה-SDK של הניווט ולאחר מכן קיבלתם הפניה למחלקה FleetEngine. ב-Driver SDK v3, מפעילים את ה-SDK באופן הבא:

  1. מקבלים אובייקט Navigator מה-NavigationApi.

    NavigationApi.getNavigator(
      this, // Activity
      new NavigationApi.NavigatorListener() {
        @Override
        public void onNavigatorReady(Navigator navigator) {
          // Keep a reference to the Navigator (used to configure and start nav)
          this.navigator = navigator;
        }
      }
);

  2. יוצרים אובייקט DriverContext, ומאכלסים את שדות החובה.

    DriverContext driverContext = DriverContext.builder(application)
             .setProviderId(providerId)
             .setVehicleId(vehicleId)
             .setAuthTokenFactory(authTokenFactory)
             .setNavigator(navigator)
             .setRoadSnappedLocationProvider(
                 NavigationApi.getRoadSnappedLocationProvider(application))
             .build()

  3. משתמשים באובייקט DriverContext כדי לאתחל את *DriverApi.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

  4. מקבלים את ה-NavigationVehicleReporter מאובייקט ה-API. תקופת הניסיון של *VehicleReporter נמשכת NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

הפעלה והשבתה של עדכוני מיקום

בגרסאות קודמות, הייתם מפעילים עדכוני מיקום אחרי שקיבלתם את ההפניה FleetEngine. ב-Driver SDK v3, מפעילים את עדכוני המיקום באופן הבא:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

על מנת לעדכן את מרווח הזמן לדיווח, משתמשים ב-RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) או ב-DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit).

בסיום משמרת הנהג, צריך להשבית את עדכוני המיקום ולסמן את הרכב כלא מקוון על ידי התקשרות ל-NavigationVehicleReporter.disableLocationTracking().

הגדרת מצב הרכב בשרת

בגרסאות קודמות צריך להשתמש באובייקט FleetEngine כדי להגדיר את מצב הרכב. בגרסה 3 של Driver SDK, משתמשים באובייקט RidesharingVehicleReporter כדי להגדיר את מצב הרכב:

  RidesharingVehicleReporter reporter = ...;

  reporter.enableLocationTracking();
  reporter.setVehicleState(VehicleState.ONLINE);

כדי להגדיר את מצב הרכב לערך OFFLINE, מתקשרים אל RidesharingVehicleReporter.disableLocationTracking(). שגיאות בעדכון מצב הרכב מופצות באמצעות ה-StatusListener שמופיע במשתנה אופציונלי של DriverContext.

דיווח שגיאה באמצעות StatusListener

השדה ErrorListener הוסר ומשולב עם StatusListener. אפשר להגדיר אותו כך:

class MyStatusListener implements StatusListener {
  /** Called when background status is updated, during actions such as location reporting. */
  @Override
  public void updateStatus(
    StatusLevel statusLevel,
    StatusCode statusCode,
    String statusMsg) {
    // Status handling stuff goes here.
    // StatusLevel may be DEBUG, INFO, WARNING, or ERROR.
    // StatusCode may be DEFAULT, UNKNOWN_ERROR, VEHICLE_NOT_FOUND, 
    // BACKEND_CONNECTIVITY_ERROR, or PERMISSION_DENIED.
  }
}

אימות מול AuthTokenFactory

עכשיו יש ל-AuthTokenFactory רק שיטה אחת, getToken(), שמקבלת AuthTokenContext כפרמטר. לקוחות שמשתמשים לנסיעות משותפות חייבים לבצע אימות לסוג השירות VEHICLE, שמאפשר דיווח על מיקום ודיווח על מצב הרכב (אונליין או לא מקוון).

class JsonAuthTokenFactory implements AuthTokenFactory {
  String vehicleServiceToken;  // initially null
  long expiryTimeMs = 0;

  // This method is called on a thread whose only responsibility is to send
  // location updates. Blocking is OK, but just know that no location updates
  // can occur until this method returns.
  @Override public String getToken(AuthTokenContext authTokenContext) {
    if (System.currentTimeMillis() > expiryTimeMs) {
      // The token has expired, go get a new one.
      fetchNewToken(vehicleId);
    }
    if (ServiceType.VEHICLE.equals(authTokenContext.getServiceType)) {
      return vehicleServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

  private void fetchNewToken(String vehicleId) {
    String url = "https://yourauthserver.example/token/" + vehicleId;

    try (Reader r = new URL(url).openStream()) {
      com.google.gson.JsonObject obj
          = new com.google.gson.JsonParser().parse(r);
      vehicleServiceToken = obj.get("VehicleServiceToken").getAsString();
      expiryTimeMs = obj.getAsLong("TokenExpiryMs");

      // The expiry time could be an hour from now, but just to try and avoid
      // passing expired tokens, we subtract 10 minutes from that time.
      expiryTimeMs -= 10 * 60 * 1000;
    } catch (IOException e) {
      // It's OK to throw exceptions here, the StatusListener you passed to
      // create the FleetEngine class will be notified and pass along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}