Obsługa zdarzeń warstwy danych na Wear

Gdy wywołujesz interfejs Data Layer API, po zakończeniu wywołania możesz otrzymać jego stan. Możesz też nasłuchiwać zdarzeń danych wynikających ze zmian danych wprowadzanych przez aplikację w dowolnym miejscu sieci Wear OS by Google.

Przykład skutecznego korzystania z interfejsu Data Layer API znajdziesz w aplikacji Android DataLayer Sample.

Oczekiwanie na stan wywołań warstwy danych

Wywołania interfejsu Data Layer API, np. wywołanie za pomocą metody putDataItem klasy DataClient, czasami zwracają obiekt Task<ResultType>. Gdy tylko obiekt Task zostanie utworzony, operacja jest umieszczana w kolejce w tle. Jeśli po tym nie podejmiesz żadnych działań, operacja zostanie ostatecznie zakończona bez powiadomienia.

Zwykle jednak po zakończeniu operacji chcesz coś zrobić z wynikiem, więc obiekt Task umożliwia oczekiwanie na stan wyniku asynchronicznie lub synchronicznie.

Połączenia asynchroniczne

Jeśli kod jest uruchamiany w głównym wątku interfejsu, nie wykonuj blokujących wywołań interfejsu Data Layer API. Uruchom wywołania asynchronicznie, dodając do obiektu Task metodę wywołania zwrotnego, która jest wywoływana po zakończeniu operacji:

// Using Kotlin function references
task.addOnSuccessListener(::handleDataItem)
task.addOnFailureListener(::handleDataItemError)
task.addOnCompleteListener(::handleTaskComplete)
...
fun handleDataItem(dataItem: DataItem) { ... }
fun handleDataItemError(exception: Exception) { ... }
fun handleTaskComplete(task: Task<DataItem>) { ... }

Więcej możliwości, w tym łączenie wykonywania różnych zadań, znajdziesz w interfejsie Task API.

Połączenia synchroniczne

Jeśli kod jest uruchamiany w osobnym wątku obsługi w usłudze działającej w tle, np. w WearableListenerService, blokowanie wywołań nie stanowi problemu. W takim przypadku możesz wywołać metodę Tasks.await() na obiekcie Task, która blokuje działanie programu do czasu zakończenia żądania i zwraca obiekt Result. Pokazano to w tym przykładzie.

Uwaga: nie wywołuj tej funkcji w głównym wątku.

try {
    Tasks.await(dataItemTask).apply {
        Log.d(TAG, "Data item set: $uri")
    }
}
catch (e: ExecutionException) { ... }
catch (e: InterruptedException) { ... }

Nasłuchiwanie zdarzeń warstwy danych

Warstwa danych synchronizuje i wysyła dane między urządzeniami przenośnymi i do noszenia, więc zwykle musisz nasłuchiwać ważnych zdarzeń, takich jak tworzenie elementów danych i odbieranie wiadomości.

Aby nasłuchiwać zdarzeń warstwy danych, masz 2 możliwości:

W przypadku obu tych opcji zastępujesz metody wywołania zwrotnego zdarzenia danych dla zdarzeń, którymi chcesz się zajmować.

Uwaga: podczas wybierania implementacji odbiornika weź pod uwagę zużycie baterii przez aplikację. WearableListenerService jest zarejestrowany w pliku manifestu aplikacji i może ją uruchomić, jeśli nie jest jeszcze uruchomiona. Jeśli chcesz nasłuchiwać zdarzeń tylko wtedy, gdy aplikacja jest już uruchomiona (co często ma miejsce w przypadku aplikacji interaktywnych), nie używaj znaku WearableListenerService. Zamiast tego zarejestruj detektor na żywo. Na przykład użyj metody addListener klasy DataClient. Może to zmniejszyć obciążenie systemu i zużycie baterii.

Używanie WearableListenerService

Zwykle tworzysz instancje WearableListenerService zarówno w aplikacjach na urządzenia przenośne, jak i na urządzenia do noszenia. Jeśli jednak nie interesują Cię zdarzenia związane z danymi w jednej z aplikacji, nie musisz wdrażać w niej tej usługi.

