GraphQL-Typen - AWS AppSync

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GraphQL-Typen

GraphQL unterstützt viele verschiedene Typen. Wie Sie im vorherigen Abschnitt gesehen haben, definieren Typen die Form oder das Verhalten Ihrer Daten. Sie sind die grundlegenden Bausteine eines GraphQL-Schemas.

Typen können in Eingaben und Ausgaben eingeteilt werden. Eingaben sind Typen, die als Argument für die speziellen Objekttypen (Query, usw.) übergeben werden dürfenMutation, wohingegen Ausgabetypen ausschließlich zum Speichern und Zurückgeben von Daten verwendet werden. Eine Liste der Typen und ihrer Kategorisierungen ist unten aufgeführt:

  • Objekte: Ein Objekt enthält Felder, die eine Entität beschreiben. Zum Beispiel könnte ein Objekt so etwas wie ein sein, book mit Feldern, die seine Eigenschaften beschreiben authorNamepublishingYear, wie, usw. Es handelt sich ausschließlich um Ausgabetypen.

  • Skalare: Dies sind primitive Typen wie int, string usw. Sie werden normalerweise Feldern zugewiesen. Anhand des authorName Felds als Beispiel könnte ihm der String Skalar zugewiesen werden, um einen Namen wie „John Smith“ zu speichern. Skalare können sowohl Eingabe- als auch Ausgabetypen sein.

  • Eingaben: Eingaben ermöglichen es Ihnen, eine Gruppe von Feldern als Argument zu übergeben. Sie sind sehr ähnlich strukturiert wie Objekte, können aber als Argumente an spezielle Objekte übergeben werden. Mithilfe von Eingaben können Sie Skalare, Aufzählungen und andere Eingaben in ihrem Gültigkeitsbereich definieren. Eingaben können nur Eingabetypen sein.

  • Spezialobjekte: Spezielle Objekte führen zustandsverändernde Operationen durch und übernehmen den Großteil der Schwerstarbeit des Dienstes. Es gibt drei spezielle Objekttypen: Abfrage, Mutation und Abonnement. Abfragen rufen in der Regel Daten ab; Mutationen manipulieren Daten; Abonnements öffnen und halten eine bidirektionale Verbindung zwischen Clients und Servern aufrecht, sodass eine ständige Kommunikation gewährleistet ist. Spezielle Objekte können aufgrund ihrer Funktionalität weder eingegeben noch ausgegeben werden.

  • Enums: Enums sind vordefinierte Listen zulässiger Werte. Wenn Sie eine Aufzählung aufrufen, können ihre Werte nur den Werten entsprechen, die in ihrem Gültigkeitsbereich definiert sind. Wenn Sie beispielsweise eine Aufzählung mit dem Namen „trafficLightsDarstellung einer Liste von Verkehrssignalen“ haben, könnte sie Werte wie redLight und greenLight aber nicht haben. purpleLight Eine echte Ampel hat nur eine begrenzte Anzahl von Signalen, sodass Sie diese anhand der Aufzählung definieren und sie bei der Referenzierung als einzig zulässige Werte erzwingen könnten. trafficLight Aufzählungen können sowohl Eingabe- als auch Ausgabetypen sein.

  • Unions/Interfaces: Unions ermöglichen es Ihnen, ein oder mehrere Dinge in einer Anfrage zurückzugeben, abhängig von den Daten, die vom Client angefordert wurden. Wenn Sie beispielsweise einen Typ mit einem title Feld und einen Book Typ mit einem Feld hätten, könnten Sie eine name Vereinigung zwischen beiden Author Typen erstellen. Wenn Ihr Kunde eine Datenbank nach dem Ausdruck „Julius Caesar“ abfragen möchte, könnte die Vereinigung Julius Caesar (das Stück von William Shakespeare) aus dem Book title und Julius Caesar (den Autor von Commentarii de Bello Gallico) aus dem zurückgeben. Author name Unions können nur Ausgabetypen sein.

    Schnittstellen sind Gruppen von Feldern, die Objekte implementieren müssen. Dies ist ein bisschen vergleichbar mit Schnittstellen in Programmiersprachen wie Java, wo Sie die in der Schnittstelle definierten Felder implementieren müssen. Nehmen wir zum Beispiel an, Sie haben eine Schnittstelle namens erstelltBook, die ein title Feld enthält. Nehmen wir an, Sie haben später einen Typ namens Novel Implemented erstelltBook. Sie Novel müssten ein title Feld einschließen. Sie Novel könnten jedoch auch andere Felder hinzufügen, die nicht in der Benutzeroberfläche enthalten sind, wie pageCount oderISBN. Schnittstellen können nur Ausgabetypen sein.

