Guida alla migrazione dell'SDK Android Driver 4.0

La release Driver SDK for Android 4.0 richiede l'aggiornamento del codice per alcune operazioni. Questa guida illustra le modifiche e gli aspetti che dovrai fare per eseguire la migrazione del codice.

Modifica del nome del pacchetto

Il nome del pacchetto è cambiato da Da com.google.android.libraries.ridesharing.driver a com.google.android.libraries.mapsplatform.transportation.driver. Non dimenticare di apporre 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. Nell'SDK Driver v4, 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 e compila i campi obbligatori.

    DriverContext driverContext = DriverContext.builder(application)
        .setProviderId(providerId)
        .setVehicleId(vehicleId)
        .setAuthTokenFactory(authTokenFactory)
        .setNavigator(navigator)
        .setRoadSnappedLocationProvider(
            NavigationApi.getRoadSnappedLocationProvider(application))
        .build();
    
  3. Utilizza 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 attivare gli aggiornamenti della posizione dopo aver ottenuto un riferimento FleetEngine. In Driver SDK v4, abilita aggiornamenti della posizione come segue:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

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

Al termine del turno del conducente, disattiva gli aggiornamenti della 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. In Driver SDK v4, utilizza RidesharingVehicleReporter per impostare lo stato del veicolo:

RidesharingVehicleReporter reporter = ...;

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

Per impostare lo stato del veicolo su OFFLINE, chiama RidesharingVehicleReporter.disableLocationTracking(). Errori aggiornamento dello stato del veicolo vengono propagati utilizzando StatusListener impostato in DriverContext.

Error Reporting con StatusListener

ErrorListener è stato rimosso e combinato con StatusListener, che possono essere definite 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

Ora AuthTokenFactory ha un solo metodo, getToken(), che richiede AuthTokenContext come parametro. L'API ServiceType è stata deprecata. Ora solo una richiesta per l'ID veicolo incluso, anziché fare affidamento ServiceType.

class JsonAuthTokenFactory implements AuthTokenFactory {
  private String token;  // initially null
  private 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(authTokenContext.getVehicleId());
    }
    return token;
  }

  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();
      token = obj.get("Token").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 is notified, and passes along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}