Search for:

DataStore und synchroner Betrieb. In den folgenden Beiträgen unseres Jetpacks… | von Simona Stojanovic Android-Entwickler Februar 2022

In den nächsten Beiträgen von uns Jetpack DataStore-ReiheWir werden einige zusätzliche Konzepte behandeln, um zu verstehen, wie der DataStore mit anderen APIs kommuniziert, sodass Ihnen alles zur Verfügung steht, um ihn zu verwenden Produktionsumfeld. In diesem Beitrag konzentrieren wir uns besonders auf das Arbeiten Synchronbetrieb mit DataStore. Wir verweisen auf Einstellungen Codelabfür Codebeispiele.

In dieser Serie haben wir den DataStore erwähnt vollständig asynchrone APIdie sich aus der internen Verwendung ergeben Kotlin Korutine und Flow. Um potenzielle ANRs und Verzögerungen der Benutzeroberfläche zu verhindern, wenn schwierige I/O-Operationen auf UI-Threads ausgeführt werden, DataStore bietet keine gebrauchsfertige synchrone Unterstützung. Der DataStore speichert seinen Datensatz in einer Datei und führt alle Datenoperationen unter der Haube durch Dispatchers.IO, Sofern nicht anders angegeben, bleibt Ihr UI-Thread entsperrt. Diese API-Struktur ist eine von Hauptvorteile DataStore im Vergleich zum Vorgänger SharedPreferences und wie man den DataStore in den meisten Fällen verwendet.

Wenn Sie jedoch feststellen, dass Ihr Code erfordert, dass Sie synchron mit dem DataStore arbeiten, sei es, weil Sie von einer anderen API abhängig sind, die im Hauptthread ausgeführt wird, oder weil Ihr aktuelles Setup erfordert, dass Sie einige dauerhafte Werte für UI-Einstellungen abrufen, können Sie dies tun benutzen runBlocking() Programmierer zum Lesen von DataStore synchron. Dieser Wille blockiert den Anruf-Thread bis DataStore zurückkehrt:

Wenn Sie sich in einer Situation befinden, in der Sie diesen Ansatz verwenden müssen, verbringen Sie einige Zeit damit, herauszufinden, ob dies der Fall ist unbedingt notwendig, um den Hauptthread zu blockieren. Überlegen Sie, wie Sie die Lieferung nutzen könnten Asynchrone DataStore-Alternative oder refaktorisieren Sie Ihren aktuellen Code, um dies zu vermeiden runBlocking()zum Beispiel durch asynchrones Laden von Daten im Voraus:

Wenn dies nicht möglich ist, stellen Sie sicher, dass Sie alle potenziellen UI-Jank-Szenarien abdecken, indem Sie Fehler behandeln. Stornierungen und Fristen oder einige nette visuelle Elemente, um die Benutzererfahrung so einfach wie möglich zu machen.

Wir haben behandelt, wie es durchgeführt wird Synchronbetrieb mit DataStore. Obwohl dies kein empfohlener Ansatz für den DataStore ist, können Sie ihn verwenden, wenn Ihre aktuelle Einstellung synchrone Aufrufe erfordert .runBlocking() kombiniert mit .first() Operator.

Begleiten Sie uns für den nächsten Beitrag in der Serie, in dem wir untersuchen, wie es geht DataStore-zu-DataStore-Migration.

DataStore- und Kotlin-Serialisierung von Simona Stojanovic Android-Entwickler Februar 2022

In den nächsten Beiträgen von uns Jetpack DataStore-ReiheWir behandeln einige zusätzliche Konzepte, um zu verstehen, wie der DataStore mit anderen APIs interagiert, sodass Sie alles zur Verfügung haben, um ihn zu verwenden Produktionsumfeld. In diesem Beitrag konzentrieren wir uns auf Kotlin-Serialisierung. Wir verweisen auf Einstellungen ich Proto Codelabs über diesen Beitrag für Codebeispiele.

In unseren vorherigen Beiträgen haben wir geschrieben, wie Einstellungen ich Proto DataStore-Ansatz zur Strukturierung und Serialisierung Ihrer persistenten Daten: Vorteile von Proto typisierte Objekte unterstützt Protokollpuffer, während Einstellungen verwendet Schlüssel/Wert-Paare wie unsere Datenanzeige, ähnlich wie SharedPreferences. Unter der Haube, Beide Implementierungen speichern Daten unter Verwendung von Protokollpuffern auf der Festplatte in einer Datei. Aber der DataStore ermöglicht es Ihnen auch, dies anzupassen und auch Datenklassen zu verwenden Kotlin-Serialisierungdir geben Art des Sicherheitsvorteils Proto DataStore, aber ohne die Notwendigkeit, Protobuffs zu verwenden. Sehen wir uns an, wie die Serialisierung standardmäßig für jeden dieser Ansätze funktioniert:

DataStore-Serialisierungsoptionen

Preferences DataStore vereinfacht die Arbeit mit Protobuffs durch Hinzufügen zusätzliche Schicht zusätzlich zu seiner geringen Proto-Implementierung. Auf diese Weise erhalten Sie es viele Vorteile der Arbeit mit DataStoreaber mit a SharedPreferences-als Mittel zur Strukturierung von Daten verwenden Schlüssel/Wert-Paare.

Wenn wir uns die Preferences API ansehen PreferencesSerializer und unser benutzerdefiniertes ProtoUserPreferencesSerializerSie werden feststellen, dass sie meistens dasselbe tun. PreferencesSerializer es hat nur einen zusätzlichen Transformationsschritt Schlüssel/Wert-Paare in Protobuffs und umgekehrt:

