Tutorial NPM Node.js: Cara Membuat, Memperluas, Menerbitkan modul

Oleh: James Hartman James Hartman
Hours Updated

Modul Node.js

Modul di Node.js adalah enkapsulasi kode logis dalam satu unit. Itu selalu merupakan praktik pemrograman yang baik untuk selalu memisahkan kode sedemikian rupa sehingga membuatnya lebih mudah dikelola dan dipelihara untuk tujuan masa depan. Di sinilah modul di Node.js berperan.

Karena setiap modul merupakan entitas independen dengan fungsionalitas terenkapsulasinya sendiri, maka modul dapat dikelola sebagai unit kerja terpisah.

Apa itu Modul di Node.js?

Seperti yang dinyatakan sebelumnya, modul di Node js adalah cara merangkum kode dalam unit logika terpisah. Ada banyak modul siap pakai yang tersedia di pasaran yang dapat digunakan dalam Node js.

Di bawah ini adalah beberapa modul populer yang digunakan dalam aplikasi Node js

  1. Kerangka kerja ekspres – Express adalah kerangka aplikasi web Node js minimal dan fleksibel yang menyediakan serangkaian fitur tangguh untuk web dan mobil aplikasi.
  2. socket.io – Socket.IO memungkinkan komunikasi berbasis peristiwa dua arah secara real-time. Modul ini bagus untuk pembuatan aplikasi berbasis chatting.
  3. Giok – Jade adalah mesin templat berkinerja tinggi dan diimplementasikan dengan JavaNaskah untuk node dan browser.
  4. MongoDB - The MongoDB Driver Node.js adalah driver node.js yang didukung secara resmi MongoDB.
  5. Perbaiki kembali – restify adalah kerangka kerja yang ringan, mirip dengan express untuk membangun REST API
  6. Bluebird – Bluebird adalah perpustakaan janji berfitur lengkap dengan fokus pada fitur dan kinerja inovatif

Menggunakan modul di Node.js

Untuk menggunakan modul dalam a Node.js aplikasi, mereka harus diinstal terlebih dahulu menggunakan manajer paket Node.

Baris perintah di bawah ini menunjukkan bagaimana modul "ekspres" dapat diinstal.

npm instal ekspres

Menggunakan Modul di Node.js

  • Perintah di atas akan mengunduh file yang diperlukan yang berisi "modul ekspres" dan juga menangani instalasi
  • Setelah modul diinstal, untuk menggunakan modul dalam aplikasi Node.js, Anda perlu menggunakan kata kunci 'require'. Kata kunci ini adalah cara yang digunakan Node.js untuk menggabungkan fungsionalitas modul dalam suatu aplikasi.

Mari kita lihat contoh bagaimana kita dapat menggunakan kata kunci “memerlukan”. Contoh kode “Guru99” di bawah ini menunjukkan cara menggunakan fungsi require

Menggunakan Modul di Node.js

var express=require('express');
var app=express();
app.set('view engine','jade');
app.get('/',function(req,res)
{
});
var server=app.listen(3000,function()
{
});
  1. Dalam pernyataan pertama itu sendiri, kami menggunakan kata kunci “memerlukan” untuk menyertakan modul ekspres. Modul “ekspres” dioptimalkan JavaNaskah perpustakaan untuk pengembangan Node.js. Ini adalah salah satu modul Node.js yang paling umum digunakan.
  2. Setelah modul disertakan, untuk menggunakan fungsionalitas di dalam modul, sebuah objek perlu dibuat. Di sini objek modul ekspres dibuat.
  3. Setelah modul disertakan menggunakan perintah “require” dan “objek” dibuat, metode yang diperlukan dari modul ekspres dapat dipanggil. Di sini kita menggunakan perintah set untuk mengatur mesin tampilan, yang digunakan untuk mengatur mesin templating yang digunakan di Node.js.

    4. Catatan: -(Hanya untuk pemahaman pembaca; mesin templating adalah pendekatan untuk memasukkan nilai ke dalam aplikasi dengan mengambil data dari file data. Konsep ini cukup terkenal di Angular JS di mana tanda kurung kurawal {{ key }} digunakan untuk menggantikan nilai dalam halaman web. Kata 'kunci' dalam kurung kurawal pada dasarnya menunjukkan variabel yang akan diganti dengan nilai saat halaman ditampilkan.)

  4. Di sini kita menggunakan metode mendengarkan untuk membuat aplikasi mendengarkan pada nomor port tertentu.

ARTIKEL TERKAIT

Cara Membuat modul NPM

Node.js memiliki kemampuan untuk membuat modul khusus dan memungkinkan Anda memasukkan modul khusus tersebut ke dalam aplikasi Node.js Anda.