In den folgenden Abschnitten wird erklärt, wie die einzelnen Typen in GraphQL funktionieren.

Objekte

GraphQL-Objekte sind der Haupttyp, den Sie im Produktionscode sehen werden. In GraphQL können Sie sich ein Objekt als eine Gruppierung verschiedener Felder vorstellen (ähnlich wie Variablen in anderen Sprachen), wobei jedes Feld durch einen Typ (normalerweise ein Skalar oder ein anderes Objekt) definiert wird, der einen Wert enthalten kann. Objekte stellen eine Dateneinheit dar, die aus Ihrer Serviceimplementierung abgerufen oder bearbeitet werden kann.

Objekttypen werden mit dem Schlüsselwort deklariert. Type Lassen Sie uns unser Schemabeispiel leicht modifizieren:

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String }

Die Objekttypen hier sind Person undOccupation. Jedes Objekt hat seine eigenen Felder mit eigenen Typen. Eine Funktion von GraphQL ist die Möglichkeit, Felder auf andere Typen festzulegen. Sie können sehen, dass das occupation Feld in einen Occupation Objekttyp Person enthält. Wir können diese Assoziation herstellen, weil GraphQL nur die Daten beschreibt und nicht die Implementierung des Dienstes.

Skalare

Skalare sind im Wesentlichen primitive Typen, die Werte enthalten. In gibt AWS AppSync es zwei Arten von Skalaren: die standardmäßigen GraphQL-Skalare und Skalare. AWS AppSync Skalare werden normalerweise verwendet, um Feldwerte innerhalb von Objekttypen zu speichern. Zu den standardmäßigen GraphQL-Typen gehören IntFloat,String,Boolean, undID. Lassen Sie uns das vorherige Beispiel noch einmal verwenden:

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String }

Wenn wir die title Felder name und herausgreifen, enthalten beide einen String Skalar. Namekönnte einen Zeichenkettenwert wie "John Smith" zurückgeben und der Titel könnte etwas wie "" firefighter zurückgeben. Einige GraphQL-Implementierungen unterstützen auch benutzerdefinierte Skalare, die das Scalar Schlüsselwort verwenden und das Verhalten des Typs implementieren. Unterstützt AWS AppSync derzeit jedoch keine benutzerdefinierten Skalare. Eine Liste der Skalare finden Sie unter Skalartypen in. AWS AppSync

Eingaben

Aufgrund des Konzepts der Eingabe- und Ausgabetypen gelten bestimmte Einschränkungen bei der Übergabe von Argumenten. Typen, die üblicherweise übergeben werden müssen, insbesondere Objekte, sind eingeschränkt. Sie können den Eingabetyp verwenden, um diese Regel zu umgehen. Eingaben sind Typen, die Skalare, Aufzählungen und andere Eingabetypen enthalten.

Eingaben werden mit dem Schlüsselwort definiert: input

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String } input personInput { id: ID! name: String age: Int occupation: occupationInput } input occupationInput { title: String }

Wie Sie sehen können, können wir separate Eingaben haben, die den ursprünglichen Typ nachahmen. Diese Eingaben werden häufig in Ihren Feldoperationen wie folgt verwendet:

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String } input occupationInput { title: String } type Mutation { addPerson(id: ID!, name: String, age: Int, occupation: occupationInput): Person }

Beachten Sie, dass wir immer noch übergebenoccupationInput, anstatt eine Occupation zu erstellenPerson.

Dies ist nur ein Szenario für Eingaben. Sie müssen Objekte nicht unbedingt 1:1 kopieren, und im Produktionscode werden Sie ihn höchstwahrscheinlich nicht so verwenden. Es empfiehlt sich, GraphQL-Schemas zu nutzen, indem Sie nur das definieren, was Sie als Argumente eingeben müssen.

Dieselben Eingaben können auch in mehreren Operationen verwendet werden, aber wir empfehlen, dies nicht zu tun. Jede Operation sollte idealerweise eine eigene eindeutige Kopie der Eingaben enthalten, falls sich die Anforderungen des Schemas ändern.

Besondere Objekte

