Руководство для начинающих по Feathers.js

Если вы завершили обучение по Express, которое я перечислил в разделе предварительных требований, генерируемый код не должен вас пугать. Вот краткое резюме, которое описывает папки и файлы.

Не беспокойтесь о том, что каждый файл делает прямо сейчас. В этом уроке вы поймете, как они работают в курсе. А пока давайте подтвердим, что тесты работают.

пыление

Чтобы убедиться, что наш проект соответствует определенным правилам ESLint , просто запустите команду npm test . Если вы работаете на платформе Unix или Linux, это должно работать нормально. Если вы работаете в Windows, вам нужно настроить несколько параметров, чтобы тесты выполнялись успешно.

Сначала зайдите в package.json и посмотрите раздел скриптов. Измените test строку на это:

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

Далее, если вы установили Prettier в коде Visual Studio, вам нужно изменить значение одинарной кавычки на true на вкладке настроек Workspace:

 { "prettier.singleQuote": true } 

Наконец, убедитесь, что при создании или редактировании какого-либо файла конец строки имеет LF . Если вы используете Visual Studio Code или аналогичный редактор, вы можете проверить текущий стиль окончания строки в строке состояния. Если написано CRLF , измените на LF . Внесение этих изменений поможет вам пройти тесты на волокно. К сожалению, чтобы пройти тесты, потребуется немного больше работы, которая не будет здесь рассмотрена.

Давайте посмотрим, как мы можем сгенерировать CRUD RESTful интерфейс.

Создать сервис

Создание интерфейса API Restful CRUD в Express требует небольшой работы. В Feathers все, что вам нужно сделать, это выполнить одну команду, ответить на несколько вопросов и сгенерировать для вас код:

 $ feathers generate service ? What kind of service is it? NeDB ? What is the name of the service? contacts ? Which path should the service be registered on? /contacts ? What is the database connection string? nedb://../data force config\default.json create src\services\contacts\contacts.service.js force src\services\index.js create src\models\contacts.model.js create src\services\contacts\contacts.hooks.js create test\services\contacts.test.js 

Мы будем использовать базу данных NeDB для этого урока. Feathers поддерживает обе базы данных SQL, такие как MySQL, и базы данных NoSQL, такие как MongoDB . Однако установка системы базы данных — на вашем компьютере или на облачном сервере — требует определенного времени для ее настройки. NeDB, с другой стороны, является базой данных в памяти, которая на 100% состоит из JavaScript и поддерживает подмножество API MongoDB. Там нет необходимости конфигурации; Вы просто устанавливаете это. Это отличная база данных для создания прототипов и тестирования новых приложений. Это то, что мы будем использовать в этом уроке.

Давайте кратко рассмотрим некоторые из файлов, которые были созданы с помощью этой команды:

• services/contacts/contact.service.js . Это служба Feathers, предоставляющая конечные точки API CRUD для /contacts . Довольно маленький, не правда ли? Это потому, что Перья делает тяжелую работу для нас. Это спасает нас от написания стандартного кода CRUD.

• services/contacts/contact.hooks.js . Здесь мы настраиваем поведение CRUD-логики. У нас есть раздел before , где мы можем проверить или изменить данные до того, как Feathers выполнит чтение или запись в базу данных. У нас также есть раздел after , где мы можем проверить или изменить результаты из базы данных, прежде чем она будет отправлена ​​клиентскому приложению. Мы можем делать такие вещи, как ограничение доступа, проверка данных, выполнение операций объединения и вычисление значений для дополнительных полей или столбцов.

• models/contacts.model.js . Здесь мы определяем модель и присоединяем ее к таблице базы данных. Здесь мы также определяем схему, которая может использоваться для проверки полей при добавлении или обновлении новой записи. К сожалению, NeDB не поддерживает схемы. Тем не менее, я привел пример модели, которая подключена к MongoDB, которая поддерживает функцию схемы через адаптер mongoose :

 "use strict"; const mongoose = require("mongoose"); const Schema = mongoose.Schema; require("mongoose-type-email"); const contactsSchema = new Schema({ name: { first: { type: String, required: [true, "First Name is required"] }, last: { type: String, required: false } }, email: { type: mongoose.SchemaTypes.Email, required: [true, "Email is required"] }, phone: { type: String, required: [true, "Phone is required"], validate: { validator: function(v) { return /^\+(?:[0-9] ?){6,14}[0-9]$/.test(v); }, message: "{VALUE} is not a valid international phone number!" } }, createdAt: { type: Date, default: Date.now }, updatedAt: { type: Date, default: Date.now } }); const contactsModel = mongoose.model("contacts", contactsSchema); module.exports = contactsModel; 

