Definition af brugerdefinerede datatyper

I GraphQL fungerer datatyper som grundplaner for oplysningerne i din applikation. De definerer strukturen og typen af data, der kan forespørges om eller ændres.

GraphQL har nogle grundlæggende typer, men du får ofte brug for at definere dine egne, så de passer perfekt til din applikations unikke datastruktur.

GraphQL har indbyggede skalar-typer som String, Int, Boolean, Float og ID. Det er grundlæggende typer med én enkelt værdi.

Men data fra den virkelige verden er komplekse! Her kommer objekttyper ind i billedet. De lader dig definere objekter med flere felter, som hver har deres egen type.

Du definerer en objekttype ved hjælp af nøgleordet type i GraphQL's Schema Definition Language (SDL). Tænk på det som at oprette en brugerdefineret klasse eller struktur.

Hvert felt i en objekttype har et navn og en type. Felter kan være andre objekttyper, skalar-typer eller endda lister med typer.

Lad os forestille os, at vi bygger en API til et bibliotek. Vi har brug for en måde at repræsentere en bog på. Sådan kan du definere objekttypen Book:

type Book {
  id: ID!
  title: String!
  author: String
  publicationYear: Int
}

! efter en type betyder, at feltet er ikke-nullbart – det skal altid have en værdi.

Nogle gange er de indbyggede skalar-typer ikke specifikke nok. Et felt Date kunne f.eks. være en String, men hvad nu hvis du skal sikre et bestemt format?

Brugerdefinerede skalar-typer lader dig definere dine egne skalar-typer med specifikke regler for serialisering, fortolkning og validering. Det sikrer ensartede data.

Det er enkelt at definere en brugerdefineret skalar-type i dit skema. Du bruger nøgleordet scalar efterfulgt af navnet på den nye skalar-type.

Senere skal din Spring Boot-applikation levere den konkrete logik til håndtering af denne brugerdefinerede skalar-types datatransformationer.

scalar Date

type Event {
  id: ID!
  name: String!
  eventDate: Date!
}

Enum-typer (en forkortelse for 'enumeration') er særlige skalar-typer, der repræsenterer et endeligt sæt mulige værdier. De er gode til felter, hvor du vil begrænse valgmulighederne til en foruddefineret liste.

Enums gør dit skema mere selvforklarende og hjælper med at forhindre, at ugyldige data sendes til din API.

I vores biblioteks-API kan en bog have en bestemt status. Vi kan definere en enum til dette:

enum BookStatus {
  AVAILABLE
  CHECKED_OUT
  LOST
  REPAIR
}

Nu kan ethvert felt, der bruger BookStatus, kun have én af disse fire værdier.

Lad os opdatere typen Book, så den bruger vores nye enum BookStatus og en brugerdefineret skalar-type Date.

scalar Date

enum BookStatus {
  AVAILABLE
  CHECKED_OUT
  LOST
}

type Book {
  id: ID!
  title: String!
  author: String
  publicationYear: Int
  status: BookStatus!
  lastCheckedOut: Date
}

Det viser, hvordan brugerdefinerede typer skaber et rigere og mere præcist skema.

Du har lært, hvordan du definerer brugerdefinerede datatyper i GraphQL ved hjælp af SDL!

• Objekttyper (type) strukturerer komplekse data.
• Brugerdefinerede skalar-typer (scalar) håndterer bestemte dataformater.
• Enum-typer (enum) begrænser feltværdier til et endeligt sæt.

Disse værktøjer er afgørende for at bygge et præcist og robust GraphQL-skema, der nøjagtigt repræsenterer din applikations domæne.