Следите за поездкой на Android

Когда вы отслеживаете поездку, ваше приложение для пользователей отображает местоположение соответствующего транспортного средства. Для этого вашему приложению необходимо начать отслеживать поездку, обновлять информацию о ходе поездки и остановить отслеживание по ее завершении.

В этом документе описывается, как работает этот процесс.

Прежде чем начать

Убедитесь, что вы настроили следующие параметры:

• Серверная часть вашего потребительского приложения настроена, и служба сопоставления потребителей с транспортными средствами работает исправно.

• Вы создали карту для своего приложения.

Начните следить за путешествием

Когда ваш бэкэнд-сервер сопоставляет потребителя с транспортным средством, используйте JourneySharingSession , чтобы начать отслеживать поездку.

Приведенный ниже пример кода демонстрирует, как начать отслеживать маршрут после загрузки страницы.

public class MainActivity extends AppCompatActivity
    implements ConsumerViewModel.JourneySharingListener  {

  // Class implementation

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // Create a TripModel instance to listen for updates to the trip specified by this trip name.
    String tripName = ...;
    TripModelManager tripModelManager = consumerApi.getTripModelManager();
    TripModel tripModel = tripModelManager.getTripModel(tripName);

    // Create a JourneySharingSession instance based on the TripModel.
    JourneySharingSession session = JourneySharingSession.createInstance(tripModel);

    // Add the JourneySharingSession instance on the map for updating the UI.
    consumerController.showSession(session);

    // Register for trip update events.
    tripModel.registerTripCallback(new TripModelCallback() {
      @Override
      public void onTripETAToNextWaypointUpdated(
          TripInfo tripInfo, @Nullable Long timestampMillis) {
        // ...
      }

      @Override
      public void onTripActiveRouteRemainingDistanceUpdated(
          TripInfo tripInfo, @Nullable Integer distanceMeters) {
        // ...
      }

      // ...
    });
  }

  @Override
  protected void onDestroy() {
    super.onDestroy();

    if (journeySharingSession != null) {
      journeySharingSession.stop();
    }
  }
}

class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {

  // Class implementation

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    // Create a TripModel instance to listen for updates to the trip specified by this trip name.
    val tripName = "tripName"
    val tripModelManager = consumerApi.getTripModelManager()
    val tripModel = tripModelManager.getTripModel(tripName)

    // Create a JourneySharingSession instance based on the TripModel.
    val session = JourneySharingSession.createInstance(tripModel)

    // Add the JourneySharingSession instance on the map for updating the UI.
    consumerController.showSession(session)

    // Register for trip update events.
    tripModel.registerTripCallback(
      object : TripModelCallback() {
        override fun onTripETAToNextWaypointUpdated(
          tripInfo: TripInfo,
          timestampMillis: Long?,
        ) {
          // ...
        }

        override fun onTripActiveRouteRemainingDistanceUpdated(
          tripInfo: TripInfo,
          distanceMeters: Int?,
        ) {
          // ...
        }

      // ...
    })
  }

  override fun onDestroy() {
    super.onDestroy()

    journeySharingSession?.stop()
  }
}

Обновление информации о ходе поездки.

Для обновления информации о ходе поездки, такой как расстояние, которое транспортное средство должно проехать до прибытия, и расчетное время прибытия, вашему приложению необходимо зарегистрировать и настроить обработчик событий, как показано в следующих примерах.