GraphQL reserviert einige Schlüsselwörter für spezielle Objekte, die einen Teil der Geschäftslogik dafür definieren, wie Ihr Schema Daten abruft/manipuliert. In einem Schema kann höchstens eines dieser Schlüsselwörter vorkommen. Sie dienen als Einstiegspunkte für alle angeforderten Daten, die Ihre Clients für Ihren GraphQL-Dienst ausführen.

Spezielle Objekte werden ebenfalls mit dem type Schlüsselwort definiert. Obwohl sie anders als normale Objekttypen verwendet werden, ist ihre Implementierung sehr ähnlich.

Queries

Abfragen sind GET Operationen insofern sehr ähnlich, als sie einen schreibgeschützten Abruf durchführen, um Daten aus Ihrer Quelle abzurufen. In GraphQL Query definiert der alle Einstiegspunkte für Clients, die Anfragen an Ihren Server stellen. In Ihrer GraphQL-Implementierung wird es immer eine Query geben.

Hier sind die Query und die modifizierten Objekttypen, die wir in unserem vorherigen Schemabeispiel verwendet haben:

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String } type Query { people: [Person] }

Unser Query enthält ein Feld namenspeople, das eine Liste von Person Instanzen aus der Datenquelle zurückgibt. Nehmen wir an, wir müssen das Verhalten unserer Anwendung ändern, und jetzt müssen wir eine Liste nur der Occupation Instanzen für einen bestimmten Zweck zurückgeben. Wir könnten es einfach zur Abfrage hinzufügen:

type Query { people: [Person] occupations: [Occupation] }

In GraphQL können wir unsere Abfrage als einzige Quelle für Anfragen behandeln. Wie Sie sehen können, ist dies potenziell viel einfacher als RESTful Implementierungen, die möglicherweise unterschiedliche Endpunkte verwenden, um dasselbe zu erreichen (.../api/1/peopleund). .../api/1/occupations

Angenommen, wir haben eine Resolver-Implementierung für diese Abfrage, können wir jetzt eine tatsächliche Abfrage durchführen. Obwohl der Query Typ existiert, müssen wir ihn explizit aufrufen, damit er im Code der Anwendung ausgeführt werden kann. Dies kann mit dem query Schlüsselwort geschehen:

query getItems { people { name } occupations { title } }

Wie Sie sehen können, wird diese Abfrage aufgerufen getItems und gibt people (eine Liste von Person Objekten) und occupations (eine Liste von Occupation Objekten) zurück. peopleIn geben wir nur das name Feld von jedem zurückPerson, während wir jeweils das title Feld zurückgebenOccupation. Die Antwort könnte so aussehen:

{ "data": { "people": [ { "name": "John Smith" }, { "name": "Andrew Miller" }, . . . ], "occupations": [ { "title": "Firefighter" }, { "title": "Bookkeeper" }, . . . ] } }

Die Beispielantwort zeigt, wie die Daten der Form der Abfrage folgen. Jeder abgerufene Eintrag wird im Bereich des Felds aufgeführt. peopleund geben occupations Dinge als separate Listen zurück. Obwohl nützlich, könnte es bequemer sein, die Abfrage so zu ändern, dass sie eine Liste mit Namen und Berufen von Personen zurückgibt:

query getItems { people { name occupation { title } }

Dies ist eine legale Änderung, da unser Person Typ ein occupation Feld vom Typ Occupation enthält. Wenn es im Geltungsbereich von aufgeführt Person istpeople, geben wir jedes Feld name zusammen mit dem zugehörigen Wert Occupation von zurücktitle. Die Antwort könnte so aussehen:

} "data": { "people": [ { "name": "John Smith", "occupation": { "title": "Firefighter" } }, { "name": "Andrew Miller", "occupation": { "title": "Bookkeeper" } }, . . . ] } }
Mutations

Mutationen ähneln zustandsverändernden Operationen wie PUT oderPOST. Sie führen einen Schreibvorgang durch, um Daten in der Quelle zu ändern, und rufen dann die Antwort ab. Sie definieren Ihre Einstiegspunkte für Anfragen zur Datenänderung. Im Gegensatz zu Abfragen kann eine Mutation je nach den Anforderungen des Projekts in das Schema aufgenommen werden oder auch nicht. Hier ist die Mutation aus dem Schemabeispiel:

type Mutation { addPerson(id: ID!, name: String, age: Int): Person }

Das addPerson Feld stellt einen Einstiegspunkt dar, der der Datenquelle a Person hinzufügt. addPersonist der Feldname;id,name, und age sind die Parameter; und Person ist der Rückgabetyp. Rückblick auf den Person Typ:

