Как следить за поездкой на устройстве 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) {
         // ...
   }
   
   // ...
   });
   

   Kotlin

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

   Kotlin

   // 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 Error. Подробные определения сообщений об ошибках и все коды ошибок приведены в документации по ошибкам Google Cloud.

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

Обработка ошибок Consumer SDK

Consumer 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()
}

Как интерпретировать коды статуса

Коды статуса охватывают два типа ошибок: ошибки сервера и сети, а также ошибки на стороне клиента.

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

Следующие коды статуса относятся к ошибкам сети или сервера. Вам не нужно предпринимать никаких действий для их устранения. Consumer SDK автоматически восстанавливается после них.

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

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