Mari kita lihat contoh sederhana bagaimana kita dapat membuat modul kita sendiri dan memasukkan modul tersebut ke dalam file aplikasi utama kita. Modul kita hanya akan melakukan tugas sederhana yaitu menjumlahkan dua angka.

Mari ikuti langkah-langkah di bawah ini untuk melihat bagaimana kita dapat membuat modul dan memasukkannya ke dalam aplikasi kita.

Berikut adalah Proses Langkah demi Langkah tentang Cara Membuat modul NPM

Langkah 1) Buat file dan tempel kode di bawah ini
Buat file bernama “Addition.js” dan sertakan kode di bawah ini. File ini akan berisi logika untuk modul Anda.

Di bawah ini adalah kode yang akan dimasukkan ke dalam file ini;

Membuat Modul NPM

var exports=module.exports={};
exports.AddNumber=function(a,b)
{
return a+b;
};
  1. Kata kunci “ekspor” digunakan untuk memastikan bahwa fungsi yang ditentukan dalam file ini benar-benar dapat diakses oleh file lain.
  2. Kami kemudian mendefinisikan fungsi yang disebut 'AddNumber'. Fungsi ini didefinisikan untuk mengambil 2 parameter, a dan b. Fungsi tersebut ditambahkan ke modul “ekspor” untuk menjadikan fungsi tersebut sebagai fungsi publik yang dapat diakses oleh modul aplikasi lain.
  3. Kami akhirnya membuat fungsi kami mengembalikan nilai tambah parameter.

Sekarang kita telah membuat modul khusus yang memiliki fungsi menambahkan 2 angka. Sekarang saatnya membuat aplikasi yang akan memanggil modul ini.

Pada langkah selanjutnya, kita akan melihat cara membuat aplikasi yang akan memanggil modul kustom kita.

Langkah 2) Buat file aplikasi
Buat file bernama “app.js,” yang merupakan file aplikasi utama Anda dan tambahkan kode di bawah ini

Membuat Modul NPM

var Addition=require('./Addition.js');
console.log(Addition.AddNumber(1,2));
  1. Kami menggunakan kata kunci “memerlukan” untuk memasukkan fungsionalitas dalam file Addition.js.
  2. Karena fungsi dalam file Addition.js sekarang dapat diakses, sekarang kita dapat melakukan panggilan ke fungsi AddNumber. Dalam fungsinya, kita melewatkan 2 angka sebagai parameter. Kami kemudian menampilkan nilainya di konsol.

Membuat Modul NPM

Keluaran:

  • Saat Anda menjalankan file app.js, Anda akan mendapatkan output nilai 3 di log konsol.
  • Hasilnya karena fungsi AddNumber di file Addition.js berhasil dipanggil, dan nilai yang dikembalikan sebesar 3 ditampilkan di konsol.

Catatan: – Kami belum menggunakan “Manajer paket Node” untuk menginstal modul Addition.js kami. Ini karena modul tersebut sudah menjadi bagian dari proyek kita di mesin lokal. Manajer paket Node muncul saat Anda mempublikasikan modul di internet, yang kita lihat di topik berikutnya.

Memperluas modul di Node.js

Saat membuat modul, dimungkinkan juga untuk memperluas atau mewarisi satu modul dari modul lainnya.

Dalam pemrograman modern, membangun perpustakaan modul umum dan kemudian memperluas fungsionalitas modul umum ini cukup umum jika diperlukan.

Mari kita lihat contoh bagaimana kita dapat memperluas modul di Node.js.

Langkah 1) Buat modul dasar.

Dalam contoh kita, buat file bernama “Tutorial.js” dan tempatkan kode di bawah ini.

Dalam kode ini, kita hanya membuat fungsi yang mengembalikan string ke konsol. String yang dikembalikan adalah “Tutorial Guru99”.

Memperluas Modul di Node.js

var exports=module.exports={};
exports.tutorial=function()
{
console.log("Guru99 Tutorial")
}
  1. Modul ekspor digunakan agar fungsi apa pun yang didefinisikan dalam file ini dapat tersedia di modul lain di Node.js
  2. Kami membuat fungsi bernama tutorial yang dapat digunakan di modul Node.js lainnya.
  3. Kami menampilkan string “Tutorial Guru99” di konsol saat fungsi ini dipanggil.

Sekarang kita telah membuat modul dasar yang disebut Tutorial.js. Sekarang saatnya membuat modul lain yang akan memperluas modul dasar ini.

Kami akan mengeksplorasi cara melakukan ini di langkah berikutnya.

Langkah 2) Selanjutnya, kita akan membuat modul tambahan kita. Buat file baru bernama “NodeTutorial.js” dan tempatkan kode di bawah ini ke dalam file.

Memperluas Modul di Node.js