type Person { id: ID! name: String age: Int occupation: Occupation }

Wir haben das occupation Feld hinzugefügt. Wir können dieses Feld jedoch nicht Occupation direkt auf setzen, da Objekte nicht als Argumente übergeben werden können; es handelt sich ausschließlich um Ausgabetypen. Wir sollten stattdessen eine Eingabe mit denselben Feldern als Argument übergeben:

input occupationInput { title: String }

Wir können unsere auch einfach aktualisierenaddPerson, um dies als Parameter einzubeziehen, wenn wir neue Person Instanzen erstellen:

type Mutation { addPerson(id: ID!, name: String, age: Int, occupation: occupationInput): Person }

Hier ist das aktualisierte Schema:

type Person { id: ID! name: String age: Int occupation: Occupation } type Occupation { title: String } input occupationInput { title: String } type Mutation { addPerson(id: ID!, name: String, age: Int, occupation: occupationInput): Person }

Beachten Sie, dass das title Feld von übergeben occupation wirdoccupationInput, um die Erstellung des Objekts Person anstelle des ursprünglichen Occupation Objekts abzuschließen. Unter der Annahme, dass wir eine Resolver-Implementierung für habenaddPerson, können wir jetzt eine tatsächliche Mutation durchführen. Der Mutation Typ existiert zwar, aber wir müssen ihn explizit aufrufen, damit er im Code der Anwendung ausgeführt wird. Dies kann mit dem mutation Schlüsselwort geschehen:

mutation createPerson { addPerson(id: ID!, name: String, age: Int, occupation: occupationInput) { name age occupation { title } } }

Diese Mutation wird als Operation bezeichnet createPerson und addPerson ist die Operation. Um eine neue zu erstellenPerson, können wir die Argumente fürid, nameage, und eingebenoccupation. Im Rahmen von addPerson können wir auch andere Felder wie nameage, usw. sehen. Dies ist Ihre Antwort. Dies sind die Felder, die nach Abschluss des addPerson Vorgangs zurückgegeben werden. Hier ist der letzte Teil des Beispiels:

mutation createPerson { addPerson(id: "1", name: "Steve Powers", age: "50", occupation: "Miner") { id name age occupation { title } } }

Mit dieser Mutation könnte ein Ergebnis so aussehen:

{ "data": { "addPerson": { "id": "1", "name": "Steve Powers", "age": "50", "occupation": { "title": "Miner" } } } }

Wie Sie sehen können, hat die Antwort die von uns angeforderten Werte in demselben Format zurückgegeben, das in unserer Mutation definiert war. Es empfiehlt sich, alle Werte zurückzugeben, die geändert wurden, um Verwirrung zu vermeiden und die Notwendigkeit weiterer Abfragen in der future zu verringern. Mutationen ermöglichen es Ihnen, mehrere Operationen in ihren Geltungsbereich einzubeziehen. Sie werden nacheinander in der Reihenfolge ausgeführt, die in der Mutation angegeben ist. Wenn wir beispielsweise eine weitere Operation mit dem Namen erstellenaddOccupation, die Berufsbezeichnungen zur Datenquelle hinzufügt, können wir dies in der nachfolgenden Mutation aufrufen. addPerson addPersonwird zuerst bearbeitet, gefolgt vonaddOccupation.

Subscriptions

Abonnements dienen WebSocketsdazu, eine dauerhafte bidirektionale Verbindung zwischen dem Server und seinen Clients herzustellen. In der Regel abonniert ein Client den Server oder hört ihn ab. Immer wenn der Server eine serverseitige Änderung vornimmt oder ein Ereignis ausführt, erhält der abonnierte Client die Updates. Dieser Protokolltyp ist nützlich, wenn mehrere Clients abonniert sind und über Änderungen auf dem Server oder anderen Clients informiert werden müssen. Abonnements können beispielsweise verwendet werden, um Social-Media-Feeds zu aktualisieren. Es könnte zwei Benutzer geben, Benutzer A und Benutzer B, die beide automatische Benachrichtigungen abonniert haben, wenn sie Direktnachrichten erhalten. Benutzer A auf Client A könnte eine Direktnachricht an Benutzer B auf Client B senden. Der Client von Benutzer A würde die Direktnachricht senden, die vom Server verarbeitet würde. Der Server würde dann die Direktnachricht an das Konto von Benutzer B senden und gleichzeitig eine automatische Benachrichtigung an Client B senden.

