Przewodnik migracji pakietu Android Driver SDK 3.0

Pakiet SDK sterowników na Androida 3.0 wymaga zaktualizowania kodu w przypadku niektórych operacji. Ten przewodnik zawiera informacje o zmianach i o tym, co musisz zrobić, aby przeprowadzić migrację kodu.

Zmiana nazwy pakietu

Nazwa pakietu zmieniła się z com.google.android.libraries.ridesharing.driver na com.google.android.libraries.mapsplatform.transportation.driver. Zaktualizuj odwołania w kodzie.

Inicjowanie pakietu SDK

We wcześniejszych wersjach należało zainicjować pakiet SDK nawigacji, a następnie uzyskać odniesienie do klasy FleetEngine. Zainicjuj pakiet SDK w wersji 3 w ten sposób:

  1. Uzyskaj obiekt Navigator z klasy 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. Utwórz obiekt DriverContext, wypełniając wymagane pola.

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

  3. Użyj obiektu DriverContext do zainicjowania *DriverApi.

    RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

  4. Uzyskaj NavigationVehicleReporter z obiektu interfejsu API. Subskrypcja *VehicleReporter została przedłużona o NavigationVehicleReporter.

    RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();

Włączanie i wyłączanie aktualizacji lokalizacji

We wcześniejszych wersjach należało włączyć aktualizacje lokalizacji po uzyskaniu odwołania do FleetEngine. W pakiecie SDK sterownika w wersji 3 włącz aktualizacje lokalizacji w ten sposób:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Aby zaktualizować częstotliwość raportowania, użyj RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) lub DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit).

Po zakończeniu zmiany kierowcy wyłącz aktualizacje lokalizacji i oznacz pojazd jako offline, dzwoniąc pod numer NavigationVehicleReporter.disableLocationTracking().

Ustawianie stanu pojazdu na serwerze

We wcześniejszych wersjach do ustawiania stanu pojazdu służył obiekt FleetEngine. W pakiecie SDK sterownika w wersji 3 użyj obiektu RidesharingVehicleReporter, aby ustawić stan pojazdu:

  RidesharingVehicleReporter reporter = ...;

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

Aby ustawić stan pojazdu na OFFLINE, wywołaj RidesharingVehicleReporter.disableLocationTracking(). Błędy aktualizacji stanu pojazdu są rozpowszechniane za pomocą opcjonalnie podanego w polu DriverContext parametru StatusListener.

Raportowanie błędów za pomocą obiektu StatusListener

Element ErrorListener został usunięty i połączony z właściwością StatusListener, która może być zdefiniowana w ten sposób:

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

Uwierzytelniam w: AuthTokenFactory

AuthTokenFactory ma teraz tylko 1 metodę – getToken(), która przyjmuje jako parametr AuthTokenContext. Klienci korzystający ze wspólnych przejazdów muszą uwierzytelniać się w przypadku usługi typu VEHICLE, co umożliwia raportowanie lokalizacji i stanu pojazdów (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);
    }
  }
}