Panduan Pemula untuk Feathers.js

feathers.js: Panduan untuk cepat membina pelayan API RESTful

mata teras:

feathers.js Memudahkan penciptaan pelayan API yang tenang, mengendalikan kebanyakan kerja backend berulang, dan membolehkan pemaju memberi tumpuan kepada penyesuaian kod dan konfigurasi.
Rangka kerja ini dibina di Express, menyokong pangkalan data SQL dan NoSQL, dan menggunakan perkhidmatan yang secara automatik menghasilkan kod yang diperlukan, yang membolehkan operasi CRUD dapat dilakukan dengan mudah.
Pengesahan dalam Feathers.js boleh menggunakan Token Web JSON (JWT) untuk melindungi titik akhir API, memastikan hanya pengguna yang diberi kuasa boleh mengakses atau mengubah suai data.
cangkuk dalam bulu.js bertindak sebagai fungsi middleware yang memanipulasi data sebelum atau selepas data mencapai pangkalan data, yang sangat berguna untuk tugas -tugas seperti pengesahan, kebenaran, dan menambahkan medan secara dinamik.
Feathers.js direka untuk mudah digunakan dan diperluaskan, menyokong kemas kini masa nyata melalui WebSockets, dan menyediakan seni bina yang fleksibel untuk pelbagai kerangka depan.

Artikel ini akan membimbing anda untuk membina pelayan API RESTful dalam node.js menggunakan Feathers.js.

pelayan API, juga dikenali sebagai pelayan aplikasi, adalah program yang menyediakan data kepada aplikasi front-end. Ia juga memproses logik perniagaan di backend dan menyediakan akses terhad kepada pangkalan data organisasi. Bukan sahaja ia menghalang orang yang tidak dibenarkan mengakses data;

Setiap aplikasi yang anda bina perlu menyediakan perkhidmatan kepada pengguna akhir. Untuk melakukan ini, aplikasi anda perlu memproses data. Anda boleh menggunakan API jauh untuk membuat perkhidmatan baru. Walau bagaimanapun, untuk kebanyakan aplikasi, anda perlu menguruskan storan data anda sendiri. Pilihan yang popular adalah menggunakan perkhidmatan penyimpanan data dalam talian seperti Firebase. Dengan cara ini, anda tidak perlu berurusan dengan butiran yang membosankan untuk menjalankan pelayan pangkalan data yang diedarkan. Walau bagaimanapun, keperluan projek anda mungkin memerlukan sistem pengurusan pangkalan data dalaman yang lengkap, seperti MongoDB atau Oracle. Agar aplikasi front-end anda untuk mengakses data yang disimpan dalam pangkalan data, anda memerlukan aplikasi pelayan yang terletak di antara pangkalan data dan aplikasi front-end.

Seperti yang ditunjukkan dalam imej di atas, tugas pelayan aplikasi adalah untuk mengakses data dari pangkalan data menggunakan arahan SQL atau NoSQL dan mengubahnya menjadi format yang dapat difahami oleh aplikasi depan (pelayar klien) - seperti JSON . Di samping itu, pelayan aplikasi boleh menggunakan pelbagai protokol keselamatan -seperti penyulitan HTTPS dan kebenaran token -untuk memastikan komunikasi antara pangkalan data dan aplikasi klien adalah selamat dan boleh dipercayai. Salah satu kelebihan utama menggunakan seni bina ini ialah anda boleh menggunakan pelayan aplikasi yang sama untuk menggunakan aplikasi untuk platform yang berbeza -desktop, mudah alih, web, dan banyak lagi. Selain itu, ia juga mudah untuk meningkatkan aplikasi anda secara mendatar untuk menyediakan perkhidmatan kepada lebih banyak pengguna dengan cekap dan mencapai masa tindak balas yang cepat.

kami akan membina pelayan API yang mudah dan menunjukkan pelbagai ciri yang disediakan oleh bulu.

Prasyarat:

Sebelum memulakan tutorial ini, anda perlu mempunyai asas yang kukuh mengenai topik berikut:

• ES6 JavaScript
• Buat Aplikasi Express
• Buat API RESTful menggunakan Express

Bulu dibina di atas Express, rangka kerja web minimalis untuk node.js. Jika anda melengkapkan tutorial yang ditunjukkan dalam pautan, anda akan mendapati sangat susah untuk membina API RESTFUL menggunakan Express sahaja. Dengan bulu, kebanyakan kerja berulang dilakukan untuk anda. Anda hanya perlu memberi tumpuan kepada mengkonfigurasi dan menyesuaikan kod anda. Mari menggali kod dan pelajari bagaimana kerangka web ini berfungsi.

Penciptaan Projek:

Untuk mula menggunakan bulu, anda perlu memasang aplikasi baris perintahnya secara global:

npm install -g @feathersjs/cli

Seterusnya, buat projek API baru menggunakan arahan berikut:

mkdir contacts-api
cd contacts-api
feathers generate app

Berikut adalah pilihan saya, anda boleh memilih rangka kerja ujian yang anda suka. Malangnya, ujian itu tidak berada dalam fokus artikel ini, jadi ia tidak akan dilindungi di sini. Saya secara peribadi suka kesederhanaan, itulah sebabnya saya memilih Jest.

Selepas pemasangan selesai, anda boleh membuka editor kod kegemaran anda untuk melihat fail projek.

Jika anda melengkapkan tutorial ekspres yang saya disenaraikan di bahagian prasyarat, kod yang dihasilkan tidak akan menakutkan anda. Berikut adalah ringkasan ringkas yang menggambarkan folder dan fail.

Sekarang jangan terlalu risau tentang peranan setiap fail. Semasa anda melalui tutorial ini, anda akan mengetahui lebih lanjut mengenai bagaimana mereka bekerja. Sekarang, mari kita sahkan bahawa ujian berfungsi dengan baik.

CODE CODE CHECK (LINTING):

Untuk memastikan projek kami mematuhi peraturan Eslint yang ditakrifkan, hanya jalankan arahan . Jika anda menggunakan platform UNIX atau Linux, ini harus berfungsi dengan baik. Jika anda menggunakan Windows, anda perlu tweak sesuatu untuk menjalankan ujian dengan jayanya.

Pertama, pergi ke npm test dan lihat bahagian

. Tukar baris

ke: package.json scripts test Seterusnya, jika anda telah dipasang pada kod Visual Studio Visual, anda perlu menukar tetapan petikan tunggal ke TRUE dalam tab Tetapan Ruang Kerja:

"scripts": {
  "test": "npm run eslint && SET NODE_ENV= npm run jest",
},

Akhir sekali, pastikan bahawa apabila membuat atau mengedit sebarang fail, Newline adalah LF. Jika anda menggunakan kod Visual Studio atau editor yang serupa, anda boleh menyemak gaya baru semasa dalam bar status. Jika CRLF dipaparkan, tukar ke LF. Membuat perubahan ini akan membantu anda lulus ujian pemeriksaan gaya kod. Malangnya, ia memerlukan lebih banyak kerja untuk mendapatkan ujian untuk lulus, dan tidak akan diperkenalkan di sini.

{
  "prettier.singleQuote": true
}

mari kita lihat bagaimana untuk menjana antara muka CRUD RESTFUL.

Menjana Perkhidmatan:

Membina antara muka API CRUD yang tenang di Express memerlukan beberapa kerja. Dalam bulu, anda boleh menjana kod dengan hanya melaksanakan satu arahan dan menjawab beberapa soalan:

npm install -g @feathersjs/cli

Dalam tutorial ini, kami akan menggunakan pangkalan data NEDB. Bulu menyokong pangkalan data SQL (seperti MySQL) dan pangkalan data NoSQL (seperti MongoDB). Walau bagaimanapun, memasang sistem pangkalan data - sama ada pada mesin anda atau pada pelayan awan - mengambil sedikit masa untuk mengkonfigurasinya. NEDB, sebaliknya, adalah pangkalan data dalam memori yang ditulis sepenuhnya dalam JavaScript, menyokong subset API MongoDB. Tiada konfigurasi diperlukan; Ia sesuai untuk prototaip dan menguji aplikasi baru. Ini adalah pangkalan data yang akan kami gunakan dalam tutorial ini.