Implementierung von DataStore mit Kotlin-Serialisierung

Wenn Sie verwenden möchten Kotlin-Serialisierung Um Ihre Daten zu strukturieren, müssen Sie lediglich a definieren eine vollständig unveränderliche Datenklasse und einen DataStore implementieren Serializer.

DataStore verlässt sich auf equals ich hashCode die für Datenklassen automatisch generiert werden. Es werden auch Datenklassen generiert toString ich copy Funktionen, die zum Debuggen und Aktualisieren von Daten nützlich sind:

🚨 Das ist sehr wichtig Stellen Sie sicher, dass Ihre Klasse unveränderlich ist seit DataStore ist nicht mit Variablentypen kompatibel. Die Verwendung von Variablentypen mit dem DataStore führt dazu Fehler aufgrund inkonsistenter Daten und Rennbedingungen. Datenklassen Sie sind nicht unbedingt standardmäßig unveränderlichStellen Sie also sicher, dass Sie überall wave anstelle von vars verwenden:

Arrays sind variabel, also sollten sie nicht ausgesetzt werden. Auch wenn wir es nur zum Lesen verwenden List als Mitglied unserer Datenklasse ist es immer noch variabel. Stattdessen sollten Sie erwägen, es zu verwenden unveränderliche / dauerhafte Sammlungen:

Die Verwendung von Variablentypen als Mitglied Ihrer Datenklasse macht sie änderbar. Stattdessen sollten Sie dafür sorgen alles Mitglieder sind unveränderliche Typen.

Kotlin unterstützt die Serialisierung mehrere Formateeinschließlich JSON und Protokollpuffer. In diesem Beispiel fahren wir mit JSON fort.

Um Ihre Datenklasse in JSON mithilfe der Kotlin-Serialisierung zu lesen und zu schreiben, müssen Sie Ihre Datenklasse mit markieren @Serializable und überwältigen Serializer’s writeTo() ich readFrom(). Hier ein Beispiel mit UserPreferences:

⚠️ Grundstücke sind nicht sicher mit DataStore verwenden, da sich das Datenformat zwischen Android-Versionen ändern kann.

Gehen Sie die neu erstellten durch UserPreferencesSerializer im DataStore, wenn Sie es erstellen:

Das Auslesen der Daten sieht genauso aus wie bei Protobuffs:

Sie können die generierte verwenden .copy() Datenaktualisierungsfunktion:

Verwenden von DataStore mit Kotlin-Serialisierung und Datenklassen kann den Standard senken und Ihren Code vereinfachenSie müssen jedoch darauf achten, es nicht einzuführen Fehler durch Variabilität. Sie müssen lediglich Ihre Datenklasse definieren und einen Serializer implementieren.

Wir deckten ab Kotlin-Serialisierung und die notwendigen Schritte zur Verwendung Persistente DataStore-Daten strukturieren – Verwenden von vollständig unveränderlichen Datenklassen und Schreiben in JSON mit@Serializable Beachten Sie, überwältigend unsere Serializer’s writeTo() ich readFrom() und schließlich die Weiterleitung an unsere DataStore-Instanz.

Begleiten Sie uns für den nächsten Beitrag in unserer Serie, in dem wir untersuchen, wie es geht Synchronbetrieb mit DataStore.

DataStore- und Injektionsabhängigkeit von Simona Stojanovic Android-Entwickler Februar 2022

Simona Stojanovic

In den nächsten Beiträgen von uns Jetpack DataStore-ReiheWir behandeln einige zusätzliche Konzepte, um zu verstehen, wie DataStore mit anderen APIs kommuniziert, damit Ihnen alles zur Verfügung steht, was Sie verwenden können Produktionsumfeld. In diesem Beitrag konzentrieren wir uns auf Einspritzabhängigkeiten sind Griff. Wir verweisen auf Datenspeicher Einstellungen ich Proto codelabs durch diesen Beitrag für Codebeispiele.

Wir brauchen einen Singleton für die Erstellung mehr als eine Instanz aus dem DataStore für eine bestimmte Datei kann alle DataStore-Funktionen beschädigen. In einer Produktionsumgebung würden wir jedoch normalerweise eine DataStore-Instanz per erhalten Injektionsabhängigkeit. Schauen wir uns also an, wie der DataStore mit arbeitet Griffeine Suchtinjektionsbibliothek, um uns zu helfen Standard reduzieren manuelles Abhängigkeitsmanagement. Wenn Sie mit Hilt nicht vertraut sind, empfehlen wir Ihnen, es zuerst durchzugehen Verwenden Sie Hilt in Ihrer Android-App Codelab zum Erlernen grundlegender Konzepte wie z Components, Modules und andere.

Griff platzieren

Alle Anwendungen, die Hilt verwenden, müssen enthalten Application Klasse mit gekennzeichnet @HiltAndroidApp zum Ausführen der Hilt-Codegenerierung, einschließlich der Basisklasse für Ihre Anwendung, die als Abhängigkeitscontainer auf Anwendungsebene dient. In unserem Fall erstellen wir eine einfache TasksApp und füge es unserem hinzu AndroidManifest.xml:

DataStore-Einstellungen einfügen

