Kaip pateikti HTTP užklausas Node.js naudojant mazgo gavimą

Kaip Pateikti Http Uzklausas Node Js Naudojant Mazgo Gavima



HTTP užklausos yra labai svarbios ir yra skirtos informacijai gauti iš URL visame pasaulyje, t. y. iškviečiant svetainę ir pan. Šis metodas taikomas, kai žiniatinklio programai reikia užmegzti ryšį su žiniatinklio serveriais, kad galėtų pasiekti išteklius. Pavyzdžiui, duomenų gavimas arba paskelbimas žiniatinklio serveryje arba API.

„JavaScript“ tai galima atlikti naudojant „ window.fetch() “ metodas. Tačiau „ node.js “, šią funkciją galima pasiekti naudojant kelis paketus, ty mazgo gavimą ir pan.

Šiame tinklaraštyje paaiškinamos šios turinio sritys:







Kas yra „mazgo gavimas“?

mazgo gavimas “ atitinka lengvą modulį, dėl kurio gavimo API pasiekiama node.js. Šis modulis taip pat leidžia vartotojams naudoti „ atnešti () “ metodas node.js, kuris dažniausiai panašus į „JavaScript“ window.fetch() “ metodas.



Sintaksė(fetch() metodas)



atnešti ( url [ , galimybės ] ) ;

Šioje sintaksėje:





  • url “ nurodo šaltinio, kurį reikia gauti / nuskaityti, URL.
  • galimybės “ parametras reikalingas, kai reikia naudoti „fetch()“ metodą, išskyrus „ GAUTI “ prašymas.

Grąžinimo vertė

Ši funkcija nuskaito atsakymo objektą, apimantį informaciją apie HTTP atsakymą, kaip nurodyta toliau:



  • tekstas: Gauna atsakymo turinį eilutės pavidalu.
  • antraštės: Pateikia objektą, kurį sudaro atsakymų tvarkyklės.
  • json (): Išnagrinėja atsakymo turinį JSON objekte.
  • statustekstas / būsena: Apima informaciją apie HTTP būsenos kodą.
  • Gerai: duoda ' tiesa “, jei būsena yra 2xx būsenos kodas.

Būtinos mazgo gavimo naudojimo sąlygos

Toliau pateikiamos būtinos sąlygos, į kurias reikia atsižvelgti prieš pradedant „ mazgo gavimas “:

  • Įdiegta bent arba naujausia nei 17.5 versija.
  • Pagrindinės JavaScript žinios.

Kaip pateikti HTTP užklausas node.js naudojant node-fetch?

HTTP užklausų teikimas yra asinchroninė procedūra, nes prašomo atsakymo gavimas užtrunka šiek tiek laiko. Tai yra tokia, kad gali būti dvi asinchroninių procedūrų naudojimo metodikos. Pirmasis yra tas, kad vartotojas gali laukti atsakymo ir tada tęsti su kodu. Kitas lygiagrečiai vykdo kodą.

Kaip pradėti naudoti mazgų gavimą?

Prieš pradėdami arba diegdami „ mazgo gavimas “ modulį, inicijuokite mazgo projektą naudodami toliau pateiktą komandą:

npm init - ir

Vykdant šią komandą sukuriama „ package.json “ failą dabartiniame kataloge taip:

Dabar įdiekite „ mazgo gavimas “ modulį naudodami šį cmdlet:

npm diegimo mazgas - atnešti

Tačiau norėdami įdiegti tikslinio modulio versiją, naudokite šią komandą:

npm diegimo mazgas - atnešti@ 2.0

Šiuo atveju „ 2.0 “ bus įdiegta modulio versija.

Pastaba: Prieš tęsdami su pavyzdžiais, sukurkite „ index.mjs “ failą darbo srityje, kuri bus naudojama funkcijoms taikyti.

1 pavyzdys: Siųsti gauti užklausas per mazgo gavimą

mazgo gavimas “ modulis gali būti naudojamas norint gauti tekstą iš žiniatinklio serverio arba duomenis per Rest API.

Žemiau pateiktas kodo pavyzdys, parašytas sukurtame ' index.mjs “ failas pateikia paprastą užklausą Gauti pagrindinį „YouTube“ puslapį:

importuoti atnešti „mazgo gavimas“ ;

