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

Ten dokument wyjaśnia, jak działa ten proces.

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

  • W swojej aplikacji masz skonfigurowaną mapę.

Rozpoczęcie śledzenia podróży

Gdy serwer backendu dopasuje klienta do pojazdu, użyj opcji JourneySharingSession, aby rozpocząć śledzenie podróży.

Poniższy przykładowy kod pokazuje, jak rozpocząć śledzenie przejazdu po załadowaniu 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()
  }
}

Aktualizacja postępu podróży

Aby aktualizować szczegóły postępu podróży, takie jak odległość, jaką pojazd musi pokonać przed przybyciem, oraz przewidywany czas przybycia, aplikacja musi zarejestrować i skonfigurować listenera w sposób pokazany w tych przykładach.

  1. Zarejestruj detektor zdarzeń 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 słuchacza na potrzeby swojej podróży 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)
    

Przerwanie obserwowania podróży

Upewnij się, że aplikacja przestaje śledzić przejazd, gdy nie jest już potrzebna, np. gdy przejazd został oznaczony przez kierowcę jako ZAMKNIĘTY. Zatrzymanie udostępniania trasy zapobiega wysyłaniu niepotrzebnych żądań sieciowych do Fleet Engine i zapobiega wyciekom pamięci.

Aby przestać śledzić podróż, użyj elementu JourneySharingSession, jak pokazano w poniższym 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 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 mieć format providers/{provider_id}/trips/{trip_id}. Parametr provider_id musi być identyfikatorem projektu Cloud należącego do dostawcy usługi.
401 UNAUTHENTICATED Ten błąd pojawia się, gdy nie ma prawidłowych danych logowania. Jeśli na przykład token JWT jest podpisany bez identyfikatora podróży lub 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 gdy interfejs API nie jest włączony w projekcie klienta. Token JWT może być nieobecny lub podpisany za pomocą identyfikatora podróży, który nie pasuje do żądanego identyfikatora podróży.
429 RESOURCE_EXHAUSTED Limit zasobu jest na poziomie 0 lub natężenie ruchu przekracza limit.
503 PRODUKT NIEDOSTĘPNY Usługa niedostępna Zwykle serwer jest niedostępny.
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 nie wystarcza na przetworzenie żądania przez serwer) i żądanie nie zostało ukończone w terminie.

Obsługa błędów Consumer SDK

Pakiet Consumer SDK wysyła błędy aktualizacji podróży do aplikacji konsumenta za pomocą mechanizmu wywołania zwrotnego. Parametr wywołania zwrotnego to typ zwracanych danych, który zależy od platformy (TripUpdateErrorna Androidzie i NSErrorna iOS).

Wyodrębnianie kodów stanu

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

Java

TripUpdateError zwracanego przez onTripUpdateError() możesz wyodrębnić kod stanu gRPC, który zawiera szczegółowe informacje o błędzie.

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

Kotlin

TripUpdateError zwracanego przez onTripUpdateError() możesz wyodrębnić kod stanu gRPC, który zawiera szczegółowe informacje o błędzie.

// 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 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 Consumer SDK automatycznie odzyskuje je z tych plików.

Kod stanuOpis
ABORTED Serwer przestał wysyłać odpowiedź. Zwykle jest to spowodowane problemem na serwerze.
ANULOWANO Serwer zakończył wysyłanie odpowiedzi. Zwykle ma to miejsce, gdy aplikacja
przechodzi do działania w tle lub gdy zmienia się stan aplikacji
konsumenckiej.
PRZERWANY
DEADLINE_EXCEEDED Serwer zbyt długo nie odpowiadał.
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 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 dla konsumenta określiła nieprawidłową nazwę podróży. Nazwa podróży musi mieć format providers/{provider_id}/trips/{trip_id}.
NOT_FOUND Podróż nie została utworzona.
PERMISSION_DENIED Aplikacja dla konsumentów ma niewystarczające uprawnienia. Ten błąd występuje, gdy:
  • Aplikacja dla konsumentów 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 żądanej podróży.
RESOURCE_EXHAUSTED Limit zasobu wynosi 0 lub szybkość przepływu danych przekracza limit prędkości.
UNAUTHENTICATED Żądanie nie zostało uwierzytelnione 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.