var Tutor=require('./Tutorial.js');
exports.NodeTutorial=function()
{
console.log("Node Tutorial")
function pTutor()
{
var PTutor=Tutor
PTutor.tutorial();
}
}

Or
var Tutor=require('./Tutorial.js');
exports.NodeTutorial=function()
{
console.log("Node Tutorial")
this.pTutor = function ()
{
var PTutor=Tutor
PTutor.tutorial();
}
}

Perhatikan poin-poin penting berikut tentang kode di atas

  1. Kami menggunakan fungsi "memerlukan" di file modul baru itu sendiri. Karena kita akan memperluas file modul “Tutorial.js” yang ada, kita perlu memasukkannya terlebih dahulu sebelum memperluasnya.
  2. Kami kemudian membuat fungsi yang disebut “Nodetutorial.” Fungsi ini akan melakukan 2 hal,
  • Ini akan mengirimkan string "Tutorial Node" ke konsol.
  • Ini akan mengirimkan string “Tutorial Guru99” dari modul dasar “Tutorial.js” ke modul tambahan kami “NodeTutorial.js”.
  1. Di sini kita melakukan langkah pertama untuk mengirim string ke “Tutorial Node” ke konsol.
  2. Langkah selanjutnya adalah memanggil fungsi dari modul Tutorial kami, yang akan menampilkan string “Tutorial Guru99” ke console.log.

Langkah 3) Buat file app.js utama Anda, yang merupakan file aplikasi utama Anda dan sertakan kode di bawah ini.

Memperluas Modul di Node.js

var localTutor=require('./NodeTutorial.js');
localTutor.NodeTutorial();
localTutor.NodeTutorial.pTutor();

Or use this code
var tut = new localTutor.NodeTutorial();  // Create and save object
tut.pTutor();  // Call function on object

Kode di atas melakukan hal-hal berikut;

  1. File aplikasi utama kita sekarang memanggil modul “NodeTutorial”.
  2. Kami memanggil fungsi "NodeTutorial". Dengan memanggil fungsi ini, teks “Tutorial Node” akan ditampilkan di log konsol.
  3. Karena kita telah memperluas modul Tutorial.js dan mengekspos fungsi yang disebut pTutor. Itu juga memanggil modul tutorial di modul Tutorial.js, dan teks “Tutorial Guru99” juga akan ditampilkan ke konsol.

Keluaran:

Karena kita telah mengeksekusi kode app.js di atas menggunakan Node, kita akan mendapatkan output berikut di file console.log

  • Tutorial Simpul
  • Tutorial Guru99

Paket Penerbitan NPM (Node Package Manager).

Seseorang dapat mempublikasikan modulnya sendiri Github gudang.

Dengan menerbitkan modul Anda ke lokasi pusat, Anda tidak terbebani karena harus menginstal sendiri di setiap mesin yang memerlukannya.

Sebagai gantinya, Anda dapat menggunakan perintah install npm dan menginstal modul npm yang Anda terbitkan.

Langkah-langkah berikut perlu diikuti untuk menerbitkan modul npm Anda

Langkah 1) Buat repositori Anda di GitHub (alat manajemen repositori kode online). Ini dapat digunakan untuk menghosting repositori kode Anda.

Langkah 2) Anda perlu memberi tahu instalasi npm lokal tentang siapa Anda. Artinya, kita perlu memberi tahu npm siapa penulis modul ini, apa ID emailnya, dan URL perusahaan mana saja yang tersedia yang perlu dikaitkan dengan ID ini. Semua detail ini akan ditambahkan ke modul npm Anda saat dipublikasikan.

Perintah di bawah ini menetapkan nama, email, dan URL pembuat modul npm.

npm tetapkan init-nama-penulis “Guru99.”

npm atur init-author-email “guru99@gmail.com”

npm atur init-author-url “http://Guru99.com”

Langkah 3) Langkah selanjutnya adalah login ke npm menggunakan kredensial yang diberikan pada langkah terakhir. Untuk login, Anda perlu menggunakan perintah di bawah ini

npm login

Langkah 4) Inisialisasi paket Anda – Langkah selanjutnya adalah menginisialisasi paket untuk membuat file package.json. Ini dapat dilakukan dengan mengeluarkan perintah di bawah ini

npm init

Saat Anda mengeluarkan perintah di atas, Anda akan dimintai beberapa pertanyaan. Yang paling penting adalah nomor versi modul Anda.

Langkah 5) Publikasikan ke GitHub – Langkah selanjutnya adalah mempublikasikan file sumber Anda ke GitHub. Ini dapat dilakukan dengan menjalankan perintah di bawah ini.

git add.
git commit -m "Initial release"
git tag v0.0.1 
git push origin master --tags

Langkah 6) Publikasikan modul Anda – Bagian terakhir adalah mempublikasikan modul Anda ke dalam registri npm. Ini dilakukan melalui perintah di bawah ini.