Możesz na przykład mieć aplikację na urządzenie przenośne, która ustawia i pobiera obiekty elementów danych, oraz aplikację na urządzenie do noszenia, która nasłuchuje tych aktualizacji, aby aktualizować interfejs. Aplikacja na urządzenie do noszenia nigdy nie aktualizuje żadnych elementów danych, więc aplikacja na urządzenie przenośne nie nasłuchuje żadnych zdarzeń danych z aplikacji na urządzenie do noszenia.

Oto niektóre zdarzenia, których możesz nasłuchiwać za pomocą interfejsu WearableListenerService:

  • onDataChanged(): gdy obiekt elementu danych zostanie utworzony, usunięty lub zmieniony, system aktywuje to wywołanie zwrotne we wszystkich połączonych węzłach.
  • onMessageReceived(): wiadomość wysłana z węzła wywołuje to wywołanie zwrotne w węźle docelowym.
  • onCapabilityChanged(): gdy w sieci stanie się dostępna funkcja, którą reklamuje instancja Twojej aplikacji, to zdarzenie wywoła to wywołanie zwrotne. Jeśli szukasz węzła w pobliżu, możesz wysłać zapytanie do metody isNearby() węzłów podanych w wywołaniu zwrotnym.

Możesz też nasłuchiwać zdarzeń z ChannelClient.ChannelCallback, takich jak onChannelOpened().

Wszystkie poprzednie zdarzenia są wykonywane w wątku w tle, a nie w wątku głównym.

Aby utworzyć WearableListenerService, wykonaj te czynności:

  1. Utwórz klasę, która rozszerza klasę WearableListenerService.
  2. Nasłuchuj zdarzeń, które Cię interesują, np. onDataChanged().
  3. Zadeklaruj filtr intencji w pliku manifestu Androida, aby powiadomić system o WearableListenerService. Ta deklaracja umożliwia systemowi powiązanie usługi w razie potrzeby.

Poniższy przykład pokazuje, jak wdrożyć WearableListenerService:

class DataLayerListenerService : WearableListenerService() {

    override fun onDataChanged(dataEvents: DataEventBuffer) {
        if (Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(TAG, "onDataChanged: $dataEvents")
        }

        // Loop through the events and send a message
        // to the node that created the data item.
        dataEvents
            .map { it.dataItem.uri }
            .forEach { uri ->
                // Get the node ID from the host value of the URI.
                val nodeId: String = uri.host!!
                // Set the data of the message to be the bytes of the URI.
                val payload: ByteArray = uri.toString().toByteArray()

                // Send the RPC.
                Wearable.getMessageClient(this)
                    .sendMessage(
                        nodeId,
                        DATA_ITEM_RECEIVED_PATH,
                        payload
                    )
            }
    }
}
DataLayerService.kt

W sekcji poniżej wyjaśniamy, jak używać filtra intencji z tym odbiornikiem.

Używanie filtrów w WearableListenerService

Filtr intencji dla przykładu WearableListenerService z poprzedniej sekcji może wyglądać tak:

<service
    android:name=".snippets.datalayer.DataLayerListenerService"
    android:exported="true"
    tools:ignore="ExportedService" >
    <intent-filter>
        <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
        <data
            android:scheme="wear"
            android:host="*"
            android:path="/start-activity" />
    </intent-filter>
</service>
AndroidManifest.xml

Filtr działania DATA_CHANGED informuje system, że Twoja aplikacja jest zainteresowana zdarzeniami warstwy danych.

W tym przykładzie zegarek nasłuchuje elementu danych /start-activity, a telefon – odpowiedzi na wiadomość /data-item-received (DATA_ITEM_RECEIVED_PATH).

Obowiązują standardowe reguły dopasowywania filtrów Androida. W jednym pliku manifestu możesz określić wiele usług, w jednym filtrze intencji – wiele działań, a w jednym filtrze – wiele sekcji danych. Filtry mogą pasować do hosta z symbolem wieloznacznym lub do konkretnego hosta. Aby dopasować hosta z symbolem wieloznacznym, użyj host="*". Aby dopasować konkretnego hosta, podaj host=<node_id>.

Możesz też dopasować dosłowną ścieżkę lub prefiks ścieżki. Aby to zrobić, musisz określić symbol wieloznaczny lub konkretnego hosta. W przeciwnym razie system zignoruje podaną ścieżkę.

