GraphQL-rajapinnat Spring Bootilla · Oppitunti

Mutaation syöteargumenttien validointi

Oppikaa validoimaan saapuvat mutaatioargumentit Spring Boot GraphQL -rajapinnassa Bean Validationin avulla, jotta tietokerrokseen päätyy vain puhdasta ja oikeanmuotoista dataa.

Oppitunti 4/413 vaihetta

Mutaation syöteargumenttien validointi on ilmainen GraphQL-rajapinnat Spring Bootilla-oppitunti CoddyKitissä. Tämä on oppitunti 4/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu GraphQL-rajapinnat Spring Bootilla-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. GraphQL-rajapinnat Spring Bootilla-kurssilla on yhteensä 4 oppituntia.

Miksi mutaation syöte pitää validoida?

Muutaatiot muuttavat tietojasi, joten niiden vastaanottamien argumenttien on oltava luotettavia. Ilman validointia asiakkaat voisivat lähettää tyhjiä nimiä, negatiivisia hintoja tai virheellisesti muotoiltuja sähköpostiosoitteita suoraan tietokantaan.

Syötteen validointi hylkää virheelliset tiedot ajoissa ja palauttaa selkeän virheen ennen kuin tietoja tallennetaan.

Validointi GraphQL:n elinkaaressa

GraphQL validoi jo syötteen rakenteen skeemaa vasten (tyypit ja pakolliset kentät). Se ei kuitenkaan tarkista liiketoimintasääntöjä, kuten että hinnan on oltava positiivinen.

Tämä semanttinen taso on sinun vastuullasi, ja Springin Bean Validation sopii siihen täydellisesti.

Bean Validation -annotaatiot

Spring Boot sisältää Jakarta Bean Validation -tuen. Yleisiä annotaatioita:

@NotNull, @NotBlank pakollisille arvoille
@Size pituusrajoille
@Min, @Max, @Positive lukuarvoille
@Email sähköpostiosoitteen muodon tarkistamiseen

Syötekoaliluokan annotointi

Yhdistä GraphQL-syötetyyppi Java-recordiin tai -luokkaan ja lisää sen kentille rajoitteet.

public record CreateBookInput(
    @NotBlank String title,
    @Size(min = 2, max = 60) String author,
    @Positive double price
) {}

Validoinnin käynnistäminen resolverissa

Lisää @Valid-annotaatio mutaatiometodin argumenttiin. Tämän jälkeen Spring tarkistaa kaikki rajoitteet ennen metodirungon suorittamista.

@MutationMapping
public Book createBook(@Argument @Valid CreateBookInput input) {
    return bookService.create(input);
}

Mitä virhetilanteessa tapahtuu

Jos jokin rajoite ei täyty, Spring heittää ConstraintViolationException-poikkeuksen ennen palvelukoodin suorittamista. Mutaatio ei tallenna mitään, joten tietokerrokseen ei päädy virheellistä tilaa.

Mukautetut virheilmoitukset

Jokainen annotaatio hyväksyy message-attribuutin, jonka ansiosta asiakkaat saavat yleisen virheen sijaan hyödyllisen palautteen.

@NotBlank(message = "Title is required")
String title;

Rikkomusten muuntaminen GraphQL-virheiksi

Muuta validointipoikkeukset DataFetcherExceptionResolver-resolverin avulla selkeiksi GraphQL-virheiksi, joissa on kenttäkohtaiset tiedot. Näin asiakkaat tietävät tarkalleen, mikä syöte oli virheellinen.

@Override
public GraphQLError resolveToSingleError(Throwable ex, DataFetchingEnvironment env) {
    return GraphqlErrorBuilder.newError(env)
        .errorType(ErrorType.BAD_REQUEST)
        .message(ex.getMessage())
        .build();
}

Mukautetut validaattorit

Jos sisäänrakennetut annotaatiot eivät pysty ilmaisemaan jotakin sääntöä (kuten että ISBN-tunnuksen on oltava yksilöllinen), kirjoita mukautettu rajoite, joka toteuttaa ConstraintValidator-rajapinnan, ja annotoi kentät sillä.

public class IsbnValidator implements ConstraintValidator<ValidIsbn, String> {
    public boolean isValid(String value, ConstraintValidatorContext ctx) {
        return value != null && value.matches("\\d{13}");
    }
}

Sisäkkäisten syötteiden validointi

Kun syöte sisältää toisen olion, merkitse myös sisäkkäinen kenttä annotaatiolla @Valid. Tällöin validointi etenee myös lapsiolioon.

public record OrderInput(
    @NotNull @Valid AddressInput shippingAddress,
    @Positive int quantity
) {}

Parhaat käytännöt

Pidä validointi luotettavana:

Validoi rajapinnalla ennen liiketoimintalogiikan suorittamista
Palauta kenttäkohtaisia viestejä, joiden perusteella asiakkaat voivat toimia
Uudelleenkäytä syöteluokkia toisiinsa liittyvissä mutaatioissa
Pidä mukautetut validaattorit tilattomina ja nopeina

Pikatarkistus

Testaa, miten hyvin ymmärrät mutaatioiden validoinnin.

Vastaa interaktiivisessa oppitunnissa

Kertaus

Opit validoimaan mutaatioiden syötteitä:

GraphQL tarkistaa rakenteen; liiketoimintasäännöt on toteutettava itse
Annotoi syöte- eli input-luokat Bean Validation -rajoitteilla
Käytä @Valid-annotaatiota resolvereissa tarkistusten käynnistämiseen
Muuta rikkomukset selkeiksi GraphQL-virheiksi
Kirjoita mukautettuja validaattoreita ja käytä sisäkkäisten @Valid-annotaatioiden ketjutusta

Validoidut mutaatiot pitävät tietokerroksen turvallisena ja siistinä.

Aloita maksutta

Opi GraphQL-rajapinnat Spring Bootilla tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 12
Oppitunnit: 48

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”Mutaation syöteargumenttien validointi” ilmainen?

Kyllä – oppitunnin ”Mutaation syöteargumenttien validointi” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko GraphQL-rajapinnat Spring Bootilla-kurssin, päivitä CoddyKit PROhon. GraphQL-rajapinnat Spring Bootilla-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Mutaation syöteargumenttien validointi”?

Oppikaa validoimaan saapuvat mutaatioargumentit Spring Boot GraphQL -rajapinnassa Bean Validationin avulla, jotta tietokerrokseen päätyy vain puhdasta ja oikeanmuotoista dataa. Harjoittelet GraphQL-rajapinnat Spring Bootilla-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni GraphQL-rajapinnat Spring Bootilla-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin GraphQL-rajapinnat Spring Bootilla-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 4/4.

Kuinka kauan ”Mutaation syöteargumenttien validointi”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä GraphQL-rajapinnat Spring Bootilla-oppitunnilla?

Kyllä. Jokainen GraphQL-rajapinnat Spring Bootilla-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

← Takaisin: GraphQL-rajapinnat Spring Bootilla