Wir haben diese Parameter bereits in der Serie erwähnt, aber fassen wir schnell zusammen:

  • corruptionHandler (optional) – aufgerufen, wenn a CorruptionException wird vom Serialisierer ausgeworfen, wenn Daten nicht deserialisiert werden können, und gibt dem DataStore Anweisungen zum Ersetzen beschädigter Daten
  • migrations (optional) – Liste DataMigration vorherige Daten in den DataStore zu verschieben
  • scope (optional) – das Ausmaß, in dem IO-Operationen und Transformationsfunktionen durchgeführt werden; in diesem Fall verwenden wir wieder gleichen Bereich wie die standardmäßige DataStore-API
  • produceFile – erzeugt File Objekt für Preferences DataStore basierend auf geliefert Context ich namedarin gespeichert this.applicationContext.filesDir + datastore/ Unterverzeichnisse

Jetzt, da wir ein Modul haben, das Hilt anweist, wie wir unseren DataStore erstellen, müssen wir noch ein paar Anpassungen vornehmen, damit wir erfolgreich bauen können.

Hilt kann Abhängigkeiten zu anderen Android-Klassen bereitstellen, die sie haben @AndroidEntryPoint Hinweis, zusammen mit @HiltAndroidApp Pro Application ich @HiltViewModel Pro ViewModel Klassen. Wenn Sie die Android-Klasse mit markieren @AndroidEntryPoint, dann müssen Sie auch andere Android-Klassen markieren, die davon abhängen. Wenn Sie zum Beispiel a notieren Fragmentdann müssen Sie auch alle Aktivitäten markieren, bei denen Sie es verwenden Fragment.

Das bedeutet, dass wir Folgendes hinzufügen müssen:

Wir haben keine anderen in dieser Probe komplexe Injektionen, wie benutzerdefinierte Builder, Factorys oder Schnittstellenimplementierungen. Wir können uns also auf Hilt und die Konstruktorinjektion für alle anderen Abhängigkeiten verlassen, die wir durchlaufen müssen. Wir werden verwenden @Inject ein Hinweis im Klassenkonstruktor, um Hilt anzuweisen, wie seine Instanzen bereitzustellen sind:

Lassen Sie uns es schließlich vollständig loswerden preferencesDataStore ein Delegierter von der Spitze von uns TasksActivity da wir es nicht mehr brauchen. Wir werden auch die Art und Weise ändern, wie es uns gehört viewModel ist vorgesehen TaskActivity onCreatedenn seine Abhängigkeiten werden nun eingefügt:

Proto DataStore einfügen

Das ist es! Sie können die App jetzt ausführen und überprüfen, ob alle Abhängigkeiten jetzt korrekt eingefügt wurden.

Begleiten Sie uns für den nächsten Beitrag aus unserer Serie, in dem wir untersuchen, wie man es verwendet Data Warehouse mit Kotlin-Serialisierung.

Alles über Proto DataStore. In diesem Beitrag werden wir etwas über Proto lernen… | von Simona Stojanovic Android-Entwickler Januar 2022

Das erfahren wir in diesem Beitrag Proto-DataStoreeiner von zwei DataStore-Implementierungen. Wir werden darüber sprechen, wie erstellen, Daten lesen und schreiben und Ausnahmen behandelnum die Szenarien besser zu verstehen, die Proto zu einer guten Wahl machen.

Proto DataStore verwendet typisierte Objekte, die von unterstützt werden Protokollpufferkleinere Datensätze beim Bereitstellen zu speichern Typ Sicherheit. Dadurch entfällt die Notwendigkeit, Schlüssel/Wert-Paare zu verwenden strukturell anders von seinem Vorgänger und seine zugehörige Implementierung, DataStore-Einstellungen. Doch das ist noch nicht alles – berichtet DataStore viele weitere Verbesserungen fertig . Melden Sie sich schnell bei uns zurück erster Beitrag in Folge und schauen Sie sich den detaillierten Vergleich an, den wir dort gemacht haben. Wir werden uns das Folgende ansehen wie nur wenn nicht anders angegeben.

zusammenfassen:

  • Bietet ein vollständig asynchrone API zum Herunterladen und Speichern von Daten mit der Kraft von Kotlin Korutina
  • Es bietet keine gebrauchsfertige synchrone Unterstützung – vermeidet direkt jegliche Arbeit, die den UI-Thread blockiert
  • Es stützt sich auf den internen Fehlersignalisierungsmechanismus von Flow, sodass Sie sicher arbeiten können Ausnahmen abfangen und verarbeiten beim Lesen oder Schreiben von Daten
  • Verarbeitet sicher Datenaktualisierungen in Atomare Read-Modify-Write-Operationstark zur Verfügung stellen SÄURE Garantien
  • Erlaubt einfache und einfache Datenmigration
  • Müssen vollständige Sicherheit und Ihre Daten erfordern die Arbeit mit mehr komplexe Klassen, wie Aufzählungen oder Listen? Dies ist mit nicht möglich Einstellungenalso wähle Proto stattdessen

Um Proto DataStore nutzen zu können, müssen Sie sich kennenlernen Protokollpuffer – sprachneutraler, plattformneutraler Mechanismus für Serialisierung strukturierter Daten. Es ist schneller, kleiner, einfacher und eindeutiger als XML und leichter zu lesen als andere ähnliche Datenformate.

Sie definieren ein Schema aus wie Sie Ihre Daten strukturiert haben möchten und geben Sie Optionen an, z. B. welche Sprache zum Generieren des Codes verwendet werden soll. Der Compiler generiert dann Klassen nach Ihren Vorgaben. Dadurch können Sie problemlos strukturierte Daten schreiben und lesen zu und von verschiedenen Datenströmen, Austausch zwischen verschiedenen Plattformen, Verwendung mehrerer verschiedener Sprachen, z. Kotlin.