npm publish

Mengelola paket pihak ketiga dengan npm

Seperti yang telah kita lihat, “Manajer paket Node” memiliki kemampuan untuk mengelola modul, yang diperlukan oleh aplikasi Node.js.

Mari kita lihat beberapa fungsi yang tersedia di manajer paket node untuk mengelola modul

  1. Menginstal paket dalam mode global – Modul dapat diinstal di tingkat global, yang pada dasarnya berarti modul ini akan tersedia untuk semua proyek Node.js di mesin lokal. Contoh di bawah ini menunjukkan cara menginstal “modul ekspres” dengan opsi global.npm instal ekspres –global Opsi global dalam pernyataan di atas memungkinkan modul dipasang di tingkat global.
  2. Mencantumkan semua paket global yang diinstal pada mesin lokal. Ini dapat dilakukan dengan menjalankan perintah di bawah ini pada command promptdaftar npm –globalDi bawah ini adalah output yang akan ditampilkan, jika sebelumnya Anda telah menginstal “modul ekspres” di sistem Anda. Di sini Anda dapat melihat berbagai modul yang diinstal pada mesin lokal.

Mengelola Paket Pihak Ketiga dengan NPM

  1. Menginstal versi paket tertentu – Terkadang mungkin ada persyaratan untuk menginstal versi paket tertentu saja. Setelah Anda mengetahui nama paket dan versi relevan yang perlu diinstal, Anda dapat menggunakan perintah npm install untuk menginstal versi spesifik tersebut. Contoh di bawah ini menunjukkan cara menginstal modul bernama garis bawah dengan versi spesifik 1.7.0npm install garis bawah@1.7.0
  2. Memperbarui versi paket – Terkadang Anda mungkin memiliki versi paket yang lebih lama di suatu sistem, dan Anda mungkin ingin memperbarui ke versi terbaru yang tersedia di pasar. Untuk melakukan ini, seseorang dapat menggunakan perintah pembaruan npm. Contoh di bawah ini menunjukkan cara memperbarui paket garis bawah ke versi terbarupembaruan npm garis bawah
  3. Mencari paket tertentu – Untuk mencari apakah versi tertentu tersedia di sistem lokal atau tidak, Anda dapat menggunakan perintah pencarian npm. Contoh di bawah ini akan memeriksa apakah modul ekspres diinstal di komputer lokal atau tidak.npm pencarian ekspres
  4. Menghapus instalasi paket – Sama seperti Anda menginstal sebuah paket, Anda juga dapat menghapus instalasi sebuah paket. Penghapusan instalasi suatu paket dilakukan dengan perintah penghapusan instalasi npm. Contoh di bawah ini menunjukkan cara menghapus instalasi modul ekspresnpm uninstall ekspres

Apa itu file package.json

File “package.json” digunakan untuk menampung metadata tentang proyek tertentu. Informasi ini memberikan manajer paket Node informasi yang diperlukan untuk memahami bagaimana proyek harus ditangani beserta dependensinya.

File package.json berisi informasi seperti deskripsi proyek, versi proyek dalam distribusi tertentu, informasi lisensi, dan data konfigurasi.

File package.json biasanya terletak di direktori root proyek Node.js.

Mari kita ambil contoh tampilan struktur modul ketika diinstal melalui npm.

Cuplikan di bawah ini menunjukkan konten file modul ekspres ketika disertakan dalam proyek Node.js Anda. Dari snapshot tersebut, Anda dapat melihat file package.json di folder express.

File Paket.json

Jika Anda membuka file package.json, Anda akan melihat banyak informasi di dalam file tersebut.

Di bawah ini adalah cuplikan sebagian file. Itu ekspres@~4.13.1 menyebutkan nomor versi modul ekspres yang digunakan.

File Paket.json

Kesimpulan

  • Modul di Node.js adalah enkapsulasi kode logis dalam satu unit. Pemisahan ke dalam modul membuat kode lebih mudah dikelola dan dipelihara untuk tujuan masa depan
  • Ada banyak modul yang tersedia di pasar yang dapat digunakan dalam Node.js seperti express, underscore, MongoDB, Dll
  • Manajer paket node (npm) digunakan untuk mengunduh dan menginstal modul yang kemudian dapat digunakan dalam aplikasi Node.js.
  • Seseorang dapat membuat modul NPM khusus, memperluas modul ini, dan juga menerbitkan modul ini.
  • Manajer paket Node memiliki seperangkat perintah lengkap untuk mengelola modul npm pada sistem lokal seperti instalasi, penghapusan instalasi, pencarian, dll.
  • File package.json digunakan untuk menyimpan seluruh informasi metadata untuk modul npm.

Anda mungkin ingin: