Node.js: n moduuli on koodin looginen kapselointi yhteen yksikköön. On aina hyvä ohjelmointikäytäntö erottaa koodi aina siten, että se on helpommin hallittavissa ja ylläpidettävissä tulevia tarkoituksia varten. Siellä Node.js: n moduulit toimivat toiminnassa.
Koska jokainen moduuli on itsenäinen kokonaisuus, jolla on omat kapseloidut toiminnot, sitä voidaan hallita erillisenä työyksikkönä.
Tässä opetusohjelmassa opit-
- Mitä moduulit ovat Node.js: ssä
- Moduulien käyttö Node.js: ssä
- NPM-moduulien luominen
- Moduulien laajentaminen
- NPM-moduulien julkaiseminen
- Kolmannen osapuolen pakettien hallinta nopeudella npm
- Mikä on package.json-tiedosto
Mitä moduulit ovat Node.js: ssä?
Kuten aiemmin todettiin, solmun js moduulit ovat tapa kapseloida koodi erilliseen loogiseen yksikköön. Markkinoilla on monia valmiin moduuleja, joita voidaan käyttää Node js: ssä.
Alla on joitain suosittuja moduuleja, joita käytetään Node js -sovelluksessa
- Express-kehys - Express on vähäinen ja joustava Node js -verkkosovelluskehys, joka tarjoaa vankan joukon ominaisuuksia verkko- ja mobiilisovelluksille.
- Socket.io - Socket.IO mahdollistaa reaaliaikaisen kaksisuuntaisen tapahtumapohjaisen viestinnän. Tämä moduuli on hyvä chattipohjaisten sovellusten luomiseen.
- Jade - Jade on korkean suorituskyvyn mallimoottori, joka on toteutettu JavaScriptillä solmuille ja selaimille.
- MongoDB - MongoDB Node.js -ohjain on MongoDB: n virallisesti tuettu node.js-ohjain.
- Restify - restify on kevyt kehys, samanlainen kuin express REST-sovellusliittymien rakentamiseen
- Bluebird - Bluebird on täysin varustettu lupakirjasto, joka keskittyy innovatiivisiin ominaisuuksiin ja suorituskykyyn
Moduulien käyttö Node.js: ssä
Jotta moduuleja voidaan käyttää Node.js-sovelluksessa, ne on ensin asennettava Node-paketinhallinnalla.
Alla oleva komentorivi näyttää kuinka "express" -moduuli voidaan asentaa.
npm install express
- Yllä oleva komento lataa tarvittavat tiedostot, jotka sisältävät "express-moduulit", ja huolehtii myös asennuksesta
- Kun moduuli on asennettu, sinun on käytettävä vaadittavaa avainsanaa, jotta moduulia voidaan käyttää Node.js-sovelluksessa. Tämä avainsana on tapa, jota Node.js käyttää sisällyttämään moduulin toiminnot sovellukseen.
Katsotaanpa esimerkkiä siitä, miten voimme käyttää "vaadi" -avainsanaa. Alla oleva "Guru99" -koodiesimerkki näyttää, kuinka vaaditaan -toimintoa käytetään
var express=require('express');var app=express();app.set('view engine','jade');app.get('/',function(req,res){});var server=app.listen(3000,function(){});
- Itse ensimmäisessä lauseessa käytämme "vaadi" -avainsanaa ilmaisumoduulin sisällyttämiseksi. "Express" -moduuli on optimoitu JavaScript-kirjasto Node.js-kehitystä varten. Tämä on yksi yleisimmin käytetyistä Node.js-moduuleista.
- Kun moduuli on mukana, on luotava objekti moduulin toimintojen käyttämiseksi. Tässä luodaan pikamoduulin objekti.
- Kun moduuli on sisällytetty "vaadi" -komennolla ja "objekti" on luotu, voidaan käyttää pikamoduulin vaadittuja menetelmiä. Tässä käytämme asetuskomentoa asettamaan näkymämoottorin, jota käytetään asettamaan Node.js: ssä käytetty mallimoottori.
Huomaa: - (Vain lukijan ymmärtämistä varten; mallimoottori on tapa lisätä arvoja sovellukseen hakemalla tietoja datatiedostoista. Tämä käsite on melko kuuluisa Angular JS: ssä, jossa kiharaisia aaltosulkeita {{key}} käytetään korvaa verkkosivun arvot. Sana "avain" kiharoissa aaltosulkeissa tarkoittaa periaatteessa muuttujaa, joka korvataan arvolla, kun sivu näytetään.)
- Tässä käytämme kuuntelumenetelmää saadaksemme sovelluksen kuuntelemaan tiettyä porttinumeroa.
NPM-moduulien luominen
Node.js pystyy luomaan mukautettuja moduuleja, ja sen avulla voit sisällyttää mukautetut moduulit Node.js-sovellukseesi.
Katsotaanpa yksinkertaista esimerkkiä siitä, kuinka voimme luoda oman moduulin ja sisällyttää kyseisen moduulin tärkeimpään sovellustiedostoon. Moduulimme tekee yksinkertaisen tehtävän lisätä kaksi numeroa.
Seuraa seuraavia vaiheita nähdäksesi, kuinka voimme luoda moduuleja ja sisällyttää ne sovellukseemme.
Vaihe 1) Luo tiedosto nimeltä "Addition.js" ja sisällytä alla oleva koodi. Tämä tiedosto sisältää moduulin logiikan.
Alla on koodi, joka menisi tähän tiedostoon;
var exports=module.exports={};exports.AddNumber=function(a,b){return a+b;};
- "Vienti" -hakusanalla varmistetaan, että muut tiedostot voivat todella käyttää tässä tiedostossa määritettyä toimintoa.
- Määritämme sitten funktion nimeltä AddNumber. Tämä toiminto on määritelty ottamaan kaksi parametria, a ja b. Toiminto lisätään moduuliin "vienti", jotta funktio olisi julkinen toiminto, johon pääsee muilla sovellusmoduuleilla.
- Viimeinkin saatamme funktion palauttamaan parametrien lisäarvon.
Nyt kun olemme luoneet mukautetun moduulin, jolla on mahdollisuus lisätä 2 numeroa. Nyt on aika luoda sovellus, joka kutsuu tätä moduulia.
Seuraavassa vaiheessa näemme todella, miten luodaan sovellus, joka kutsuu mukautettua moduulia.
Vaihe 2) Luo tiedosto nimeltä app.js, joka on tärkein sovellustiedosto, ja lisää alla oleva koodi
var Addition=require('./Addition.js');console.log(Addition.AddNumber(1,2));
- Käytämme "vaadi" -avainsanaa sisällyttääksesi toiminnot Addition.js-tiedostoon.
- Koska Addition.js-tiedoston toiminnot ovat nyt käytettävissä, voimme nyt soittaa AddNumber-funktiolle. Toiminnossa välitetään 2 numeroa parametrina. Näytämme sitten arvon konsolissa.
Tuotos :
- Kun suoritat app.js-tiedoston, saat arvon 3 tuloksen konsolilokiin.
- Tulos johtuu siitä, että Addition.js-tiedoston AddNumber-funktiota kutsuttiin onnistuneesti ja palautettu arvo 3 näytettiin konsolissa.
Huomaa: - Emme vielä käytä "Solmupaketinhallintaa" Addition.js-moduulin asentamiseen. Tämä johtuu siitä, että moduuli on jo osa projektia paikallisessa koneessa. Solmun paketinhallinta tulee kuvaan, kun julkaiset moduulin Internetissä, jonka näemme seuraavassa aiheessa.
Moduulien laajentaminen
Moduuleja luodessa on myös mahdollista laajentaa tai periä moduuleja toisilta.
Nykypäivän ohjelmoinnissa on melko yleistä rakentaa kirjasto yhteisistä moduuleista ja laajentaa sitten näiden yleisten moduulien toiminnallisuutta tarvittaessa.
Katsotaanpa esimerkkiä siitä, kuinka voimme laajentaa moduuleja Node.js: ssä.
Vaihe 1) Luo perusmoduuli.
Luo esimerkissämme tiedosto nimeltä Tutorial.js ja aseta alla oleva koodi.
Tässä koodissa olemme juuri luomassa toimintoa, joka palauttaa merkkijonon konsolille. Palautettu merkkijono on "Guru99 Tutorial".
var exports=module.exports={};exports.tutorial=function(){console.log("Guru99 Tutorial")}
- Vientimoduulia käytetään niin, että mikä tahansa tässä tiedostossa määritelty toiminto voi olla käytettävissä muissa Node.js-moduuleissa
- Luomme toiminnon nimeltä opetusohjelma, jota voidaan käyttää muissa Node.js-moduuleissa.
- Näytämme merkkijonon "Guru99 Tutorial" konsolissa, kun tätä toimintoa kutsutaan.
Nyt kun olemme luoneet perusmoduulin nimeltä Tutorial.js. Nyt on aika luoda toinen moduuli, joka laajentaa tätä perusmoduulia.
Seuraavassa vaiheessa tutkitaan, miten tämä tehdään.
Vaihe 2) Seuraavaksi luomme laajennetun moduulin. Luo uusi tiedosto nimeltä "NodeTutorial.js" ja aseta alla oleva koodi tiedostoon.
var Tutor=require('./Tutorial.js');exports.NodeTutorial=function(){console.log("Node Tutorial")function pTutor(){var PTutor=TutorPTutor.tutorial();}}Orvar Tutor=require('./Tutorial.js');exports.NodeTutorial=function(){console.log("Node Tutorial")this.pTutor = function (){var PTutor=TutorPTutor.tutorial();}}
Huomaa, että seuraavat avainkohdat koskevat yllä olevaa koodia
- Käytämme "vaatia" -toimintoa itse uudessa moduulitiedostossa. Koska aiomme laajentaa olemassa olevaa moduulitiedostoa "Tutorial.js", meidän on ensin sisällytettävä se ennen sen laajentamista.
- Sitten luomme toiminnon nimeltä "Nodetutorial". Tämä toiminto tekee 2 asiaa,
- Se lähettää merkkijonon "Node Tutorial" konsolille.
- Se lähettää merkkijonon "Guru99 Tutorial" perusmoduulista "Tutorial.js" laajennettuun moduuliin "NodeTutorial.js".
- Täällä suoritamme ensimmäisen vaiheen merkkijonon lähettämiseksi "Solmuopetusohjelmaan" konsolille.
- Seuraava vaihe on kutsua funktio Tutorial-moduulistamme, joka antaa merkkijonon "Guru99 Tutorial" konsoliin.log.
Vaihe 3) Luo tärkein app.js-tiedosto, joka on tärkein sovellustiedostosi, ja lisää alla oleva koodi.
var localTutor=require('./NodeTutorial.js');localTutor.NodeTutorial();localTutor.NodeTutorial.pTutor();Or use this codevar tut = new localTutor.NodeTutorial(); // Create and save objecttut.pTutor(); // Call function on object
Yllä oleva koodi tekee seuraavat asiat;
- Pääsovellustiedostomme kutsuu nyt "NodeTutorial" -moduulia.
- Kutsumme "NodeTutorial" -toimintoa. Kutsuen tätä toimintoa, teksti "Solmun opetusohjelma" näkyy konsolilokissa.
- Koska olemme laajentaneet Tutorial.js-moduulia ja paljastaneet toiminnon nimeltä pTutor. Se kutsuu myös Tutorial.js-moduulin opetusmoduulin, ja teksti "Guru99 Tutorial" näytetään myös konsolissa.
Tuotos:
Koska olemme suorittaneet yllä olevan app.js-koodin solmun avulla, saamme seuraavan ulostulon console.log-tiedostoon
- Solmun opetusohjelma
- Guru99-opetusohjelma
NPM (Node Package Manager) -moduulien julkaiseminen
Voidaan julkaista oma moduuli omaan Github-arkistoonsa.
Julkaistessasi moduulin keskeiseen sijaintiin sinun ei tarvitse joutua asentamaan itseäsi jokaiseen sitä vaativaan koneeseen.
Sen sijaan voit käyttää asennuskomentoa npm ja asentaa julkaistun npm-moduulin.
Seuraavat vaiheet on noudatettava npm-moduulin julkaisemiseksi
Vaihe 1) Luo arkisto GitHubiin (online-koodivaraston hallintatyökalu). Sitä voidaan käyttää koodivarastojen ylläpitoon.
Vaihe 2 ) Sinun on kerrottava paikalliselle npm -asennuksellesi kuka olet. Mikä tarkoittaa, että meidän on kerrottava npm: lle, kuka on tämän moduulin kirjoittaja, mikä on sähköpostiosoite ja mikä tahansa käytettävissä oleva yrityksen URL-osoite, joka on liitettävä tähän tunnukseen. Kaikki nämä tiedot lisätään npm-moduuliin, kun se julkaistaan.
Alla olevat komennot asettavat npm-moduulin kirjoittajan nimen, sähköpostiosoitteen ja URL-osoitteen.
npm asettaa init.author.name "Guru99".
npm set init.author.email " Tämä sähköpostiosoite on suojattu spamboteilta. Javascript-tuen tulee olla päällä nähdäksesi sen."
npm aseta init.author.url http://Guru99.com
Vaihe 3) Seuraava vaihe on kirjautua sisään npm käyttämällä viimeisessä vaiheessa annettuja kirjautumistietoja. Sisäänkirjautumiseen on käytettävä alla olevaa komentoa
npm login
Vaihe 4) Alusta paketti - Seuraava askel on alustaa paketti luoda package.json-tiedosto. Tämä voidaan tehdä antamalla alla oleva komento
npm init
Kun annat yllä olevan komennon, sinulta kysytään joitain kysymyksiä. Tärkein on moduulin versionumero.
Vaihe 5) Julkaise GitHubissa - Seuraava vaihe on julkaista lähdetiedostosi GitHubissa. Tämä voidaan tehdä suorittamalla alla olevat komennot.
git add.git commit -m "Initial release"git tag v0.0.1git push origin master --tags
Vaihe 6) Julkaise moduuli - Viimeinen bitti on julkaista moduuli npm-rekisteriin. Tämä tehdään alla olevan komennon avulla.
npm publish
Kolmannen osapuolen pakettien hallinta nopeudella npm
Kuten olemme nähneet, "Node-paketinhallinnalla" on kyky hallita moduuleja, joita Node.js-sovellukset edellyttävät.
Tarkastellaan joitain solmujen paketinhallinnassa käytettävissä olevia toimintoja moduulien hallintaan
-
Pakettien asentaminen globaalissa tilassa - Moduulit voidaan asentaa globaalilla tasolla, mikä tarkoittaa käytännössä sitä, että nämä moduulit olisivat käytettävissä kaikille Node.js-projekteille paikallisella koneella. Alla oleva esimerkki osoittaa, kuinka "express-moduuli" asennetaan globaalilla vaihtoehdolla.
npm install express -global
Edellä olevan lauseen yleinen vaihtoehto on se, mikä sallii moduulien asentamisen maailmanlaajuisesti.
-
Luettele kaikki paikalliseen koneeseen asennetut globaalit paketit. Tämä voidaan tehdä suorittamalla alla oleva komento komentokehotteessa
npm-luettelo - globaali
Alla on lähtö, joka näytetään, jos olet aiemmin asentanut "express-moduulin" järjestelmääsi.
Täältä näet paikalliseen koneeseen asennetut moduulit.
-
Tietyn paketin version asentaminen - Joskus voi olla vaatimus vain paketin tietyn version asentamisesta. Kun tiedät paketin nimen ja sen asennettavan version, voit asentaa kyseisen version npm install -komennolla.
Alla olevassa esimerkissä näkyy, kuinka alaviiva-niminen moduuli asennetaan tietyllä versiolla 1.7.0
npm asenna [email protected]
-
Pakettiversioiden päivittäminen - Joskus järjestelmässäsi voi olla paketin vanhempi versio, ja haluat ehkä päivittää uusimpaan markkinoilla olevaan versioon. Voit tehdä tämän käyttämällä npm-päivityskomentoa. Alla olevassa esimerkissä näkyy, kuinka alleviivauspaketti päivitetään uusimpaan versioon
npm-päivityksen alaviiva
-
Tietyn paketin etsiminen - Voit etsiä, onko tietty versio käytettävissä paikallisessa järjestelmässä, käyttämällä npm-hakukomentoa. Alla oleva esimerkki tarkistaa, onko pikamoduuli asennettu paikalliselle koneelle vai ei.
npm haku express
-
Paketin asennuksen poistaminen - Voit poistaa paketin myös samalla, johon voit asentaa paketin. Paketin poisto tapahtuu npm-asennuksen poistokomennolla. Alla oleva esimerkki osoittaa, kuinka pikamoduuli poistetaan
npm uninstall express
Mikä on package.json-tiedosto
"Package.json" -tiedostoa käytetään tietyn projektin metatietojen säilyttämiseen . Nämä tiedot antavat Node-paketinhallinnalle tarvittavat tiedot sen ymmärtämiseksi, miten projektia ja sen riippuvuuksia tulisi käsitellä.
Pack.json-tiedostot sisältävät tietoja, kuten projektin kuvaus, projektin versio tietyssä jakelussa, lisenssitiedot ja määritystiedot.
Pack.json-tiedosto sijaitsee yleensä Node.js-projektin juurihakemistossa.
Otetaan esimerkki siitä, miten moduulin rakenne näyttää, kun se asennetaan npm: n kautta.
Alla oleva tilannekuva näyttää pikamoduulin tiedostosisällön, kun se sisältyy Node.js-projektiisi. Tilannekuvasta näet paketti.json-tiedoston pikakansiossa.
Jos avaat package.json-tiedoston, näet tiedostossa paljon tietoa.
Alla on tilannekuva osan tiedostosta. Express@~4.13.1 mainitsee versionumeron ilmaista moduulia käytetään.
Yhteenveto
- Node.js: n moduuli on koodin looginen kapselointi yhteen yksikköön. Moduuleihin erottaminen tekee koodista hallittavamman ja ylläpidettävän tulevia tarkoituksia varten
- Markkinoilla on monia moduuleja, joita voidaan käyttää Node.js: ssä, kuten express, alleviiva, MongoDB jne.
- Solmupaketin hallintaa (npm) käytetään moduulien lataamiseen ja asentamiseen, joita voidaan sitten käyttää Node.js-sovelluksessa.
- Voidaan luoda mukautettuja NPM-moduuleja, laajentaa näitä moduuleja ja myös julkaista nämä moduulit.
- Solmun paketinhallinnalla on täydellinen joukko komentoja hallita paikallisen järjestelmän npm-moduuleja, kuten asennus, asennuksen poisto, haku jne.
- Pack.json-tiedostoa käytetään pitämään npm-moduulin koko metatiedot.