Hier ist ein Beispiel für aSubscription, das wir dem Schemabeispiel hinzufügen könnten:

type Subscription { personAdded: Person }

Das personAdded Feld sendet eine Nachricht an abonnierte Kunden, wenn der Datenquelle eine neue hinzugefügt Person wird. Vorausgesetzt, wir haben eine Resolver-Implementierung fürpersonAdded, können wir jetzt das Abonnement verwenden. Der Subscription Typ ist zwar vorhanden, aber wir müssen ihn explizit aufrufen, damit er im Code der Anwendung ausgeführt wird. Dies kann mit dem subscription Schlüsselwort geschehen:

subscription personAddedOperation { personAdded { id name } }

Das Abonnement wird aufgerufenpersonAddedOperation, und der Vorgang istpersonAdded. personAddedgibt die name Felder id und und neuer Person Instanzen zurück. Wenn wir uns das Mutationsbeispiel ansehen, haben wir Person mit dieser Operation eine hinzugefügt:

addPerson(id: "1", name: "Steve Powers", age: "50", occupation: "Miner")

Wenn unsere Kunden Updates für die neu hinzugefügten Apps abonniert hättenPerson, könnten sie nach dem Start Folgendes sehenaddPerson:

{ "data": { "personAdded": { "id": "1", "name": "Steve Powers" } } }

Im Folgenden finden Sie eine Zusammenfassung dessen, was Abonnements bieten:

Abonnements sind bidirektionale Kanäle, die es dem Client und dem Server ermöglichen, schnelle, aber stetige Updates zu erhalten. Sie verwenden in der Regel das WebSocket Protokoll, das standardisierte und sichere Verbindungen herstellt.

Abonnements sind insofern flexibel, als sie den Aufwand für den Verbindungsaufbau reduzieren. Einmal abonniert, kann ein Kunde dieses Abonnement einfach über einen längeren Zeitraum nutzen. Sie nutzen Computerressourcen in der Regel effizient, indem sie es Entwicklern ermöglichen, die Laufzeit des Abonnements individuell zu gestalten und zu konfigurieren, welche Informationen angefordert werden.

Im Allgemeinen ermöglichen Abonnements dem Kunden, mehrere Abonnements gleichzeitig abzuschließen. Apropos AWS AppSync, Abonnements werden nur für den Empfang von Echtzeit-Updates vom AWS AppSync Dienst verwendet. Sie können nicht zur Durchführung von Abfragen oder Mutationen verwendet werden.

Die wichtigste Alternative zu Abonnements ist das Polling, bei dem Abfragen in festgelegten Intervallen gesendet werden, um Daten anzufordern. Dieser Prozess ist in der Regel weniger effizient als Abonnements und belastet sowohl den Client als auch das Backend stark.

Eine Sache, die in unserem Schemabeispiel nicht erwähnt wurde, war die Tatsache, dass Ihre speziellen Objekttypen auch in einem schema Root-Verzeichnis definiert werden müssen. Wenn Sie also ein Schema exportieren AWS AppSync, könnte es so aussehen:

schema.graphql
schema { query: Query mutation: Mutation subscription: Subscription } . . . type Query { # code goes here } type Mutation { # code goes here } type Subscription { # code goes here }

Aufzählungen

Aufzählungen oder Aufzählungen sind spezielle Skalare, die die zulässigen Argumente einschränken, die ein Typ oder Feld haben kann. Das bedeutet, dass immer dann, wenn eine Aufzählung im Schema definiert ist, der zugehörige Typ oder das zugehörige Feld auf die Werte in der Aufzählung beschränkt wird. Aufzählungen werden als Zeichenkettenskalare serialisiert. Beachten Sie, dass verschiedene Programmiersprachen GraphQL-Enums möglicherweise unterschiedlich handhaben. JavaScript Hat beispielsweise keine native Enum-Unterstützung, sodass die Enum-Werte stattdessen Int-Werten zugeordnet werden können.

Aufzählungen werden mit dem Schlüsselwort definiert. enum Ein Beispiel:

enum trafficSignals { solidRed solidYellow solidGreen greenArrowLeft ... }

Beim Aufrufen der trafficLights Enumeration können die Argumente nursolidRed, solidYellowsolidGreen, usw. sein. Es ist üblich, Aufzählungen zu verwenden, um Dinge darzustellen, für die es eine bestimmte, aber begrenzte Anzahl von Auswahlmöglichkeiten gibt.

Unionen/Schnittstellen

Siehe Schnittstellen und Unions in GraphQL.