Więcej informacji o typach filtrów obsługiwanych przez Wear OS znajdziesz w dokumentacji interfejsu API WearableListenerService.

Więcej informacji o filtrach danych i regułach dopasowywania znajdziesz w dokumentacji interfejsu API elementu manifestu <data>.

Podczas dopasowywania filtrów intencji pamiętaj o 2 ważnych zasadach:

  • Jeśli w filtrze intencji nie określono schematu, system ignoruje wszystkie inne atrybuty URI.
  • Jeśli w filtrze nie określono hosta, system ignoruje wszystkie atrybuty ścieżki.

Korzystanie z funkcji słuchania na żywo

Jeśli Twoja aplikacja potrzebuje zdarzeń warstwy danych tylko wtedy, gdy użytkownik wchodzi z nią w interakcję, może nie potrzebować długotrwałej usługi do obsługi każdej zmiany danych. W takim przypadku możesz nasłuchiwać zdarzenia w aktywności, implementując co najmniej 1 z tych interfejsów:

Aby utworzyć aktywność, która nasłuchuje zdarzeń związanych z danymi:

  1. Zaimplementuj wymagane interfejsy.
  2. W metodzie onCreate() lub onResume() wywołaj funkcję Wearable.getDataClient(this).addListener(), MessageClient.addListener(), CapabilityClient.addListener() lub ChannelClient.registerChannelCallback(), aby powiadomić usługi Google Play o tym, że Twoja aktywność jest zainteresowana zdarzeniami warstwy danych.
  3. W przypadku onStop() lub onPause() wyrejestruj wszystkie detektory za pomocą DataClient.removeListener(), MessageClient.removeListener(), CapabilityClient.removeListener() lub ChannelClient.unregisterChannelCallback().
  4. Jeśli aktywność ma otrzymywać tylko zdarzenia z określonym prefiksem ścieżki, dodaj odbiornik z filtrem prefiksu, aby otrzymywać tylko dane istotne dla bieżącego stanu aplikacji.
  5. Wdróż metody onDataChanged(), onMessageReceived(), onCapabilityChanged() lub metody z interfejsu ChannelClient.ChannelCallback w zależności od zaimplementowanych interfejsów. Te metody są wywoływane w głównym wątku. Możesz też określić niestandardowy Looper za pomocą WearableOptions.

Oto przykład implementacji elementu DataClient.OnDataChangedListener:

class MainActivity : Activity(), DataClient.OnDataChangedListener {

    public override fun onResume() {
        super.onResume()
        Wearable.getDataClient(this).addListener(this)
    }

    override fun onPause() {
        super.onPause()
        Wearable.getDataClient(this).removeListener(this)
    }

    override fun onDataChanged(dataEvents: DataEventBuffer) {
        dataEvents.forEach { event ->
            if (event.type == DataEvent.TYPE_DELETED) {
                Log.d(TAG, "DataItem deleted: " + event.dataItem.uri)
            } else if (event.type == DataEvent.TYPE_CHANGED) {
                Log.d(TAG, "DataItem changed: " + event.dataItem.uri)
            }
        }
    }
}
DataLayerService.kt

Ostrzeżenie: przed użyciem interfejsu Wearable Data Layer API sprawdź, czy jest on dostępny na urządzeniu. W przeciwnym razie wystąpi wyjątek. Użyj klasy GoogleApiAvailability, tak jak w przypadku klasy Horologist.

Używanie filtrów w przypadku słuchaczy na żywo

Jak wspomnieliśmy wcześniej, tak jak możesz określać filtry intencji dla obiektów WearableListenerServiceopartych na pliku manifestu, możesz używać filtrów intencji podczas rejestrowania aktywnego odbiornika za pomocą Wearable API. Te same reguły obowiązują zarówno w przypadku słuchaczy na żywo korzystających z interfejsu API, jak i słuchaczy korzystających z pliku manifestu.

Często stosuje się wzorzec, w którym detektor jest rejestrowany z określoną ścieżką lub prefiksem ścieżki w metodzie onResume() działania, a następnie usuwany w metodzie onPause() działania. Wdrożenie detektorów w ten sposób pozwala aplikacji bardziej selektywnie odbierać zdarzenia, co poprawia jej projekt i wydajność.