mari kita lihat dengan ringkas beberapa fail yang dijana menggunakan arahan ini:

• services/contacts/contact.service.js. Ini adalah perkhidmatan bulu yang menyediakan titik akhir API CRUD untuk /contacts. Sangat kecil, bukan? Ini kerana bulu telah mengangkat berat untuk kita. Ia menjimatkan kita daripada menulis kod crud boilerplate.
• services/contacts/contact.hooks.js. Di sini kita menyesuaikan tingkah laku logik CRUD. Kami mempunyai bahagian before di mana kita boleh menyemak atau menukar data sebelum bulu membaca atau menulis ke pangkalan data. Kami juga mempunyai seksyen after di mana kami boleh menyemak atau menukar hasil dalam pangkalan data sebelum menghantarnya ke aplikasi klien. Kami boleh melakukan operasi seperti menyekat akses, pengesahan data, melakukan operasi gabungan, dan mengira nilai medan atau lajur tambahan.
• models/contacts.model.js. Di sini kita menentukan model dan masukkannya ke jadual pangkalan data. Ini juga di mana kita menentukan corak yang boleh digunakan untuk mengesahkan medan apabila rekod baru dimasukkan atau dikemas kini. Malangnya, NEDB tidak menyokong mod. Walau bagaimanapun, saya telah memberikan contoh model yang disambungkan ke MongoDB yang menyokong fungsi mod melalui penyesuai mongoose:

mkdir contacts-api
cd contacts-api
feathers generate app

Walaupun beberapa batasan dengan NEDB, ia masih merupakan pangkalan data yang sangat sesuai untuk prototaip. Kebanyakan pangkalan data NoSQL membolehkan anda menghantar data menggunakan struktur mana -mana tanpa menentukan skema terlebih dahulu. Adalah lebih baik untuk melaksanakan model selepas melaksanakan keperluan projek. Dengan corak, bulu akan melakukan pengesahan medan untuk anda menggunakan peraturan yang anda tentukan. Anda memerlukan pangkalan data siap pengeluaran (seperti MongoDB) untuk menentukan skema. Sila ambil perhatian bahawa definisi konfigurasi pangkalan data pembangunan berada di config/default.json:

"scripts": {
  "test": "npm run eslint && SET NODE_ENV= npm run jest",
},

Ini adalah di mana kelayakan pangkalan data disediakan. Kami mempunyai fail konfigurasi lain config/production.json. Ini adalah konfigurasi pangkalan data pengeluaran yang digunakan semasa menggunakan aplikasi Bulu. Adalah penting untuk menggunakan pangkalan data berasingan semasa pembangunan. Jika tidak, anda berisiko memadam atau merosakkan data operasi perniagaan dalam pangkalan data pengeluaran anda.

Sekarang kita telah menubuhkan perkhidmatan CRUD kenalan, sudah tiba masanya untuk mencubanya. Anda boleh memulakan pelayan bulu menggunakan arahan npm start. Sila ambil perhatian bahawa pelayan ini tidak menyokong memuat semula panas. Oleh itu, ia perlu dimulakan semula setiap kali anda menukar kod. Untuk berinteraksi dengan aplikasi Feathers kami, kami memerlukan alat pelayar API seperti Postman atau Insomnia. Dalam tutorial ini, saya akan menggunakan insomnia, tetapi anda boleh dengan mudah melakukannya dengan Postman atau alat lain.

Buat permintaan GET baru (tekan ctrl n ) dan namakannya "Kenalan senarai". Dalam bahagian URL, masukkan http://localhost:3030/contacts. Apabila anda mengklik butang "Hantar", anda harus melihat pandangan berikut:

Tiada apa -apa! Pangkalan data kami kini kosong, jadi kami perlu membuat beberapa kenalan baru. Buat permintaan baru yang dipanggil Buat Kenalan. Isi medan yang tinggal seperti berikut:

Jika anda lupa untuk menukar kaedah dalam borang di atas untuk menyiarkan, anda boleh mengubahnya kemudian. Tukar kaedah untuk menyiarkan dan menukar tab badan ke JSON. Salin data berikut ke tab JSON:

Apabila anda mengklik butang "Hantar", anda harus menerima respons berikut. Sila ambil perhatian bahawa

npm install -g @feathersjs/cli

telah dihasilkan untuk kenalan baru anda.

_id

Kembali ke "Kenalan Senarai", dan klik butang "Hantar" sekali lagi. Anda harus mendapatkan hasil berikut:

kembali ke "Buat Hubungi" dan menerbitkan beberapa rekod baru:

mkdir contacts-api
cd contacts-api
feathers generate app

Mari kita lakukan operasi kemas kini sekarang. Untuk tujuan ini, kami tidak akan menggunakan kaedah HTTP kemas kini. Kaedah ini akan menimpa rekod sepenuhnya. Apa yang kita mahu lakukan ialah menimpa satu bidang, bukan keseluruhan rekod. Untuk melakukan ini, kami akan menggunakan patch. Buat permintaan baru, "Kemas kini Kenalan", seperti yang ditunjukkan di bawah:

"scripts": {
  "test": "npm run eslint && SET NODE_ENV= npm run jest",
},

{
  "prettier.singleQuote": true
}

Dalam medan URL, masukkan

. Ganti dengan ID rekod pertama. Tampalkan data berikut ke tab JSON:

http://localhost:3030/contacts/{_id} Klik butang "Hantar". Anda harus melihat hasil berikut: {_id}

feathers generate service

Sila ambil perhatian bahawa medan yang tinggal tetap tidak berubah. Seterusnya, kami akan memadamkan rekod. Ia mudah. Cukup buat permintaan padam baru dan namakannya "Padam Hubungi". Dalam medan URL, gunakan format http://localhost:3030/contacts/{_id}. Sama seperti sebelumnya, ganti dengan ID rekod yang anda mahu padamkan. Mengklik "Hantar" akan memadam rekod untuk anda. Anda boleh mengesahkan dengan menjalankan permintaan kenalan senarai lagi. {_id}

kami hanya mengesahkan bahawa semua operasi CRUD berjalan dengan betul. Dalam bahagian seterusnya, kami akan belajar bagaimana untuk menyediakan pengesahan.

(Kandungan berikut adalah serupa dengan teks asal, tetapi beberapa pelarasan pernyataan dan penggabungan perenggan telah dibuat untuk meningkatkan kebolehbacaan dan kelancaran dan mengekalkan niat asal tidak berubah. Format imej tetap tidak berubah.) 🎜> Pengesahan:

Pada masa ini, titik akhir API kami tidak dilindungi. Jika kami menggunakan aplikasi ke pelayan awan, sesiapa sahaja yang mempunyai URL boleh mengakses dan mengendalikan rekod kami. Untuk menyekat akses, kita perlu menyediakan pengesahan. Kami akan menggunakan token Web JSON untuk melaksanakan pengesahan untuk aplikasi API kami. Jalankan arahan berikut untuk menetapkannya:

/contacts Seperti yang anda lihat, bulu menyokong kaedah pengesahan pengguna yang berbeza. Pilihan "Nama Pengguna Tempatan" adalah yang paling mudah untuk ditetapkan.

npm install -g @feathersjs/cli

Pilih pilihan berikut:

Seterusnya, kita perlu membuat pengguna baru. Kita boleh melakukan ini menggunakan insomnia atau mana -mana alat pelayar API lain. Buat permintaan baru dan namakannya "Buat Pengguna".

Di tab JSON, hantar data berikut:

anda harus menerima respons yang serupa dengan yang berikut:

mkdir contacts-api
cd contacts-api
feathers generate app

