Śledź podróż na Androidzie

Wybierz platformę: Android iOS JavaScript

Gdy śledzisz przejazd, aplikacja konsumencka wyświetla użytkownikowi lokalizację odpowiedniego pojazdu. Aby to zrobić, aplikacja musi rozpocząć śledzenie podróży, aktualizować jej postępy i przestać ją śledzić po jej zakończeniu.

W tym dokumencie opisujemy, jak działa ten proces.

Zanim zaczniesz

Upewnij się, że masz skonfigurowane te elementy:

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

  • Skonfigurowano mapę w aplikacji.

Rozpoczynanie śledzenia podróży

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

Poniższy 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()
  }
}

Aktualizowanie postępów podróży

Aby aktualizować szczegóły postępów w podróży, takie jak odległość, jaką pojazd musi pokonać do przyjazdu, i szacowany czas przyjazdu, aplikacja musi zarejestrować i skonfigurować odbiornik, jak pokazano w przykładach poniżej.

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

Przestawanie obserwowania podróży

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 trasy zapobiega niepotrzebnym żądaniom sieciowym wysyłanym do Fleet Engine i wyciekom pamięci.

Aby przestać śledzić podróż, użyj 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 przejazdu

Metoda onTripRefreshError zgłasza 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ę wycieczki. Nazwa wycieczki musi mieć format providers/{provider_id}/trips/{trip_id}. provider_id musi być identyfikatorem projektu w Google Cloud należącego do dostawcy usług.
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 przejazdu lub wygasł.
403 PERMISSION_DENIED Ten błąd pojawia się, gdy klient nie ma wystarczających uprawnień (np. użytkownik z rolą konsumenta próbuje wywołać funkcję 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 identyfikatorem przejazdu, który nie pasuje do żądanego identyfikatora przejazdu.
429 RESOURCE_EXHAUSTED Limit zasobu wynosi zero lub natężenie ruchu przekracza limit.
503 PRODUKT NIEDOSTĘPNY 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 ustawi termin krótszy niż domyślny termin metody (czyli żądany termin jest niewystarczający, aby serwer mógł przetworzyć żądanie), a żądanie nie zostało zakończone w tym terminie.

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

Pakiet Consumer SDK wysyła błędy aktualizacji przejazdu do aplikacji konsumenckiej za pomocą mechanizmu wywołania zwrotnego. Parametr wywołania zwrotnego to typ zwracany 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

Z wartości TripUpdateError zwróconej 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

Z wartości TripUpdateError zwróconej 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

Poniższe kody stanu oznaczają błędy sieci lub serwera, więc nie musisz podejmować żadnych działań, aby je rozwiązać. Pakiet Consumer SDK automatycznie przywraca działanie po wystąpieniu tych błędów.

Kod stanuOpis
PRZERWANO Serwer przestał wysyłać odpowiedź. Zwykle jest to spowodowane problemem z serwerem.
ANULOWANO Serwer zakończył wychodzącą odpowiedź. Zwykle dzieje się tak, gdy

aplikacja przechodzi do działania w tle lub gdy w aplikacji konsumenckiej następuje zmiana stanu.
PRZERWANE
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 oznaczają błędy klienta, które musisz naprawić. Pakiet SDK dla konsumentów będzie ponawiać próbę odświeżenia podróży, dopóki nie zakończysz udostępniania podróży, ale nie będzie działać prawidłowo, dopóki nie podejmiesz odpowiednich działań.

Kod stanuOpis
INVALID_ARGUMENT Aplikacja konsumencka podała nieprawidłową nazwę przejazdu. Nazwa przejazdu musi być w formacie providers/{provider_id}/trips/{trip_id}.
NOT_FOUND Podróż nie została utworzona.
PERMISSION_DENIED Aplikacja konsumencka ma niewystarczające uprawnienia. Ten błąd występuje, gdy:
  • Aplikacja konsumencka 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 identyfikatorem przejazdu, który nie pasuje do żądanego przejazdu.
RESOURCE_EXHAUSTED Limit zasobów wynosi zero lub szybkość przepływu ruchu 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 przejazdu lub gdy token JWT wygasł.