Beispielschema einiger Daten ua Datei:

So verwenden Sie den generierten Kotlin-Code zum Erstellen Ihres Datenmodells:

Oder Sie können das neu Angekündigte ausprobieren Kotlin DSL-Unterstützung für Protokollpuffer für eine idiomatischere Art, Ihr Datenmodell zu erstellen:

Etwas mehr Zeit in das Erlernen dieses neuen Serialisierungsmechanismus zu investieren, lohnt sich auf jeden Fall, denn er bringt Typsicherheit, verbesserte Lesbarkeit und allgemeine Einfachheit des Codes.

Schauen wir uns jetzt etwas Code an und lernen, wie Proto funktioniert.

Wir werden verwenden Proto-DataStore Codelab-Muster. Wenn Sie an einem praktischeren Ansatz zur Implementierung interessiert sind, empfehlen wir Ihnen wirklich, es durchzugehen Arbeiten Sie mit Proto DataStore Codelab selbstständig.

Diese Beispielanwendung zeigt eine Liste von Aufgaben an, und der Benutzer kann sie nach ihrem abgeschlossenen Status filtern oder nach Priorität und Frist sortieren. Wir möchten ihre Auswahl speichern boolean, um abgeschlossene Aufgaben anzuzeigen ia Aufzählung sortieren Proto.

Wir werden zunächst Proto-Abhängigkeiten und einige der grundlegenden Protobuff-Einstellungen zu Ihrem Modul hinzufügen . Wenn Sie an einer fortgeschritteneren Anpassung der Protobuffs-Kompilation interessiert sind, werfen Sie einen Blick darauf Protobuf-Plugin für Gradle-Notizen:

💡 Kurzer Tipp – Wenn Sie Ihre Konstruktion minimieren möchten, fügen Sie unbedingt eine zusätzliche Regel hinzu Datei, um zu verhindern, dass Ihre Felder gelöscht werden:

Unsere Reise mit Proto beginnt mit der Definition Ihrer Struktur persistente Daten u Datei. Betrachten Sie es als lesbares Schema für dich u.a Entwurf für den Compiler. Wir werden unsere nennen und füge es hinzu Verzeichnis.

Begleitet Protobuf-SprachführerWir werden dieser Datei ein hinzufügen Nachricht für jede Datenstruktur wir wollen serialisieren und dann a spezifizieren Name ia Typ für jedes Feld in der Nachricht. Um dies einfacher zu visualisieren, schauen wir uns sowohl die Kotlin-Datenklasse als auch das entsprechende Protobuff-Schema an.

– Kotlin-Datenklasse:

planen:

Wenn Sie noch nie Protobuffs verwendet haben, interessieren Sie sich vielleicht für die ersten Zeilen des Schemas. Lassen Sie uns sie aufschlüsseln:

  • – zeigt an zu verwenden Syntax
  • – eine Dateioption, die angibt Paketerklärung für Ihre generierten Klassen, was dazu beiträgt, dies zu verhindern Namenskonflikte zwischen verschiedenen Projekten
  • – eine Dateioption, die angibt, ob nur eine einzelne Datei mit verschachtelten Unterklassen werden hierfür generiert (wenn auf false gesetzt) ​​oder if getrennte Dateien wird für jeden Nachrichtentyp der obersten Ebene generiert (wenn auf wahr gesetzt); es ist standardmäßig falsch

Das Folgende ist die Definition unserer Botschaft. Eine Nachricht ist ein Aggregat, das enthält eine Reihe von typisierten Feldern. Viele einfache Standarddatentypen sind als Feldtypen verfügbar, einschließlich , , doppelt i . Sie können Ihre Nachrichten auch mit weiter strukturieren andere Nachrichtentypen als Feldtypenwie wir mit .

Der , Die Markierungen auf jedem Element identifizieren das eindeutige “Tag”, das das Feld in der Binärcodierung verwendet – wie z. B. die Sortier-ID. Wenn Ihr Nachrichtentyp verwendet wird, müssen diese Nummern nicht geändert werden.

Wenn Sie den Protokollpuffer-Compiler auf einem ausführen Der Compiler generiert Code in der von Ihnen ausgewählten Sprache. In unserem speziellen Fall führt dies beim Start des Compilers zur Generierung Klasse, die in Ihrer Bewerbung enthalten ist … Verzeichnis:

💡 Schneller Tipp – Du kannst auch die neu angekündigten ausprobieren Kotlin DSL-Unterstützung für Protokollpuffer um eine idiomatischere Methode zum Erstellen Ihres Datenmodells zu verwenden.

Jetzt, wo wir haben wir müssen angeben Richtlinien wie Proto sie lesen und schreiben soll. Wir tun dies über den DataStore es bestimmt das endgültige Format Ihrer Daten wann es gespeichert wird und wie man richtig darauf zugreift. Dies erfordert das Überschreiben von:

  • – was zurückgegeben werden soll, wenn keine Daten vorhanden sind
  • – wie man die Speicheranzeige unseres Datenobjekts in ein für die Speicherung geeignetes Format umwandelt
  • – die Umkehrung des Obigen, wie man von einem Speicherformat in eine geeignete Speicheranzeige umwandelt

Um Ihren Code so sicher wie möglich zu machen, zu handhaben um unangenehme Überraschungen zu vermeiden, wenn die Datei aufgrund einer Formatbeschädigung nicht deserialisiert werden kann.

