Śledź podróż na Androidzie

Wybierz platformę: Android iOS JavaScript

Gdy podążasz za podróżą, aplikacja konsumenta wyświetla 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:

  • Dostępne są usługi backendu aplikacji dla użytkowników indywidualnych i usługi dopasowywania konsumentów do pojazdów.

  • W swojej aplikacji skonfiguruj mapę.

Zacznij obserwować podróż

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

Ten przykładowy kod pokazuje, jak rozpocząć śledzenie podróży 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()
  }
}

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

Przestań obserwować podróż

Upewnij się, że aplikacja przestaje śledzić podróż, gdy nie jest już potrzebna, np. gdy kierowca oznaczy podróż jako ZAKOŃCZONO. Zatrzymanie udostępniania podróży pozwala uniknąć zbędnych żądań sieciowych do Fleet Engine i zapobiegać wyciekom pamięci.

Użyj polecenia JourneySharingSession, aby zatrzymać śledzenie podróży zgodnie z tym przykładowym kodem.

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 informuje o błędach, które występują 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 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ę 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. Na przykład jeśli token JWT jest podpisany bez identyfikatora podróży 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 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 zasobów wynosi zero lub tempo ruchu przekracza limit.
503 PRODUKT NIEDOSTĘPNY Usługa niedostępna Serwer zwykle jest niedostępny.
504 DEADLINE_EXCEEDED Przekroczono termin prośby. Ten błąd występuje tylko wtedy, gdy osoba wywołująca ustawi termin krótszy niż domyślny termin metody (czyli żądany termin jest niewystarczający na przetworzenie żądania przez serwer), a żądanie nie zostało ukończone w wyznaczonym terminie.

Obsługa błędów Consumer SDK

Pakiet SDK Consumer SDK wysyła do aplikacji konsumenta błędy aktualizacji podróży 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 wywołania zwrotnego są zwykle błędami gRPC, ale możesz również 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

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

Możesz wyodrębnić kod stanu gRPC zawierający szczegółowe informacje o błędzie z wywołania TripUpdateError zwróconego z 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

Poniższe kody stanu dotyczą błędów sieci lub serwera i nie musisz nic robić, aby je rozwiązać. Pakiet Consumer SDK automatycznie odzyskuje je z tych plików.

Kod stanuOpis
ABORTED Serwer przestał wysyłać odpowiedź. Zazwyczaj jest to spowodowane problemem z serwerem.
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 klienta i musisz podjąć działania, aby je usunąć. Pakiet Consumer SDK będzie ponawiać próby odświeżenia podróży, dopóki nie zakończysz udostępniania informacji o podróży, ale nie przywróci ona tego stanu, dopóki nie podejmiesz odpowiednich działań.

Kod stanuOpis
INVALID_ARGUMENT Aplikacja 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 SDK dla klientów nie jest włączony w projekcie w konsoli Google Cloud.
  • Brakuje 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 token JWT wygasł.