Migrationsanleitung für Android Driver SDK 4.0

Das Driver SDK for Android 4.0 erfordert, dass Sie Ihren Code für bestimmte Vorgänge aktualisieren. In diesem Leitfaden werden die Änderungen und die erforderlichen Schritte für die Migration des Codes beschrieben.

Beim untrusted Treibermodell müssen sich Bereitstellungsclients nur für den Diensttyp VEHICLE authentifizieren, wodurch Standortberichte aktiviert werden. Clients mit einem vertrauenswürdigen Fahrermodell müssen eine Authentifizierung für den Diensttyp TASK bieten, um Methoden zum Melden von Fahrzeughaltestellen in DeliveryVehicleReporter zu aktivieren.

Änderung des Paketnamens

Der Paketname wurde von com.google.android.libraries.ridesharing.driver zu com.google.android.libraries.mapsplatform.transportation.driver geändert. Bitte aktualisieren Sie die Verweise in Ihrem Code.

SDK initialisieren

In früheren Versionen mussten Sie das Navigation SDK initialisieren und dann einen Verweis auf die FleetEngine-Klasse abrufen. Initialisieren Sie das SDK in Version 4 des Driver SDK so:

  1. Ruft ein Navigator-Objekt aus dem NavigationApi ab.

    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. Erstellen Sie ein DriverContext-Objekt und füllen Sie die Pflichtfelder aus.

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

  3. Verwenden Sie das Objekt DriverContext, um *DriverApi zu initialisieren.

    DeliveryDriverApi deliveryDriverApi = DeliveryDriverApi.createInstance(driverContext);

  4. Rufen Sie die NavigationVehicleReporter aus dem API-Objekt ab. *VehicleReporter erweitert NavigationVehicleReporter.

    DeliveryVehicleReporter vehicleReporter = deliveryDriverApi.getDeliveryVehicleReporter();

Standortaktualisierungen aktivieren und deaktivieren

In früheren Versionen konnten Standortaktualisierungen erst nach dem Abrufen einer FleetEngine-Referenz aktiviert werden. Aktivieren Sie in Driver SDK v4 die Standortaktualisierungen so:

DeliveryVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Verwenden Sie DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit), um das Berichtsintervall zu aktualisieren.

Wenn die Schicht des Fahrers beendet ist, deaktiviere die Standortaktualisierungen und markiere das Fahrzeug durch Aufrufen von NavigationVehicleReporter.disableLocationTracking() als offline.

Error Reporting mit StatusListener

ErrorListener wurde entfernt und mit StatusListener kombiniert, die so definiert werden können:

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.
  }
}

Authentifizierung bei AuthTokenFactory

AuthTokenFactory hat jetzt nur noch eine Methode, getToken(), die AuthTokenContext als Parameter verwendet.

class JsonAuthTokenFactory implements AuthTokenFactory {
  // Initially null.
  private String vehicleServiceToken;
  // Initially null. Only used in the trusted driver model to authenticate
  // vehicle-stop reporting.
  private String taskServiceToken;
  private long expiryTimeMs = 0;

  // This method is called on a thread that only sends location updates (and
  // vehicle stop updates if you choose to report them). Blocking is OK, but just
  // know that no 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 if (ServiceType.TASK.equals(authTokenContext.getServiceType())) {
      // Only used for the trusted driver model to access vehicle-stop reporting
      // methods in DeliveryVehicleReporter.
      return taskServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

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

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

      // 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 DriverContext class will be notified and passed along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}

Liste „Task“ wird zu „TaskInfo“-Liste

Die Liste Task wurde durch die Liste TaskInfo in VehicleStop ersetzt. Das folgende Codebeispiel zeigt, wie ein VehicleStop-Objekt erstellt wird.

VehicleStop vehicleStop = VehicleStop.builder()
    .setTaskInfoList(taskInfoList)
    .setWaypoint(waypoint)
    .setVehicleStopState(vehicleStopState)
    .build();