Migrationsanleitung für Android Driver SDK 3.0

Das Driver SDK for Android 3.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.

Ä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 Driver SDK Version 3 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.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

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

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

Standortaktualisierungen aktivieren und deaktivieren

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

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Verwenden Sie RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) oder 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.

Fahrzeugstatus auf dem Server festlegen

In früheren Versionen wurde das FleetEngine-Objekt verwendet, um den Fahrzeugstatus festzulegen. Verwende in Driver SDK Version 3 das Objekt RidesharingVehicleReporter, um den Fahrzeugstatus festzulegen:

  RidesharingVehicleReporter reporter = ...;

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

Rufen Sie RidesharingVehicleReporter.disableLocationTracking() auf, um den Fahrzeugstatus auf OFFLINE zu setzen. Fehler beim Aktualisieren des Fahrzeugstatus werden über den optional bereitgestellten StatusListener, der in der DriverContext festgelegt ist, weitergegeben.

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 eine AuthTokenContext als Parameter verwendet. Kunden, die Mitfahrdienste nutzen, müssen sich für den Diensttyp VEHICLE authentifizieren. Dadurch sind Standortberichte und Berichte zum Fahrzeugstatus (online/offline) möglich.

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);
    }
  }
}