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

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

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

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

אתחול ה-SDK

בגרסאות קודמות, הייתם מפעילים את Navigation SDK ולאחר מכן מקבלים הפניה לכיתה FleetEngine. ב-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 גרסה 3, מפעילים עדכוני מיקום באופן הבא:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

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

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

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

בגרסאות קודמות, צריך להשתמש באובייקט FleetEngine כדי להגדיר את מצב הרכב. ב-Driver SDK v3, משתמשים ב אובייקט 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);
    }
  }
}