GET-meetod: kataloogi laadimine
Saad teada, kuidas klient, server ja andmebaas omavahel suhtlevad ning kuidas andmed nende vahel liiguvad. Veebipoe kataloogi laadimise näitel vaatame, kuidas GET-päring töötab ja kuidas server andmed kliendile tagastab.
Tootest
BB Food on kojuveoga toidukaupade e-pood. Ostja avab veebilehe, sirvib kataloogi, valib tooted ja vormistab tellimuse.
Praegu on kataloogis 7 toodet. Enne veebilehe testimist vaatame, kuidas see töötab: mis toimub brauseris, mis serveris ja kus tooteid hoitakse.
Alustame peamisest: kuidas on üles ehitatud peaaegu iga veebirakendus.
Teeme selgeks!
Sellel on kaks poolt. Klient on see, mida inimene kasutab: brauser või mobiilirakendus. Server on programm teises arvutis, mis töötab ööpäevaringselt ja kuulab päringuid. Klient küsib, server vastab.
Ostja brauser saadab päringu „anna tootenimekiri“ ja programm teises arvutis vastab sellele. Kes neist on klient ja kes server?
Kuule, kust server andmed võtab?
Server hoiab andmeid andmebaasis. See on eraldi programm, sageli isegi eraldi arvutis. Klient ei pöördu andmebaasi poole otse: sellega suhtleb ainult server.
Ka server ja andmebaas vahetavad päringuid, kuid oma keeles — SQL-is.
Aga kuidas nad üldse teineteisest aru saavad?
Neil on oma eriline keel — HTTP-protokoll. See on kõige levinum, kuid on ka teisi. Klient saadab päringu ja server tagastab vastuse. Nii päringul kui ka vastusel on range vorming. Päring näeb välja nii. Tegelikult võib päringul olla rohkem osi, kuid kõike korraga ei jõua — alustame lihtsast variandist, millel on kaks osa:
Päring
GET /api/v1/products
- Osa 1. Meetod — mida teha.
GETtähendab „saa“. On ka teisi meetodeid — neist räägime hiljem - Osa 2. Aadress — millega.
/api/v1/productson tootenimekiri
Selge! Ja mida server vastuseks saadab?
Lihtsas variandis on ka vastusel kaks osa:
Vastus
200 OK
[
{
"id": 1,
"name": "Banaanid, 1 kg",
"price": 1.49
},
{
"id": 2,
"name": "Kirsstomatid, 250 g",
"price": 2.29
},
…
]- Osa 1. Olekukood — kuidas läks.
200 OKtähendab „õnnestus“ - Osa 2. Vastuse keha (response body) — andmed ise, tavaliselt JSON-vormingus
Kontrollime, kas kõik on selge. Kust saab klient tootenimekirja?
Oota, mis asi on JSON?
JSON on lihtne tekstivorming, milles programmid üksteisele andmeid saadavad. Ka inimene loeb seda kergesti, nii et testija näeb seda pidevalt. JSON ei ole ainus selline vorming — on ka teisi —, kuid alustame temast: seda kohtab kõige sagedamini.
Kõige lihtsam variant on objekt. See kirjutatakse loogeliste sulgude { } vahele ja koosneb paaridest „võti: väärtus“.
Võti on välja nimi jutumärkides. Väärtus on tekst jutumärkides või number ilma jutumärkideta. Paarid eraldatakse komadega.
Nii näeb välja üks toode:
{
"id": 3,
"name": "Piim 2,5%, 1 l",
"price": 1.19
}Loeb lihtsalt: toote id on 3, nimi „Piim 2,5%, 1 l“, hind 1.19. Pane tähele: JSON-is kirjutatakse kümnendmurrud punktiga.
Harjutame natuke. Server saatis sellise objekti. Mis on selle toote hind?
{
"id": 4,
"name": "Gouda juust, 200 g",
"price": 2.99
}Aga kui tooteid on palju, kuidas siis?
Siis pannakse objektid nimekirja — seda nimetatakse ka massiiviks. Nimekiri kirjutatakse nurksulgude [ ] vahele ja objektid on selle sees komadega eraldatud. Just nii saadab server meie kataloogi:
[
{"id": 1, "name": "Banaanid, 1 kg", "price": 1.49},
{"id": 2, "name": "Kirsstomatid, 250 g", "price": 2.29}
]Kui tooteid üldse pole, tuleb tühi nimekiri []. See pole viga, vaid lihtsalt „andmeid pole“ — jäta meelde, see tuleb meil veel kasuks.
Tähelepanu küsimus: mitu toodet on selles vastuses?
[
{"id": 1, "name": "Banaanid, 1 kg", "price": 1.49},
{"id": 5, "name": "Rukkileib", "price": 1.79},
{"id": 6, "name": "Apelsinimahl, 1 l", "price": 2.49}
]Hurraa, proovime praktikas järele!
Siin on BB Foodi veebileht. Tooteid sellel veel ei kuvata: brauser pole serverilt veel midagi küsinud.
Sinu ülesanne praegu: vajuta „Laadi tooted“ ja jälgi ümbriku teekonda: klient → server → andmebaas → server → klient.
Testitav rakendus
Stsenaarium 1. Positiivne: server töötab
Server ootab päringuid. Vajuta brauseris „Laadi tooted“, et klient saadaks päringu GET /api/v1/products.
Animatsioon on aeglustatud: tegelikult võtab kogu teekond mõnikümmend millisekundit.
Tooteid pole veel laaditud.
Tooteid ei õnnestunud laadida: serveris tekkis viga (500). Proovi hiljem uuesti.
Tooted laaditi! Kuid need ei ela brauseris: need on salvestatud serveri poolel andmebaasis ja klient saab need iga kord päringuga.
Oi, kas tooteid saab uuesti laadida?
Jah, muidugi. Päring läbib sama tee: klient → server → andmebaas → server → klient. Kuid vastus näitab alati andmebaasi hetkeseisu: kui tooted on muutunud, tuleb juba teistsugune vastus.
Huvitav! Aga kuidas tooted andmebaasis välja näevad?
Hea küsimus! Andmebaas hoiab andmeid tabelites. Meie tooted on tabelis products. Üks rida on üks toode ja üks veerg on toote üks omadus: id on unikaalne number, name on nimi ja price on hind.
Kui saabub päring GET /api/v1/products, täidab server SQL-päringu SELECT * FROM products. See tähendab „vali tabelist products kõigi ridade kõik veerud“. Seejärel teeb server ridadest JSON-i ja saadab selle kliendile.
Nii näeb andmebaasis välja tabel products:
| id | name | price |
|---|---|---|
| 1 | Banaanid, 1 kg | 1.49 |
| 2 | Kirsstomatid, 250 g | 2.29 |
| 3 | Piim 2,5%, 1 l | 1.19 |
| 4 | Gouda juust, 200 g | 2.99 |
| 5 | Rukkileib | 1.79 |
| 6 | Apelsinimahl, 1 l | 2.49 |
| 7 | Soolaheeringas, 300 g | 3.29 |
Ja pea meeles: klient ei lähe kunagi ise andmebaasi. Andmebaasiga suhtleb ainult server.
Võrdle veebilehe tooteid selle tabeliga: kas kõik jõudsid kliendini?
Ostja vajutab „Laadi tooted“ viis korda järjest. Mis juhtub andmebaasis olevate toodetega?
Positiivne stsenaarium on läbi võetud. Liigume edasi?
Jah, lähme edasi!
Stsenaarium 2. Negatiivne: serveri viga
Niisiis, positiivse stsenaariumi kontrollisime: server töötab ja tooted jõudsid kliendini. Kuid testijat huvitab alati midagi muud: mis siis, kui midagi läheb valesti? Näiteks serveris läheb midagi katki. Mis sa arvad, mida kasutaja siis näeb?
Hmm, ei aimagi. Kontrollime!
Kujutame ette, et serveris läks midagi katki.
Sinu ülesanne praegu: vajuta allolevel veebilehel „Laadi tooted“ ja vaata, mis juhtub.
Server töötab ja vastab, kuid toodete asemel tagastas ta vea 500: serveri sees läks midagi katki. Pane tähele: vastus jõudis kohale ja selles on kood. Kõik koodid, mis algavad viiega, on serveripoolsed vead: kasutaja pole milleski süüdi, parandada tuleb server.
Pea meeles: 500 on serveri viis öelda „minu poolel läks midagi katki“. Neljaga algavad koodid ütlevad vastupidi, et eksis klient: näiteks küsis midagi, mida pole.
Mida ma siin kontrollima peaksin ja miks?
Hea küsimus! Testija kontrollib mitte ainult seda, mis töötab siis, kui kõik on korras, vaid ka seda, kuidas rakendus rikke korral käitub. Kontrolli kolme asja: kasutaja näeb arusaadavat veateadet, mitte tehnilist koodi ega tühja ekraani, rakendus ei jää ootama ja nuppu saab uuesti vajutada. Miks? Serverid lähevad katki ja kasutaja ei tohi sellisel juhul segadusse jääda.
Teata arendajatele veast
Arendajad parandasid serveri. Hurraa! Hea, et kõik töötab jälle ja saame testimist jätkata.
Sinu ülesanne praegu: vajuta „Laadi tooted“ — nüüd peaks päring õnnestuma.
Suurepärane, kõik töötab! Aga puhkame nüüd natuke — lähme joome kohvi ☕
Lähme!
Lühiviide
Klient
Programm, mida inimene kasutab: brauser või mobiilirakendus. Klient kuvab liidest ja küsib andmeid serverilt.
Server
Programm, mis kuulab pidevalt sissetulevaid päringuid, töötleb neid ja saadab vastuse. Server ei kirjuta kunagi esimesena: see ainult vastab klientide päringutele.
Andmebaas
Hoidla, kus andmed on tabelites. Klient ei pöördu andmebaasi poole otse: sellega töötab ainult server.
Päring ja vastus
Klient ja server suhtlevad HTTP-protokolli kaudu. Päringus on meetod (mida teha) ja aadress (millega). Vastuses on olekukood (kuidas läks) ja keha andmetega, enamasti JSON-vormingus.
JSON
Tekstiline andmevorming. Objekt kirjutatakse loogeliste sulgude { } vahele „võti: väärtus“ paaridena, näiteks {"id": 3, "price": 1.19}. Tekst on jutumärkides, numbrid ilma jutumärkideta. Objektide nimekiri kirjutatakse nurksulgude [ ] vahele komadega eraldatult. Tühi nimekiri [] tähendab „andmeid pole“, mitte viga.
GET-meetod ja kood 200
GET /api/v1/products tähendab „saa andmed“. See ei muuda serveris midagi, seega võib seda korrata kui tahes palju kordi. Kood 200 OK tähendab, et päring õnnestus.
Kood 500
Vastus, mille server saadab, kui tema enda poolel läks midagi katki. Viiega algavad koodid on serveri vead, neljaga algavad koodid kliendi vead. Testija kontrollib, et kasutaja näeb arusaadavat veateadet ja rakendus ei jää ootama.