kami kini mempunyai pengguna. Mari sahkan ini dengan membuat permintaan baru "Senarai Pengguna" dan menghantar URL

. Malangnya, anda akan menerima respons berikut:

kita perlu mengesahkan untuk mengakses data ini. Oleh kerana kita tidak mempunyai aplikasi front-end yang boleh kita gunakan untuk log masuk, kita akan terus menggunakan pelayar API. Buat permintaan baru dan namakannya "Dapatkan JWT Token". Isi borang seperti berikut: http://localhost:3030/users

Permintaan ini menggunakan kaedah pos. Untuk lebih jelas, anda boleh menamakannya semula untuk "log masuk". Dalam tab JSON, salin data berikut:

Setelah mengklik butang Hantar, anda harus menerima respons berikut:

"scripts": {
  "test": "npm run eslint && SET NODE_ENV= npm run jest",
},

Salin kod token (tanpa petikan berganda). Pergi ke halaman permintaan pengguna senarai, pilih tab Auth dan pilih pembawa. Tampalkan kod token ini ke dalam medan token.

Selepas mengklik butang "Hantar", anda harus melihat senarai pengguna. Sila ambil perhatian bahawa sistem pengesahan kami tidak sepenuhnya selamat. Sesiapa yang mempunyai titik akhir url

boleh membuat akaun baru dan mengakses sistem kami. Untuk mengelakkan penciptaan akaun baru yang tidak dibenarkan, kita juga perlu menyekat titik akhir ini. Buka fail

dan kemas kini coretan kod berikut:

Ini akan memastikan bahawa hanya pengguna yang disahkan boleh membuat akaun baru. Langkah seterusnya adalah untuk melindungi titik akhir /contacts. Cukup buka fail services/contacts/contacts.hooks.js dan kemas kini dengan sewajarnya:

Mulakan semula pelayan bulu untuk perubahan kod yang akan berkuatkuasa. Jika anda cuba menjalankan permintaan kenalan senarai, anda akan menerima respons berikut:

Untuk mengesahkan, anda perlu menyediakan token pembawa seperti dahulu. Sebaik sahaja anda telah melakukan ini, anda boleh menghantar permintaan dan anda harus menerima senarai kenalan anda. Sila ambil perhatian bahawa token yang anda peroleh sebelum ini akan tamat tempoh dalam satu hari. Untuk kecekapan, lebih baik menggunakan pembolehubah persekitaran untuk memudahkan mengemas kini semua parameter permintaan API sekaligus. Apabila membina aplikasi front-end, anda perlu menyimpan token ini dalam storan tempatan. Jangan gunakan kuki. Jika tidak, permohonan anda akan terdedah kepada serangan CSRF. Semak dokumentasi keselamatan bulu untuk risiko keselamatan lain yang perlu anda ketahui.

Sekarang bahawa anda telah menyediakan pengesahan, mana -mana perkhidmatan baru yang dibuat kemudian akan memberi anda pilihan untuk melindungi titik akhir baru. Mari kita lihat topik terakhir tutorial ini di bahagian seterusnya.

cangkuk:

Hook adalah fungsi middleware yang dilampirkan pada kaedah perkhidmatan sebelum, selepas, atau apabila ralat berlaku. Mereka sering digunakan untuk mengendalikan pembalakan, menyekat akses, melindungi medan, entiti yang berkaitan, menghantar pemberitahuan, dan banyak lagi. Jika anda melihat services/users/users.hooks.js, anda dapat melihat beberapa cangkuk bulu terbina dalam digunakan. Kami akan membuat cangkuk tersuai kami sendiri. Pertama, hentikan pelayan dan padamkan jadual pangkalan data data/contacts.db. Seterusnya, gunakan arahan berikut untuk menghasilkan cangkuk baru:

npm install -g @feathersjs/cli

Buat cangkuk tersuai dengan pilihan berikut process-contact:

Apa yang kita mahu lakukan dalam cangkuk ini adalah menyuntik dua medan baru sebelum memproses permintaan "membuat kenalan".