💡 Kurztipp – Wenn dein AS mal nichts finden kann in Verbindung gebracht, reinigen und erneuern Ihr Projekt, um mit der Generierung von Protobuff-Klassen zu beginnen.

Sie interagieren mit Proto über Instanzen . ist eine Schnittstelle, die bietet Zugriff auf dauerhafte Informationenin unserem Fall in der generierten Form .

Es wird empfohlen, zum Erstellen dieser Instanz einen Delegaten zu verwenden und Pass erforderlich ich Argumente:

verwendet, um a zu erstellen verwendet, um Daten zu speichern. Deshalb ist es so Der Delegierte ist a Kotlin-Eigenschaftserweiterung dessen Empfängertyp eine Instanz sein muss weil es benötigt wird, um eine Datei über zu erstellen . Vermeiden Sie die Verwendung dieser Datei außerhalb von Proto, da dies die Konsistenz Ihrer Daten beeinträchtigen würde.

U Delegierten können Sie ein weiteres optionales Argument weiterleiten – . Dieser Operator heißt, wenn a wurde vom Serialisierer ausgeworfen, als Daten können nicht deserialisiert werden. würde dann Proto anweisen, wie die beschädigten Daten zu ersetzen sind:

Sie sollten nicht mehr als eine DataStore-Instanz für eine bestimmte Datei erstellen, weil es die gesamte Funktionalität des DataStore ruinieren kann. Daher können Sie ein Delegate-Konstrukt einmal auf der obersten Ebene Ihrer Kotlin-Datei hinzufügen und es in der gesamten Anwendung verwenden, um es als zu übergeben Einzelling. Wie das mit einer Suchtspritze geht, sehen wir uns in späteren Beiträgen an.

Zum Auslesen gespeicherter Daten, u wir belichten a von . Dies ermöglicht ein effizientes Vorgehen der letzte erhaltene Zustand ich Sendungen bei jeder Änderung. Dies ist einer von größte Stärke von Proto – deins ‘s Werte kommen bereits in der generierten Form . Das heisst Sie müssen keine zusätzlichen Transformationen vornehmen von den gespeicherten Daten zum Kotlin-Datenklassenmodell, so wie Sie es tun würden oder :

Flow wird immer entweder einen Wert ausgeben oder verwerfen Sie die Ausnahme beim Versuch, von der Festplatte zu lesen. Wir werden uns in späteren Abschnitten mit der Behandlung von Ausnahmen befassen. Der DataStore stellt außerdem sicher, dass die Arbeit immer erledigt wird Ihr UI-Thread wird also nicht blockiert.

🚨 Erstellen Sie keine Cache-Repositories um den aktuellen Stand Ihrer Proto-Daten abzubilden. Damit erlischt die DataStore-Garantie für Datenkonsistenz. Wenn Sie eine Aufnahme Ihrer Daten ohne ein Abonnement für weitere Flow-Shows benötigen, verwenden Sie sie stattdessen :

Wir werden die Aussetzung verwenden, um Daten zu schreiben Funktion.

Lassen Sie es uns aufschlüsseln:

  • Schnittstelle – wird derzeit verwendet als konkrete Implementierung von Proto
  • – ein Suspend-Block, der verwendet wird, um bestimmte Änderungen an unseren permanenten T-Typ-Daten anzuwenden

Auch hier können Sie einen Unterschied bemerken die auf den Gebrauch angewiesen ist ich ähnlich ich als Standarddatenanzeige.

Jetzt können wir dies nutzen, um unsere zu ändern boolesch. Protokollpuffer vereinfachen dies ebenfallsEliminierung der Notwendigkeit einer manuellen Transformation in und aus Datenklassen:

Es gibt mehrere Schritte für die Analyse:

  • – er gewann Version von uns die es für Änderungen „freischaltet“.
  • – setzt einen neuen Wert
  • – Beendet den Update-Vorgang durch Konvertieren in

Die Datenaktualisierung erfolgt transaktional in einem Atomare Read-Modify-Write-Operation. Das bedeutet, dass es eine bestimmte Abfolge von Datenverarbeitungsvorgängen garantiert, während derer Daten für andere Threads gesperrt sind Konsistenz ich verhindert Rennbedingungen. Nur nach ich Corutins erfolgreich abgeschlossen, Daten werden dauerhaft auf der Festplatte gespeichert und Der Fluss wird die Aktualisierung widerspiegeln.

🚨 Beachten Sie, dass dies die einzige Möglichkeit ist, den Status des DataStore zu ändern. Wartung u Referenz und manuelle Mutation danach vervollständigt ändert die permanenten Daten nicht in Proto, also sollten Sie nicht versuchen zu modifizieren außen Block.

Wenn der Schreibvorgang aus irgendeinem Grund fehlschlägt, wird die Transaktion beendet und eine Ausnahme ausgelöst.

Wenn Sie es zuvor verwendet haben in Ihrer Anwendung und Sie Ihre Daten sicher an Proto übertragen möchten, können Sie verwenden . Dazu braucht es Kontext, Namen und Anweisungen, wie Sie Ihren eigenen umwandeln können Schlüssel/Wert-Paare für Innerhalb Parameter. Geben Sie dies weiter Parameter Delegierter für einfache Migration:

In diesem Beispiel durchlaufen wir den Konstruktionsprozess und seine Einstellung zu dem, was zuvor in der entsprechenden gespeichert wurde Schlüssel-Wert-Paar oder einfach auf NONE gesetzt.

