Skip to content
TheChatArchiveThe Chat Archive
gpt-4o-2024-08-06· OpenAIAi2 WildChat-4.8M (AI2)

Я сейчас предоставлю текст, ты должен сжать его и выписать самое важное. В это должно…

  1. User

    Я сейчас предоставлю текст, ты должен сжать его и выписать самое важное. В это должно входить: Что такое контроллеры, модели, роутеры, сервисы. Сам текст: Лабораторная работа №8. Создание Node.JS сервера. Знакомство с фреймворком Express, ORM sequelize. Создание Restful API для документа «Доверенность».

    1. Создание Node.JS приложения, установка необходимых библиотек. Express - самый популярный веб-фреймворк для Node.JS. Он является базовой библиотекой для ряда других популярных веб-фреймворков. Express предоставляет следующие механизмы: • Написание обработчиков для запросов с различными HTTP-методами в разных URL-адресах (маршрутах). • Интеграцию с механизмами рендеринга «view», для генерации ответов, вставляя данные в шаблоны. • Установка общих параметров веб-приложения, такие как порт для подключения, и расположение шаблонов, которые используются для отображения ответа. • «промежуточное ПО» для дополнительной обработки запроса в любой момент в конвейере обработки запросов. В то время как сам express довольно минималистичный, разработчики создали совместимые пакеты промежуточного программного обеспечения для решения практически любой проблемы, которая может возникнуть в процессе разработки. Существуют библиотеки для работы с куки-файлами, сеансами, входами пользователей, параметрами URL, данными POST, заголовками безопасности и многими другими. Вы можете найти список пакетов промежуточного программного обеспечения, поддерживаемых командой Express в Express Middlewares (наряду со списком некоторых популярных пакетов сторонних производителей) по ссылке: http://expressjs.com/en/resources/middleware.html Приступим к созданию серверной части приложения. Для начала необходимо создать папку, в которой будут храниться два приложения, клиентское и серверное. Внутри созданной папки необходимо добавить ещё одну папку и назовите её «proxy-backend». В ней будет происходить разработка серверного приложения. Затем нужно открыть папку «proxy-backend» в редакторе кода (в нашем случае VS Code). Теперь нужно инициализировать приложение. Для этого в верхнем меню выбрать пункт «Terminal», затем – «New Terminal».

    В отрывшемся снизу терминале прописать следующую команду: «npm init -y». npm – это стандартный менеджер пакетов, автоматически устанавливающийся вместе с Node.js. Он используется для скачивания пакетов из облачного сервера npm, либо для загрузки пакетов, созданных пользователями на эти сервера.. Команда, которую вы прописали, создает в проекте файл «package.json». Package.json представляет собой нечто вроде файла-манифеста для проекта. Данный файл даёт в распоряжение разработчика множество разноплановых возможностей. Например, он представляет собой центральный репозиторий настроек для инструментальных средств, используемых в проекте. Кроме того, он является тем местом, куда npm и yarn записывают сведения об именах и версиях установленных пакетов. Теперь нужно установить остальные библиотеки. Установка через npm происходит с помощью команды «npm install [название библиотеки]». Установим необходимые библиотеки. Для этого в терминале написать: «npm install express, nodemon, mysql2, sequelize, cors». Рассмотрим установленные библиотеки. nodemon предназначен для автоматической перезагрузки сервера в процессе разработки при сохранении какого-либо файла. Без данной библиотеки после каждого изменения внутри файла, необходимо завершать и заново стартовать сервер вручную. mysql2 – это драйвер для работы с MySQL сервером в Node.JS. Кроме данного существуют ещё некоторые драйвера, например, mysql. Но тесты показывают, что mysql2 более производителен, нежели другие драйвера. sequelize – это ORM-библиотека для приложений на Node.JS, которая осуществляет сопоставление таблиц в базе данных и отношений между ними с классами. При использовании Sequelize, можно не писать SQL-запросы, а работать с данными, как с обычными объектами. Причем Sequelize может работать с рядом СУБД – MySQL, Postgres, MariaDB, SQLite, MS SQL Server. ORM расшифровывается как Object-Relational Mapping — объектно-реляционное отображение или преобразование. ORM хороши тем, что позволяют взаимодействовать с БД на языке приложения (в нашем случае – JavaScript), т.е. без использования специально предназначенных для этого языков (SQL).

    сors – эта библиотека нужна для взаимодействия с серверной частью приложения из браузера. Все установленные библиотеки, а также их версии можно посмотреть в файле package.json

    Кроме того, в папке с проектом появилась новая папка «node_modules». В ней хранится весь исходный код установленных нами библиотек. Однако, если раскрыть папку, то можно увидеть, что число библиотек в ней превышает число библиотек, установленных нами. Это связано с тем, что установленные нами библиотеки также имеют package.json файл, в котором указаны зависимости наших библиотек. Поэтому команда «npm install [название библиотека]» устанавливает не только необходимую нам библиотеку, но и все её зависимости тоже и так далее, пока все зависимости не будут установлены. Обычно, папка «node_modules» содержит очень много файлов и, как следствие, занимает достаточно много памяти. Поэтому при использовании систем контроля версий (например, git) или при передаче проекта, ее не копирует. Вместо нее отправляется «package.json» файл, в котором прописаны все зависимости. А для того, чтобы скачать все зависимости из «package.json» используется команда «npm install» без указания названия библиотеки. Теперь в корневой папке проекта необходимо создать файл, который будет запускать приложение. Назовем файл «index.js», и пропишем там следующий код: /** Подключение зависимостей */ const express = require('express'); const cors = require('cors');

    const PORT = 8080; /** Экземпляр приложения */ const app = express();

    /** Подключение middlewares */ app.use(express.json()); app.use(cors());

    /** Функция старта приложения */ const start = async () => { try { app.listen(PORT, () => console.log(Server run on port - ${PORT})); } catch (e) { console.log(e); } }

    start();

    Метод «require()» используется для получения доступа к объектам или функциям, находящимся в других файлах. В качестве аргумента он принимает строку, содержащую путь к файлу. Переменная PORT содержит порт, по которому сервер будет принимать запросы. Переменная app будет содержать экземпляр express-приложения. Метод «use()» используется для установки функций промежуточной обработки (middlewares). Функции промежуточной обработки могут выполнять следующие задачи: • Выполнение любого кода. • Внесение изменений в объекты запросов и ответов. • Завершение цикла “запрос-ответ”. • Вызов следующей функции промежуточной обработки из стека. Вызов функции промежуточной обработки «express.json()» необходим для преобразования входящих запросов на сервер в формат «JSON». JSON – это текстовый формат обмена данными, основанный на JavaScript. Но при этом формат независим от JS и может использоваться в любом языке программирования. Пример json-файла: { "query": "Иванов Иван", "count": 7 } Вызов функции промежуточной обработки «cors()» позволяет серверу обрабатывать запросы, отправленные из браузера. Метод «listen()» запускает сервер. Первым параметром он принимает номер порта, по которому происходит прослушивание запросов, а вторым – функцию, которая выполняется при успешном запуске сервера. Для того чтобы передать файл на выполнение используется команда «node [название файла]» Запустим «index.js» файл на выполнение. Для этого в терминале пропишем «node index.js». И в случае успешного запуска сервера в консоли появится следующая надпись:

    Теперь задействуем библиотеку «nodemon». Для этого перейдем в package.json файл и в блоке «scripts» добавим два скрипта:

    Помимо зависимостей в package.json файле можно прописывать скрипты для взаимодействия с приложением, например, для запуска приложения на этапе разработке, либо на этапе публикации, для сборки приложения или для его деплоя. Данные скрипты запускаются командой «npm run [название скрипта]». Запустим приложение командой «npm run dev». Для того чтобы остановить работу сервера, необходимо перенести курсор в терминал и нажать сочетание клавиш «CTRL + C». Теперь пропишем команду «npm run dev».

    Теперь видно, за какими путями и расширениями файлов следит nodemon, и при их изменении, перезагружает сервер. Теперь необходимо подключиться к Базе Данных. Для этого в корневой папке проекта создадим файл «connection.js» и напишем следующий код:

    const Sequelize = require('sequelize');

    //** Подключение к БД // const sequelize = new Sequelize( 'proxy', // название Базы Данных 'root', // Пользователь Базы Данных '*', // Пароль для пользователя root { host: 'localhost', // Адрес сервера БД dialect: 'mysql', // Название сервера БД

    }
    

    );

    // Экспорт экземпляра подключения // Нужен для использования в других файлах module.exports = sequelize;

    Не забываем сохранять файлы сочетанием клавиш «CTRL + S». Обратите внимание на то, что после сохранения файла nodemon автоматически перезапускает сервер. Это видно в терминале. Теперь перейдем в «index.js» файл и добавим следующий код:

    1. Под комментарием «Подключение зависимостей» добавить подключение к БД, созданное в файле «connection.js» const sequelize = require('./connection.js');

    2. Перед функцией «start» описать следующую функцию: //** Проверка подключения к БД **// const assertDatabaseConnectionOk = async () => { console.log(Checking database connection...); try { await sequelize.authenticate(); console.log('Database connection OK!'); } catch (error) { console.log('Unable to connect to the database:'); console.log(error.message); } }

    Все функции для работы с Базой Данных асинхронны, то есть неизвестно, сколько времени потребуется для ее выполнения. Асинхронные функции помечаются ключевым словом async. В языке JavaScript такие функции неявным образом возвращают специальный объект Promise. Говоря простым языком, объекты Promise нужны как раз для случаев, когда неизвестно, как долго будет выполнятся функция и как она завершит своё выполнение – успешно или с ошибкой. После выполнения асинхронной функции, Promise сообщит нам, что операция выполнена успешно (говорят: промис разрешился, от англ. resolve - решать), либо операция завершена с ошибкой (операция отклонена, промис зареджектился от reject - отклонять). Внутри функций, помеченных ключевым словом «async» можно использовать другое ключевое слово – await. Ключевое слово await заставит интерпретатор JavaScript ждать до тех пор, пока промис справа от await не выполнится. После чего оно вернёт его результат, и выполнение кода продолжится. Это сделано, потому что код в JavaScript выполняется синхронно, сверху-вниз, строчка за строчкой. И если попадается строка, на которой выполняется какая-либо асинхронная операция, то она начнет свое выполнение, однако код, написанный после нее, продолжит свое выполнение. Это позволяет не блокировать выполнение кода (программа не останавливает своё выполнение), потому что, как было сказано, время, за которое выполнится асинхронная операция, неизвестно. Блокировать выполнение необходимо, если нам нужно знать результат выполнения этой асинхронной операции до того, как дальнейший код выполнится. Блоки кода try {} и catch(e) нужны для того, чтобы отлавливать потенциально возможные ошибки. То есть, в блоке try {} код «пытается» выполниться и если операция выполняется с ошибкой, то эта ошибка попадает в блок catch(e) {}, а программа продолжает работать, а не аварийно прекращает свою работу. 3. Внутри функции «start» перед вызовом «app.listen()» вставьте: await assertDatabaseConnectionOk();

    Это асинхронная функция, и перед тем, как запустить сервер, необходимо удостовериться, что соединение с Базой Данных успешно установлено. Поэтому перед вызовом используется ключевое слово «await». Сохраняем файл. Теперь, если соединение с БД установлено успешно, в терминале появится следующая запись:

    Теперь необходимо описать модели, на которых будет основываться взаимодействие с базой данных. Модели являются ключевым компонентом в работе Sequelize с БД. Они описывают структуру хранящихся в БД данных. Кроме того, через модели в основном идёт взаимодействие с БД. Для начала в корневой папке проекта необходимо создать папку «models» и создать в ней следующие файлы:

    В каждом файле необходимо подключить библиотеку Sequelize и объект соединения с БД: const Sequelize = require('sequelize'); const sequelize = require('../connection');

    Первая строчка подключает библиотеку sequelize, вторая – получает доступ к нашему соединению с БД. Через библиотеку мы получим доступ к типам данных колонок, а через соединение будет происходить создание модели, синхронизация полей модели с полями, описанными в таблице БД. Создание модели происходит через использование метода «define», который имеет наше соединение. Первым параметром в метод передается название модели. Оно должно совпадать с названием таблицы в БД, для которой строится модель, но в единственном числе! Второй параметр, который передается в метод – объект, который задаёт структуру модели, то есть описывает ее поля. Для каждого поля определяется ряд атрибутов (тип поля, ограничение по длине, является ли первичным или внешним ключом и т.д.), которые указывались при создании таблиц в БД. Разберем создание модели на примере таблицы «products» (справочник товаров). Для начала откроем файл «product-model.js». Создадим переменную.

    const ProductModel = sequelize.define(

    В качестве имени модели укажем название таблицы в единственном числе, то есть:

    'product',

    Далее необходимо открыть фигурную скобку, т.к. передаётся объект. В качестве ключей объекта используются названия полей из таблицы, а в качестве значений – другой объект с атрибутами. Например: { id: { type: Sequelize.INTEGER, primaryKey: true, autoIncrement: true, allowNull: false, }, title: { type: Sequelize.STRING, allowNull: false, }, },

    И в конце добавим ещё один объект конфигурации для того, чтобы sequelize не добавлял в записи поля «createdAt» и «updatedAt» { timestamps: false, }

    Вот, что должно получится:

    Добавим ещё одно ограничение: длина строки «title» ограничена 50 символами.

    Для этого атрибуту type в значение Sequelize.STRING в круглых скобках необходимо передать число. В нашем случае – 50. Рассмотрим создание ещё одной модели на примере таблицы «proxyheaders» (шапка документа «Доверенность»): Также создаем модель через sequelize.define(). В качестве имени указываем «proxyheader» В качестве структуры модели – следующие значения: поле type primaryKey autoIncrement allowNull foreignKey id Sequelize.STRING true true false - number Sequelize.INTEGER - - false - dischargeDate Sequelize.DATE - - false - endDate Sequelize.DATE - - false - individualId Sequelize.INTEGER - - false true organizationId Sequelize.INTEGER - - false true

    Третьим параметром передаём { timestamps: false, }

    И экспортируем модель:

    module.exports = ProxyHeaderModel;
    

    Должно получиться следующее:

    Аналогичным образом опишите модели для оставшихся таблиц:

    1. «individuals» (справочник физ. лиц)
    2. «organizations» (справочник организация)
    3. «proxybodies» (тело документа «Доверенность») Название полей таблиц и их атрибуты можно посмотреть в ЛР 7, либо, открыв dbForge, перейти в нужную таблицу и открыть вкладку «columns». После описания моделей, необходимо написать сервисы. Сервисы в нашем случае – это файлы, в которые будет вынесено взаимодействие с базой данных. Выносить это взаимодействие правильно с архитектурной точки зрения. Для начала в корне приложения следует создать папку «services», и создать в ней следующие файлы:

    Рассмотрим создание сервиса для работы с таблицей «products» (справочник товаров). Для начала откроем файл «product-service.js». Импортируем сюда модель этой таблицы («ProductModel»). Затем объявим класс «ProductService» и в экспорт добавим новый экземпляр этого класса: const ProductModel = require('../models/product-model');

    class ProductService {

    }

    module.exports = new ProductService();

    С данными в базе данных можно выполнить 4 операции: • Получить • Добавить • Изменить • Удалить Поэтому в сервисе нам нужно написать 4 метода для этих операций. Конечно, методов в сервисе может быть и больше, например, если необходимо вызвать хранимую процедуру из БД или наоборот, меньше, если какие-то операции не нужны. Напишем метод для получения всех записей из таблицы «products». Так как все операции с БД асинхронны, поэтому все функции будут помечены ключевым словом «async». Для получения всех записей из таблицы у модели есть специальный метод «findAll()». Ниже представлен метод класса ProductService, который возвращает все записи из таблицы «products».

    /** получить все записи из таблицы "products" */
    async getAllRecords() {
        const list = await ProductModel.findAll();
        return list;
    }
    

    Теперь напишем метод для добавления записи в таблицу «products». Для добавления записи у модели есть метод «create()», который принимает данные для записи, создает запись в таблице и возвращает эту запись. Ниже представлен метод класса ProductService, который создает новую запись в таблице «products» и возвращает её со сгенерированным идентификатором.

    /** создать запись в таблице "products" */
    async createRecord(payload) {
        const data = await ProductModel.create(payload);
        return data;
    }
    

    Затем реализуем метод обновления записи по переданному идентификатору. Для этого напишем метод, который будет принимать объект записи, далее внутри этого метода будет происходить поиск одной записи по идентификатору и изменение полей этой записи. Для поиска одной записи у модели есть метод «findOne()», в который можно передать условия отбора. Для сохранения изменений у найденной записи есть метод «save()», который возвращает обновленную запись. Ниже представлен метод класса ProductService, который обновляет запись в таблице «products» и возвращает обновленную запись:

    /** обновить запись в таблице "products" */
    async updateRecord(payload) {
        let record = await ProductModel.findOne({ where: { id: payload.id } });
    

    record.title = payload?.title || record.title;
    return await record.save(); }

    И, наконец, добавим метод, который будет удалять запись по переданному идентификатору. Для удаления записи из таблицы у модели есть метод «destroy()», в который можно передать условия отбора. Ниже представлен метод класса ProductService, который удаляет запись из таблицы «products» и возвращает удаленную запись.

    /** удалить запись из таблицы "products" */
    async removeRecord(recordId) {
        const record = await ProductModel.destroy({ where: { id: recordId } });
        return record;
    }
    

    Аналогичным образом напишите следующие методы: Individual-service.js: • getAllRecords(); - получает все записи из таблицы «individuals» (справочник физ. лиц) и возвращает их. • createRecord(payload); - создает запись в таблице «individuals» • updateRecord(payload); - получает запись из таблицы «individuals» и присваивает ей значение переданного payload • removeRecord(recordId); - удаляет запись из таблицы «individuals» organization-service.js: • getAllRecords(); - получает все записи из таблицы «organizations» (справочник организаций) и возвращает их. • createRecord(payload); - создает запись в таблице «organizations» • updateRecord(payload); - получает запись из таблицы «organizations» и присваивает ей значение переданного payload • removeRecord(recordId); - удаляет запись из таблицы «organizations» по ее идентификатору proxy-header-service.js: • getAllRecords(); - получает все записи из таблицы «proxyheaders» (шапка документа «Доверенность») и возвращает их. • getOneRecords(recordId); - получает запись из таблицы «proxyheaders» по ее идентификатору и возвращает её. • createRecord(payload); - создает запись в таблице «proxyheaders » • updateRecord(payload); - получает запись из таблицы «proxyheaders» и присваивает ей значение переданного payload • removeRecord(recordId); - удаляет запись из таблицы «proxyheaders » по ее идентификатору proxy-body-service.js: • getAllHeadersRecords (headerId); - получает все записи из таблицы «proxybodies» (тело документа «Доверенность») по полю «proxyHeaderId» (внешний ключ таблицы «proxybodies», который связан с таблицей «proxyheaders») и возвращает их. (в метод «findAll» также можно передавать условие отбора). • createRecord(payload); - создает запись в таблице «proxybodies» • updateRecord(payload); - получает запись из таблицы «proxybodies» и присваивает ей значение переданного payload • removeRecord(recordId); - удаляет запись из таблицы «proxybodies» по идентификатору записи

    Теперь, когда описано все взаимодействие с БД, необходимо описать взаимодействие с клиентской частью приложения. Веб-браузеры взаимодействуют с веб-серверами при помощи протокола передачи гипертекста (HTTP). Когда вы кликаете на ссылку на странице, заполняете форму или производите поиск, браузер отправляет на сервер HTTP-запрос.

    Этот запрос включает: • Путь (URL), который определяет целевой сервер и ресурс (например, HTML-файл, конкретная точка данных на сервере или запускаемый инструмент). • Метод, который определяет необходимое действие (например, получить файл, сохранить или обновить какие-либо данные). Различные методы/команды и связанные с ними действия перечислены ниже: o GET – получить определённый ресурс (например, HTML-файл, содержащий информацию о товаре или список товаров). o POST – создать новый ресурс (например, добавить новую статью, добавить новый контакт в базу данных). o HEAD – получить метаданные об определённом ресурсе без получения содержания, как это делает запрос GET. Например, вы можете использовать запрос HEAD, чтобы узнать, когда ресурс в последний раз обновлялся, и только потом использовать (более «затратный») запрос GET, чтобы загрузить сам ресурс, если он был изменён. o PUT – обновить существующий ресурс (или создать новый, если таковой не существует). o DELETE – удалить определённый ресурс. o TRACE, OPTIONS, CONNECT, PATCH – эти команды используются для менее популярных/более сложных задач, поэтому пока мы не будем их рассматривать. • Дополнительная информация может быть закодирована в запросе (например, данные HTML-формы). Информация может быть закодирована как: o URL-параметры: GET запросы зашифровывают данные в URL-адресе, который отправляется на сервер, путём добавления пар имя/значение в его конец, например, http://mysite.com?name=Fred&age=11. В этом случае всегда ставится знак вопроса (?), отделяющий основную часть URL-адреса от URL-параметров, знак равно (=), отделяющий каждое имя от соответствующего ему значения, и амперсанд (&), разделяющий пары. URL-параметры, по своей сути, «небезопасны», так как могут быть изменены пользователями и затем отправлены повторно. В результате, URL-параметры /GET запросы не используются для запросов, которые обновляют данные на сервере. o POST данные. POST запросы добавляют новые ресурсы, данные которых зашифрованы в теле самого запроса. o Куки-файлы клиентской части. Куки-файлы содержат данные сессий о клиенте, включая ключи, которые сервер может использовать для определения статуса его авторизации и разрешения/права доступа к ресурсам. Веб-серверы ожидают сообщений с запросами от клиентов, обрабатывают их, когда они приходят и отвечают веб-браузеру через сообщение с HTTP-ответом. Ответ содержит Код статуса HTTP-ответа, который показывает, был ли запрос успешным (например, «200 OK» означает успех, «404 Not Found» если ресурс не может быть найден, «403 Forbidden», если пользователь не имеет права просматривать ресурс, и т. д.). Тело успешного ответа на запрос GET будет содержать запрашиваемый ресурс. В настоящее время всё большую популярность приобретает способ взаимодействия между серверными и клиентскими приложениями под названием «REST API». Так произошло, поскольку HTTP-протокол реализован во всех языках программирования и всех операционных системах, в отличие от проприетарных протоколов. Representational State Transfer (REST) в переводе — это передача состояния представления. Технология позволяет получать и модифицировать данные и состояния удаленных приложений, передавая HTTP-вызовы через интернет или любую другую сеть. Если проще, то REST API — это когда серверное приложение дает доступ к своим данным клиентскому приложению по определенному URL. Application Programming Interface (API), или программный интерфейс приложения — это набор инструментов, который позволяет одним программам работать с другими. API предусматривает, что программы могут работать в том числе и на разных компьютерах. В этом случае требуется организовать интерфейс API так, чтобы ПО могло запрашивать функции друг друга через сеть. В REST API есть четыре метода HTTP, которые используют для действий с объектами на серверах: • GET (получение информации о данных или списка объектов) • DELETE (удаление данных) • POST (добавление или замена данных) • PUT (обновление данных) Такие запросы еще называют идентификаторами CRUD: create (создать), read (прочесть), update (обновить) delete (удалить). Это стандартный набор действий для работы с данными. • Маршрут (Route - роут) — это «имя», которое отсылает работу API к определенным эндпоинтам. Если упростить, то можно сказать, что маршрут – это URL, к которому можно обратиться разными HTTP методами. Маршрут может иметь несколько эндпоинтов. • Эндпоинт (Endpoint - конечная точка) — это само обращение к маршруту отдельным HTTP методом. Эндпоинт выполняют конкретную задачу, принимают параметры и возвращают данные Клиенту. Например, http://example.com/wp-json/wp/v2/posts/123: • Здесь wp/v2/posts/123 — это маршрут, а /wp-json — это базовый путь самого REST API. • Этот маршрут имеет 3 эндпоинта: o GET o PUT|PATCH|POST o DELETE Для того чтобы сервер мог вернуть ответ на запрос по определенному эндпоинту, необходимо описать эти эндпоинты. Для этого необходимо в корневой папке проекта создать папку «routers» и создать в ней файл «router.js»:

    Затем необходимо перейти в созданный файл и подключить класс «Router» из библиотеки «express». Следующим шагом будет создание экземпляра класса «Router» и его экспорт:

    const Router = require("express").Router;
    
    const router = new Router();
    

    module.exports = router;

    У экземпляра класса «Router» существуют методы, которые соответствуют HTTP-методам: • .post() – для HTTP-метода POST, • .get () – для HTTP-метода GET, • .put () – для HTTP-метода PUT, • .delete () – для HTTP-метода DELETE, Каждый из этих методов первым параметром принимает строку «эндпоинт». Затем передается функция, которая будет обрабатывать этот эндпоинт. Данные функции называются контроллерами. Создадим папку «controllers» в корневой папке приложения и добавим в неё следующие файлы:

    Рассмотрим пример работы с HTTP-запросом и HTTP-ответом на примере работы со справочником продуктов. Пусть вся работа с продуктами осуществляется через «/products». Добавим первый обработчик, который будет реагировать на HTTP GET запрос и возвращать список всех продуктов из Базы Данных.

    Для начала перейдем в файл «product-controller.js», создадим в нем класс «ProductController» и экспортируем его экземпляр:

    class ProductController {

    }

    module.exports = new ProductController()

    Внутри класса добавим метод, которому будет передано управлении при запросе на эндпоинт «.get(‘/products’)». const ProductService = require('../services/product-service');

    class ProductController { async getAllRecords(req, res) { try { const list = await ProductService.getAllRecords(); return res .status(200) .json(list); } catch (e) { return res .status(500) .json(e); } } }

    module.exports = new ProductController()

    Функция-контроллер принимает объект HTTP-запроса и объект HTTP-ответа в качестве параметров. Благодаря этим объектам можно взаимодействовать с данными, которые были переданы в HTTP-запросе, добавлять статус-код HTTP-ответа, возвращать данные на клиент. В данном случае нам нужно получить все записи из таблицы «products». Это действие мы описали в классе «ProductService» в методе «getAllRecords()». Поэтому мы вызываем данный метод внутри контроллера. Через объект «res» (объект HTTP-ответа) мы устанавливаем статус-код 200, что соответствует успешному ответу и передаем JSON объект со списком продуктов. В случае ошибки в методе «getAllRecords()» класса «ProductService» мы устанавливаем статус-код 500, что соответствует ошибке на стороне сервера и передаем JSON объект с описанием ошибки. Теперь в файле «router.js» необходимо связать эндпоинт и функцию-контроллер:

    const Router = require("express").Router; const ProductController = require('../controllers/product-controller');

    const router = new Router();

    router.get ( '/products', ProductController.getAllRecords, );

    module.exports = router;

    Рассмотрим пример создания контроллера для HTTP-метода POST: Метод POST применяется для создания записи, поэтому создадим функцию-контроллер «createRecord» и вызовем внутри метод «createRecord» класса «ProductService». Тело запроса можно получить из поля «req.body» внутри контроллера. Код функции-контроллера для создания записи в таблице «products» выглядит следующим образом: async createRecord(req, res) { try { const record = await ProductService.createRecord(req.body); return res .status(200) .json(record); } catch (e) { return res .status(500) .json(e); } }

    Свяжем эндпоинт и контроллером в файле «router.js»: router.post ( '/products', ProductController.createRecord, )

    Функция-контроллер для обновления записи в таблице «products»: async updateRecord(req, res) { try { const record = await ProductService.updateRecord(req.body); return res .status(200) .json(record); } catch (e) { return res .status(500) .json(e); } }

    Ее эндпоинт: router.put( '/products', ProductController.updateRecord, )

    Удаление будет происходить по идентификатору записи. Этот идентификатор будет передаваться в URL строке с названием «id». Для получения URL параметров нужно обратиться к полю «req.params.[название_параметра]». Название параметра указывается по следующему шаблону: «/products/:[название_параметра]» при указании эндпоинта. Функция-контроллер для удаления записи из таблицы «products»: async removeRecord(req, res) { try { const recordId = req.params.id; const record = await ProductService.removeRecord(recordId); return res .status(200) .json(record); } catch (e) { return res .status(500) .json(e); } }

    Ее эндпоинт: router.delete ( '/products/:id', ProductController.removeRecord, )

    Аналогичным образом опишите контроллеры и эндпоинты для остальных сервисов.

    !!!! ОБРАТИТЕ ВНИМАНИЕ Для получения записей из таблицы «proxybodies» (тело документа «Доверенность») необходимо передать параметр «headerId». Сделайте это аналогично передаче параметра при удалении в описании эндпоинта для получения списка из этой таблицы.

    Теперь необходимо зарегистрировать роутер в файле «index.js»

    Проверим работу приложения. Для этого запустите сервер, откройте браузер и в URL-строке укажите «http://localhost:8080/api/products»

    По умолчанию при указании URL строки браузер отправляет HTTP GET запрос по указанному пути. Мы описали обработчик для этого эндпоинта, поэтому сервер взял данные из БД таблицы «products» и отправил их браузеру.

  2. Assistant

    Контроллеры, модели, роутеры и сервисы — это ключевые компоненты архитектуры приложения, особенно популярные в веб-разработке на JavaScript с использованием фреймворков, таких как Express и ORM-библиотеки, такие как Sequelize.

    1. Контроллеры:

      • Контроллеры обрабатывают HTTP-запросы, получаемые сервером. Они содержат бизнес-логику приложения.
      • Контроллеры принимают объект HTTP-запроса и формируют HTTP-ответ, взаимодействуя с сервисами для выполнения операций с данными.
      • В контроллерах реализуются методы для обработки основных HTTP-запросов: GET, POST, PUT, DELETE и т.д.
    2. Модели:

      • Модели представляют собой структуры данных, которые работают с базой данных. Они определяют схемы таблиц и занимаются отображением объектно-реляционных записей данных.
      • С помощью ORM, таких как Sequelize, модели абстрагируют взаимодействие с базами данных, позволяя выполнять операции без написания SQL-запросов.
      • Модели определяют, какие поля содержит одна или несколько таблиц и взаимодействуют напрямую с базой данных через методы create, findAll, update и другие.
    3. Роутеры:

      • Роутеры управляют URL-адресами приложения и направляют запросы на соответствующие контроллеры.
      • Они позволяют определить, какой метод контроллера обрабатывать данные по конкретному маршруту.
      • Почти каждый HTTP-метод имеет свой роут: .get(), .post(), .put(), .delete() и другие для реализации REST API.
    4. Сервисы:

      • Сервисы обеспечивают бизнес-логику приложения, отделяя её от контроллеров.
      • Они предлагают функции для выполнения операций с данными. Это позволяет централизовать логику и многократно использовать её в различных частях приложения.
      • Сервисы взаимодействуют с моделями для получения, добавления, обновления и удаления данных из базы.

    Эти компоненты совместно обеспечивают структурированное и модульное построение приложения, упрощая его разработку, тестирование и поддержку.

  3. User

    Дополни краткую выжимку от себя (дополни предыдущий ответ)

  4. Assistant

    Контроллеры, модели, роутеры и сервисы составляют основу современной архитектуры веб-приложений, особенно при использовании Node.js и Express. Эти компоненты позволяют разделить ответственность, организовать код и упростить поддержку приложения.

    1. Контроллеры:

      • Контроллеры служат связующим звеном между пользовательскими запросами и бизнес-логикой.
      • Они обрабатывают входящие запросы, проверяют данные и вызывают соответствующие методы в сервисах.
      • Контроллеры также формируют HTTP-ответы, обеспечивая взаимодействие между клиентом и сервером.
    2. Модели:

      • Модели представляют данные и правила их хранения в базе данных.
      • Они абстрагируют сложность SQL-запросов, что упрощает их использование и уменьшает риск ошибок.
      • Модели не только описывают структуру данных, но и могут включать методы, связанные с конкретными операциями данных.
    3. Роутеры:

      • Роутеры организуют маршрутизацию запросов в приложении, определяя, какой контроллер и метод следует использовать.
      • Они обеспечивают гибкость в управлении потоком запросов и позволяют легко добавлять новые маршруты.
      • Использование роутеров облегчает управление сложной логикой маршрутизации в крупных приложениях.
    4. Сервисы:

      • Сервисы помогают поддерживать чистоту и организованность кода, вынеся бизнес-логику из контроллеров.
      • Они обеспечивают интерфейс для выполнения всех операций с данными, включая взаимодействие с внешними API.
      • Сервисы делают код более поддерживаемым и тестируемым, концентрируя операции в одном месте.

    Эта архитектурная модель позволяет создать стабильно функционирующее приложение с четкой структурой, что облегчает разработку новых функций и масштабирование проекта. Каждая из этих частей имеет свою четко определенную задачу, что позволяет разработчикам сосредоточиться на отдельных аспектах приложения без перегрузки.