atnešti ( „https://youtube.com“ )

. tada ( res => res. tekstą ( ) )

. tada ( tekstą => konsolė. žurnalas ( tekstą ) ) ;

Šiose kodo eilutėse:

  • Įkelti ' mazgo gavimas “ modulį ir per nurodytą URL, į kurį pateikiama HTTP užklausa, nuskaityti pagrindinį „YouTube“ puslapį.
  • Po to sujunkite „ tada () “ metodus, kaip tvarkyti atsakymą ir pateiktos užklausos duomenis.
  • Ankstesnis metodas „tada ()“ rodo, kad reikia laukti atsakymo iš „YouTube“ serverio ir paversti jį teksto formatu.
  • Pastarasis metodas „ten()“ reiškia ankstesnės transformacijos rezultato laukimą ir rodo jį konsolėje.

Išvestis

Dabar paleiskite kodą naudodami šią cmdlet:

mazgo indeksas. mjs

Vykdydami aukščiau pateiktą komandą, bus nuskaitytas visas konsolėje rodomas „YouTube“ pagrindinio puslapio HTML žymėjimas:

2 pavyzdys: Gaukite JSON duomenis iš poilsio API

Šiame pavyzdyje naudojama „ mazgo gavimas “, kad gautumėte netikrus duomenis per JSONPlaceholder RestAPI. Taip yra, kad „ atnešti () “ metodas apima serverio URL ir laukia atsakymo:

importuoti atnešti „mazgo gavimas“ ;

atnešti ( „https://jsonplaceholder.typicode.com/users“ )

. tada ( res => res. json ( ) )

. tada ( json => {

konsolė. žurnalas ( 'Pirmasis masyvo vartotojas ->' ) ;

konsolė. žurnalas ( json [ 0 ] ) ;

konsolė. žurnalas ( 'Pirmasis masyvo vartotojo vardas ->' ) ;

konsolė. žurnalas ( json [ 0 ] . vardas ) ;

} )

Pagal šį kodo bloką atlikite šiuos veiksmus:

  • HTTPS korpusą sudaro JSON formatuoti duomenys, turintys vartotojo duomenis.
  • Po to „ json () “ funkcija taikoma atskiriems įrašams ir atitinkamoms reikšmėms iškviesti.

Išvestis

Norėdami vykdyti kodą, naudokite toliau nurodytą cmdlet:

mazgo indeksas. mjs

3 pavyzdys: paskelbimo užklausos per mazgo gavimą

mazgo gavimas “ modulis taip pat gali būti naudojamas užklausoms paskelbti, o ne jas gauti. Tai galima pasiekti naudojant „ atnešti () “ metodas, apimantis papildomą parametrą, skirtą serveriui pateikti POST užklausas.

Su šiuo parametru galima priskirti kelias parinktis. Tačiau šiuo atveju „ metodas ', ' kūnas “ ir „ antraštes ' Bus panaudota. Toliau pateikiamas kiekvienos parinkties aprašymas:

  • metodas “ parinktis nustato HTTP užklausų tipą, t. y. „POST“ šiame scenarijuje.
  • kūnas “ parinktį sudaro užklausos turinys.
  • antraštę “ parinktyje yra visos reikalingos antraštės, ty „ Turinio tipas “ pagal šį scenarijų.

Dabar pereikite prie praktinio paskelbimo užklausų siuntimo įgyvendinimo, pridėdami naują elementą prie JSON rezervuotos vietos. visi “. Tai atliekama prie sąrašo pridedant naują elementą, kurio vartotojo ID yra „476“:

importuoti atnešti „mazgo gavimas“ ;

tegul viskas = {

Vartotojo ID : 476 ,

svetainę : 'Tai yra Linux užuomina' ,

baigtas : klaidinga

} ;

atnešti ( „https://jsonplaceholder.typicode.com/todos“ , {

metodas : „PASKELBTI“ ,

kūnas : JSON. sugriežtinti ( visi ) ,

antraštes : { 'Turinio tipas' : „application/json“ }

} ) . tada ( res => res. json ( ) )

. tada ( json => konsolė. žurnalas ( json ) ) ;

Šiame kode:

  • Pirmiausia sukurkite „todo“ objektą ir paverskite jį JSON, pridėdami jį prie korpuso.
  • Dabar taip pat nurodykite URL su reikiamomis parinktimis kaip „ atnešti () “ metodo pasirenkamus parametrus.
  • Po to pritaikykite „ JSON.stringify() “ metodą, skirtą paversti objektą suformatuota (JSON) eilute prieš siunčiant / perduodant jį į žiniatinklio serverį.
  • Eidami į priekį, įgyvendinkite bendrą tada () “ metodus, kaip gauti duomenis, laukiant atsakymo, transformuojant juos į JSON ir atitinkamai prisijungiant prie konsolės.

Išvestis

Vykdykite toliau pateiktą komandą, kad paleistumėte kodą:

mazgo indeksas. mjs

Kas yra HTTP būsenos kodai?

Prieš pereidami prie kito pavyzdžio, įsitikinkite, kad jei atsakyme yra „ 3xx “ būsenos kodą, papildomus veiksmus turi atlikti klientas. Taip pat „ 4xx “ kodai reiškia neteisingą užklausą, o „ 5xx “ kodai atitinka serverio klaidas.

Pastaba: sugauti () “ funkcija negali susidoroti su aukščiau aptartais atvejais, nes serverio ryšys vyksta supaprastintu būdu. Todėl veiksmingas būdas užtikrinti, kad nepavykusios užklausos grąžintų klaidą, yra apibrėžti funkciją, analizuojančią serverio atsako HTTP būseną.

4 pavyzdys: Susidoroti su išimtimis ir apribojimais

Gali būti keletas apribojimų arba išimčių, susijusių su siunčiamomis užklausomis, pvz., problemos su internetu, ' atnešti () ' funkcijų apribojimai ir tt Šios išimtys gali būti tvarkomos pridedant ' sugauti () ' funkcija:

funkcija analizėStatus ( x ) {

jeigu ( x. Gerai ) {

grąžinti x

} Kitas {

mesti naujas Klaida ( „HTTP būsena atsakymo atžvilgiu -> $ { x. statusą } ( $ { x. statusTekstas } ) ` ) ;

}

}

atnešti ( „https://jsonplaceholder.typicode.com/MissingResource“ )

. tada ( analizuotiBūsena )

. tada ( x => x. json ( ) )

. tada ( json => konsolė. žurnalas ( json ) )

. sugauti ( klysti => konsolė. žurnalas ( klysti ) ) ;

Šiame kodo fragmente:

  • Pirmiausia, prieš analizuodami atsakymą, apibrėžkite funkciją, turinčią nurodytą parametrą, kad susidorotumėte su iškilusiais apribojimais.
  • Dabar įtraukite „ jei/kitaip “ teiginius, kad pašalintumėte iškilusią klaidą arba pasirinktinį apribojimą.
  • Po to panašiai pritaikykite „ atnešti () “ metodą ir susijusius „ten()“ metodus, skirtus duomenims nuskaityti laukiant atsakymo, transformuojant juos į JSON ir prisijungiant prie konsolės.
  • Galiausiai, vykdymo laiko išimtis galima išspręsti įdėjus „ sugauti () “ metodas pažadų grandinės gale.

Išvestis

Galiausiai paleiskite toliau pateiktą cmdlet, kad paleistumėte kodą ir išmeskite iškilusias išimtis:

mazgo indeksas. mjs

Kiti „mazgo gavimo“ naudojimo atvejai

mazgo gavimas “ taip pat gali būti naudojamas gaminant “ API užklausos “ arba „ Žiniatinklio įbrėžimas “. Išsamiai aptarkime šiuos naudojimo atvejus.

Mazgo gavimo naudojimas teikiant API užklausas

API gali būti reikalinga keliuose scenarijuose, norint gauti tikslinius duomenis per vidinį šaltinį. HTTP užklausos gali turėti daug autentifikavimo metodų, pvz., naudojant API raktą, kai API teikėjas pateikia tik vartotojui skirtą raktą. Kitas būdas apsaugoti API gali būti „ Pagrindinis autentifikavimas “, kuriame reikia išsiųsti antraštę, kad būtų iškviesta API.

Toliau pateikiamas pastarojo metodo demonstravimas, t. y. „Pagrindinis autentifikavimas“ pašto užklausoje, naudojant „ atnešti () “ metodas:

( async ( ) => {

konst x = laukti atvežimo ( „http://httpbin.org/post“ , {

metodas : „PASKELBTI“ ,

antraštes : {

'Įgaliojimas' : „Pagrindiniai $ { bro ( 'prisijungimo slaptažodis' ) } `

} ,

kūnas : JSON. sugriežtinti ( {

'Raktas' : 'vertė'

} )

} ) ;

konst rezultatas = laukti x. tekstą ( ) ;

konsolė. žurnalas ( rezultatas ) ;

} ) ( ) ;

