Netzwerkmodus

TanStack Query bietet drei verschiedene Netzwerkmodi, um zu unterscheiden, wie sich Queries und Mutations verhalten sollen, wenn keine Netzwerkverbindung besteht. Dieser Modus kann für jede einzelne Query / Mutation oder global über die Query- / Mutationsstandards eingestellt werden.

Da TanStack Query am häufigsten für das Abrufen von Daten in Kombination mit Datenabrufbibliotheken verwendet wird, ist der Standard-Netzwerkmodus online.

In diesem Modus werden Queries und Mutations nicht ausgeführt, es sei denn, Sie haben eine Netzwerkverbindung. Dies ist der Standardmodus. Wenn eine Abfrage für eine Query initiiert wird, bleibt sie immer im state (pending, error, success), in dem sie sich befindet, wenn der Abruf nicht erfolgen kann, da keine Netzwerkverbindung besteht. Es wird jedoch zusätzlich ein fetchStatus bereitgestellt. Dieser kann entweder sein

• fetching: Die queryFn wird tatsächlich ausgeführt - eine Anfrage ist in Bearbeitung.
• paused: Die Query wird nicht ausgeführt - sie ist paused, bis Sie wieder eine Verbindung haben.
• idle: Die Query ruft nicht ab und ist nicht pausiert.

Die Flags isFetching und isPaused werden aus diesem Status abgeleitet und zur Bequemlichkeit bereitgestellt.

Beachten Sie, dass es möglicherweise nicht ausreicht, den pending-Status zu überprüfen, um eine Ladeanzeige anzuzeigen. Queries können im state: 'pending' sein, aber fetchStatus: 'paused', wenn sie zum ersten Mal gemountet werden und keine Netzwerkverbindung besteht.

Wenn eine Query ausgeführt wird, weil Sie online sind, Sie aber offline gehen, während der Abruf noch stattfindet, wird TanStack Query auch den Wiederholungsmechanismus pausieren. Pausierte Queries werden dann fortgesetzt, sobald Sie die Netzwerkverbindung wiederhergestellt haben. Dies ist unabhängig von refetchOnReconnect (das in diesem Modus ebenfalls standardmäßig auf true gesetzt ist), da es sich nicht um einen refetch, sondern um eine continue handelt. Wenn die Query inzwischen abgebrochen wurde, wird sie nicht fortgesetzt.

In diesem Modus ruft TanStack Query immer ab und ignoriert den Online-/Offline-Status. Dies ist wahrscheinlich der Modus, den Sie wählen möchten, wenn Sie TanStack Query in einer Umgebung verwenden, in der Sie keine aktive Netzwerkverbindung benötigen, damit Ihre Queries funktionieren. z. B. wenn Sie nur aus AsyncStorage lesen, oder wenn Sie einfach nur Promise.resolve(5) aus Ihrer queryFn zurückgeben möchten.

• Queries werden niemals paused, weil Sie keine Netzwerkverbindung haben.
• Wiederholungsversuche werden ebenfalls nicht pausiert - Ihre Query geht in den error-Status, wenn sie fehlschlägt.
• refetchOnReconnect ist standardmäßig false in diesem Modus, da das erneute Herstellen der Verbindung zum Netzwerk kein guter Indikator mehr dafür ist, dass veraltete Queries erneut abgerufen werden sollten. Sie können ihn bei Bedarf trotzdem aktivieren.

Dieser Modus ist der Mittelweg zwischen den ersten beiden Optionen, bei dem TanStack Query die queryFn einmal ausführt, aber dann Wiederholungsversuche pausiert. Dies ist sehr praktisch, wenn Sie einen ServiceWorker haben, der eine Anfrage zur Zwischenspeicherung abfängt, wie in einer Offline-First-PWA, oder wenn Sie HTTP-Caching über den Cache-Control-Header verwenden.

In diesen Situationen kann der erste Abruf erfolgreich sein, da er aus einem Offline-Speicher / Cache stammt. Wenn es jedoch zu einem Cache-Fehler kommt, wird die Netzwerkanfrage gesendet und schlägt fehl, in welchem Fall sich dieser Modus wie eine online-Query verhält - Wiederholungsversuche werden pausiert.

Die TanStack Query Devtools zeigen Queries im Status paused an, wenn sie abrufen würden, aber keine Netzwerkverbindung besteht. Es gibt auch eine Umschaltfläche, um das Offline-Verhalten zu simulieren. Beachten Sie, dass diese Schaltfläche Ihre Netzwerkverbindung nicht tatsächlich beeinflusst (das können Sie in den Browser-Entwicklertools tun), sondern den OnlineManager in einen Offline-Zustand versetzt.

• networkMode: 'online' | 'always' | 'offlineFirst'
  • optional
  • standardmäßig 'online'