Несмотря на ограничения использования NeDB, это все еще отличная база данных для прототипирования. Большинство баз данных NoSQL позволяют вам отправлять данные, используя любую структуру, без предварительного определения схемы. Разумнее будет реализовать схему после того, как будут выполнены требования проекта. При наличии схемы Feathers выполнит для вас проверку полей с использованием определенных вами правил. Вам понадобится готовая к работе база данных, такая как MongoDB, чтобы иметь возможность определять схему. Обратите внимание, что конфигурация для базы данных разработки определена в config/default.json :

 "nedb": "../data" 

Здесь предоставляются учетные данные базы данных. У нас также есть другой файл config/production.json именем config/production.json . Это конфигурация производственной базы данных, которая используется при развертывании приложения Feathers. При разработке важно использовать отдельную базу данных. В противном случае вы рискуете удалить или повредить бизнес-данные в производственной базе данных.

Теперь, когда у нас настроен CRUD-сервис для contacts , пришло время его развернуть. Вы можете запустить сервер Feather, используя команду npm start . Обратите внимание, что этот сервер не поддерживает горячую перезагрузку. Поэтому вам нужно будет перезапускать его каждый раз, когда вы вносите изменения в код. Чтобы взаимодействовать с нашим приложением Feathers, нам понадобится инструмент браузера API, такой как Postman или Insomnia . Я буду использовать Insomnia в этом уроке, но вы можете легко следовать за Postman или любым другим инструментом.

Создайте новый запрос GET (нажмите Ctrl + N ) и присвойте ему заголовок «Список контактов». В разделе URL введите http://localhost:3030/contacts . Когда вы нажмете кнопку « Отправить» , у вас должно появиться следующее представление:

Ничего! Наша база данных в настоящее время пуста, поэтому нам нужно создать несколько новых контактов. Создайте новый запрос под названием « Create Contact . Заполните остальные поля, как показано ниже:

В случае, если вы забыли изменить МЕТОД на POST в вышеуказанной форме, вы можете сделать это позже. Измените метод на POST и измените вкладку Body на JSON. Скопируйте следующие данные на вкладку JSON:

 { "name": { "first": "Jack", "last": "Bauer" }, "email": "[email protected]", "phone": "+1234567" } 

Когда вы нажмете кнопку «Отправить», вы получите следующий ответ. Обратите внимание, что _id был создан для вашего нового контакта.

Вернитесь к List Contacts и снова нажмите кнопку Отправить . Вы должны получить следующий результат:

 { "total": 1, "limit": 10, "skip": 0, "data": [ { "name": { "first": "Jack", "last": "Bauer" }, "email": "[email protected]", "phone": "+1234567", "_id": "ybnRxL6s2QEGhj4i" } ] } 

Вернитесь к Create Contact и опубликуйте пару новых записей:

 { "name": { "first": "Chloe", "last": "O'Brian" }, "email": "[email protected]", "phone": "+1987654" } 

 { "name": { "first": "Renee", "last": "Walker" }, "email": "[email protected]", "phone": "+150505050" } 

 { "email": "[email protected]" } 

 feathers generate authentication 

 { "email": "[email protected]", "password": "secret" } 

 { "strategy": "local", "email": "[email protected]", "password": "secret" } 

 module.exports = { before: { //... create: [ hashPassword(), authenticate('jwt') ], //... 

 const { authenticate } = require('@feathersjs/authentication').hooks; module.exports = { before: { all: [authenticate('jwt')], //... }, 

 { "name": "NotAuthenticated", "message": "No auth token", "code": 401, "className": "not-authenticated", "data": {}, "errors": {} } 

 feathers generate hooks 

 module.exports = function(options = {}) { return async context => { return context; }; }; 

 module.exports = function(options = {}) { return async context => { // Get authenticated user const user = context.params.user; //Extract Submitted Data const { data } = context; // Add new Fields context.data = { ...data, // Preserve submitted data createdBy: user._id, createdOn: new Date() }; return context; }; }; 

 // eslint-disable-next-line no-unused-vars module.exports = function(options = {}) { return async context => { const { app, method, result, params } = context; // Ensure contacts is an array. If it's a single contact, wrap it into an array const contacts = method === "find" ? result.data : [result]; // Fetch user object from each contact's createdBy await Promise.all( contacts.map(async contact => { contact.user = await app .service("users") .get(contact.createdBy, params); }) ); return context; }; };