Guida alla migrazione dell'SDK Android Driver 3.0

La release Driver SDK for Android 3.0 richiede l'aggiornamento del codice per alcune operazioni. Questa guida illustra le modifiche e cosa devi fare per eseguire la migrazione del codice.

Modifica del nome del pacchetto

Il nome del pacchetto è cambiato da com.google.android.libraries.ridesharing.driver a com.google.android.libraries.mapsplatform.transportation.driver. Aggiorna i riferimenti nel codice.

Inizializzazione dell'SDK

Nelle versioni precedenti, dovevi inizializzare l'SDK di navigazione e quindi ottenere un riferimento alla classe FleetEngine. In Driver SDK v3, inizializza l'SDK come segue:

  1. Ottieni un oggetto Navigator da 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. Crea un oggetto DriverContext, compilando i campi obbligatori.

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

  3. Usa l'oggetto DriverContext per inizializzare *DriverApi.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

  4. Ottieni NavigationVehicleReporter dall'oggetto API. *VehicleReporter estende NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

Attivazione e disattivazione degli aggiornamenti della posizione

Nelle versioni precedenti, dovevi abilitare gli aggiornamenti della località dopo aver ottenuto un riferimento FleetEngine. In Driver SDK v3, attiva gli aggiornamenti delle posizioni come segue:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Per aggiornare l'intervallo di report, utilizza RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) o DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit).

Quando il turno del conducente è terminato, disattiva gli aggiornamenti di posizione e contrassegna il veicolo come offline chiamando il numero NavigationVehicleReporter.disableLocationTracking().

Impostazione dello stato del veicolo sul server

Nelle versioni precedenti, utilizzavi l'oggetto FleetEngine per impostare lo stato del veicolo. Nell'SDK Driver v3, utilizza l'oggetto RidesharingVehicleReporter per impostare lo stato del veicolo:

  RidesharingVehicleReporter reporter = ...;

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

Per impostare lo stato del veicolo su OFFLINE, chiama il numero RidesharingVehicleReporter.disableLocationTracking(). Gli errori di aggiornamento dello stato del veicolo vengono propagati utilizzando l'elemento StatusListener fornito facoltativamente in DriverContext.

Error Reporting con StatusListener

ErrorListener è stato rimosso e combinato con StatusListener, che potrebbe essere definito come segue:

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

Autenticazione con AuthTokenFactory

AuthTokenFactory ora ha un solo metodo, getToken(), che prende un AuthTokenContext come parametro. I client di ridesharing devono eseguire l'autenticazione per il tipo di servizio VEHICLE, che consente la segnalazione della posizione e la generazione di report sullo stato dei veicoli (online/offline).

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