• createdBy: Pautan ke pengguna yang sedang dicatat dalam pengguna melalui _id
• createdOn

hooks/process-contact.js

populate-user

hooks/populate-user

: Tambah tarikh penciptaan Buka fail dan kemas kini fail seperti berikut: Seterusnya, buat cangkuk lain yang akan melampirkan objek pengguna untuk setiap rekod kenalan apabila diminta. Ikuti arahan dalam tangkapan skrin di bawah: Buka fail dan masukkan kod berikut: Sekarang anda boleh memulakan pelayan. Gunakan permintaan Buat Kenalan untuk membuat tiga kenalan sekali lagi. Jika anda belum menyediakan token pembawa, tetapkannya. Jika tidak, anda akan menerima ralat kebenaran. Ini adalah jenis tindak balas yang perlu anda dapatkan semasa membuat kenalan baru: Ringkasan:

Saya harap anda sekarang telah belajar bagaimana untuk membina pelayan API RESTful anda dengan cepat. Kami hanya menyentuh asas -asas dan anda harus membaca panduan penuh untuk mengetahui lebih banyak ciri -ciri bulu yang boleh ditawarkan yang dapat membantu anda mencapai ciri -ciri canggih dengan usaha yang minimum. Anda juga harus menyemak halaman Feathers yang hebat, yang mengandungi banyak sumber. Sama ada anda memerlukan plugin, contoh projek, atau tutorial, anda boleh menemui pautan di sana. Anda juga harus menyemak bulu-plus CLI, yang merupakan versi bulu yang dipertingkatkan. Ia menambah ciri -ciri baru di atas apa yang telah disediakan oleh bulu CLI, seperti menghasilkan kod untuk penyediaan dan sokongan GraphQL.

Jika anda ingin memperbaiki projek contacts-api lagi, saya cadangkan anda membuat aplikasi front-end baru menggunakan rangka pilihan anda. Bina skrin log masuk dan halaman CRUD untuk /contacts dan /users endpoints. Nikmati keseronokan melaksanakan cabaran.

soalan yang sering ditanya mengenai Feathers.js:

• Apa itu Feathers.js? Feathers.js adalah rangka kerja web untuk membina aplikasi masa nyata. Direka untuk menjadi ringan, fleksibel dan mudah digunakan, ia menyediakan suite alat dan corak untuk membina aplikasi pelayan yang berskala dan diselenggara.

• Bahasa pengaturcaraan apa yang disokong oleh bulu.js? feathers.js terutamanya menggunakan JavaScript pada pelayan dan klien. Ia boleh digunakan dengan node.js pada pelayan dan menyokong pelbagai rangka kerja JavaScript pada pelanggan, termasuk rangka kerja seperti React, Sudut dan Vue.js.

• Apakah ciri -ciri utama Feathers.js? Feathers.js termasuk ciri-ciri masa nyata (melalui WebSocket dan API RESTful), seni bina berorientasikan perkhidmatan, sokongan untuk pelbagai pangkalan data (MongoDB, PostgreSQL, dll), mekanisme pengesahan dan kebenaran, dan sistem pemalam untuk sambungan.

• Bagaimana feathers.js mengendalikan komunikasi masa nyata? Feathers.js menggunakan fungsi websocket untuk mencapai komunikasi masa nyata. Ia menyediakan API masa nyata keluar dari kotak yang membolehkan pelanggan menerima kemas kini masa nyata apabila data pada perubahan pelayan.

• Bolehkah saya menggunakan Feathers.js untuk Rendering Sider Server (SSR)? Walaupun Feathers.js digunakan terutamanya untuk membina API dan aplikasi masa nyata, ia boleh digunakan bersempena dengan rangka kerja lain seperti Next.js atau Nuxt.js untuk melaksanakan Rendering Server (SSR) aplikasi web.

Semua pautan imej mengekalkan format asal.

Atas ialah kandungan terperinci Panduan Pemula untuk Feathers.js. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!