1. Зарегистрируйте слушатель на объекте TripModel .

   Java

   // Create a TripModel instance for listening to updates to the trip specified by this trip name.
   String tripName = ...;
   TripModelManager tripModelManager = consumerApi.getTripModelManager();
   TripModel tripModel = tripModelManager.getTripModel(tripName);
   
   // Create a JourneySharingSession instance based on the TripModel.
   JourneySharingSession session = JourneySharingSession.createInstance(tripModel);
   
   // Add the JourneySharingSession instance on the map for updating the UI.
   consumerController.showSession(session);
   
   // Register for trip update events.
   tripModel.registerTripCallback(new TripModelCallback() {
   @Override
   public void onTripETAToNextWaypointUpdated(
           TripInfo tripInfo, @Nullable Long timestampMillis) {
         // ...
   }
   
   @Override
   public void onTripActiveRouteRemainingDistanceUpdated(
           TripInfo tripInfo, @Nullable Integer distanceMeters) {
         // ...
   }
   
   // ...
   });
   

   Котлин

   // Create a TripModel instance for listening to updates to the trip specified by this trip name.
   val tripName = "tripName"
   val tripModelManager = consumerApi.getTripModelManager()
   val tripModel = tripModelManager.getTripModel(tripName)
   
   // Create a JourneySharingSession instance based on the TripModel.
   val session = JourneySharingSession.createInstance(tripModel)
   
   // Add the JourneySharingSession instance on the map for updating the UI.
   consumerController.showSession(session)
   
   // Register for trip update events.
   tripModel.registerTripCallback(
     object : TripModelCallback() {
       override fun onTripETAToNextWaypointUpdated(
         tripInfo: TripInfo,
         timestampMillis: Long?,
       ) {
         // ...
       }
   
       override fun onTripActiveRouteRemainingDistanceUpdated(
         tripInfo: TripInfo,
         distanceMeters: Int?,
       ) {
         // ...
       }
   
     // ...
   })
   

2. Настройте обработчик событий для вашей поездки, используя TripModelOptions .

   Java

   // Set refresh interval to 2 seconds.
   TripModelOptions tripOptions =
         TripModelOptions.builder().setRefreshIntervalMillis(2000).build();
   tripModel.setTripModelOptions(tripOptions);
   

   Котлин

   // Set refresh interval to 2 seconds.
   val tripOptions = TripModelOptions.builder().setRefreshIntervalMillis(2000).build()
   tripModel.setTripModelOptions(tripOptions)
   

Прекратите следить за поездкой

Убедитесь, что ваше приложение прекращает отслеживать поездку, когда она больше не нужна, например, когда водитель отмечает поездку как ЗАВЕРШЕННУЮ на стороне сервера. Прекращение обмена данными о поездках позволяет избежать ненужных сетевых запросов к Fleet Engine и предотвратить утечки памяти.

Используйте JourneySharingSession , чтобы остановить отслеживание поездки, как показано в следующем примере кода.

public class MainActivity extends AppCompatActivity
    implements ConsumerViewModel.JourneySharingListener  {

  // Class implementation

  @Override
  protected void onDestroy() {
    super.onDestroy();

    if (journeySharingSession != null) {
      journeySharingSession.stop();
    }
  }
}

class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {

  // Class implementation

  override fun onDestroy() {
    super.onDestroy()

    journeySharingSession?.stop()
  }
}

Обработка ошибок поездки

Метод onTripRefreshError отображает ошибки, возникающие во время мониторинга поездок. Сообщения об ошибках соответствуют стандарту Google Cloud Errors. Подробные определения сообщений об ошибках и все коды ошибок см. в документации Google Cloud Errors .

Вот некоторые распространенные ошибки, которые могут возникнуть при отслеживании поездок:

Обработка ошибок потребительского SDK

SDK для потребителей отправляет ошибки обновления поездки в приложение потребителя с помощью механизма обратного вызова. Параметр обратного вызова имеет тип возвращаемого значения, специфичный для платформы ( TripUpdateError на Android и NSError на iOS).

Извлечение кодов состояния

Ошибки, передаваемые в функцию обратного вызова, обычно являются ошибками gRPC, и из них также можно извлечь дополнительную информацию в виде кода состояния. Полный список кодов состояния см. в разделе «Коды состояния и их использование в gRPC» .

// Called when there is a trip update error.
@Override
public void onTripUpdateError(TripInfo tripInfo, TripUpdateError error) {
  Status.Code code = error.getStatusCode();
}

// Called when there is a trip update error.
override fun onTripUpdateError(tripInfo: TripInfo, error: TripUpdateError) {
  val code = error.getStatusCode()
}

Интерпретация кодов состояния

Коды состояния охватывают два типа ошибок: ошибки, связанные с сервером и сетью, и ошибки на стороне клиента.

Ошибки сервера и сети

Приведенные ниже коды состояния указывают на ошибки сети или сервера, и вам не нужно предпринимать никаких действий для их устранения. SDK потребителя автоматически восстанавливается после них.

Ошибки клиента

Приведенные ниже коды состояния указывают на ошибки клиента, и для их устранения необходимо принять меры. SDK для потребителей продолжает попытки обновления поездки до тех пор, пока вы не завершите обмен данными о поездке, но процесс не восстановится, пока вы не предпримете необходимые действия.