Руководство по миграции Android Driver SDK 4.0

Версия Driver SDK для Android 4.0 требует обновления кода для определенных операций. В этом руководстве описываются изменения и то, что вам нужно сделать для переноса кода.

Изменение имени пакета

Имя пакета изменилось с com.google.android.libraries.ridesharing.driver на com.google.android.libraries.mapsplatform.transportation.driver . Пожалуйста, обновите ссылки в вашем коде.

Инициализация SDK

В более ранних версиях вам нужно было инициализировать Navigation SDK, а затем получить ссылку на класс FleetEngine . В Driver SDK v4 инициализируйте SDK следующим образом:

1. Получите объект Navigator из 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. Создайте объект DriverContext , заполнив необходимые поля.

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

3. Используйте объект DriverContext для инициализации *DriverApi .

   RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);
   

4. Получите NavigationVehicleReporter из объекта API. *VehicleReporter расширяет NavigationVehicleReporter .

   RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();
   

Включение и отключение обновления местоположения

В более ранних версиях обновление местоположения можно было включить после получения ссылки FleetEngine . В Driver SDK v4 включите обновление местоположений следующим образом:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Чтобы обновить интервал отчетности, используйте RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) .

Когда смена водителя закончится, отключите обновление местоположения и отметьте транспортное средство как отключенное от сети, вызвав NavigationVehicleReporter.disableLocationTracking() .

Настройка состояния автомобиля на сервере

В более ранних версиях для установки состояния транспортного средства можно было использовать объект FleetEngine . В Driver SDK v4 используйте объект RidesharingVehicleReporter , чтобы установить состояние транспортного средства:

RidesharingVehicleReporter reporter = ...;

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

Чтобы установить состояние транспортного средства в OFFLINE , вызовите RidesharingVehicleReporter.disableLocationTracking() . Ошибки обновления состояния транспортного средства распространяются с помощью дополнительно предоставленного StatusListener установленного в DriverContext .

Отчеты об ошибках с помощью StatusListener

ErrorListener был удален и объединен с StatusListener , который можно определить следующим образом:

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

Аутентификация с помощью AuthTokenFactory

AuthTokenFactory теперь имеет только один метод, getToken() , который принимает AuthTokenContext в качестве параметра. ServiceType устарел. Теперь вам нужно получить заявку только на включенный идентификатор транспортного средства, а не полагаться на 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);
    }
  }
}