wird dafür sorgen wurde gestartet vor einem möglichen Zugriff auf Daten im Datenspeicher. Das bedeutet Ihre Migration ihm muss es gelungen sein bevor der DataStore weitere Werte aussendet und bevor er mit neuen Datenänderungen beginnt. Sobald Sie erfolgreich migriert haben, können Sie die Verwendung sicher einstellen wie Schlüssel nur einmal migriert und dann ENTFERNT von .

Der akzeptiert die Liste . Wir werden in späteren Episoden sehen, wie wir dies für andere Arten von Datenmigrationen verwenden können. Wenn Sie nicht migrieren müssen, können Sie dies ignorieren, da es eine gibt Ursprünglich bereitgestellt schon.

Einer der Hauptvorteile von DataStore gegenüber ist seine ein geordneter Mechanismus zum Erfassen und Behandeln von Ausnahmen. Während wirft Parsing-Fehler als Laufzeitausnahmen aus und lässt Raum für unerwartete, nicht abgefangene Abstürze, DataStore wirft aus wenn beim Lesen/Schreiben von Daten ein Fehler auftritt.

Wir können dies sicher lösen, indem wir verwenden Flow- und Broadcast-Betreiber :

Oder mit dem einfachen Blockschreiben:

Wenn eine andere Art von Ausnahme ausgelöst wird, sollten Sie sie besser erneut auslösen.

Wir deckten ab Protokollpuffer ich Das Proto von DataStore Implementierung – wann und wie man damit Daten liest und schreibt, wie man mit Fehlern umgeht und wie man sie überwindet . Im nächsten und letzten Beitrag gehen wir noch einen Schritt weiter und sehen, wie sich der DataStore in Ihren einfügt Anwendungsarchitektur, wie man es mit Hilt injiziert und natürlich, wie man es testet. Seh dich später!

Alles über DataStore-Einstellungen. In diesem Beitrag werden wir uns ansehen… | von Simona Stojanovic Android-Entwickler Januar 2022

Wir werden uns diesen Beitrag ansehen DataStore-Einstellungeneiner von zwei Datenspeicher Implementierung. Wir werden weitermachen, wie erstellen, Daten lesen und schreiben und Ausnahmen behandelnund all das sollte Ihnen hoffentlich genügend Informationen liefern, um zu entscheiden, ob dies die richtige Wahl für Ihre Anwendung ist.

Einstellungen DataStore-Verwendungen Schlüssel/Wert-Paare um kleinere Datensätze zu speichern, ohne zuerst das Schema zu definieren. Dies könnte Sie daran erinnern SharedPreferences, aber nur in der Art und Weise, wie es Ihre Datenmodelle strukturiert. Es gibt ein verschiedene Vorteile bringt der DataStore durch seine SharedPreferences Vorgänger. Melden Sie sich schnell bei uns zurück vorherigen Post und schauen Sie sich den detaillierten Vergleich an, den wir dort gemacht haben. Wir werden uns das Folgende ansehen Preferences DataStore wie nur Preferenceswenn nicht anders angegeben.

Für eine kurze Zusammenfassung:

Lassen Sie uns nun in etwas Code eintauchen und lernen, wie Einstellungen implementiert werden sollten.

Wir werden verwenden DataStore-Einstellungen Codelab-Code. Wenn Sie an einem praktischeren Ansatz zur Implementierung interessiert sind, empfehlen wir Ihnen wirklich, es durchzugehen Arbeiten Sie mit DataStore-Einstellungen codelab allein.

Diese Beispielanwendung zeigt eine Liste von Aufgaben an, und der Benutzer kann sie nach ihrem abgeschlossenen Status filtern oder nach Priorität und Frist sortieren. Wir möchten ihre Auswahl speichern boolean für abgeschlossene Aufgaben ia Aufzählung sortieren im Datenspeicher.

Beginnen wir mit dem Hinzufügen der erforderlichen Abhängigkeiten:

💡 Ein kurzer Tipp: Wenn Sie Ihre Konstruktion minimieren möchten, fügen Sie Ihrer eigenen eine zusätzliche Regel hinzu proguard-rules.pro Datei, um zu verhindern, dass Ihre Felder gelöscht werden:

Sie interagieren mit den im DataStore gespeicherten Daten über eine Instanz DataStore<Preferences>. DataStore ist eine Schnittstelle, die den Zugriff auf dauerhafte Informationen gewährt. Einstellungen ist eine abstrakte Klasse ähnlich einer generischen Karte, die insbesondere in der Implementierung des Preferences DataStore verwendet wird, um Schlüssel-Wert-Paare Ihrer Daten zu verfolgen. Wir werden darüber sprechen MutablePreferences Unterklasse, wenn wir über das Schreiben von Daten sprechen.

Es wird empfohlen, zum Erstellen dieser Instanz einen Delegaten zu verwenden preferencesDataStore und Pass erforderlich name Streit. Dieser Delegierte ist a Kotlin-Eigenschaftserweiterung dessen Empfängertyp eine Instanz sein muss Contextanschließend für den Bau benötigt File Objekt, in dem DataStore Daten speichert:

Sie sollten nicht mehr als eine DataStore-Instanz für eine bestimmte Datei erstellen, weil es die gesamte Funktionalität des DataStore ruinieren kann. Daher können Sie ein Delegate-Konstrukt einmal auf der obersten Ebene Ihrer Kotlin-Datei hinzufügen und es in der gesamten Anwendung verwenden, um es als zu übergeben Einzelling. Wie das mit einer Suchtspritze geht, sehen wir uns in späteren Beiträgen an.

