Śledź podróż na Androidzie

Wybierz platformę: Android iOS JavaScript

Podczas śledzenia przejazdu aplikacja dla klienta wyświetla mu lokalizację odpowiedniego pojazdu. Aby to zrobić, aplikacja musi zacząć śledzić podróż, aktualizować postępy w jej trakcie i przestać ją śledzić po jej zakończeniu.

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

Zanim zaczniesz

Upewnij się, że masz skonfigurowane te elementy:

  • Usługi backendu aplikacji dla konsumentów są dostępne, a usługi dopasowywania konsumentów do pojazdów działają.

  • Masz skonfigurowaną mapę dla swojej aplikacji.

Zacznij obserwować podróż

Gdy serwer backenda dopasuje klienta do pojazdu, użyj opcji JourneySharingSession, aby rozpocząć śledzenie podróży za pomocą udostępniania ścieżki.

Ten przykładowy kod pokazuje, jak rozpocząć udostępnianie ścieżek po 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()
  }
}

Zaktualizuj postęp podróży

Aby zaktualizować szczegóły postępu w podróży, np. odległość, jaką musi pokonać pojazd podróży przed przyjazdem i szacunkowej godziny przyjazdu, aplikacja musi: zarejestrować i skonfigurować odbiornik, jak pokazano w poniższych przykładach.

  1. Zarejestruj detektor 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 detektor w podróży, używając usługi 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)
    

Przerwanie obserwowania podróży

Upewnij się, że aplikacja przestaje śledzić podróż, gdy nie jest już potrzebna, na przykład tak, jak gdy kierowca zaznaczy na backendzie podróż jako ZAKOŃCZONO. Zatrzymanie udostępniania trasy zapobiega niepotrzebnym żądaniom sieciowym do Fleet Engine i unikaniu wycieków pamięci.

Użyj aplikacji JourneySharingSession, aby zatrzymać śledzenie podróży zgodnie z instrukcjami na ten przykładowy kod.

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 dotyczących podróży

Metoda onTripRefreshError wyświetla błędy występujące podczas monitorowania podróży. 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 Google Cloud dotyczącej błędów.

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ę podróży. Nazwa podróży musi być zgodna z format: providers/{provider_id}/trips/{trip_id}. provider_id musi być identyfikatorem projektu Cloud należącego do z dostawcą usług.
401 BEZ UWIERZYTELNIANIA Ten błąd występuje, jeśli nie istnieją prawidłowe dane uwierzytelniające. Jeśli na przykład token JWT jest podpisany bez identyfikatora podróży lub tokena JWT wygasła.
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 gdy interfejs API nie jest włączony w projekcie klienta. Być może brakuje tokena JWT lub jest on podpisany za pomocą identyfikatora podróży, nie pasuje do żądanego identyfikatora podróży.
429 RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub tempo ruchu przekracza limit.
503 PRODUKT NIEDOSTĘPNY Usługa niedostępna Zwykle serwer jest niedostępny.
504 DEADLINE_EXCEEDED Przekroczono termin prośby. 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 nie wystarcza na przetworzenie żądania przez serwer) i żądanie nie zostało ukończone w terminie.

Obsługa błędów Consumer SDK

Pakiet SDK Consumer SDK wysyła do aplikacji konsumenta błędy aktualizacji podróży za pomocą wywołania zwrotnego . Parametr wywołania zwrotnego jest typem zwrotu specyficznym dla platformy ( TripUpdateError na Androidzie oraz NSError w systemie iOS).

Wyodrębnianie kodów stanu

Błędy przekazywane do wywołania zwrotnego są zwykle błędami gRPC. Możesz również wyodrębnienia z nich dodatkowych informacji w postaci kodu stanu. W przypadku wartości pełna lista kodów stanu, zob. Kody stanu i ich zastosowania w gRPC.

Java

Możesz wyodrębnić kod stanu gRPC zawierający szczegółowe informacje o błędzie od: TripUpdateError zwróconych przez: onTripUpdateError().

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

Kotlin

Możesz wyodrębnić kod stanu gRPC zawierający szczegółowe informacje o błędzie od: TripUpdateError zwróconych przez: onTripUpdateError().

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

Zinterpretuj kody stanu

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

Błędy serwera i sieci

Podane niżej kody stanu dotyczą błędów sieci lub serwera. Nie musisz podejmować żadnych działań, aby je rozwiązać. Pakiet SDK klienta automatycznie dochodzi do regeneracji.

Kod stanuOpis
ANULOWANO Serwer przestał wysyłać odpowiedź. Przyczyną tej sytuacji jest zwykle problem z serwerem.
ANULOWANO Serwer zakończył odpowiedź wychodzącą. To normalne ma miejsce, gdy
aplikacja jest wysyłana w tle lub po zmianie stanu
Aplikacja dla klientów indywidualnych.
PRZERWANY
DEADLINE_EXCEEDED Oczekiwanie na odpowiedź serwera trwało zbyt długo.
PRODUKT NIEDOSTĘPNY Serwer był niedostępny. Zwykle jest to spowodowane problemem z siecią.

Błędy klienta

Poniższe kody stanu dotyczą błędów po stronie klienta. Aby je naprawić, musisz podjąć odpowiednie działania. Pakiet SDK dla konsumentów będzie nadal próbować odświeżyć podróż, dopóki nie zakończysz udostępniania podróży, ale nie odzyska jej stanu, dopóki nie podejmiesz działań.

Kod stanuOpis
INVALID_ARGUMENT Aplikacja konsumenta podała nieprawidłową nazwę podróży. Nazwa podróży musi musi mieć format providers/{provider_id}/trips/{trip_id}.
NOT_FOUND Podróż nie została utworzona.
PERMISSION_DENIED Aplikacja konsumenta ma niewystarczające uprawnienia. Ten błąd występuje, gdy:
  • Aplikacja konsumenta nie ma uprawnień
  • Pakiet Consumer SDK nie jest włączony w przypadku projektu w konsoli Google Cloud.
  • Brak tokena JWT lub jest on nieprawidłowy.
  • Token JWT jest podpisany za pomocą identyfikatora podróży, który nie pasuje do identyfikatora podróży wybrana podróż.
RESOURCE_EXHAUSTED Limit zasobu wynosi 0 lub szybkość przepływu danych przekracza limit prędkości.
UNAUTHENTICATED Uwierzytelnianie nie powiodło się z powodu nieprawidłowego tokena JWT. Ten błąd występuje, gdy token JWT jest podpisany bez identyfikatora podróży lub gdy jego ważność wygasła.