Śledź podróż na Androidzie

Wybierz platformę: Android iOS JavaScript

Gdy śledzisz przejazd, aplikacja użytkownika wyświetla użytkownikowi lokalizację odpowiedniego pojazdu. Aby to zrobić, aplikacja musi rozpocząć śledzenie przejazdu, aktualizować jego postęp i zakończyć śledzenie po jego zakończeniu.

Z tego dokumentu dowiesz się, jak działa ten proces.

Zanim zaczniesz

Upewnij się, że masz skonfigurowane te elementy:

  • Usługi backendu aplikacji użytkownika są skonfigurowane, a usługi dopasowywania użytkowników do pojazdów działają.

  • Masz skonfigurowaną mapę w aplikacji.

Rozpoczęcie śledzenia przejazdu

Gdy serwer backendu dopasuje konsumenta do pojazdu, użyj JourneySharingSession, aby rozpocząć śledzenie przejazdu.

Ten przykładowy kod pokazuje, jak rozpocząć śledzenie przejazdu po wczytaniu widoku.

Java

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

Kotlin

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

Aktualizowanie postępu przejazdu

Aby aktualizować szczegóły postępu przejazdu, takie jak odległość, jaką pojazd musi pokonać przed przyjazdem, i szacowany czas dotarcia, aplikacja musi zarejestrować i skonfigurować detektor, jak pokazano w tych przykładach.

  1. Zarejestruj odbiornik w obiekcie 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. Skonfiguruj odbiornik dla przejazdu za pomocą 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)
    

Zakończenie śledzenia przejazdu

Upewnij się, że aplikacja przestaje śledzić przejazd, gdy nie jest to już potrzebne, np. gdy kierowca oznaczy przejazd jako ZAKOŃCZONY w backendzie. Zatrzymanie udostępniania podróży pozwala uniknąć niepotrzebnych żądań sieciowych do Fleet Engine i zapobiega wyciekom pamięci.

Aby zatrzymać śledzenie przejazdu, użyj JourneySharingSession, jak pokazano w tym przykładowym kodzie.

Java

public class MainActivity extends AppCompatActivity
    implements ConsumerViewModel.JourneySharingListener  {

  // Class implementation

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

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

Kotlin

class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {

  // Class implementation

  override fun onDestroy() {
    super.onDestroy()

    journeySharingSession?.stop()
  }
}

Obsługa błędów przejazdu

Metoda onTripRefreshError wyświetla błędy, które występują podczas monitorowania przejazdu. Komunikaty o błędach są zgodne ze standardem błędów Google Cloud. Szczegółowe definicje komunikatów o błędach i wszystkie kody błędów znajdziesz w dokumentacji błędów Google Cloud.

Oto kilka typowych błędów, które mogą wystąpić podczas monitorowania przejazdu:

HTTP RPC Opis
400 INVALID_ARGUMENT Klient podał nieprawidłową nazwę przejazdu. Nazwa przejazdu musi być w formacie providers/{provider_id}/trips/{trip_id}. provider_id musi być identyfikatorem projektu w chmurze należącego do dostawcy usług.
401 UNAUTHENTICATED Ten błąd występuje, gdy nie ma prawidłowych danych uwierzytelniających. Na przykład jeśli token JWT jest podpisany bez identyfikatora przejazdu lub token JWT wygasł.
403 PERMISSION_DENIED Ten błąd występuje, gdy klient nie ma wystarczających uprawnień (np. użytkownik z rolą konsumenta próbuje wywołać metodę updateTrip), gdy token JWT jest nieprawidłowy lub interfejs API nie jest włączony w projekcie klienta. Token JWT może być nieobecny lub podpisany identyfikatorem przejazdu, który nie pasuje do żądanego identyfikatora przejazdu.
429 RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub natężenie ruchu przekracza limit.
503 UNAVAILABLE Usługa niedostępna. Zwykle serwer nie działa.
504 DEADLINE_EXCEEDED Upłynął termin realizacji żądania. Ten błąd występuje tylko wtedy, gdy wywołujący ustawia termin, który jest krótszy niż domyślny termin metody (czyli żądany termin jest zbyt krótki, aby serwer mógł przetworzyć żądanie), a żądanie nie zostało zakończone w tym terminie.

Obsługa błędów pakietu SDK konsumenta

Pakiet SDK konsumenta wysyła błędy aktualizacji przejazdu do aplikacji użytkownika za pomocą mechanizmu wywołania zwrotnego. Parametr wywołania zwrotnego to zwracany typ specyficzny dla platformy (TripUpdateError na Androidzie i NSError na iOS).

Wyodrębnianie kodów stanu

Błędy przekazywane do wywołania zwrotnego to zwykle błędy gRPC. Możesz też wyodrębnić z nich dodatkowe informacje w postaci kodu stanu. Pełną listę kodów stanu znajdziesz w artykule Kody stanu i ich użycie w gRPC.

Java

Kod stanu gRPC, który zawiera szczegółowe informacje o błędzie możesz wyodrębnić z elementu TripUpdateError zwróconego przez onTripUpdateError().

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

Kotlin

Kod stanu gRPC, który zawiera szczegółowe informacje o błędzie możesz wyodrębnić z elementu TripUpdateError zwróconego przez onTripUpdateError().

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

Interpretowanie kodów stanu

Kody stanu obejmują 2 rodzaje błędów: błędy serwera i sieci oraz błędy po stronie klienta.

Błędy serwera i sieci

Te kody stanu dotyczą błędów sieci lub serwera i nie musisz podejmować żadnych działań, aby je rozwiązać. Pakiet SDK konsumenta automatycznie je naprawia.

Kod stanuOpis
ABORTED Serwer przestał wysyłać odpowiedź. Zwykle jest to spowodowane problemem z serwerem.
CANCELLED Serwer zakończył wychodzącą odpowiedź. Zwykle dzieje się tak, gdy aplikacja jest wysyłana w tle lub gdy następuje zmiana stanu w aplikacji użytkownika.

INTERRUPTED
DEADLINE_EXCEEDED Oczekiwanie na odpowiedź serwera trwało zbyt długo.
UNAVAILABLE Serwer był niedostępny. Zwykle jest to spowodowane problemem z siecią problem.

Błędy klienta

Te kody stanu dotyczą błędów klienta i musisz podjąć działania, aby je rozwiązać. Pakiet SDK konsumenta będzie ponawiać próbę odświeżenia przejazdu, dopóki nie zakończysz udostępniania podróży, ale nie naprawi błędu, dopóki nie podejmiesz działań.

Kod stanuOpis
INVALID_ARGUMENT Aplikacja użytkownika podała nieprawidłową nazwę przejazdu. Nazwa przejazdu musi być w formacie providers/{provider_id}/trips/{trip_id}.
NOT_FOUND Przejazd nigdy nie został utworzony.
PERMISSION_DENIED Aplikacja użytkownika nie ma wystarczających uprawnień. Ten błąd występuje, gdy:
  • aplikacja użytkownika nie ma uprawnień,
  • pakiet SDK konsumenta nie jest włączony w projekcie w Google Cloud Console.
  • token JWT jest nieobecny lub nieprawidłowy,
  • token JWT jest podpisany identyfikatorem przejazdu, który nie pasuje do żądanego przejazdu.
RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub natężenie ruchu przekracza limit.
UNAUTHENTICATED Żądanie nie powiodło się z powodu nieprawidłowego tokena JWT. Ten błąd występuje, gdy token JWT jest podpisany bez identyfikatora przejazdu lub wygasł.