Schlüssel definieren

DataStore bietet eine schnelle Möglichkeit, Schlüssel für verschiedene Datentypen zu erstellen, z booleanPreferencesKey, intPreferencesKey und vieles mehr – Sie müssen nur bestehen Schlüsselname als Wert. Obwohl dies einige Einschränkungen für Datentypen mit sich bringt, sollten Sie dies im Hinterkopf behalten bietet keine endgültige Typsicherheit. Indem wir den bevorzugten Schlüssel eines bestimmten Typs bestimmen, hoffen wir das Beste und verlassen uns auf unsere Annahmen der Wert eines bestimmten Typs würde zurückgegeben. Wenn Sie der Meinung sind, dass Ihr Code so strukturiert ist, dass er sicher zu handhaben ist, können Sie gerne mit den Einstellungen fortfahren. Wenn nicht, erwägen Sie, den Bruder von Preferences zu verwenden, Proto-DataStorewie er prophezeit vollständige Sicherheit.

In unserer Anwendung UserPreferencesRepositoryWir geben alle Schlüssel an, die zur Strukturierung der Schlüssel/Wert-Paare unserer persistenten Daten erforderlich sind:

Zum Auslesen gespeicherter Daten, u UserPreferencesRepository wir belichten a Flow<Preferences> von dataStore.data. Dies ermöglicht ein effizientes Vorgehen der letzte erhaltene Zustand ich Sendungen bei jeder Änderung. Mithilfe von Kotlin-Datenklassen können wir alle Sendungen beobachten und den Datenspeicher transformieren Preferences unterliegen unseren UserPreferences Modell, nur verwenden Schlüssel/Wert-Paare wir sind interessiert an:

Flow wird immer entweder einen Wert ausgeben oder verwerfen Sie die Ausnahme beim Versuch, von der Festplatte zu lesen. Wir werden uns in späteren Abschnitten mit der Behandlung von Ausnahmen befassen. Der DataStore stellt außerdem sicher, dass die Arbeit immer erledigt wird Dispatchers.IO Ihr UI-Thread wird also nicht blockiert.

🚨 Erstellen Sie keine Cache-Repositories um den aktuellen Stand Ihrer Präferenzdaten abzubilden. Damit erlischt die DataStore-Garantie für Datenkonsistenz. Wenn Sie eine Aufnahme Ihrer Daten ohne ein Abonnement für weitere Flow-Shows benötigen, verwenden Sie sie stattdessen dataStore.data.first():

Wir werden die Aussetzung verwenden, um Daten zu schreiben DataStore<Preferences>.edit(transform: suspend (MutablePreferences) -> Unit) Funktion. Lassen Sie es uns aufschlüsseln:

Als Beispiel werden wir unsere ändern SHOW_COMPLETED Flagge:

Die Bearbeitung von Daten erfolgt transaktional in einem Atomare Read-Modify-Write-Operation. Das bedeutet, dass es eine bestimmte Abfolge von Datenverarbeitungsvorgängen garantiert, während derer Daten für andere Threads gesperrt sind Konsistenz ich verhindert Rennbedingungen. Nur nach transform ich edit Corutins erfolgreich abgeschlossen, Daten werden dauerhaft auf der Festplatte gespeichert und datastore.data Der Fluss wird die Aktualisierung widerspiegeln.

🚨 Beachten Sie, dass dies die einzige Möglichkeit ist, den Status des DataStore zu ändern. Wartung u MutablePreferences Referenz und manuelle Mutation danach transform vervollständigt ändert die permanenten Daten nicht im DataStore, also sollten Sie nicht versuchen, es zu ändern MutablePreferences außen transform Block.

Wenn der Schreibvorgang aus irgendeinem Grund fehlschlägt, wird die Transaktion beendet und eine Ausnahme ausgelöst.

Wenn Sie es zuvor verwendet haben SharedPreferences in Ihrer Bewerbung und möchten Ihre Daten sicher an Preferences übertragen, können Sie verwenden SharedPreferencesMigration. Dazu braucht es Kontext, SharedPreferences den Namen und den optionalen Schlüsselsatz, den Sie migrieren möchten (oder lassen Sie es einfach so Ursprünglich MIGRATE_ALL_KEYS Wert).

Ansehen SharedPreferencesMigration Implementierung sehen Sie a getMigrationFunction() die dafür verantwortlich ist, alle erforderlichen, gespeicherten Schlüssel/Wert-Paare abzurufen und sie zu den Einstellungen hinzuzufügen gleichen Tasten. Bestehen SharedPreferencesMigration über dem produceMigrations ParameterpreferencesDataStore delegieren an einfach zu migrieren:

produceMigrations wird dafür sorgen getMigrationFunction() wurde gestartet vor einem möglichen Zugriff auf Daten im Datenspeicher. Das bedeutet Ihre Migration ihm muss es gelungen sein bevor der DataStore weitere Werte aussendet und bevor er mit neuen Datenänderungen beginnt. Sobald Sie erfolgreich migriert haben, können Sie die Verwendung sicher einstellen SharedPreferenceswie Schlüssel nur einmal migriert und dann ENTFERNT von SharedPreferences.

Der produceMigrations akzeptiert die Liste DataMigration. Wir werden in späteren Episoden sehen, wie wir dies für andere Arten von Datenmigrationen verwenden können. Wenn Sie nicht migrieren müssen, können Sie dies ignorieren, da es eine gibt Ursprünglich listOf() bereitgestellt schon.