Aukščiau pateiktoje demonstracijoje antraštė siunčiama su „ bazė64 'užkoduota formato eilutė' prisijungimo slaptažodis “.

Mazgo gavimo panaudojimas žiniatinklio grandinėjimui

Žiniatinklio įbrėžimas “ reiškia techniką, kurią naudojant duomenys / turinys paimami iš svetainių ir analizuojami. Šis analizavimas pasiekiamas naudojant „ cheerio “ biblioteka.

Žemiau pateikiama puslapio pavadinimo gavimo naudojant „ atnešti () “ metodas ir „ cheerio biblioteka:

konst lib = reikalauti ( 'nudžiuginti' ) ;

( async ( ) => {

konst x = laukti atvežimo ( „https://linuxhint.com/“ ) ;

konst ir = laukti x. tekstą ( ) ;

konst $ = lib. apkrova ( ir ) ;

konsolė. žurnalas ( $ ( 'pavadinimas' ) . Pirmas ( ) . tekstą ( ) ) ;

} ) ( ) ;

Šis pavyzdys nuskaito „“ plytelę Linux “ svetainės pavadinimas.

Išvada

HTTP užklausas node.js galima pateikti naudojant mazgo gavimą siunčiant užklausas gauti, nuskaitant JSON duomenis iš REST API arba siunčiant pranešimų užklausas. Be to, išimtis ir apribojimus galima veiksmingai tvarkyti naudojant „ sugauti () ' funkcija.