Mukautettujen tietotyyppien määrittäminen

GraphQL:ssä tietotyypit toimivat sovelluksen tietojen suunnitelmina. Ne määrittävät kyseltävissä tai muokattavissa olevien tietojen rakenteen ja tyypin.

GraphQL tarjoaa joitakin perustyyppejä, mutta usein tarvitsette omia tyyppejä, jotta ne vastaavat tarkasti sovelluksen yksilöllistä tietorakennetta.

GraphQL sisältää sisäänrakennettuja skalaarityyppejä, kuten String, Int, Boolean, Float ja ID. Nämä ovat perustavanlaatuisia yhden arvon tyyppejä.

Tuotantodatan rakenne on kuitenkin monimutkainen! Tässä tulevat mukaan objektityypit. Niiden avulla voitte määrittää objekteja, joilla on useita kenttiä ja joilla kullakin on oma tyyppinsä.

Objektityyppi määritellään GraphQL:n Schema Definition Language (SDL) -kielessä avainsanalla type. Ajatelkaa sitä mukautetun luokan tai tietorakenteen luomisena.

Jokaisella objektityypin kentällä on nimi ja tyyppi. Kentät voivat olla muita objektityyppejä, skalaarityyppejä tai jopa tyyppien listoja.

Kuvitellaan, että rakennamme kirjaston API:a. Tarvitsemme tavan esittää kirja. Book-objektityyppi voidaan määritellä seuraavasti:

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

Tyypin perässä oleva ! tarkoittaa, että kenttä on ei-nullable – sillä on aina oltava arvo.

Joskus sisäänrakennetut skalaarit eivät ole riittävän täsmällisiä. Esimerkiksi Date-kenttä voisi olla String, mutta entä jos haluatte varmistaa tietyn muodon?

Mukautettujen skalaarityyppien avulla voitte määrittää omia skalaarityyppejä, joilla on omat serialisointi-, jäsennys- ja validointisääntönsä. Näin tietojen yhdenmukaisuus säilyy.

Mukautetun skalaarin määrittäminen skeemassa on suoraviivaista. Käyttäkää avainsanaa scalar ja kirjoittakaa sen perään uuden skalaarityypin nimi.

Myöhemmin Spring Boot -sovelluksen on tarjottava varsinainen logiikka tämän mukautetun skalaarin tietomuunnoksia varten.

scalar Date

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

Enum-tyypit (lyhenne sanasta ”enumeration”) ovat erityisiä skalaarityyppejä, jotka esittävät rajallista joukkoa mahdollisia arvoja. Ne sopivat erinomaisesti kentille, joiden vaihtoehdot halutaan rajoittaa ennalta määritettyyn luetteloon.

Enum-tyypit tekevät skeemasta itseään paremmin dokumentoivan ja auttavat estämään virheellisten tietojen lähettämisen API:in.

Kirjaston API:ssa kirjalla voi olla tietty tila. Voimme määrittää sitä varten enum-tyypin:

enum BookStatus {
  AVAILABLE
  CHECKED_OUT
  LOST
  REPAIR
}

Nyt kaikki BookStatus-tyyppiä käyttävät kentät voivat sisältää vain yhden näistä neljästä arvosta.

Päivitetään Book-tyyppi käyttämään uutta BookStatus-enumia ja mukautettua Date-skalaaria.

scalar Date

enum BookStatus {
  AVAILABLE
  CHECKED_OUT
  LOST
}

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

Tämä osoittaa, miten mukautetuilla tyypeillä rakennetaan monipuolisempi ja täsmällisempi skeema.

Olette oppineet määrittämään GraphQL:n mukautettuja tietotyyppejä SDL:n avulla!

• Objektityypit (type) jäsentävät monimutkaisia tietoja.
• Mukautetut skalaarityypit (scalar) käsittelevät tiettyjä tietomuotoja.
• Enum-tyypit (enum) rajoittavat kenttien arvot rajalliseen joukkoon.

Nämä työkalut ovat ratkaisevan tärkeitä täsmällisen ja vankan GraphQL-skeeman rakentamisessa, jotta se kuvaa sovelluksen toimialuetta oikein.