Einer der Hauptvorteile von DataStore gegenüber SharedPreferences ist seine ein geordneter Mechanismus zum Erfassen und Behandeln von Ausnahmen. Während SharedPreferences wirft Parsing-Fehler als Laufzeitausnahmen aus und lässt Raum für unerwartete, nicht abgefangene Abstürze, DataStore wirft aus IOException wenn beim Lesen/Schreiben von Daten ein Fehler auftritt.

Wir können dies sicher lösen, indem wir verwenden catch() Flow-Operator kurz davor map() und Rundfunk emptyPreferences():

Oder mit dem einfachen try-catch Blockschreiben:

Wenn eine andere Art von Ausnahme ausgelöst wird, sollten Sie sie besser erneut auslösen.

Wir deckten ab DataStore-Einstellungen Implementierung – wann und wie man damit Daten liest und schreibt, wie man mit Fehlern umgeht und wie man sie überwindet SharedPreferences. Im nächsten Beitrag werden wir die gleichen Themen mit behandeln Proto-DataStore Umsetzung, also bleiben.

Einführung in Jetpack DataStore von Simona Stojanovic Android-Entwickler Januar 2022

Simona Stojanovic

Datenspeicher ist eine Jetpack-Datenspeicherbibliothek, die eine sichere und konsistente Möglichkeit bietet, kleine Datenmengen wie Einstellungen oder Anwendungsstatus zu speichern. Es basiert auf Kotlin Korutine und Flow die eine asynchrone Datenspeicherung ermöglichen. Es zielt darauf ab, zu ersetzen SharedPreferences, weil es sicher ist und nicht blockiert. Es bietet zwei verschiedene Implementierungen: Proto-DataStoredas typisierte Objekte speichert (unterstützt von Protokollpuffer) ich DataStore-Einstellungen, die Schlüssel/Wert-Paare speichert. Machen wir weiter, wenn wir es einfach benutzen DataStoregilt dies für beide Implementierungen, sofern nicht anders angegeben.

Wir werden uns diesen Blogbeitrag genauer ansehen Datenspeicher – wie es funktioniert, welche Implementierungen es bietet und ihre individuellen Anwendungsfälle. Wir werden uns auch ansehen, welche Vorteile und Verbesserungen es bringt SharedPreferences und warum sich der DataStore dadurch lohnt.

Schauen wir uns einen direkten Vergleich zwischen an SharedPreferences und Datenspeicher:

Vergleich von DataStore-Implementierungen mit SharedPreferences

Asynchrone API

Synchronbetrieb

Es ist jedoch möglich, DataStore und synchronen Betrieb mit ein wenig Hilfe des Corutin-Builders zu kombinieren, wie wir später sehen werden.

Fehlerbehandlung

Sicherheitsstufe

Datenkonsistenz

Migrationsunterstützung

Einstellungen Datenspeicher liest und schreibt datenbasiert Schlüssel/Wert-Paare, ohne vorherige Definition der Regelung. Auch wenn das vielleicht ähnlich klingt SharedPreferences, denken Sie an alle oben genannten Verbesserungen, die der DataStore mit sich bringt. Lassen Sie sich nicht von ihrem Teilen täuschen.”Einstellungen„Bei der Benennung – sie haben nichts gemeinsam und kommen von zwei völlig getrennten APIs.

Proto Datenspeicher Geschäfte getippte Objektemit Unterstützung Protocol Buffers, bietet Typsicherheit und eliminiert die Notwendigkeit von Schlüsseln. Protobuffs sind schneller, kleiner, einfacher und weniger mehrdeutig als XML und andere ähnliche Datenformate. Wenn Sie sie noch nie benutzt haben, haben Sie keine Angst! Dies ist sehr einfach zu lernen. Obwohl der Proto DataStore erfordert, dass Sie einen neuen Serialisierungsmechanismus erlernen, sind wir von seinen Vorteilen besonders überzeugt Typ Sicherheites ist es wert.

Vergleich von DataStore-Implementierungen

Bei der Wahl zwischen den beiden müssen Sie Folgendes berücksichtigen:

  • Wenn Sie mit arbeiten Schlüssel/Wert-Paare zum Lesen und Schreiben von Daten, die Sie möchten schnell migrieren von SharedPreferences mit minimalen Änderungen, während Sie immer noch die Vorteile von DataStore-Verbesserungen nutzen und sich ohne Typsicherheitsprüfungen sicher genug fühlen, können Sie mit gehen DataStore-Einstellungen
  • Wenn Sie Protokollpuffer für den zusätzlichen Vorteil einer verbesserten Lesbarkeit lernen möchten, wenn Ihre Daten Arbeit erfordern komplexere Klassenwie Aufzählungen oder Listen, und die Sie haben möchten vollständige Sicherheit unterstützen, während Sie dies tun, können Sie versuchen Proto-DataStore

Wenn Sie mit arbeiten müssen komplexe Datensätze größer als ein paar 10 KB ist, ist es sehr wahrscheinlich, dass Sie es brauchen werden Teilaktualisierungen oder Referenzintegrität zwischen verschiedenen Datentabellen. In diesem Fall sollte der Einsatz erwogen werden Zimmer.

Wenn Sie jedoch mit arbeiten kleiner und einfacher Datensätzewie z. B. Anwendungseinstellungen oder Status, und daher keine Teilaktualisierungen oder Referenzintegrität erfordern, sollten Sie auswählen Datenspeicher.

So wählen Sie zwischen DataStore und Room